infrahub-sync
Synchronize registered configurations through the Sync API.
Usage:
$ infrahub-sync [OPTIONS] COMMAND [ARGS]...
Options:
--api-url <str>: Absolute URL of the Sync API. Defaults to INFRAHUB_SYNC_API_URL. [env var: INFRAHUB_SYNC_API_URL]--verbosity <quiet|default|verbose>: Log verbosity level. [default: default]-v, --verbose: Shorthand for --verbosity verbose.-q, --quiet: Shorthand for --verbosity quiet.--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
diff: Create a plan run and review its saved...sync: Create a confirmed synchronization run.apply: Apply a service-owned plan after binding...configs: Register and inspect configuration packages.runs: Inspect service-owned runs.
infrahub-sync diff
Create a plan run and review its saved summary after completion.
Usage:
$ infrahub-sync diff [OPTIONS]
Options:
--config-id <str>: Registered configuration identity. [required]--version <int>: Registered configuration version. [required]--reason <str>: Audit reason for the plan. [required]--branch <str>: Destination branch admitted by the Sync API.--idempotency-key <str>: Retry key.--wait / --no-wait: Wait for this run's execution. [default: wait]--wait-timeout <float>: Bounded wait in seconds. [default: 1800.0]--poll-interval <float>: Poll interval in seconds. [default: 2.0]--help: Show this message and exit.
infrahub-sync sync
Create a confirmed synchronization run.
Usage:
$ infrahub-sync sync [OPTIONS]
Options:
--config-id <str>: Registered configuration identity. [required]--version <int>: Registered configuration version. [required]--reason <str>: Audit reason for the synchronization. [required]--branch <str>: Destination branch admitted by the Sync API.--idempotency-key <str>: Retry key.--wait / --no-wait: Wait for this run's execution. [default: wait]--wait-timeout <float>: Bounded wait in seconds. [default: 1800.0]--poll-interval <float>: Poll interval in seconds. [default: 2.0]--help: Show this message and exit.
infrahub-sync apply
Apply a service-owned plan after binding its reviewed checksum.
Usage:
$ infrahub-sync apply [OPTIONS] {run_id}
Arguments:
run_id: Service-issued run ID whose plan was reviewed. [required]
Options:
--expected-checksum <str>: Checksum printed byruns plan. [required]--reason <str>: Audit reason for the apply. [required]--branch <str>: Destination branch admitted by the Sync API.--idempotency-key <str>: Retry key.--wait / --no-wait: Wait for this run's apply execution. [default: wait]--wait-timeout <float>: Bounded wait in seconds. [default: 1800.0]--poll-interval <float>: Poll interval in seconds. [default: 2.0]--help: Show this message and exit.
infrahub-sync configs
Register and inspect configuration packages.
Usage:
$ infrahub-sync configs [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
register: Register a JSON or YAML configuration...version: Create the next immutable version of a...list: List registered configurations.show: Show a configuration or one of its versions.versions: List immutable versions of a registered...validate: Validate a registered configuration version.
infrahub-sync configs register
Register a JSON or YAML configuration package.
Usage:
$ infrahub-sync configs register [OPTIONS] {package}
Arguments:
package: [required]
Options:
--reason <str>: Audit reason for the mutation. [required]--idempotency-key <str>: Retry key. A new key is generated and printed when omitted.--help: Show this message and exit.
infrahub-sync configs version
Create the next immutable version of a registered configuration.
Usage:
$ infrahub-sync configs version [OPTIONS] {config_id} {package}
Arguments:
config_id: [required]package: [required]
Options:
--reason <str>: Audit reason for the mutation. [required]--idempotency-key <str>: Retry key. A new key is generated and printed when omitted.--help: Show this message and exit.
infrahub-sync configs list
List registered configurations.
Usage:
$ infrahub-sync configs list [OPTIONS]
Options:
--help: Show this message and exit.
infrahub-sync configs show
Show a configuration or one of its versions.
Usage:
$ infrahub-sync configs show [OPTIONS] {config_id}
Arguments:
config_id: [required]
Options:
--version <int>: Show one immutable registry version.--help: Show this message and exit.
infrahub-sync configs versions
List immutable versions of a registered configuration.
Usage:
$ infrahub-sync configs versions [OPTIONS] {config_id}
Arguments:
config_id: [required]
Options:
--help: Show this message and exit.
infrahub-sync configs validate
Validate a registered configuration version.
Usage:
$ infrahub-sync configs validate [OPTIONS] {config_id} {version}
Arguments:
config_id: [required]version: [required]
Options:
--offset <int>: Finding offset. [default: 0]--limit <int>: Maximum findings to return. [default: 256]--help: Show this message and exit.
infrahub-sync runs
Inspect service-owned runs.
Usage:
$ infrahub-sync runs [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
show: Show one run's service record and its...results: Print the results the service recorded for...plan: Review a saved plan summary, checksum, and...
infrahub-sync runs show
Show one run's service record and its selected execution.
Usage:
$ infrahub-sync runs show [OPTIONS] {run_id}
Arguments:
run_id: Service-issued run ID. [required]
Options:
--help: Show this message and exit.
infrahub-sync runs results
Print the results the service recorded for one run, as JSON.
Usage:
$ infrahub-sync runs results [OPTIONS] {run_id}
Arguments:
run_id: Service-issued run ID. [required]
Options:
--help: Show this message and exit.
infrahub-sync runs plan
Review a saved plan summary, checksum, and operations.
Usage:
$ infrahub-sync runs plan [OPTIONS] {run_id}
Arguments:
run_id: Service-issued run ID. [required]
Options:
--detail: Render every saved operation.--kind <str>: Filter the detailed operation list by destination kind; requires --detail.--help: Show this message and exit.