Skip to main content

License

Licensing Information

Before running Chef Infra, you must accept the Chef EULA and add a license key.

Chef Infra accepts a license key using one of two methods:

For more information on Chef licenses, see Chef’s licensing documentation.

You can request a trial license if you’d like to try out Infra.

Accept the Chef EULA

You must accept the Chef End User License Agreement (EULA) before running Chef Infra using one of two methods.

If no command line argument or environment variable is set, Chef Infra requests acceptance through an interactive prompt. If the prompt can’t be displayed, then the product will fail with exit code 172.

If the product attempts to persist the accepted license and fails, Chef Infra sends a message to STDOUT and continues to run. In a future invocation, you will need to accept the license again.

Command line option

Use the --chef-license <value> argument to accept the Chef EULA.

Replace <value> with one of the following options.

accept
Accept the license and attempts to persist a marker file locally. Persisting these marker files means future invocations don’t require accepting the license again.
accept-silent
Similar to accept, but no messaging is sent to STDOUT.
accept-no-persist
Similar to accept-silent, but no marker file is persisted. Future invocation will require accepting the license again.

Environment variable

Use the CHEF_LICENSE="<value>" environment variable to accept the Chef EULA.

Replace <value> with one of the following options.

accept
Accept the license and attempts to persist a marker file locally. Persisting these marker files means future invocations don’t require accepting the license again.
accept-silent
Similar to accept, but no messaging is sent to STDOUT.
accept-no-persist
Similar to accept-silent, but no marker file is persisted. Future invocation will require accepting the license again.

License key

You can add a license key to Chef Infra using one of three methods:

Note

Existing commercial customers of Progress Chef may use an asset serial number from the Progress support portal as a license key.

Interactive license dialog

The easiest way to provide a license key to Chef Infra is to run Chef Infra. Start a run and Infra will start an interactive licensing dialog if no license key is already set and it doesn’t detect an automated method of setting the license key.

  1. To start the interactive licensing dialog, start a run

  2. At the first prompt, select I already have a license ID.

    ------------------------------------------------------------
  License ID Validation

  To continue using Chef Infra, a license ID is required.
  (Free, Trial, or Commercial)

  If you generated a license previously, you might
  have received it in an email.

  If you are a commercial user, you can also find it in the
  https://community.progress.com/s/products/chef portal.
------------------------------------------------------------

Please choose one of the options below (Press ↑/↓ arrow to move and Enter to select)
‣ I already have a license ID
  I don't have a license ID and would like to generate a new license ID
  Skip

  3. Enter your license key at the second prompt.

    Please choose one of the options below I already have a license ID
Please enter your license ID:  <LICENSE_KEY>
✔ [Success] License validated successfully.
------------------------------------------------------------
License Details
  Asset Name       : Infra
  License ID       : <LICENSE_KEY>
  Type             : Trial
  Status           : Active
  Validity         : Unlimited
  No. Of Units     : 10 Targets
------------------------------------------------------------

Chef Infra validates the license key, displays information about the license entitlements, and then executes the run. Chef Infra stores license keys for future use and will not prompt you for the license key for the duration of your license.

Command line option

You can set the license key in the command line using the --chef-license-key option. You may provide this argument to most Chef Infra CLI main commands.

Environment variable

You can set the license key using the CHEF_LICENSE_KEY environment variable. Chef Infra will read the license key from the variable and attempt to validate the key. If successful, Infra saves the key and will not prompt you for it the next time you run Infra.

export CHEF_LICENSE_KEY=<LICENSE_KEY>

Chef Local License Service

For large or isolated (air-gapped) fleets, Chef Infra can retrieve a license key from a Chef Local License Service. With Chef Local License Service, Infra users do not need to know a license key—only the service URL(s).

Chef Infra sends a request to the Local License Service for a list of license keys and then uses that response to license itself during execution. Infra will not prompt you for a license key. Chef Infra does not store license keys for long-term use when they are retrieved from a Chef Local License Service.

Use one of the following methods to set a Local License Service URL.

Command line option

Use the --chef-license-server command line option to set a Chef Local License Service URL.

--chef-license-server https://license-server.example.com

Environment variable

Use the CHEF_LICENSE_SERVER environment variable to set a Chef Local License Service URL.

export CHEF_LICENSE_SERVER=https://license-server.example.com

Multiple license servers

You can set multiple Chef Local License Services, which provides resiliency and redundancy for managing licenses.

Enter up to five Chef Local License Service URLs as a comma-separated list. Chef Infra will try each URL and use the first one that works.

export CHEF_LICENSE_SERVER=https://license-server-01.example.com,https://license-server-02.example.com

This capability is basic and you must synchronize the license servers, otherwise you may get inconsistent results.

Edit this page on GitHub

Thank you for your feedback!

×









Search Results