Consul-Terraform-Sync Command (CLI)

When running as a daemon, there is no default configuration to run Consul-Terraform-Sync in a meaningful way. Setting a configuration flag -config-file or -config-dir is required. For example:

To view a list of available flags, use the -help or -h flag.

Consul-Terraform-Sync can be run as a daemon in different modes.

Long-running Mode

Flag: none

Behavior: This is the default mode in which Consul-Terraform-Sync passes through a once-mode phase and then turns into a long running process. During the once-mode phase, the daemon will exit with a non-zero status if it encounters an error. After successfully passing through once-mode phase, it will begin a long-running process in which errors are logged and exiting is not expected behavior. Once beginning the long-running process, the daemon serves any API and command requests.

Usage: Intended to be run as a long running process after running once-mode successfully for given configuration and tasks.

Inspect Mode

Behavior: Consul-Terraform-Sync will display the proposed state changes for all tasks once and exit. No changes are applied in this mode. On encountering an error before completing, Consul-Terraform-Sync will exit with a non-zero status.

Usage: Intended to be run before daemon-mode in order to confirm configuration is accurate and tasks would update network infrastructure as expected.

Flag: -inspect-task [task-name]

Behavior: This has similar behavior as -inspect mode for the selected task. The flag can be specified multiple times to inspect multiple tasks. No changes are applied in this mode.

Usage: Useful to debug one or more tasks to confirm configuration is accurate and the selected tasks would update network infrastructure as expected.

Once Mode

Flag: -once

Usage: Intended to be run before daemon-mode in order to confirm configuration is accurate and tasks update network infrastructure as expected.

Commands

In addition to running the daemon, Consul-Terraform-Sync has a set of commands that act as a client to the daemon server. The commands provide a user-friendly experience interacting with the daemon. The commands use the Consul-Terraform-Sync’s APIs but does not correspond one-to-one with it. Please see the individual commands in the left navigation for more details.

To get help for a command, run: consul-terraform-sync <command> -h

Consul-Terraform-Sync commands follow the below structure

• args: Required arguments specific to a commands

Example:

Below are options that can be used across all commands: