Skip to content

Commit 06fac8e

Browse files
authored
Merge in Client RC3 Workstation docs (#4)
* Merge in Client RC3 Workstation docs Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * lint fixes Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> --------- Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
1 parent a11378b commit 06fac8e

24 files changed

Lines changed: 1112 additions & 383 deletions

config/_default/menu.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ identifier = "tools"
5959
title = "Knife"
6060
identifier = "tools/knife"
6161
parent = "tools"
62+
weight = 100
6263

6364
[[tools]]
6465
title = "Knife plugins"
@@ -69,3 +70,4 @@ identifier = "tools"
6970
title = "Test Kitchen"
7071
identifier = "tools/test_kitchen"
7172
parent = "tools"
73+
weight = 200

config/_default/params.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ menuOrder = [
1111
"about",
1212
"install",
1313
"set_up",
14+
"license",
1415
"configure",
16+
"upgrade",
17+
"uninstall",
1518
"troubleshooting",
1619
"privacy",
1720
"tools",

content/_index.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,7 @@ draft = false
1414

1515
{{< readfile file="content/reusable/md/chef_workstation.md" >}}
1616

17-
Chef Workstation replaces ChefDK, combining all the existing features
18-
with new features, such as ad-hoc task support and the new Chef
19-
Workstation desktop application.
20-
21-
## Getting Started
17+
## Get started
2218

2319
Chef Infra is a systems and cloud infrastructure automation framework
2420
that makes it easy to deploy servers and applications to any physical,
@@ -33,7 +29,7 @@ the actual configuration.
3329
- [An Overview of Chef Infra](https://docs.chef.io/chef_overview/)
3430
- [Install Chef Workstation](/install/)
3531

36-
### Cookbook Development Workflow
32+
### Cookbook development workflow
3733

3834
Chef Infra defines a common workflow for cookbook development:
3935

@@ -42,15 +38,26 @@ Chef Infra defines a common workflow for cookbook development:
4238
1. Test in acceptance. Test your work in an environment that matches your production environment.
4339
1. Deploy your cookbooks to the production environment, but only after they pass all the acceptance tests and are verified to work in the desired manner.
4440

45-
## Tools
41+
## Included tools and components
42+
43+
Chef Workstation includes the following fully integrated tools:
44+
45+
### Core development tools
46+
47+
- **Chef CLI (`chef-cli`)**: Primary command-line interface for Chef development workflows, providing unified access to common Chef operations
48+
- **Chef Infra Client**: Latest release candidate of the Chef Infra Client, enabling infrastructure automation and configuration management
49+
- **Knife**: Essential tool for interacting with Chef Infra Server, managing nodes, cookbooks, roles, and other Chef objects
50+
- **Chef InSpec**: Latest release candidate of InSpec, enabling compliance and security testing.
51+
52+
### Testing and quality assurance
4653

47-
Chef Workstation packages all the tools necessary to be successful with Chef Infra and InSpec. These tools are combined into packages for common operating systems and include all the dependencies you need to get started.
54+
- **Chef Test Kitchen Enterprise**: Comprehensive testing framework for validating infrastructure code across multiple platforms and environments
55+
- **Chef InSpec**: Compliance and security testing framework for auditing infrastructure and applications against security standards and regulations
56+
- **Cookstyle**: Ruby and Chef cookbook linting tool that enforces style guidelines and best practices
57+
- **Fauxhai**: Mock Ohai data generator for testing purposes, enabling rapid cookbook testing without requiring actual systems
4858

49-
The most important tools included in Chef Workstation are:
59+
### Dependency and secret management
5060

51-
- **Chef CLI**: A workflow tool for Chef Infra.
52-
- **knife**: A tool for managing systems on Chef Infra Server.
53-
- **Chef Infra Client**: The Chef Infra agent.
54-
- **Chef InSpec**: A compliance as code tool that can also be used for testing Chef Infra cookbooks.
55-
- **Cookstyle**: A linting tool that helps you write better Chef Infra cookbooks by detecting and automatically correcting style, syntax, and logic mistakes in your code.
56-
- **Test Kitchen**: An integration testing framework tool that tests cookbooks across platforms and various cloud provider / hypervisors.
61+
- **Berkshelf**: Cookbook dependency manager that streamlines the process of managing and retrieving cookbook dependencies
62+
- **Chef Vault**: Secure data management tool for encrypting and managing secrets within Chef workflows
63+
- **Ohai**: System profiling tool that detects and reports system attributes for use in Chef recipes

content/config.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,23 @@ draft = false
1212
<!-- markdownlint-disable-file MD024 -->
1313
<!-- vale Microsoft.Contractions = NO -->
1414

15-
Chef Workstation App and `chef-run` configuration is managed in `config.toml`. Chef Workstation will create `config.toml` the first time you use `chef-run`, if one doesn't already exist. To configure other tools, see their respective pages found in the toolbar under Chef Workstation Tools.
15+
The Chef Workstation and `chef-run` configuration is managed in the `config.toml` file.
16+
Chef Workstation creates the `config.toml` file the first time you use `chef-run`, if one doesn't already exist.
17+
18+
To configure other Workstation tools, see their documentation.
1619

1720
## Default location
1821

1922
Chef Workstation looks for the `config.toml` in a default location.
2023

21-
### Windows
24+
- On Windows:
2225

23-
- Powershell: `$env:USERPROFILE\.chef-workstation\config.toml`
24-
- cmd.exe: `%USERPROFILE%\.chef-workstation\config.toml`
26+
- Powershell: `$env:USERPROFILE\.chef-workstation\config.toml`
27+
- cmd.exe: `%USERPROFILE%\.chef-workstation\config.toml`
2528

26-
### Linux and Mac
29+
- On Linux and macOS:
2730

28-
`/home/$USER/.chef-workstation/config.toml`
31+
- `/home/$USER/.chef-workstation/config.toml`
2932

3033
## Settings
3134

0 commit comments

Comments
 (0)