Chef Blogs

What the New Runtime Licensing Means for chef Gem Users

Clinton Wolfe | Posted on | Chef | Chef Infra | Chef Infra Client

Background

Progress Chef Infra Client, the flagship configuration management agent from Progress Chef, is built upon the Ruby language platform. Like most Ruby software, Chef Infra Client is internally composed of components known as Gems. These Gems may be publicly distributed via a hub, rubygems.org.  Progress Chef publishes several internal components of Chef Infra Client to rubygems.org, including the core library, chef.

What’s Changing?

Chef Infra Client 19 introduces new licensing requirements.  When distributed in an official Progress distribution (such as an RPM, DEB, or MSI) or through a Progress RubyGem server, runtime licensing is not required. However, when obtained through any other channel, including the public rubygems.org server, a license key is required at runtime.

You can get limited-capability license keys on a free and trial basis or contact us for commercial licenses.

Who is Affected?

Users Who Run gem install chef

While most users install Chef Infra Client from a native package (and will thus be unaffected), those who wish for additional control over the Gem ecosystem may opt for direct installation of the chef gem. This may be done at the CLI or in a pipeline. In this case, a license key will be required.

Users Who Run gem install knife

The best way to get Knife is via Workstation from a native package. Users wishing for more control in the future can look to our new Hab-based installation system for Chef Workstation 26.  Previously, to get this effect, gem installation was the only answer.  In this case, users would need to provide a license key to use Chef or bootstrap nodes.

Using Chef in a Project

If a user uses Chef in another Gem, they will require a license key.

Who is Not Affected?

Users Who Run gem install test-kitchen

Gem-based installs of test-kitchen do not depend on the chef gem. It bootstraps instances; it does not converge locally.  However, for Chef 19 support, users will need to switch to Chef Test Kitchen Enterprise following the release of Workstation 26, which introduces forward support for Chef Infra Client licensing and advanced Habitat-based installs.

Users Installing from RPM, DEB, MSI or DMG

Users of the OS-native installer have already used their license key at download time. They are thus free to distribute the binary within their organization according to the terms of their License.  These native binaries do not require runtime licensing.

 

What do I need to do?

Obtain a license key

To begin your journey with enhanced support, a complete ecosystem, and access to premium content, contact your Progress sales representative for a commercial license. To obtain a free or trial license key for only Chef Infra Client, submit a License Request.

Provide a license key

ENV var

You may set the CHEF_LICENSE_KEY environment variable to provide the license key. This may be done through automation, a secrets manager, or manually.

--license-key

You may use the CLI option `--license-key` to provide the license key.

Interactive

If the license key is not provided through an environment variable or the CLI option, Chef Infra Client will detect if the terminal is interactive and then prompt the user for a license key. If non-interactive, Chef Infra Client will issue errors and exit.

What's Next?

Stay tuned for the release of Workstation 26, which comes with advanced package management allowing you to choose à la carte which components you want.

 

To obtain a new license: 

  1. Contact us for a Commercial License
  2. Request a Free or Trial License