Skip to content

Commit e080ddb

Browse files
github-actions[bot]KuxhulIanMadd
authored
Update InSpec 7 licensing documentation (#74) (#90)
* Update InSpec 7 licensing documentation Updates the InSpec 7 licensing documentation to reflect the updated licensing model, including download-based enforcement and clarification around official and non-official distribution channels. * Address review feedback on licensing documentation Updated licensing explanation to avoid "license enforcement" terminology and removed Infra Client workflow examples that are not relevant to InSpec. * Minor fixes * Reorganize and clarify license text --------- (cherry picked from commit 3898763) Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: Kushal S J <kushalj@progress.com> Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
1 parent f1d1324 commit e080ddb

1 file changed

Lines changed: 38 additions & 28 deletions

File tree

content/install/license.md

Lines changed: 38 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,8 @@ draft = false
99
weight = 30
1010
+++
1111

12-
To use Chef InSpec 7, you need to [accept the Chef EULA](#accept-the-chef-eula).
13-
Depending on the InSpec distribution you install, you need a [license](#add-a-license) to execute InSpec:
14-
15-
- The Chef Habitat package for InSpec 7 doesn't require a license to execute InSpec.
16-
- The `inspec` gem requires a license to execute InSpec.
17-
18-
You can't manually enable or disable licensing. The licensing requirements are determined by the distribution.
19-
20-
If you'd like to try out Chef InSpec, you can [request a trial license](https://www.chef.io/licensing/inspec/license-generation-free-trial).
21-
22-
For more information, see [Chef's licensing documentation](https://docs.chef.io/licensing/).
12+
To use Chef InSpec 7, you must [accept the Chef EULA](#accept-the-chef-eula).
13+
Depending on how you obtained Chef InSpec, you may also need to [add a Progress Chef license key](#progress-chef-license).
2314

2415
## Accept the Chef EULA
2516

@@ -28,7 +19,7 @@ You must accept the [Chef End User License Agreement (EULA)](https://www.chef.io
2819
- [Use a command line option](#use-a-command-line-option)
2920
- [Set an environment variable](#set-an-environment-variable)
3021

31-
If you don't set either, Chef InSpec prompts you to accept the EULA interactively. If the prompt can't be displayed, Chef InSpec exits with code 172.
22+
If you don't use either method, Chef InSpec prompts you to accept the EULA interactively. If the prompt can't be displayed, Chef InSpec exits with code 172.
3223

3324
If Chef InSpec can't persist the accepted license, it sends a message to STDOUT and continues to run. You'll need to accept the license again the next time you run Chef InSpec.
3425

@@ -71,22 +62,37 @@ Replace `<value>` with one of these options:
7162
`accept-no-persist`
7263
: Similar to `accept-silent`, but doesn't persist a marker file. You'll need to accept the license again for future runs.
7364

74-
## Add a license
65+
## Progress Chef license
7566

76-
The `inspec` gem requires a license to execute.
77-
You can add a license key in three ways:
67+
### License key requirements
68+
69+
Chef InSpec 7 introduces an updated licensing model designed to simplify usage while maintaining compliance across distribution channels.
70+
71+
If you download InSpec from the following official Progress distribution channels, a license key isn't required to execute InSpec after it's installed:
72+
73+
- The Progress Download Portal
74+
- Habitat-based package distribution
75+
- The Chef Commercial Downloads API
76+
77+
If you download Chef InSpec from sources outside the official Progress distribution channels---such as public Ruby gems or other external repositories---a valid license may be required to execute the software.
78+
79+
For more information, see [Chef's licensing documentation](https://docs.chef.io/licensing/).
80+
81+
### Add a license key
82+
83+
If you downloaded Chef InSpec from sources outside the official Progress distribution channels, use one of the following methods to add a license key:
7884

7985
- [Use the interactive license dialog](#use-the-interactive-license-dialog)
80-
- [command line option](#use-a-command-line-option-1)
81-
- [environment variable](#set-an-environment-variable-1)
86+
- [Use a command line option](#use-a-command-line-option-1)
87+
- [Set an environment variable](#set-an-environment-variable-1)
8288

8389
{{< note >}}
8490

8591
If you're a commercial customer, you can use an asset serial number from the [Progress support portal](https://community.progress.com/s/products/chef) as your license key.
8692

8793
{{< /note >}}
8894

89-
### Use the interactive license dialog
95+
#### Use the interactive license dialog
9096

9197
The easiest way to provide a license key is to run Chef InSpec.
9298
If no license key is set and it doesn't detect an automated method of setting a license key, Chef InSpec starts an interactive licensing dialog.
@@ -100,17 +106,17 @@ To add a license with the interactive license dialog, follow these steps:
100106

101107
Chef InSpec validates your license key, displays license details, runs `inspec shell`, and stores the key for future use.
102108

103-
### Use a command line option
109+
#### Use a command line option
104110

105111
Set the license key with the `--chef-license-key` option:
106112

107113
```sh
108114
inspec exec <PROFILE_NAME> --chef-license-key <LICENSE_KEY>
109115
```
110116

111-
Most of the main Chef InSpec CLI commands accept this argument, however some plugins don't support the flag.
117+
Most Chef InSpec CLI commands accept this argument, but some plugins don't support the flag.
112118

113-
### Set an environment variable
119+
#### Set an environment variable
114120

115121
Set the license key with the `CHEF_LICENSE_KEY` environment variable:
116122

@@ -119,25 +125,25 @@ export CHEF_LICENSE_KEY=<LICENSE_KEY>
119125
inspec exec <PROFILE_NAME>
120126
```
121127

122-
## Add a license with Chef's Local License Service
128+
### Add a license with Chef's Local License Service
123129

124-
For large or air-gapped fleets, you can retrieve a license key from a [Chef Local License Service](https://docs.chef.io/licensing/local_license_service/). With this service, you only need the service URLs.
130+
For large or air-gapped fleets, you can retrieve a license key from a [Chef Local License Service](https://docs.chef.io/licensing/local_license_service/). With this service, you only need the Local License Service URL.
125131
Chef InSpec requests license keys from the Local License Service and uses them during execution. Chef InSpec doesn't store these keys long-term.
126132

127133
You can set a Local License Service URL in two ways:
128134

129135
- [Use a command line option](#use-a-command-line-option-2)
130136
- [Set an environment variable](#set-an-environment-variable-2)
131137

132-
### Use a command line option
138+
#### Use a command line option
133139

134140
Set the Chef Local License Service URL with the `--chef-license-server` option:
135141

136142
```sh
137143
inspec exec <PROFILE_NAME> --chef-license-server https://license-server.example.com
138144
```
139145

140-
### Set an environment variable
146+
#### Set an environment variable
141147

142148
Set the Chef Local License Service URL with the `CHEF_LICENSE_SERVER` environment variable:
143149

@@ -146,7 +152,7 @@ export CHEF_LICENSE_SERVER=https://license-server.example.com
146152
inspec exec <PROFILE_NAME>
147153
```
148154

149-
#### Use multiple license servers
155+
##### Use multiple license servers
150156

151157
You can set up to five Chef Local License Service URLs as a comma-separated list. Chef InSpec tries each URL and uses the first one that works.
152158

@@ -155,9 +161,13 @@ export CHEF_LICENSE_SERVER=https://license-server-01.example.com,https://license
155161
inspec exec <PROFILE_NAME>
156162
```
157163

158-
Make sure you synchronize your license servers to avoid inconsistent results.
164+
Synchronize your license servers to avoid inconsistent results.
165+
166+
## Trial license
167+
168+
If you'd like to try out Chef InSpec, you can [request a trial Progress Chef license](https://www.chef.io/licensing/inspec/license-generation-free-trial).
159169

160-
## Licensing Telemetry service
170+
## Licensing telemetry service
161171

162172
The Chef Licensing Telemetry service gathers product activation, usage statistics, environment information, bugs, and other data related to Chef InSpec.
163173

0 commit comments

Comments
 (0)