Skip to content

Commit bce81be

Browse files
chandra-progresslbarry316IanMadd
authored
CHEF-32332 : [Documentation] Update docs for InSpec 7 installation using Native installer (#82)
* InSpec native installer install doc Signed-off-by: Chandra <cprasad@progress.com> * update inpsec package name as inspe-ie Signed-off-by: Chandra <cprasad@progress.com> * rename inspec package name Signed-off-by: Chandra <cprasad@progress.com> * Removed the term 'Native Installer' Signed-off-by: Chandra <cprasad@progress.com> * Editorial improvement to _index.md Signed-off-by: LisaBarry316 <lisa.barry@progress.com> * Editing Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * Add uninstall page Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * Reorganize install page Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * updating example package name Signed-off-by: Chandra <cprasad@progress.com> * removed - [Chef Downloads](https://www.chef.io/downloads) Signed-off-by: Chandra <cprasad@progress.com> * Editorial improvement Signed-off-by: LisaBarry316 <lisa.barry@progress.com> * Nitpicking the uninstall page instructions Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> --------- Signed-off-by: Chandra <cprasad@progress.com> Signed-off-by: LisaBarry316 <lisa.barry@progress.com> Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: lbarry316 <118758673+lbarry316@users.noreply.github.com> Co-authored-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: LisaBarry316 <lisa.barry@progress.com> Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
1 parent 9b5fccf commit bce81be

3 files changed

Lines changed: 213 additions & 39 deletions

File tree

‎config/_default/params.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# Menus are defined in the /config/_default/menu.toml file
88
#######
99

10-
menuOrder = ["about", "install", "configure", "profiles", "shell", "troubleshooting", "chef_tools", "related", "resources", "reference"]
10+
menuOrder = ["about", "install", "configure", "uninstall", "profiles", "shell", "troubleshooting", "chef_tools", "related", "resources", "reference"]
1111

1212
#######
1313
# robots = The default robots config applied to each page in the robots meta tag.

‎content/install/_index.md‎

Lines changed: 136 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
+++
2-
title = "Install Chef InSpec"
2+
title = "Chef InSpec install guide"
33
draft = false
44

55
[menu.install]
6-
title = "Install InSpec"
6+
title = "Install Chef InSpec"
77
identifier = "install/install"
88
parent = "install"
99
weight = 10
1010
+++
1111

12-
<!-- cSpell:ignore binlink, binlinks, binlinked -->
12+
<!-- cSpell:ignore -->
1313

14-
This page documents how to install Chef InSpec from a Chef Habitat package.
14+
Chef InSpec 7 installers are available for Windows, Debian, and RPM-based Linux distributions.
15+
You can download and install pre-built `.msi`, `.deb`, or `.rpm` packages using your existing package management tools.
1516

1617
## Supported platforms
1718

@@ -22,58 +23,155 @@ Chef InSpec is supported on the following platforms:
2223

2324
## Prerequisites
2425

25-
- [Chef Habitat installed on your workstation](https://docs.chef.io/habitat/install_habitat/)
26-
- [A Chef Habitat Builder profile with a personal access token](https://docs.chef.io/habitat/builder_profile/)
26+
This installation process has the following prerequisites:
27+
28+
- Chef InSpec, Chef Automate, and Chef Workstation aren't installed on the target system.
29+
30+
If Chef InSpec is already installed, see the [Chef InSpec uninstall documentation](/uninstall/).
31+
32+
- On Windows systems, `tar` is installed.
33+
- On Debian-based systems, the `dpkg` package manager is installed.
34+
- On RPM-based systems, `rpm` and either `dnf` or `yum` are installed. For Amazon Linux 2, use `rpm` and `yum`.
35+
- You have a valid Progress Chef license key.
36+
- The target system is connected to the internet.
2737

2838
## Install Chef InSpec
2939

30-
Install the Chef InSpec Habitat package:
40+
### Install Chef InSpec on Debian-based systems
41+
42+
To install Chef InSpec on a Debian-based system, follow these steps:
43+
44+
1. Download the Debian-based installer using one of the following methods:
45+
46+
- Download using `wget`:
47+
48+
```sh
49+
wget -O "inspec-enterprise-<VERSION>-linux.deb" "https://chefdownload-commercial.chef.io/stable/inspec/download?eol=false&license_id=<LICENSE_ID>&m=x86_64&p=linux&pm=deb&v=<VERSION>"
50+
```
51+
52+
- Download using `curl`:
53+
54+
```sh
55+
curl -o "inspec-enterprise-<VERSION>-linux.deb" "https://chefdownload-commercial.chef.io/stable/inspec/download?eol=false&license_id=<LICENSE_ID>&m=x86_64&p=linux&pm=deb&v=<VERSION>"
56+
```
57+
58+
Replace:
59+
60+
- `<VERSION>` with the version number to install.
61+
- `<LICENSE_ID>` with your Chef license ID.
62+
63+
1. Install Chef InSpec:
64+
65+
```sh
66+
sudo dpkg -i inspec-enterprise-<VERSION>_amd64.deb
67+
```
68+
69+
Replace `<VERSION>` with the version number of the downloaded package, for example `inspec-enterprise-7.1.6-1_amd64.deb`.
70+
71+
1. Verify that Chef InSpec is installed:
72+
73+
```sh
74+
inspec version
75+
```
76+
77+
The output displays the installed Chef InSpec version.
78+
79+
1. [Accept the Chef EULA](license#accept-the-chef-eula).
80+
81+
### Install Chef InSpec on RPM-based systems
82+
83+
To install Chef InSpec on an RPM-based system, follow these steps:
84+
85+
1. Download the RPM-based installer using one of the following methods:
86+
87+
- Download using `wget`:
88+
89+
```sh
90+
wget -O "inspec-enterprise-<VERSION>-linux.rpm" "https://chefdownload-commercial.chef.io/stable/inspec/download?eol=false&license_id=<LICENSE_ID>&m=x86_64&p=linux&pm=rpm&v=<VERSION>"
91+
```
92+
93+
- Download using `curl`:
94+
95+
```sh
96+
curl -o "inspec-enterprise-<VERSION>-linux.rpm" "https://chefdownload-commercial.chef.io/stable/inspec/download?eol=false&license_id=<LICENSE_ID>&m=x86_64&p=linux&pm=rpm&v=<VERSION>"
97+
```
98+
99+
Replace:
100+
101+
- `<VERSION>` with the version number to install.
102+
- `<LICENSE_ID>` with your Chef license ID.
103+
104+
1. Install Chef InSpec using one of the following methods:
105+
106+
- Install using `rpm`:
107+
108+
```sh
109+
sudo rpm -Uvh inspec-enterprise-<VERSION>.x86_64.rpm
110+
```
111+
112+
- Install using `dnf`:
113+
114+
```sh
115+
sudo dnf install ./inspec-enterprise-<VERSION>.x86_64.rpm
116+
```
117+
118+
- For Amazon Linux 2 or systems using `yum`:
119+
120+
```sh
121+
sudo yum install ./inspec-enterprise-<VERSION>.x86_64.rpm
122+
```
123+
124+
Replace `<VERSION>` with the version number of the downloaded package, for example `inspec-enterprise-7.1.6-1.amzn2.x86_64.rpm`.
125+
126+
1. Verify that Chef InSpec is installed:
127+
128+
```sh
129+
inspec version
130+
```
131+
132+
The output displays the installed Chef InSpec version.
133+
134+
1. [Accept the Chef EULA](license#accept-the-chef-eula).
31135

32-
```sh
33-
sudo hab pkg install chef/inspec --channel base-2025 --binlink --force --auth <HAB_BUILDER_TOKEN>
34-
```
136+
### Install Chef InSpec on Windows
35137

36-
For more information, see the [Habitat CLI documentation](https://docs.chef.io/habitat/habitat_cli/#hab-pkg-install).
138+
To install Chef InSpec on Windows, follow these steps:
37139

38-
## Verify installation
140+
1. Download the installer in an elevated PowerShell session:
39141

40-
Use the following commands to verify that Chef InSpec is installed:
142+
```powershell
143+
Invoke-WebRequest -Uri "https://chefdownload-commercial.chef.io/stable/inspec/download?eol=false&license_id=<LICENSE_ID>&m=x86_64&p=windows&pm=msi&v=<VERSION>" -OutFile "inspec-enterprise-<VERSION>-windows.msi"
144+
```
41145

42-
- If you binlinked the InSpec package during installation, check the installed InSpec version:
146+
1. Install Chef InSpec using one of the following methods:
43147

44-
```sh
45-
inspec version
46-
```
148+
- Run the following command in an elevated PowerShell or Command Prompt session:
47149

48-
## Manage the Chef InSpec package
150+
```powershell
151+
msiexec /i inspec-enterprise-<VERSION>-x64.msi /qn
152+
```
49153

50-
### Upgrade Chef InSpec
154+
Replace `<VERSION>` with the version number of the downloaded package, for example `inspec-enterprise-7.1.6-1_x64.msi`.
51155

52-
To upgrade to a newer version in the same channel, re-run the install command with `--force`:
156+
- Double-click the `.msi` file and follow the on-screen installation wizard.
53157

54-
```sh
55-
sudo hab pkg install chef/inspec --channel base-2025 --binlink --force
56-
```
158+
1. Verify that Chef InSpec is installed:
57159

58-
### Uninstall the InSpec package
160+
```sh
161+
inspec version
162+
```
59163

60-
```sh
61-
sudo hab pkg uninstall chef/inspec
62-
```
164+
The output displays the installed Chef InSpec version.
63165

64-
## Troubleshooting
166+
1. [Accept the Chef EULA](license#accept-the-chef-eula).
65167

66-
### Authentication errors
168+
## Upgrade Chef InSpec
67169

68-
While installing Chef InSpec, if you see an error like this:
170+
To upgrade Chef InSpec to a newer version:
69171

70-
```sh
71-
✗✗✗ When applicable, we try once, then re-attempt 5 times to
72-
✗✗✗ download a package. Unfortunately, we failed to download
73-
✗✗✗ chef/inspec/7.*.**/2025****** for x86_64-linux.
74-
✗✗✗ Last error: [401 Unauthorized] Please check that you have specified a valid Personal Access Token.
75-
```
172+
1. [Uninstall the current version](/uninstall/) using the steps for your platform.
173+
1. Download and install the new version using the steps for your platform using the instruction on this page.
76174

77-
This indicates that Habitat CLI can't authenticate with Chef Habitat Builder due to an invalid personal access token.
175+
## More information
78176

79-
- [Verify your token or create a new personal access token](https://docs.chef.io/habitat/builder_profile/#create-a-personal-access-token) in Chef Habitat Builder.
177+
- [Chef Download API documentation](https://docs.chef.io/download/)

‎content/uninstall.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
+++
2+
title = "Uninstall Chef InSpec"
3+
draft = false
4+
5+
[menu.uninstall]
6+
title = "Uninstall"
7+
identifier = "uninstall"
8+
+++
9+
10+
## Uninstall Habitat-based Chef InSpec
11+
12+
If you installed Chef InSpec as a Habitat package, use the [`hab pkg uninstall`](https://docs.chef.io/habitat/latest/reference/habitat_cli/#hab-pkg-uninstall) command:
13+
14+
```sh
15+
sudo hab pkg uninstall chef/inspec
16+
```
17+
18+
## Uninstall Chef InSpec on Debian-based distributions
19+
20+
To uninstall Chef InSpec, follow these steps:
21+
22+
1. Remove the package:
23+
24+
```sh
25+
sudo apt-get remove inspec
26+
```
27+
28+
1. Verify that the package has been removed:
29+
30+
```sh
31+
dpkg -l inspec
32+
```
33+
34+
The command returns no output if the package is removed successfully.
35+
36+
## Uninstall Chef InSpec on RPM-based distributions
37+
38+
To uninstall Chef InSpec, follow these steps:
39+
40+
1. Remove the package.
41+
42+
- Using `dnf`:
43+
44+
```sh
45+
sudo dnf remove inspec
46+
```
47+
48+
- For Amazon Linux 2 or systems using `yum`:
49+
50+
```sh
51+
sudo yum remove inspec
52+
```
53+
54+
1. Verify that the package has been removed:
55+
56+
```sh
57+
rpm -qa inspec
58+
```
59+
60+
The command returns no output if the package is removed successfully.
61+
62+
## Uninstall Chef InSpec on Windows
63+
64+
To uninstall using the Windows UI:
65+
66+
1. Open **Settings > Apps > Installed apps**.
67+
1. Search for **Chef InSpec**.
68+
1. Select **Uninstall**, then follow the on-screen prompts.
69+
70+
To uninstall from the command line, run the following command in an elevated PowerShell or Command Prompt session:
71+
72+
```powershell
73+
msiexec /x inspec-enterprise-<VERSION>-x64.msi /qn
74+
```
75+
76+
Replace `<VERSION>` with the version number of the currently installed package.

0 commit comments

Comments
 (0)