Skip to main content
Version: V3

Install Infrahub Sync

Infrahub Sync V3 runs as a service on a Docker Compose host. The private candidate includes the Sync API, worker, Prefect, PostgreSQL, object storage, and a matching command-line client. Run that client through the bundle on the Docker host; a separate Sync installation on the host is not required.

See Supported platforms and limits for Compose deployment qualification and current product limits.

Moving from V2? Move from V2 to V3 compares the two lines and states what to prepare first. A switch starts a fresh deployment; there is no in-place state migration.

Get the private candidate​

Candidate 4 (3.0.0a4) is available from the private release. Sign in to GitHub with an account that has access to opsmill/infrahub-sync-lab. If you cannot open the release or download its attachments, contact the person who provided the candidate.

Download both release attachments:

  • private-candidate-3.0.0a4-f98a845-h1.1.tar.gz
  • private-candidate-3.0.0a4-f98a845-h1.1.tar.gz.sha256

For Candidate 4, follow the Quick Start linked from its release notes to verify both checksum layers, load the image, extract the Compose bundle, and run init and start. Continue only when status reports READY. Those instructions are pinned to Candidate 4-compatible guides; the current development documentation can change independently.

The public PyPI package is V2, not this private candidate's client. Follow the bundled CLI route below for V3 testing.

Run the included CLI​

From the extracted infrahub-sync-compose-3.0.0a4 directory on the Docker host, run:

./infrahub-sync-compose cli configs list

The wrapper runs the CLI in the same image as the deployment, on its network, with the API token generated by init. You do not need to export a token or install Sync with pip.

On a fresh deployment, the registry is empty: the command prints no configuration output and exits zero. Docker Compose may print container progress messages. This checks access to the Sync API, not a connection to your source or destination. If it fails, check ./infrahub-sync-compose status and follow the Candidate 4 operator guide for diagnosis.

The extracted bundle also includes OPERATING.md for local operating instructions. Use it after the release's download and checksum steps.

Next step​

Prepare a configuration using the source tutorials linked from the Candidate 4 release notes, then follow its operator guide to register the package and review a plan.