Skip to content

Commit 760c075

Browse files
sanghinitinIanMadd
andauthored
Documentation for workstation 26 (#6)
* First documention for workstation 26 Signed-off-by: nitin sanghi <nsanghi@progress.com> * Remove chef habitat part and fixed binlink output display Signed-off-by: nitin sanghi <nsanghi@progress.com> * Fixed pipeline issue Signed-off-by: nitin sanghi <nsanghi@progress.com> * Removed TODO and added doc for that Signed-off-by: nitin sanghi <nsanghi@progress.com> * Removed chef workstation app and chef-run from tools Signed-off-by: nitin sanghi <nsanghi@progress.com> * Remove chef report and chef capture command support Signed-off-by: nitin sanghi <nsanghi@progress.com> * Update doc based on feedback Signed-off-by: nitin sanghi <nsanghi@progress.com> * Docs update after feedback on PR Signed-off-by: nitin sanghi <nsanghi@progress.com> * Update docs for chef manage and others Signed-off-by: nitin sanghi <nsanghi@progress.com> * Change the order for upgrade Signed-off-by: nitin sanghi <nsanghi@progress.com> * Target to agentless mode change Signed-off-by: nitin sanghi <nsanghi@progress.com> * Remove config page Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * Removed extra page and updated based on feedback Signed-off-by: nitin sanghi <nsanghi@progress.com> * removed chef manage details Signed-off-by: nitin sanghi <nsanghi@progress.com> * To rerun pipeline add this line Signed-off-by: nitin sanghi <nsanghi@progress.com> * Added hab auth token and other suggestion Signed-off-by: nitin sanghi <nsanghi@progress.com> * Editing Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * More editing Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * More updates Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * Reorganize menu Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> * Add Cookstyle to menu config Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> --------- Signed-off-by: nitin sanghi <nsanghi@progress.com> Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
1 parent 06fac8e commit 760c075

60 files changed

Lines changed: 525 additions & 1886 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

config/_default/menu.toml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,30 @@ weight = 60
5555
title = "Tools"
5656
identifier = "tools"
5757

58+
[[tools]]
59+
title = "Cookstyle"
60+
identifier = "tools/cookstyle"
61+
parent = "tools"
62+
weight = 90
63+
url = "https://docs.chef.io/workstation/cookstyle"
64+
5865
[[tools]]
5966
title = "Knife"
6067
identifier = "tools/knife"
6168
parent = "tools"
6269
weight = 100
6370

71+
[[tools]]
72+
title = "Knife CLI reference"
73+
identifier = "tools/knife/reference"
74+
parent = "tools/knife"
75+
weight = 120
76+
6477
[[tools]]
6578
title = "Knife plugins"
6679
identifier = "tools/knife/plugins"
6780
parent = "tools/knife"
81+
weight = 130
6882

6983
[[tools]]
7084
title = "Test Kitchen"

config/_default/params.toml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@
1010
menuOrder = [
1111
"about",
1212
"install",
13+
"upgrade",
1314
"set_up",
1415
"license",
15-
"configure",
16-
"upgrade",
16+
"get_started",
1717
"uninstall",
18-
"troubleshooting",
19-
"privacy",
2018
"tools",
19+
"troubleshooting",
2120
"extension_apis"
2221
]
2322

content/_index.md

Lines changed: 58 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,18 @@ draft = false
1212

1313
<!-- markdownlint-disable-file MD033 -->
1414

15-
{{< readfile file="content/reusable/md/chef_workstation.md" >}}
15+
Chef Workstation is an all-in-one package that gives you everything you need to get started with Chef infrastructure automation.
16+
With a single installation, you get tools for configuration management, compliance scanning, cookbook development, dependency resolution, and testing.
1617

17-
## Get started
18-
19-
Chef Infra is a systems and cloud infrastructure automation framework
20-
that makes it easy to deploy servers and applications to any physical,
21-
virtual, or cloud location, no matter the size of the infrastructure.
22-
Each organization is comprised of one (or more) Chef Workstation
23-
installations, a single server, and every node that will be configured
24-
and maintained by Chef Infra Client. Cookbooks (and recipes) are used to
25-
tell Chef Infra Client how each node in your organization should be
26-
configured. Chef Infra Client---which is installed on every node---does
27-
the actual configuration.
28-
29-
- [An Overview of Chef Infra](https://docs.chef.io/chef_overview/)
30-
- [Install Chef Workstation](/install/)
31-
32-
### Cookbook development workflow
33-
34-
Chef Infra defines a common workflow for cookbook development:
18+
Chef Workstation is the primary toolkit for Chef infrastructure engineers.
19+
You can use Chef Workstation to:
3520

36-
1. Create a skeleton cookbook by running `chef generate cookbook MY_COOKBOOK_NAME`. This generates a cookbook with a single recipe and testing configuration for Test Kitchen with Chef InSpec.
37-
1. Write cookbook recipes or resources and lint and debug them with Cookstyle and Test Kitchen. Making your own cookbooks is an iterative process where you develop, test, find and fix bugs, and then develop and test some more. A text editor---Visual Studio Code, Atom, vim, or any other preferred text editor---is the only tool that you need to author your cookbooks.
38-
1. Test in acceptance. Test your work in an environment that matches your production environment.
39-
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.
21+
- **Define automation**: Generate cookbooks and write configuration policy using Chef's declarative resources, or use community cookbooks from Chef Supermarket.
22+
- **Manage secrets**: Encrypt and manage sensitive data, such as passwords and certificates, using Chef Vault.
23+
- **Scan for compliance**: Run Chef InSpec profiles against remote systems to detect and remediate security and configuration issues.
24+
- **Test locally**: Validate your cookbooks with Test Kitchen and Cookstyle before deploying to production.
4025

41-
## Included tools and components
26+
## Components
4227

4328
Chef Workstation includes the following fully integrated tools:
4429

@@ -61,3 +46,52 @@ Chef Workstation includes the following fully integrated tools:
6146
- **Berkshelf**: Cookbook dependency manager that streamlines the process of managing and retrieving cookbook dependencies
6247
- **Chef Vault**: Secure data management tool for encrypting and managing secrets within Chef workflows
6348
- **Ohai**: System profiling tool that detects and reports system attributes for use in Chef recipes
49+
50+
## Get started
51+
52+
To get started with Chef Workstation:
53+
54+
1. [Install Workstation](/install/)
55+
1. [Set up Workstation](/set_up/)
56+
1. [Add a license](/license/)
57+
1. Optional: [Get started with Workstation](/get_started/)
58+
59+
### Cookbook development workflow
60+
61+
Use the following workflow when creating, developing, and testing your cookbooks:
62+
63+
1. Generate a new cookbook with `chef generate cookbook <COOKBOOK_NAME>`
64+
65+
This creates a cookbook with a default recipe, a `kitchen.yml` configuration for Test Kitchen Enterprise, and a starter Chef InSpec profile.
66+
67+
1. Write cookbook recipes in the `recipes` directory.
68+
69+
1. Create a Chef InSpec profile that verifies that your cookbook runs successfully.
70+
71+
1. Lint the cookbook with Cookstyle (`cookstyle .`) to check for style issues.
72+
73+
1. Run Test Kitchen Enterprise (`kitchen converge`) to converge your cookbook in a local VM or container and verify it works:
74+
75+
This command does the following:
76+
77+
1. Creates a VM, container, or cloud instance.
78+
1. Installs the provisioner (Chef Infra Client) on the instance.
79+
1. Loads the cookbook and Test Kitchen config on the instance.
80+
1. Runs the cookbook to bring the instance into the state defined in the cookbook.
81+
82+
1. Use Test Kitchen Enterprise to run your InSpec profile (`kitchen verify`) against the converged instance.
83+
84+
Test Kitchen reports a pass or fail for each control defined in the InSpec profile.
85+
86+
1. Destroy the Test Kitchen Enterprise instance (`kitchen destroy`) when you're done.
87+
88+
1. If your tests fail, update your cookbook and InSpec profile, re-converge your cookbook and re-verify your InSpec profile until all tests pass.
89+
90+
1. Before deploying in a production environment, test your cookbook in a matching environment.
91+
92+
1. Deploy your cookbooks to production only after they pass all acceptance tests.
93+
94+
## More resources
95+
96+
- [Chef Tutorials](https://www.chef.io/training/tutorials)
97+
- [Chef Support and Learning Hub](https://community.progress.com/s/products/chef)

0 commit comments

Comments
 (0)