Skip to main content

infrahub-sync

Synchronize registered configurations through the Sync API.

Usage:

$ infrahub-sync [OPTIONS] COMMAND [ARGS]...

Options:

  • --api-url TEXT: 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 TEXT: Registered configuration identity. [required]
  • --version INTEGER: Registered configuration version. [required]
  • --reason TEXT: Audit reason for the plan. [required]
  • --branch TEXT: Destination branch admitted by the Sync API.
  • --idempotency-key TEXT: 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 TEXT: Registered configuration identity. [required]
  • --version INTEGER: Registered configuration version. [required]
  • --reason TEXT: Audit reason for the synchronization. [required]
  • --branch TEXT: Destination branch admitted by the Sync API.
  • --idempotency-key TEXT: 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 TEXT: Checksum printed by runs plan. [required]
  • --reason TEXT: Audit reason for the apply. [required]
  • --branch TEXT: Destination branch admitted by the Sync API.
  • --idempotency-key TEXT: 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 TEXT: Audit reason for the mutation. [required]
  • --idempotency-key TEXT: 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 TEXT: Audit reason for the mutation. [required]
  • --idempotency-key TEXT: 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 INTEGER: 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 INTEGER: Finding offset. [default: 0]
  • --limit INTEGER: 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:

  • plan: Review a saved plan summary, checksum, and...

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 TEXT: Filter the detailed operation list by destination kind; requires --detail.
  • --help: Show this message and exit.