Skip to content

Commit 37fbd1b

Browse files
authored
Merge branch 'main' into im/package
2 parents aa993ac + 9f79c38 commit 37fbd1b

File tree

9 files changed

+78
-58
lines changed

9 files changed

+78
-58
lines changed

.github/workflows/lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ jobs:
5656
- uses: actions/checkout@v3
5757
- uses: errata-ai/vale-action@reviewdog
5858
with:
59-
files: '["archetypes", "assets", "content", "data", "layouts", "static"]'
59+
files: '["assets", "content", "data", "layouts", "static"]'
6060
vale_flags: "--config=tools/vale/.vale-github-action.ini"
6161
filter_mode: diff_context
6262
fail_on_error: true

_vendor/github.com/chef/compliance-profiles/docs-chef-io/content/release_notes_compliance_profiles.md

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

_vendor/github.com/chef/compliance-remediation-2022/docs-chef-io/content/release_notes_compliance_remediation.md

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

_vendor/modules.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
# github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250205062508-ee50345a4044
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
14-
# github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250207053335-f11d6ce5b3c1
15-
# github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20240313054833-ebbc45209efa
14+
# github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250403124242-2087b16979ee
15+
# github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20250403111641-fada5190e176
1616
# github.com/chef/license-service/docs-chef-io v0.0.0-20250120051510-ae1de80f4621
1717
# github.com/chef/samples v0.0.0-20250304162216-b7bf3710b07e
1818
# github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258
Lines changed: 33 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,36 @@
1-
The following diagram shows the stages of the bootstrap operation, and
2-
the list below the diagram describes each of those stages in greater
3-
detail.
1+
The following diagram shows the stages of the bootstrap operation,
2+
and the list below the diagram describes each of those stages in greater detail.
43

54
![image](/images/chef_bootstrap.png)
65

7-
During a `knife bootstrap` bootstrap operation, the following happens:
8-
9-
<!-- markdownlint-disable-file MD033 -->
10-
11-
<table>
12-
<colgroup>
13-
<col style="width: 25%" />
14-
<col style="width: 75%" />
15-
</colgroup>
16-
<thead>
17-
<tr class="header">
18-
<th>Stages</th>
19-
<th>Description</th>
20-
</tr>
21-
</thead>
22-
<tbody>
23-
<tr>
24-
<td><strong>knife bootstrap</strong></td>
25-
<td>Enter the <code>knife bootstrap</code> subcommand from a workstation. Include the hostname, IP address, or FQDN of the target node as part of this command. Knife will establish an SSH or WinRM connection with the target system and run a bootstrap script.</td>
26-
</tr>
27-
<tr>
28-
<td><p><strong>Get the install script from Chef</strong></p></td>
29-
<td><p>The shell script will make a request to the Chef website to get the most recent version of a the Chef Infra Client install script(<code>install.sh</code> or <code>install.ps1</code>).</td>
30-
</tr>
31-
<tr>
32-
<td><strong>Get the Chef Infra Client package from Chef</strong></td>
33-
<td>The install script then gathers system-specific information and determines the correct package for Chef Infra Client, and then downloads the appropriate package from <code>omnitruck-direct.chef.io</code>.</td>
34-
</tr>
35-
<tr>
36-
<td><strong>Install Chef Infra Client</strong></td>
37-
<td>Chef Infra Client is installed on the target node using a system native package (.rpm, .msi, etc).</td>
38-
</tr>
39-
<tr>
40-
<td><p><strong>Start a Chef Infra Client run</strong></p></td>
41-
<td><p>On UNIX and Linux-based machines: The second shell script executes the <code>chef-client</code> binary with a set of initial settings stored within <code>first-boot.json</code> on the node. <code>first-boot.json</code> is generated from the workstation as part of the initial <code>knife bootstrap</code> subcommand.</p>
42-
<p>On Windows machines: The batch file that's derived from the windows-chef-client-msi.erb bootstrap template executes the <code>chef-client</code> binary with a set of initial settings stored within <code>first-boot.json</code> on the node. <code>first-boot.json</code> is generated from the workstation as part of the initial <code>knife bootstrap</code> subcommand.</p></td>
43-
</tr>
44-
<tr>
45-
<td><p><strong>Complete a Chef Infra Client run</strong></p></td>
46-
<td><p>a Chef Infra Client run proceeds, using HTTPS (port 443), and registers the node with the Chef Infra Server.</p>
47-
<p>The first Chef Infra Client run, by default, contains an empty run-list. A <a href="/workstation/knife_bootstrap/">run-list can be specified</a> as part of the initial bootstrap operation using the <code>--run-list</code> option as part of the <code>knife bootstrap</code> subcommand.</p></td>
48-
</tr>
49-
</tbody>
50-
</table>
6+
When you run `knife bootstrap` on a node for the first time, Chef Workstation, Infra Client, and Infra Server handle the following tasks:
7+
8+
1. **Run `knife bootstrap`**
9+
10+
Run the [`knife bootstrap`](/workstation/knife_bootstrap/) subcommand from a workstation. Include the hostname, IP address, or FQDN of the target node as part of this command. Knife establishes an SSH or WinRM connection with the target system and runs the bootstrap script.
11+
12+
By default, the first Chef Infra Client run has an empty run list. You can add a [run list](/run_lists/) to the initial bootstrap operation using the [`--run-list`](/workstation/knife_bootstrap/#node-options) option.
13+
14+
1. **Get the install script**
15+
16+
A shell script gets the most recent version of the [Chef Infra Client install script](/chef_install_script/) (`install.sh` or `install.ps1`) from Chef.
17+
18+
1. **Get the Chef Infra Client package**
19+
20+
The install script gathers system-specific information, determines the correct package for Chef Infra Client, and downloads that package from Chef's downloads API.
21+
22+
1. **Install Chef Infra Client**
23+
24+
Chef Infra Client is installed on the target node using a system native package (.rpm, .msi, etc).
25+
26+
1. **Start a Chef Infra Client run**
27+
28+
When you first run `knife bootstrap`, Chef Workstation creates a `first-boot.json` file with some initial settings.
29+
30+
On UNIX and Linux-based machines, the second shell script executes the `chef-client` binary with the `first-boot.json` file on the node.
31+
32+
On Windows machines, the batch file that's derived from the `windows-chef-client-msi.erb` bootstrap template executes the `chef-client` binary with the `first-boot.json` file on the node.
33+
34+
1. **Complete the Chef Infra Client run**
35+
36+
The Chef Infra Client run proceeds using HTTPS (port 443) and registers the node with Chef Infra Server.

content/reusable/md/infra_lang_method_registry_value_exists_syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The syntax for the `registry_dvalue_exists?` method is as follows:
1+
The syntax for the `registry_value_exists?` method is as follows:
22

33
```ruby
44
registry_value_exists?(

data/infra/resources/snap_package.yaml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,25 @@ properties_list:
7474
required: false
7575
description_list:
7676
- markdown: The version of a package to be installed or upgraded.
77-
examples:
77+
examples: |
78+
**Install a package**
79+
80+
```ruby
81+
snap_package 'hello'
82+
```
83+
84+
**Upgrade a package**
85+
86+
```ruby
87+
snap_package 'hello' do
88+
action :upgrade
89+
end
90+
```
91+
92+
**Install a package with classic confinement**
93+
94+
```ruby
95+
snap_package 'hello' do
96+
options 'classic'
97+
end
98+
```

go.mod

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ require (
77
github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258 // indirect
88
github.com/chef/chef-server/docs-chef-io v0.0.0-20250303143005-18808e167759 // indirect
99
github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250205062508-ee50345a4044 // indirect
10-
github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250207053335-f11d6ce5b3c1 // indirect
11-
github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20240313054833-ebbc45209efa // indirect
10+
github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250403124242-2087b16979ee // indirect
11+
github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20250403111641-fada5190e176 // indirect
1212
github.com/chef/desktop-config/docs-chef-io v0.0.0-20240814044820-5af667d41a43 // indirect
1313
github.com/chef/effortless/docs-chef-io v0.0.0-20230711123605-c8beb79aba4f // indirect
1414
github.com/chef/license-service/docs-chef-io v0.0.0-20250120051510-ae1de80f4621 // indirect

go.sum

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ github.com/chef/chef-server/docs-chef-io v0.0.0-20250303143005-18808e167759 h1:v
66
github.com/chef/chef-server/docs-chef-io v0.0.0-20250303143005-18808e167759/go.mod h1:gMSa25GUHmLimA0gjvRd3hs1buOBqkKPrdHzHvaJauY=
77
github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250205062508-ee50345a4044 h1:9su2oorS/cjvdxUEBaTZBjiCS3WafkLgk6bwDNQ1SDk=
88
github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250205062508-ee50345a4044/go.mod h1:u6KNpAJs9lTmRigxXsxX0dEywa5KLB40m1vbAalN0NI=
9-
github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250207053335-f11d6ce5b3c1 h1:nd2OPJ6j6JoCURF4r+vYCzpr/7pznUClcQc0L7ed9GU=
10-
github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250207053335-f11d6ce5b3c1/go.mod h1:fsG7S6r66ZW6Af/sqq+OL3WNP+BoO4V1/Evwu98Noig=
11-
github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20240313054833-ebbc45209efa h1:H2kX1/99ggT3YoLlO6xe7FuqsWl0dETD0OXUvKCWrII=
12-
github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20240313054833-ebbc45209efa/go.mod h1:kNxSqzNZGBwfF4AfALPzUfOeAsscIIKq8vyoCNL33DA=
9+
github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250403124242-2087b16979ee h1:IXegzdAKZ900k9sPqTJYhNBMpiIQlK90hRzqAk4xsO4=
10+
github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250403124242-2087b16979ee/go.mod h1:fsG7S6r66ZW6Af/sqq+OL3WNP+BoO4V1/Evwu98Noig=
11+
github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20250403111641-fada5190e176 h1:X2e3RK5CGhJQZTK9gsWU3bgOdfUypefRELmeynWxIVA=
12+
github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20250403111641-fada5190e176/go.mod h1:kNxSqzNZGBwfF4AfALPzUfOeAsscIIKq8vyoCNL33DA=
1313
github.com/chef/desktop-config/docs-chef-io v0.0.0-20240814044820-5af667d41a43 h1:2wrzLEbX7qPYQRw/LTBm2pHB5HKyL9ElYUA7bkYScaE=
1414
github.com/chef/desktop-config/docs-chef-io v0.0.0-20240814044820-5af667d41a43/go.mod h1:90xAx6sIfgSL50M2KzeBmx7V7s7dlhQU3xpUkJO0qW0=
1515
github.com/chef/effortless/docs-chef-io v0.0.0-20230711123605-c8beb79aba4f h1:6+VjBykE1b9LGfJEBstSKLAGJySrhu6NY162gz+cnxo=

0 commit comments

Comments
 (0)