Skip to content

cli-migration.md

Latest commit

 

History

History
94 lines (77 loc) · 2.84 KB

cli-migration.md

File metadata and controls

94 lines (77 loc) · 2.84 KB

CLI Config Migration Details

Parent document: BEP-1046

CLI Usage

Provides a CLI tool that auto-generates the new [service-discovery.endpoints] section from existing config.

# Usage — structured as subcommands under config migrate
# Extensible structure for future config migrations
$ backend.ai ag config migrate service-discovery -i agent.toml
$ backend.ai mgr config migrate service-discovery -i manager.toml
$ backend.ai storage config migrate service-discovery -i storage-proxy.toml

# Options
  -i, --input PATH     Existing config file path
  -o, --output PATH    Output file (stdout if omitted)
  --append             Append directly to existing file
  --dry-run            Preview without changes (default)
  --force              Execute without confirmation

Mapping Rules

Per-component rules that map existing config fields to (role, scope, protocol) tuples are defined in code:

# Agent mapping rules
AGENT_MAPPING_RULES = [
    MappingRule(source="agent.advertised-rpc-addr",
                fallback="agent.rpc-listen-addr",
                role="rpc", scope="cluster", protocol="zmq"),
    MappingRule(source="agent.service.announce-internal-addr",
                fallback="agent.service.service-addr",
                role="metrics", scope="cluster", protocol="http"),
    MappingRule(source="agent.service.announce-internal-addr",
                role="metrics", scope="container", protocol="http"),
]

# Storage Proxy mapping rules
STORAGE_MAPPING_RULES = [
    MappingRule(source="manager.announce-addr",
                fallback="manager.service-addr",
                role="api", scope="cluster", protocol="http"),
    MappingRule(source="client.service-addr",
                role="client-api", scope="cluster", protocol="http"),
    MappingRule(source="manager.announce-internal-addr",
                role="client-api", scope="container", protocol="http"),
]

# Manager mapping rules
MANAGER_MAPPING_RULES = [
    MappingRule(source="manager.service-addr",
                role="api", scope="cluster", protocol="http"),
]

Output Example

$ backend.ai ag config migrate service-discovery -i agent.toml

# Detected existing config fields:
#   agent.rpc-listen-addr = 0.0.0.0:6001
#   agent.advertised-rpc-addr = 10.0.1.5:6001
#   agent.service.service-addr = 0.0.0.0:6002
#   agent.service.announce-internal-addr = host.docker.internal:6002
#
# Generated [service-discovery] section:

[service-discovery]

[[service-discovery.endpoints]]
role = "rpc"
scope = "cluster"
address = "10.0.1.5"
port = 6001
protocol = "zmq"

[[service-discovery.endpoints]]
role = "metrics"
scope = "cluster"
address = "host.docker.internal"
port = 6002
protocol = "http"

[[service-discovery.endpoints]]
role = "metrics"
scope = "container"
address = "host.docker.internal"
port = 6002
protocol = "http"