Skip to content

Commit d9f1cd5

Browse files
Remove references to packages.chef.io (#4316)
* updated the chef package link Signed-off-by: Dishank Tiwari <[email protected]> * Fix images Signed-off-by: Ian Maddaus <[email protected]> * Undo file changes Signed-off-by: Ian Maddaus <[email protected]> * Corrections and edits Signed-off-by: Ian Maddaus <[email protected]> * Editing Signed-off-by: Ian Maddaus <[email protected]> * Lints Signed-off-by: Ian Maddaus <[email protected]> * Bring in updates from workstation docs Signed-off-by: Ian Maddaus <[email protected]> --------- Signed-off-by: Dishank Tiwari <[email protected]> Signed-off-by: Ian Maddaus <[email protected]> Co-authored-by: Ian Maddaus <[email protected]>
1 parent 9e13424 commit d9f1cd5

File tree

8 files changed

+163
-161
lines changed

8 files changed

+163
-161
lines changed

_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/install_workstation.md

Lines changed: 39 additions & 40 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/knife_ssh.md

Lines changed: 9 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/modules.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# github.com/inspec/inspec-azure/docs-chef-io v0.0.0-20240122032234-c1394fc25525
99
# github.com/inspec/inspec-habitat/docs-chef-io v0.0.0-20220218210405-bfd542da49fd
1010
# github.com/inspec/inspec-k8s/docs-chef-io v0.0.0-20240122032042-421355eaf502
11-
# github.com/chef/chef-workstation/docs-chef-io v0.0.0-20240809064339-878cb76b2b66
11+
# github.com/chef/chef-workstation/docs-chef-io v0.0.0-20241212065721-f1621731d636
1212
# github.com/chef/supermarket/docs-chef-io v0.0.0-20241105172430-a362eded8f72
1313
# github.com/chef/effortless/docs-chef-io v0.0.0-20230711123605-c8beb79aba4f
1414
# github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20241211025148-fb9cb1f3e2bc

content/azure_chef_cli.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Windows PowerShell cmdlets and two Microsoft Azure CLI commands.
2222

2323
If the Microsoft Azure [cross-platform command line tool
2424
(Xplat-CLI)](https://github.com/Azure/azure-xplat-cli) is installed on
25-
the workstation, along with the Azure Chef Extension, the `get-chef` and
26-
`set-chef` extensions may be used to manage Chef running on virtual
25+
the workstation along with the Azure Chef Extension, you can use the `get-chef` and
26+
`set-chef` extensions to manage Chef running on virtual
2727
machines in Microsoft Azure.
2828

2929
### get-chef
@@ -125,7 +125,7 @@ azure vm extension set-chef your-vm-name --validation-pem ~/chef-repo/.chef/test
125125
azure vm extension set-chef your-vm-name --validation-pem ~/chef-repo/.chef/testorg-validator.pem --client-config ~/chef-repo/.chef/client.rb --version "1201.12" -R 'recipe[your_cookbook_name::your_recipe_name]'
126126
```
127127

128-
##### Azure Resource Manager (ARM) Templates
128+
##### Azure Resource Manager (ARM) templates
129129

130130
If you are using Azure Resource Manager templates to create your infrastructure you can use the Chef extension to have Azure handle the bootstrapping/configuration of your node to your Chef Infra Server.
131131

@@ -222,7 +222,7 @@ The extension has the following options that can be provided in the
222222

223223
: Verify the SSL certificate on the Chef Infra Server. When `true`, Chef Infra Client always verifies the SSL certificate. When `false`, Chef Infra Client uses the value of `ssl_verify_mode` to determine if the SSL certificate requires verification.
224224

225-
#### Protected Settings
225+
#### Protected settings
226226

227227
The following options can be provided to the extension through the `protectedSettings` hash:
228228

@@ -240,9 +240,9 @@ The following options can be provided to the extension through the `protectedSet
240240

241241
### Examples
242242

243-
The following examples show how Chef Infra Client can be installed and configured from an ARM template.
243+
The following examples show how you can install and configure Chef Infra Client from an ARM template.
244244

245-
#### Installing the Azure Chef extension on a Linux system
245+
#### Install the Azure Chef extension on a Linux system
246246

247247
```json
248248
{
@@ -270,7 +270,7 @@ The following examples show how Chef Infra Client can be installed and configure
270270
}
271271
```
272272

273-
#### Installing the Azure Chef extension on a Windows system
273+
#### Install the Azure Chef extension on a Windows system
274274

275275
```json
276276
{
@@ -289,7 +289,7 @@ The following examples show how Chef Infra Client can be installed and configure
289289
"validation_client_name": "my-chef-organization-validator"
290290
},
291291
"runlist": "recipe[awesome_customers_windows],recipe[iis],role[windows_base]",
292-
"chef_package_url" : "https://my.packages.chef.io/chef-client-15.11.8-1-x64.msi",
292+
"chef_package_url" : "https://download.example.com/chef-client-15.11.8-1-x64.msi",
293293
"validation_key_format": "plaintext"
294294
},
295295
"protectedSettings": {
@@ -299,7 +299,7 @@ The following examples show how Chef Infra Client can be installed and configure
299299
}
300300
```
301301

302-
#### Installing the Azure Chef extension on a Linux system with SSL peer verification turned off and given a data bag secret
302+
#### Install the Azure Chef extension on a Linux system with SSL peer verification turned off and given a data bag secret
303303

304304
```json
305305
{
@@ -331,6 +331,6 @@ The following examples show how Chef Infra Client can be installed and configure
331331

332332
{{< note >}}
333333

334-
Here we're also base64 encoding our validator key which is a recommended approach when using the Azure Chef extension in an ARM template
334+
In this example the validator key is base64 encoded, which is a recommended approach when using the Azure Chef extension in an ARM template.
335335

336336
{{< /note >}}

content/install_bootstrap.md

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
+++
2-
title = "Bootstrap a Node"
2+
title = "Bootstrap a node"
33
draft = false
44
gh_repo = "chef-web-docs"
55
aliases = ["/install_bootstrap.html"]
@@ -23,21 +23,26 @@ product = ["client", "workstation"]
2323

2424
### Run the bootstrap command
2525

26-
The `knife bootstrap` subcommand is used to run a bootstrap operation that installs Chef Infra Client on the target node. The following steps describe how to bootstrap a node using knife.
26+
The `knife bootstrap` command runs a bootstrap operation that installs Chef Infra Client on a target node. The following steps describe how to bootstrap a node using knife.
2727

2828
1. Identify the FQDN or IP address of the target node. The `knife bootstrap` command requires the FQDN or the IP address for the node to complete the bootstrap operation.
2929

30-
2. Once the workstation machine is configured, it can be used to install Chef Infra Client on one (or more) nodes across the organization using a knife bootstrap operation. The `knife bootstrap` command is used to SSH into the target machine, and then do what is needed to allow Chef Infra Client to run on the node. It will install the Chef Infra Client executable (if necessary), generate keys, and register the node with the Chef Infra Server. The bootstrap operation requires the IP address or FQDN of the target system, the SSH credentials (username, password or identity file) for an account that has root access to the node, and (if the operating system is not Ubuntu, which is the default distribution used by `knife bootstrap`) the operating system running on the target system.
30+
2. Once the workstation machine is configured, it can be used to install Chef Infra Client on one (or more) nodes across the organization using a knife bootstrap operation. The `knife bootstrap` command is used to SSH into the target machine, and then do what's needed to allow Chef Infra Client to run on the node. It will install the Chef Infra Client executable (if necessary), generate keys, and register the node with the Chef Infra Server. The bootstrap operation requires the IP address or FQDN of the target system, the SSH credentials (username, password or identity file) for an account that has root access to the node, and (if the operating system isn't Ubuntu, which is the default distribution used by `knife bootstrap`) the operating system running on the target system.
3131

3232
In a command window, enter the following:
3333

3434
```bash
35-
knife bootstrap 172.16.1.233 -U USERNAME --sudo
35+
knife bootstrap <ADDRESS> -U <USERNAME> --sudo
3636
```
3737

38-
where `172.16.1.233` is the IP address or the FQDN for the node, and `USERNAME` is the username you want to use to connect, and `--sudo` specifies to elevate privileges using the sudo command on UNIX-based systems.
38+
Replace:
3939

40-
Then while the bootstrap operation is running, the command window will show something similar to the following:
40+
- `<ADDRESS>` the IP address or the FQDN of the node
41+
- `<USERNAME>` with the username used to connect to the node
42+
43+
The `--sudo` option elevates privileges using the sudo command on UNIX-based systems.
44+
45+
While the bootstrap operation is running, the command window returns something similar to the following:
4146

4247
```bash
4348
Enter password for [email protected]:
@@ -123,16 +128,16 @@ The `knife bootstrap` subcommand is used to run a bootstrap operation that insta
123128
client2
124129
```
125130

126-
## Validatorless and Legacy Validator Bootstraps
131+
## Validatorless and legacy validator bootstraps
127132

128133
We recommended using "validatorless bootstrapping" to authenticate new nodes with the Chef Infra Server.
129134

130135
The legacy Chef Infra validator-based node bootstrapping process depended on using a shared "validatory" key throughout an organization for authenticating new nodes with the Chef Infra Server.
131136

132137
Shortcomings of the legacy validator process are:
133138

134-
* All users share the same key for bootstrapping new systems
135-
* Key sharing makes key rotation difficult, if it is compromised or if an employee leaves the organization.
139+
- All users share the same key for bootstrapping new systems
140+
- Key sharing makes key rotation difficult, if it's compromised or if an employee leaves the organization.
136141
137142
The "validatorless bootstrap" generates a key for each node, which is then transferred to the new node and used to authenticate with the Chef Infra Server instead of relying on a shared "validator" key.
138143
@@ -152,7 +157,7 @@ Use the following options with a validatorless bootstrap to specify items that a
152157
153158
`--bootstrap-vault-json VAULT_JSON`
154159
155-
: A JSON string that contains a list of vaults and items to be updated. --bootstrap-vault-json '{ "vault1": \["item1", "item2"\], "vault2": "item2" }'
160+
: A JSON string that contains a list of vaults and items to be updated. `--bootstrap-vault-json '{ "vault1": \["item1", "item2"\], "vault2": "item2" }'`
156161
157162
## Examples
158163
@@ -175,7 +180,7 @@ cat sea-power-content.json
175180
knife vault create sea power -M client -A sean_horn,angle -J sea-power-content.json
176181
```
177182
178-
No clients, because the `-S` option was not specified while creating the vault.
183+
No clients, because the `-S` option wasn't specified while creating the vault.
179184

180185
At this time, only the users `sean_horn` and `angle` are authorized to read and manage the vault.
181186

@@ -190,7 +195,7 @@ search_query:
190195
some: content for them
191196
```
192197

193-
It is definitely an encrypted databag, see?
198+
It's definitely an encrypted databag, see?
194199
195200
```bash
196201
knife data_bag show sea power
@@ -344,36 +349,37 @@ search_query:
344349
some: content for them
345350
```
346351

347-
## Unattended Installs
352+
## Unattended installs
348353

349-
Chef Infra Client can be installed using an unattended bootstrap. This allows Chef Infra Client to be installed from itself, without requiring SSH. For example, machines are often created using environments like AWS Auto Scaling, AWS CloudFormation, Rackspace Auto Scale, and PXE. In this scenario, using tooling for attended, single-machine installs like `knife bootstrap` or `knife CLOUD_PLUGIN create` is not practical because the machines are created automatically and someone cannot always be on-hand to initiate the bootstrap process.
354+
Chef Infra Client can be installed using an unattended bootstrap. This allows Chef Infra Client to be installed from itself, without requiring SSH. For example, machines are often created using environments like AWS Auto Scaling, AWS CloudFormation, Rackspace Auto Scale, and PXE. In this scenario, using tooling for attended, single-machine installs like `knife bootstrap` or `knife CLOUD_PLUGIN create` is not practical because the machines are created automatically and someone can't always be on-hand to initiate the bootstrap process.
350355
351356
When Chef Infra Client is installed using an unattended bootstrap, remember that Chef Infra Client:
352357
353-
* Must be able to authenticate to the Chef Infra Server
354-
* Must be able to configure a run-list
355-
* May require custom attributes, depending on the cookbooks that are being used
356-
* Must be able to access the chef-validator.pem so that it may create a new identity on the Chef Infra Server
357-
* Must have a unique node name; Chef Infra Client will use the FQDN for the host system by default
358+
- Must be able to authenticate to the Chef Infra Server.
359+
- Must be able to configure a run-list.
360+
- May require custom attributes, depending on the cookbooks that are being used.
361+
- Must be able to access the `chef-validator.pem` file so that it may create a new identity on the Chef Infra Server.
362+
- Must have a unique node name; Chef Infra Client will use the FQDN for the host system by default.
358363
359364
When Chef Infra Client is installed using an unattended bootstrap, it may be built into an image that starts Chef Infra Client on boot, or installed using User Data or some other kind of post-deployment script. The type of image or User Data used depends on the platform on which the unattended bootstrap will take place.
360365
361-
### Bootstrapping with User Data
366+
### Bootstrapping with user data
362367
363-
The method used to inject a user data script into a server will vary depending on the infrastructure platform being used. For example, on AWS you can pass this data in as a text file using the command line tool.
368+
The method used to inject a user data script into a server varies depending on the infrastructure platform being used.
369+
For example, on AWS you can pass this data in as a text file using the command line.
364370
365371
The following user data examples demonstrate the process of bootstrapping Windows and Linux nodes.
366372
367-
#### PowerShell User Data
373+
#### PowerShell user data
368374
369375
```powershell
370376
## Set host file so the instance knows where to find chef-server
371377
$hosts = "1.2.3.4 hello.example.com"
372378
$file = "C:\Windows\System32\drivers\etc\hosts"
373379
$hosts | Add-Content $file
374380
375-
## Download the Chef Infra Client
376-
$clientURL = "https://packages.chef.io/files/stable/chef/12.19.36/windows/2012/chef-client-<version-here>.msi"
381+
## Download Chef Infra Client
382+
$clientURL = "https://chefdownload-commercial.chef.io/stable/client/download?p=windows>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>"
377383
$clientDestination = "C:\chef-client.msi"
378384
Invoke-WebRequest $clientURL -OutFile $clientDestination
379385
@@ -402,7 +408,7 @@ Set-Content -Path c:\chef\client.rb -Value $clientrb
402408
C:\opscode\chef\bin\chef-client.bat -j C:\chef\first-boot.json
403409
```
404410
405-
#### Bash User Data
411+
#### Bash user data
406412
407413
```bash
408414
#!/bin/bash -xev
@@ -447,7 +453,7 @@ EOF
447453
chef-client -j /etc/chef/first-boot.json
448454
```
449455
450-
It is important that settings in the [client.rb file](/config_rb_client/)---`chef_server_url`, `http_proxy`, and so on are used---to ensure that configuration details are built into the unattended bootstrap process.
456+
It's important that settings in the [client.rb file](/config_rb_client/)---for example `chef_server_url` and `http_proxy`---are used to ensure that configuration details are built into the unattended bootstrap process.
451457

452458
##### Setting the initial run-list
453459

0 commit comments

Comments
 (0)