diff --git a/content/licensing/_index.md b/content/licensing/_index.md index fa3dc1f6f01..1a299ead06a 100644 --- a/content/licensing/_index.md +++ b/content/licensing/_index.md @@ -29,11 +29,11 @@ Source code reuse is unchanged and follows the [Apache 2.0](#apache-20) model fo The commercial distributions of our products--such as Chef Infra Client, Chef Habitat, or Chef InSpec--are governed by either the [Chef End User License Agreement (Chef EULA)](https://www.chef.io/end-user-license-agreement) or your commercial agreement with Progress Software Corporation. You must accept these terms when using the distributions for the first time. For additional information on how to accept the license, see [Accepting the Chef License](accept) documentation. -If you have a license from before April 2019 (referred to as the Chef Master License and Services Agreement, or MLSA), please consult the [Chef versions documentation](https://docs.chef.io/versions/) to understand which license applies. +If you have a license from before April 2019 (referred to as the Chef Master License and Services Agreement, or MLSA), please consult the [Chef versions documentation](/versions/) to understand which license applies. ## Apache 2.0 -The [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) governs the reuse of source code of open source Progress Chef projects--including Chef Infra Client ("chef"), Chef InSpec, and Chef Habitat--unless specified otherwise in the project's repository. +The [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) governs the reuse of source code of open-source Progress Chef projects--including Chef Infra Client ("chef"), Chef InSpec, and Chef Habitat--unless specified otherwise in the project's repository. Source code is released publicly through repositories in these organizations: - [Progress Chef](https://github.com/chef) @@ -46,7 +46,6 @@ Intermediate products--such as binaries, modules, containers, and executables (i For further questions, please contact [Chef Developer Relations](https://community.chef.io/). - ## License tiers Starting with Chef InSpec 6, there are three license tiers that have different entitlements: free, trial, and commercial. @@ -56,8 +55,7 @@ Upon installation of Chef InSpec, you must accept the basic [Progress Chef EULA] |------------|------------------------------------|--------------------------------|-----------------------------------------|-----------------------------------------------------------|----------------------------------------------------| | Free | Perpetual requiring annual renewal | Basic | Non-production workloads | Community support in Slack | Personal and non-commercial use | | Trial | 30-days, renewable up to 90 days | Advanced functionality enabled | Non-production workloads | Community support in Slack and solution architect support | Evaluate products in a non-production environment. | -| Commercial | Renewable and upgradable | Advanced functionality enabled | Production and Non-production workloads | Support per contract | Enterprise workloads | - +| Commercial | Renewable and upgradable | Advanced functionality enabled | Production and Non-production workloads | Support by contract | Enterprise workloads | Licensing is available for non-profit, research, and academic organizations through a special, free, or highly discounted commercial license in [Progress Chef's Non-Profit Entitlement Program](https://www.chef.io/nonprofit-entitlement-program). @@ -71,8 +69,6 @@ The basic license information collected includes which applications are in use, Licensed customer may opt to send additional telemetry and usage data to Progress Chef. This telemetry is used to tailor recommendations to customers, develop new features, and optimize the customer experience. - \ No newline at end of file diff --git a/content/licensing/accept.md b/content/licensing/accept.md index 74ba48bcf15..273c278cd7f 100644 --- a/content/licensing/accept.md +++ b/content/licensing/accept.md @@ -12,21 +12,23 @@ aliases = ["/chef_license_accept.html", "/chef_license_accept/"] weight = 20 +++ -This page aims to document how to accept the Chef license for all Chef Software products. For an overview of the license, see the [Chef license](/chef_license/) documentation. There are two types of license: MLSA and EULA. The MLSA applies to customers with a commercial contract with Chef Software, and the EULA covers all other cases. +This page aims to document how to accept the Chef license and set a license ID for all Progress Chef products. +For an overview of the license, see the [Chef license](/licensing/) documentation. +Progress Chef has two licenses: MLSA and EULA. The MLSA applies to customers with a commercial contract with Progress Chef, and the EULA covers all other cases. ## Accept the Chef MLSA -There are three ways to accept the Chef MLSA: +You can accept the Chef MLSA using one of the following ways: -1. When running `chef--ctl reconfigure` the Chef MLSA is printed. Type `yes` to accept it. Anything other than typing `yes` rejects the Chef MLSA, and the upgrade process will exit. Typing `yes` adds a `.license.accepted` file to the `/etc/chef/accepted_licenses/` file. As long as this file exists in this directory, the Chef MLSA is accepted and the reconfigure process will not prompt for `yes`. +1. When running `chef--ctl reconfigure` the Chef MLSA is printed. Type `yes` to accept it. Anything other than typing `yes` rejects the Chef MLSA, and the upgrade process will exit. Typing `yes` adds a `.license.accepted` file to the `/etc/chef/accepted_licenses/` file. As long as this file exists in this directory, the Chef MLSA is accepted and the reconfigure process won't prompt for `yes`. 2. Run the `chef--ctl reconfigure` command using the `--chef-license=accept` option. This automatically types `yes` and skips printing the Chef MLSA. -3. Add a `.license.accepted` file to the `/var/opt//` directory. The contents of this file do not matter. As long as this file exists in this directory, the Chef MLSA is accepted and the reconfigure process will not prompt for `yes`. +3. Add a `.license.accepted` file to the `/var/opt//` directory. The contents of this file don't matter. As long as this file exists in this directory, the Chef MLSA is accepted and the reconfigure process won't prompt for `yes`. ## Accept the Chef EULA -Products below are split below into two categories: workstation and server. Affected product versions which require accepting the EULA to use are shown. Versions before this do not require accepting the EULA. More information on supported versions can be seen at the [Supported Versions](/versions/) documentation. +Products below are split below into two categories: workstation and server. Affected product versions which require accepting the EULA to use are shown. Versions before this don't require accepting the EULA. More information on supported versions can be seen at the [Supported Versions](/versions/) documentation. -### Workstation Products +### Workstation products - Chef Workstation \>= 0.4, which also contains: - Chef Infra Client @@ -40,23 +42,23 @@ These products are typically installed on a user's workstation. Two common metho 1. `--chef-license ` argument passed to the command line invocation. 1. `CHEF_LICENSE=""` as an environment variable. `` can be specified as one of the following: - 1. `accept` - Accepts the license and attempts to persist a marker file locally. Persisting these marker files means future invocations do not require accepting the license again. + 1. `accept` - Accepts the license and attempts to persist a marker file locally. Persisting these marker files means future invocations don't require accepting the license again. 1. `accept-silent` - Similar to `accept` except no messaging is sent to STDOUT 1. `accept-no-persist` - Similar to `accept-silent` except no marker file is persisted. Future invocation will require accepting the license again. -If no command line argument or environment variable is set, these products will attempt to request acceptance through an interactive prompt. If the prompt cannot be displayed, then the product will fail with an exit code 172. +If no command line argument or environment variable is set, these products will attempt to request acceptance through an interactive prompt. If the prompt can't be displayed, then the product will fail with an exit code 172. If the product attempts to persist the accepted license and fails, a message will be sent to STDOUT, but product invocation will continue successfully. In a future invocation, however, the license would need to be accepted again. Please see [License File Persistence](https://github.com/chef/license-acceptance#license-file-persistence) for details about persisted marker files. -The `--chef-license` command line argument is not backwards compatible to older non-EULA versions. If you are managing a multi-version environment, we recommend using the environment variable as that is ignored by older versions. +The `--chef-license` command line argument isn't backwards compatible to older non-EULA versions. If you are managing a multi-version environment, we recommend using the environment variable as that's ignored by older versions. Products with specific features or differences from this general behavior are documented below. #### Chef Workstation -Chef Workstation contains multiple Chef Software products. When invoking the `chef` command line tool and accepting the license, users are required to accept the license for all the embedded products as well. The same license applies to all products, but each product must have its own license acceptance. `chef --chef-license accept` will accept the license for Chef Workstation, Chef Infra Client, and Chef InSpec. For example, `chef env --chef-license accept`. +Chef Workstation contains multiple Progress Chef products. When invoking the `chef` command line tool and accepting the license, users are required to accept the license for all the embedded products as well. The same license applies to all products, but each product must have its own license acceptance. `chef --chef-license accept` will accept the license for Chef Workstation, Chef Infra Client, and Chef InSpec. For example, `chef env --chef-license accept`. #### Chef Infra Client @@ -64,29 +66,30 @@ In addition to the above methods, users can specify `chef_license 'accept'` in t #### Chef Habitat -There are two methods for accepting the Chef Habitat license: +You can accept the Chef Habitat license with two different methods: 1. Users can execute `hab license accept` on the command line. 1. Alternatively, users can set `HAB_LICENSE=""` as an environment variable. `` can be specified as one of the following: - 1. `accept` - Accepts the license and persists a marker file locally. Future invocations do not require accepting the license again. + 1. `accept` - Accepts the license and persists a marker file locally. Future invocations don't require accepting the license again. 1. `accept-no-persist` - accepts the license without persisting an marker file. Future invocation will require accepting the license again. -If the license is not accepted through either of these methods, Chef Habitat will request acceptance through an interactive prompt. +If the license isn't accepted through either of these methods, Chef Habitat will request that you accept the license through an interactive prompt. -Additionally, to accepting the license in CI or other automation, user may choose to create an empty file on the filesystem at `/hab/accepted-licenses/habitat` (if your hab commands run as root) or at `$HOME/.hab/accepted-licenses/habitat` (if your hab commands run as a user other than root). For situations where hab commands run as multiple users, it is advisable to create both files. +To accept the license in CI or other automation, you may create an empty file on the filesystem at `/hab/accepted-licenses/habitat` (if your hab commands run as root) or at `$HOME/.hab/accepted-licenses/habitat` (if your hab commands run as a user other than root). +For situations where `hab` commands run as multiple users, we recommend creating both files. #### Errors -If the Chef Habitat License prompt cannot be displayed, then the product fails with an exit code 172. If Chef Habitat cannot persist the accepted license, it sends a message STDOUT, but the product invocation will continue successfully. In a future invocation, however, the user will need to accept the license again. +If the Chef Habitat License prompt can't be displayed, then the product fails with an exit code 172. If Chef Habitat can't persist the accepted license, it sends a message STDOUT, but the product invocation will continue successfully. In a future invocation, however, the user will need to accept the license again. #### Chef as `hab` packages -Chef Software products are also distributed as `hab` packages. When Chef products are installed using Chef Habitat, the products request license acceptance at product usage time. Accept the licenses in the same way detailed above. +Progress Chef products are also distributed as `hab` packages. When Chef products are installed using Chef Habitat, the products request license acceptance at product usage time. Accept the licenses in the same way detailed above. -### Server Products +### Server products -Some Chef products distributed as `hab` packages contain servers. In these cases, Chef Habitat runs the server products as a supervisor. See the below sections for information on how to accept the license for these products when they are distributed as `hab` packages. +Some Chef products distributed as `hab` packages contain servers. In these cases, Chef Habitat runs the server products as a supervisor. See the below sections for information on how to accept the license for these products when they're distributed as `hab` packages. | Product | Version | |-------------------|---------| @@ -94,12 +97,12 @@ Some Chef products distributed as `hab` packages contain servers. In these cases | Chef Automate | >= 2.0 | | Supermarket | >= 4.0 | -Server products are typically installed and managed by some kind of process supervisor. Chef Software server products do not allow interactive license acceptance because process supervisors do not allow interactivity. Instead, the license is accepted during the `reconfigure` command or `upgrade` command for the Omnibus ctl command. For example: +Server products are typically installed and managed by some kind of process supervisor. Progress Chef server products don't allow interactive license acceptance because process supervisors don't allow interactivity. Instead, the license is accepted during the `reconfigure` command or `upgrade` command for the Omnibus ctl command. For example: - `chef-server-ctl reconfigure --chef-license=accept` - `CHEF_LICENSE="accept-no-persist" supermarket-ctl reconfigure` -In addition, the Chef license can be accepted via the omnibus configuration file. Specify `chef_license 'accept'` in the `chef-server.rb` or `supermarket.rb` configuration. +In addition, the Chef license can be accepted using the omnibus configuration file. Specify `chef_license 'accept'` in the `chef-server.rb` or `supermarket.rb` configuration. #### Chef Automate @@ -113,7 +116,7 @@ Chef Infra Server is also distributed as a `hab` package and ran using the super For example: Against a supervisor running Chef Infra Server, run `echo "chef_license.acceptance = accept" | hab config apply server.default 100`. See the [Chef Habitat config updates documentation](/habitat/service_updates/) for more information about how to apply this configuration to a service group. -### Remote Management Products +### Remote management products - Test Kitchen - `knife bootstrap` in Chef Infra Client @@ -122,21 +125,21 @@ For example: Against a supervisor running Chef Infra Server, run `echo "chef_lic - Terraform Chef Provider (Deprecated) - Vagrant -These products install or manage Chef on a remote instance. If a user has accepted the appropriate product license locally, it will be automatically transferred to the remote instance. For example, if a user has accepted the Chef Infra Client license locally and converges a Test Kitchen instance with the Chef provisioner, it will succeed by copying the acceptance to the remote instance. We aim to support this behavior, so Workstation users do not have their workflow affected, but any differences from that behavior are documented below. +These products install or manage Chef on a remote instance. If a user has accepted the appropriate product license locally, it will be automatically transferred to the remote instance. For example, if a user has accepted the Chef Infra Client license locally and converges a Test Kitchen instance with the Chef provisioner, it will succeed by copying the acceptance to the remote instance. We aim to support this behavior, so Workstation users don't have their workflow affected, but any differences from that behavior are documented below. #### Test Kitchen -Test Kitchen is not owned by or covered by the Chef license, but installing Chef Infra Client on a test instance is covered by the EULA. Without accepting the license, the converge will fail on the test instance. +Test Kitchen isn't owned by or covered by the Chef license, but installing Chef Infra Client on a test instance is covered by the EULA. Without accepting the license, the converge will fail on the test instance. The Chef provisioner in Test Kitchen \>= 2.3 has been updated to simplify accepting this license on behalf of the test instance. Users can set the `CHEF_LICENSE` environment variable or add `chef_license: accept` to their provisioner config in their **kitchen.yml**. Specifying **accept** will attempt to persist the license acceptance locally. If a local license marker file is detected, no configuration is required; acceptance is automatically transferred to the test instance. To disable this persistence, specify `accept-no-persist` on every test instance converge. -`kitchen-inspec` uses Chef InSpec as a library, and is not covered by the EULA when installed as a gem, but is covered by the EULA when packaged as part of the Chef Workstation installation. Accept the license in a similar way to the Chef Infra Client license - specify the `CHEF_LICENSE` environment variable, specify the `chef_license` config under the verifier section in `kitchen.yml` or persist the acceptance locally. +`kitchen-inspec` uses Chef InSpec as a library, and isn't covered by the EULA when installed as a gem, but is covered by the EULA when packaged as part of the Chef Workstation installation. Accept the license in a similar way to the Chef Infra Client license - specify the `CHEF_LICENSE` environment variable, specify the `chef_license` config under the verifier section in `kitchen.yml` or persist the acceptance locally. ##### Test Kitchen: Pin to Chef 14 -You can pin to a specific version of chef in your kitchen.yml: +You can pin to a specific version of Chef Infra Client in your `kitchen.yml` file: ```none provisioner: @@ -147,13 +150,13 @@ provisioner: #### `knife bootstrap` -`knife` usage does not require accepting the EULA. A Chef Infra Client instance does require EULA acceptance. Using `knife bootstrap` to manage a Chef Infra Client instance will prompt a user to accept the license locally before allowing for bootstrapping the remote instance. Without this, `knife bootstrap` would fail. +`knife` usage doesn't require accepting the EULA. A Chef Infra Client instance does require EULA acceptance. Using `knife bootstrap` to manage a Chef Infra Client instance will prompt a user to accept the license locally before allowing for bootstrapping the remote instance. Without this, `knife bootstrap` would fail. -In most usage cases via Chef Workstation, this license will already have been accepted and will transfer across transparently. But if a user installs Chef Workstation and the first command they ever run is `knife bootstrap`, it will perform the same license acceptance flow as the Chef Infra Client product. +In most usage cases with Chef Workstation, this license will already have been accepted and will transfer across transparently. But if a user installs Chef Workstation and the first command they ever run is `knife bootstrap`, it will perform the same license acceptance flow as the Chef Infra Client product. ##### `knife bootstrap` in Chef Infra Client 14 -The `knife bootstrap` command in Chef Infra Client 14 cannot accept the Chef Infra Client 15 EULA on remote nodes unless you use a [custom template](/workstation/knife_bootstrap/#custom-templates) and add chef_license "accept" to the client.rb. This applies to workstations who have Chef Infra Client \<= 14.x, ChefDK \<= 3.x or Chef Workstation \<= 0.3 installed. +The `knife bootstrap` command in Chef Infra Client 14 can't accept the Chef Infra Client 15 EULA on remote nodes unless you use a [custom template](/workstation/knife_bootstrap/#custom-templates) and add chef_license "accept" to the client.rb. This applies to workstations who have Chef Infra Client \<= 14.x, ChefDK \<= 3.x or Chef Workstation \<= 0.3 installed. ##### `knife bootstrap`: Pin to Chef 14 @@ -169,50 +172,20 @@ knife bootstrap --bootstrap-version 14.12.3 To accept the license, complete one of the following three tasks. Either pass the `--chef-license` command line flag, set the `CHEF_LICENSE` environment variable, or add the following to your `~/.chef-workstation/config.toml` file: -```none +```toml [chef] chef_license = "accept" ``` -#### Packer - -Use a custom [Chef configuration template](https://www.packer.io/docs/provisioners/chef/chef-client#chef-configuration). In your provisioners config, include: - -```json -{ - "type": "chef-client", - "config_template": "path/to/client.rb" -} -``` - -In `path/to/client.rb`, include: - -```ruby -chef_license 'accept' -``` - -You may also add it to the [execute_command](https://www.packer.io/docs/provisioners/chef-client.html#execute_command), but this is not backwards-compatible, so it is not suggested. - -##### Packer: Pin to Chef 14 - -In your [Packer provisioners -config](https://www.packer.io/docs/provisioners/chef-client.html#install_command), -include: - -```json -{ - "type": "chef-client", - "install_command": "curl -L https://omnitruck.chef.io/install.sh | sudo bash -s -- -v 14.12.9" -} -``` - #### Terraform Chef Provisioner {{< warning >}} + Terraform deprecated the Chef Provisioner in the [0.13.4](https://www.terraform.io/docs/language/resources/provisioners/chef.html) release and they will remove it in a future version. Terraform continues to support the Chef Provider. + {{< /warning >}} -The license can be accepted via the Chef Infra Client config file, which is specified by the `client_options` [Terraform provisioner config](https://www.terraform.io/docs/provisioners/chef.html#client_options-array-): +You can accept the license using the Chef Infra Client config file with the `client_options` [Terraform provisioner config](https://www.terraform.io/docs/provisioners/chef.html#client_options-array-): ```none provisioner "chef" { @@ -232,7 +205,7 @@ provisioner "chef" { #### Vagrant -This license acceptance can be done via the arguments API: +You can accept tjhe license with the arguments API: ```ruby config.vm.provision 'chef_zero' do |chef| @@ -240,11 +213,12 @@ config.vm.provision 'chef_zero' do |chef| end ``` -See the [Vagrant documentation](https://www.vagrantup.com/docs/provisioning/chef_common.html#arguments) for details. The `--chef-license` argument is not backwards-compatible to non-EULA Chef Infra Client versions. So instead, users can use the [custom config path](https://www.vagrantup.com/docs/provisioning/chef_common.html#custom_config_path) and point at a local file, which specifies the `chef_license` config. The environment variable is not currently supported. +See the [Vagrant documentation](https://www.vagrantup.com/docs/provisioning/chef_common.html#arguments) for details. The `--chef-license` argument isn't backwards-compatible to non-EULA Chef Infra Client versions. Instead users can use the [custom config path](https://www.vagrantup.com/docs/provisioning/chef_common.html#custom_config_path) and point at a local file, which specifies the `chef_license` config. The environment variable isn't supported. ##### Vagrant: Pin to Chef 14 -This version pinning can be done using the [version API](https://www.vagrantup.com/docs/provisioning/chef_common.html#version). In your Chef provisioner config: +You can pin a version of Chef Infra Client using the [version API](https://www.vagrantup.com/docs/provisioning/chef_common.html#version). +In your Chef provisioner config: ```ruby config.vm.provision 'chef_zero' do |chef| @@ -254,12 +228,11 @@ end ### Pre-upgrade support -Chef Software aims to make upgrading from a non-EULA version to a EULA version as simple as possible. For some products (Chef Infra Client 14.12.9, Chef InSpec 3.9.3), we added backwards-compatible support for the `--chef-license` command that performs a no-op. This allows customers to start specifying that argument in whatever way they manage those products before upgrading. +Progress Chef aims to make upgrading from a non-EULA version to a EULA version as simple as possible. For some products (Chef Infra Client 14.12.9, Chef InSpec 3.9.3), we added backwards-compatible support for the `--chef-license` command that performs a no-op. This allows customers to start specifying that argument in whatever way they manage those products before upgrading. -Alternatively, users can specify the `CHEF_LICENSE` environment variable when invoking any of the EULA products to accept the license. This environment variable is ignored by non-EULA products, and so is backwards-compatible to older versions. +Users can also specify the `CHEF_LICENSE` environment variable when invoking any of the EULA products to accept the license. +Products that don't accept the EULA and backwards-compatible older versions of products that do accept the EULA ignore this environment variable. #### `chef-client` cookbook -For users that manage their Chef Infra Client installation using the `chef-client` cookbook, we added a new attribute that can be specified. Specify the node attribute `node['chef_client']['chef_license'] = 'accept'` when running the cookbook to apply the license acceptance in a backwards-compatible way. - -This functionality allows users to set that attribute for a Chef Infra Client 14 install, upgrade to Chef Infra Client 15, and have the product continue to work correctly. +For users that manage their Chef Infra Client installation using the `chef-client` cookbook, you can set the node attribute `node['chef_client']['chef_license'] = 'accept'` when running the cookbook to apply the license acceptance in a backwards-compatible way. diff --git a/content/licensing/terms.md b/content/licensing/terms.md index 4762c617f22..f244dd4fd15 100644 --- a/content/licensing/terms.md +++ b/content/licensing/terms.md @@ -12,13 +12,13 @@ gh_repo = "chef-web-docs" +++ Node -: An individual component of your system, physical or virtual (for example, a server, workstation, IP router, virtual machine, or another device or component) that is assessed, installed, configured, updated, scanned and/or managed using any Chef product. +: An individual component of your system, physical or virtual (for example, a server, workstation, IP router, virtual machine, or another device or component) that's assessed, installed, configured, updated, scanned and/or managed using any Chef product. Scan : A rules-based inspection of a target. There can be many scans applied to a target. Target -: Each instance of infrastructure, software, configuration, cloud accounts, container hosts, or other technical resource that is the compliance target of one or more Chef InSpec profiles used by you. Each target can access a resource with its credentials and locations. +: Each instance of infrastructure, software, configuration, cloud accounts, container hosts, or other technical resource that's the compliance target of one or more Chef InSpec profiles used by you. Each target can access a resource with its credentials and locations. Subscription License : One of the license types that continue until the expiration of the subscription period identified in the order, unless earlier terminated in accordance with the terms of the [Progress Chef End User License Agreement](https://www.chef.io/end-user-license-agreement). @@ -43,10 +43,10 @@ Community Users Users that use older versions of Chef open-source software or downstream OSS distributions of Chef (CINC). Open Source -: Chef Code available to all under Apache License, Version 2.0. This is not same as access to any licensed Chef products or free Chef products. +: Chef Code available to all under Apache License, Version 2.0. This isn't same as access to any licensed Chef products or free Chef products. Open Source Users : Users who download the source code and build executables on their own, or get binaries/executables from open derivative work to confirming Apache License, Version 2.0. These users need not purchase license to use the product. Endpoint -: A compute device such as a laptop, desktop, or a tablet that is a primary workstation of a knowledge worker/student that has Chef supported platforms and is assessed, installed, configured, updated, scanned and is managed using Chef Desktop. +: A compute device such as a laptop, desktop, or a tablet that's a primary workstation of a knowledge worker/student that has Chef supported platforms and is assessed, installed, configured, updated, scanned and is managed using Chef Desktop.