Consul-Terraform-Sync Enterprise License

    Licenses are only required for Consul-Terraform-Sync (CTS) Enterprise

    CTS Enterprise binaries require a Consul Enterprise license to run. There is no CTS Enterprise specific license. As a result, CTS Enterprise’s licensing is very similar to Consul Enterprise.

    All CTS Enterprise features are available with a valid Consul Enterprise license, regardless of your Consul Enterprise packaging or pricing model.

    To get a trial license for CTS, you can sign-up for the .

    CTS automatically retrieves a license from Consul on startup and then attempts to retrieve a new license once a day. If the current license is reaching its expiration date, CTS attempts to retrieve a license with increased frequency, as defined by the License Expiration Date Handling.

    If a license needs to be manually set, choose one of the following methods (in order of precedence) to set the license:

    1. Set the environment variable to the path of the file containing the license.

      1. export CONSUL_LICENSE_PATH=<PATH>/<TO>/<FILE>

    2. To point to the file containing the license, in the configuration file, configure the path option.

      1.   path = "<PATH>/<TO>/<FILE>"

    3. To point to the file containing the license, in the configuration file, configure the license_path option i. Deprecated in CTS 0.6.0 and will be removed in a future release. Use instead.

      1. license_path = "<PATH>/<TO>/<FILE>"

    To update the license when it expires or is near the expiration date and automatic license retrieval is disabled:

    1. Stop and restart CTS Enterprise

    Once CTS Enterprise starts again, it will pick up the new license and run the tasks with any changes that may have occurred between the stop and restart period.

    Licenses have an expiration date and a termination date. The termination date is a time at or after the license expires. CTS Enterprise will cease to function once the termination date has passed.

    The time between the expiration and termination dates is a grace period. Grace periods are generally 24-hours, but you should refer to your license agreement for complete terms of your grace period.

    When approaching expiration and termination, by default, CTS Enterprise will attempt to retrieve a new license. If auto-retrieval is disabled, CTS Enterprise will provide notifications in the system logs: