Skip to content

Commit ff0adb4

Browse files
committed
Update doc based on feedback
Signed-off-by: nitin sanghi <nsanghi@progress.com>
1 parent 862b5ec commit ff0adb4

4 files changed

Lines changed: 62 additions & 36 deletions

File tree

content/install.md

Lines changed: 31 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,19 @@ We use Chef Habitat to distribute and install Chef Workstation and its component
2727
See the following guides to install and configure Chef Habitat:
2828

2929
- [Install Chef Habitat](https://docs.chef.io/habitat/install_habitat/)
30-
- [Create a Chef Habitat Builder profile](https://docs.chef.io/habitat/builder_profile/)
30+
- [Create a Chef Habitat Builder profile](https://docs.chef.io/habitat/builder/saas/builder_profile/)
3131

3232
## Install Chef Workstation
3333

3434
Chef Workstation supports several installation methods to accommodate different deployment scenarios.
3535
Installing the Latest Stable Version To install the most recent stable release from the default channel, execute the following command:
3636

37-
```shell
38-
hab pkg install chef/chef-workstation # Installs the latest stable version from the default channel base-2025
37+
### Installing with Binary Linking (Recommended)
3938

39+
The recommended installation method includes binary linking, which creates symbolic links to the package binaries in your system PATH. This enables direct command execution without requiring the full Habitat exec syntax:
40+
41+
```shell
42+
hab pkg install chef/chef-workstation --binlink --force
4043
```
4144

4245
### Installing from the Unstable Channel
@@ -61,14 +64,6 @@ For example, to install version 26.0.15 with timestamp 20260320102857:
6164
hab pkg install chef/chef-workstation/26.0.15/20260320102857
6265
```
6366

64-
### Installing with Binary Linking (Recommended)
65-
66-
The recommended installation method includes binary linking, which creates symbolic links to the package binaries in your system PATH. This enables direct command execution without requiring the full Habitat exec syntax:
67-
68-
```shell
69-
hab pkg install chef/chef-workstation --binlink --force
70-
```
71-
7267
### Post-Installation Verification
7368

7469
After completing the installation, verify that Chef Workstation is correctly installed by checking the version information:
@@ -120,31 +115,7 @@ Note: After installing a Habitat package on Windows, you need to add (use hab cl
120115

121116
Chef Workstation provides two primary methods for executing the bundled tools. This section describes each approach and provides guidance on selecting the appropriate method for your use case.
122117

123-
### Method 1: Using Habitat Exec
124-
125-
The Habitat exec command provides explicit control over which package and version is used to execute a command. This method is recommended when you need to ensure a specific package version is used or when binary linking isn't available.
126-
The general syntax for the Habitat exec command is as follows:
127-
128-
```shell
129-
hab pkg exec chef/<package-name> <binary-name> <command>
130-
```
131-
132-
The following table provides examples of common tool invocations using the Habitat exec method:
133-
134-
| Tool | Command | Version Command |
135-
|--------------------|-------------------------------------------------------------------------|----------------------------------|
136-
| Test Kitchen | hab pkg exec chef/chef-test-kitchen-enterprise kitchen | kitchen -v |
137-
| Chef CLI | hab pkg exec chef/chef-cli chef-cli | chef-cli -v |
138-
| Chef Infra Client | hab pkg exec chef/chef-infra-client chef-client | chef-client --version |
139-
| Berkshelf | hab pkg exec chef/berkshelf berks | berks -v |
140-
| Ohai | hab pkg exec chef/ohai ohai | ohai --version |
141-
| Cookstyle | hab pkg exec chef/cookstyle cookstyle | cookstyle -v |
142-
| Chef Vault | hab pkg exec chef/chef-vault chef-vault | chef-vault -v |
143-
| Fauxhai | hab pkg exec chef/fauxhai fauxhai | fauxhai -v |
144-
| Chef InSpec | hab pkg exec chef/inspec inspec | inspec version |
145-
| Knife | hab pkg exec chef/knife knife | knife -v |
146-
147-
### Method 2: Using Direct Executables with Binary Linking
118+
### Method 1: Using Direct Executables with Binary Linking
148119

149120
Binary linking creates symbolic links to package executables in a system-wide location, allowing you to invoke tools directly without the Habitat exec prefix. This method provides a more familiar command-line experience similar to traditional installations.
150121
To enable binary linking during the initial installation, include the binlink flag:
@@ -170,6 +141,30 @@ inspec version
170141
knife -v
171142
```
172143

144+
### Method 2: Using Habitat Exec
145+
146+
The Habitat exec command provides explicit control over which package and version is used to execute a command. This method is recommended when you need to ensure a specific package version is used or when binary linking isn't available.
147+
The general syntax for the Habitat exec command is as follows:
148+
149+
```shell
150+
hab pkg exec chef/<package-name> <binary-name> <command>
151+
```
152+
153+
The following table provides examples of common tool invocations using the Habitat exec method:
154+
155+
| Tool | Command | Version Command |
156+
|-------------------|------------------------------------------------------------|-----------------------|
157+
| Test Kitchen | hab pkg exec chef/chef-test-kitchen-enterprise kitchen | kitchen -v |
158+
| Chef CLI | hab pkg exec chef/chef-cli chef-cli | chef-cli -v |
159+
| Chef Infra Client | hab pkg exec chef/chef-infra-client chef-client | chef-client --version |
160+
| Berkshelf | hab pkg exec chef/berkshelf berks | berks -v |
161+
| Ohai | hab pkg exec chef/ohai ohai | ohai --version |
162+
| Cookstyle | hab pkg exec chef/cookstyle cookstyle | cookstyle -v |
163+
| Chef Vault | hab pkg exec chef/chef-vault chef-vault | chef-vault -v |
164+
| Fauxhai | hab pkg exec chef/fauxhai fauxhai | fauxhai -v |
165+
| Chef InSpec | hab pkg exec chef/inspec inspec | inspec version |
166+
| Knife | hab pkg exec chef/knife knife | knife -v |
167+
173168
## Install Chef Workstation tools
174169

175170
The following applications are included with Chef Workstation,
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
+++
2+
title = "Chef Workstation App"
3+
draft = false
4+
5+
6+
[menu]
7+
[menu.tools]
8+
title = "Chef Workstation App"
9+
identifier = "tools/chef_workstation_app.md Chef Workstation App"
10+
parent = "tools"
11+
weight = 61
12+
+++
13+
14+
Chef Workstation App is no longer supported in Chef Workstation 26.

content/tools/chef_run.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
title = "chef-run executable"
3+
draft = false
4+
5+
6+
[menu]
7+
[menu.tools]
8+
title = "chef-run executable"
9+
identifier = "tools/chef_run.md chef-run executable"
10+
parent = "tools"
11+
weight = 31
12+
+++
13+
14+
The Chef Workstation 26 no longer support Chef Workstation and chef-run if you want to use similar functionality you can use chef target mode.
15+
For more information on chef target mode see [Chef Target Mode documentation](https://docs.chef.io/target_mode/).

content/tools/ctl_chef.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ To use a different cache location, set the `CHEF_WORKSTATION_HOME` environment v
3030
{{< /note >}}
3131

3232
## chef capture
33+
3334
The Chef Workstation 26 no longer support `chef capture` command.
3435

3536
## chef env
@@ -713,6 +714,7 @@ This subcommand has the following options:
713714
None.
714715

715716
## chef report
717+
716718
The Chef Workstation 26 no longer support `chef report` command.
717719

718720
## chef shell-init

0 commit comments

Comments
 (0)