Skip to content

Commit 8a8479a

Browse files
johnmccraeIanMadd
johnmccrae
and
IanMadd
authored
Making the docs match the codebase (#163)
* Making the docs match the codebase Signed-off-by: John McCrae <john.mccrae@progress.com> * Update resource YAML metadata versions * Correcting linting problems Signed-off-by: John McCrae <john.mccrae@progress.com> * Editing Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> --------- Signed-off-by: John McCrae <john.mccrae@progress.com> Signed-off-by: Ian Maddaus <ian.maddaus@progress.com> Co-authored-by: Ian Maddaus <ian.maddaus@progress.com>
1 parent b6c8a81 commit 8a8479a

25 files changed

Lines changed: 302 additions & 64 deletions

‎content/integrations/windows.md‎

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -48,29 +48,11 @@ have access to Chef Infra Server using HTTPS. The Chef Infra Client can be
4848
used to manage machines that run on the following versions of Microsoft
4949
Windows:
5050

51-
<table>
52-
<colgroup>
53-
<col style="width: 33%" />
54-
<col style="width: 33%" />
55-
<col style="width: 33%" />
56-
</colgroup>
57-
<thead>
58-
<tr class="header">
59-
<th>Operating System</th>
60-
<th>Architecture</th>
61-
<th>Version</th>
62-
</tr>
63-
</thead>
64-
<tbody>
65-
<tr>
66-
<td>Windows</td>
67-
<td><code>x86</code>, <code>x64</code></td>
68-
<td><code>8.1</code>, <code>2012</code>, <code>2012 R2</code>, <code>2016</code>, <code>10 (all channels except "insider" builds)</code>, <code>2019 (Long-term servicing channel (LTSC), both Desktop Experience and Server Core)</code></td>
69-
</tr>
70-
</tbody>
71-
</table>
51+
| Operating System | Architecture | Version |
52+
| ---------------- | ------------ | ------------------------------------------------------- |
53+
| Windows | `x64` | `10`, `11`, `Server 2016`, `Server 2019`, `Server 2022` |
7254

73-
After Chef Infra Client is installed, it's located at `C:\opscode`. The
55+
After Chef Infra Client is installed, it's located at `C:\hab`. The
7456
main configuration file for Chef Infra Client is located at
7557
`C:\chef\client.rb`.
7658

‎content/resources/bundled/chef_client_hab_ca_cert.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
+++
2+
title = "chef_client_hab_ca_cert Resource"
3+
draft = false
4+
robots = ""
5+
6+
data_path = ["infra","resources","chef_client_hab_ca_cert"]
7+
layout = "infra_resource"
8+
toc_layout = "infra_resource_toc"
9+
10+
[menu]
11+
[menu.resources]
12+
title = "chef_client_hab_ca_cert"
13+
identifier = "resources/bundled/chef_client_hab_ca_cert"
14+
parent = "resources/bundled"
15+
+++
16+
17+
<!-- The contents of this page are automatically generated from the chef_client_hab_ca_cert.yaml file in the data/infra/resources directory. -->
18+
<!-- To suggest a change, edit the https://github.com/chef/chef/blob/main/lib/chef/resource/chef_client_hab_ca_cert.rb file and submit a pull request to the https://github.com/chef/chef repository. -->
19+
<!-- markdownlint-disable-file -->

‎content/resources/bundled/macos_pkg.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
+++
2+
title = "macos_pkg Resource"
3+
draft = false
4+
robots = ""
5+
6+
data_path = ["infra","resources","macos_pkg"]
7+
layout = "infra_resource"
8+
toc_layout = "infra_resource_toc"
9+
10+
[menu]
11+
[menu.resources]
12+
title = "macos_pkg"
13+
identifier = "resources/bundled/macos_pkg"
14+
parent = "resources/bundled"
15+
+++
16+
17+
<!-- The contents of this page are automatically generated from the macos_pkg.yaml file in the data/infra/resources directory. -->
18+
<!-- To suggest a change, edit the https://github.com/chef/chef/blob/main/lib/chef/resource/macos_pkg.rb file and submit a pull request to the https://github.com/chef/chef repository. -->
19+
<!-- markdownlint-disable-file -->

‎data/infra/resources/apt_package.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ properties_list:
8080
ruby_type: Hash
8181
required: false
8282
default_value: "{}"
83-
new_in: '18.8'
83+
new_in: '19.0'
8484
description_list:
8585
- markdown: A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'}
8686
to be set before running the command.

‎data/infra/resources/bash.yaml‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ resource_description_list:
1212
in which they are run. Use `not_if` and `only_if` to guard this resource for idempotence.
1313
syntax_full_code_block: |-
1414
bash 'name' do
15+
cgroup String
1516
code String
1617
command String, Array # default value: 'name' unless specified
1718
creates String
@@ -38,15 +39,23 @@ syntax_full_properties_list:
3839
- "`name` is the name given to the resource block."
3940
- "`action` identifies which steps Chef Infra Client will take to bring the node into
4041
the desired state."
41-
- "`code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`, `environment`,
42-
`flags`, `group`, `input`, `interpreter`, `live_stream`, `login`, `password`, `returns`,
43-
`timeout`, and `user` are the properties available to this resource."
42+
- "`cgroup`, `code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`,
43+
`environment`, `flags`, `group`, `input`, `interpreter`, `live_stream`, `login`,
44+
`password`, `returns`, `timeout`, and `user` are the properties available to this
45+
resource."
4446
actions_list:
4547
:nothing:
4648
shortcode: resources_common_actions_nothing.md
4749
:run:
4850
markdown: Run a command. (default)
4951
properties_list:
52+
- property: cgroup
53+
ruby_type: String
54+
required: false
55+
new_in: '19.0'
56+
description_list:
57+
- markdown: 'Linux only: Run the command within a specific cgroup, creating it if
58+
it doesn''t exist.'
5059
- property: code
5160
ruby_type: String
5261
required: true

‎data/infra/resources/chef_client_hab_ca_cert.yaml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
resource_reference: true
3+
resources_common_guards: true
4+
resources_common_notification: true
5+
resources_common_properties: true
6+
resource: chef_client_hab_ca_cert
7+
resource_description_list:
8+
- markdown: Use the **chef_client_hab_ca_cert** resource to add certificates to the
9+
Habitat Chef Infra Client's CA bundle. This allows Chef Infra Client to communicate
10+
with internal encrypted resources without errors. To make sure these CA certs
11+
take effect, configure the `ssl_ca_file` to point to the CA cert file path of
12+
the `core/cacerts` Habitat package.
13+
resource_new_in: '19.1'
14+
syntax_full_code_block: |-
15+
chef_client_hab_ca_cert 'name' do
16+
cert_name String # default value: 'name' unless specified
17+
certificate String
18+
action Symbol # defaults to :add if not specified
19+
end
20+
syntax_properties_list:
21+
syntax_full_properties_list:
22+
- "`chef_client_hab_ca_cert` is the resource."
23+
- "`name` is the name given to the resource block."
24+
- "`action` identifies which steps Chef Infra Client will take to bring the node into
25+
the desired state."
26+
- "`cert_name` and `certificate` are the properties available to this resource."
27+
actions_list:
28+
:nothing:
29+
shortcode: resources_common_actions_nothing.md
30+
:add:
31+
markdown: Add a local certificate to the Habitat Chef Infra Client's CA bundle.
32+
(default)
33+
properties_list:
34+
- property: cert_name
35+
ruby_type: String
36+
required: false
37+
default_value: The resource block's name
38+
description_list:
39+
- markdown: The name to use for the certificate. If not provided, the name of the
40+
resource block will be used instead.
41+
- property: certificate
42+
ruby_type: String
43+
required: true
44+
description_list:
45+
- markdown: The text of the certificate file including the BEGIN/END comment lines.
46+
examples: |
47+
**Trust a self-signed certificate**:
48+
49+
```ruby
50+
chef_client_hab_ca_cert 'self-signed.badssl.com' do
51+
certificate <<~CERT
52+
-----BEGIN CERTIFICATE-----
53+
MIIDeTCCAmGgAwIBAgIJAPziuikCTox4MA0GCSqGSIb3DQEBCwUAMGIxCzAJBgNV
54+
BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNp
55+
c2NvMQ8wDQYDVQQKDAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTAeFw0x
56+
OTEwMDkyMzQxNTJaFw0yMTEwMDgyMzQxNTJaMGIxCzAJBgNVBAYTAlVTMRMwEQYD
57+
VQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ8wDQYDVQQK
58+
DAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTCCASIwDQYJKoZIhvcNAQEB
59+
BQADggEPADCCAQoCggEBAMIE7PiM7gTCs9hQ1XBYzJMY61yoaEmwIrX5lZ6xKyx2
60+
PmzAS2BMTOqytMAPgLaw+XLJhgL5XEFdEyt/ccRLvOmULlA3pmccYYz2QULFRtMW
61+
hyefdOsKnRFSJiFzbIRMeVXk0WvoBj1IFVKtsyjbqv9u/2CVSndrOfEk0TG23U3A
62+
xPxTuW1CrbV8/q71FdIzSOciccfCFHpsKOo3St/qbLVytH5aohbcabFXRNsKEqve
63+
ww9HdFxBIuGa+RuT5q0iBikusbpJHAwnnqP7i/dAcgCskgjZjFeEU4EFy+b+a1SY
64+
QCeFxxC7c3DvaRhBB0VVfPlkPz0sw6l865MaTIbRyoUCAwEAAaMyMDAwCQYDVR0T
65+
BAIwADAjBgNVHREEHDAaggwqLmJhZHNzbC5jb22CCmJhZHNzbC5jb20wDQYJKoZI
66+
hvcNAQELBQADggEBAGlwCdbPxflZfYOaukZGCaxYK6gpincX4Lla4Ui2WdeQxE95
67+
w7fChXvP3YkE3UYUE7mupZ0eg4ZILr/A0e7JQDsgIu/SRTUE0domCKgPZ8v99k3A
68+
vka4LpLK51jHJJK7EFgo3ca2nldd97GM0MU41xHFk8qaK1tWJkfrrfcGwDJ4GQPI
69+
iLlm6i0yHq1Qg1RypAXJy5dTlRXlCLd8ufWhhiwW0W75Va5AEnJuqpQrKwl3KQVe
70+
wGj67WWRgLfSr+4QG1mNvCZb2CkjZWmxkGPuoP40/y7Yu5OFqxP5tAjj4YixCYTW
71+
EVA0pmzIzgBg+JIe3PdRy27T0asgQW/F4TY61Yk=
72+
-----END CERTIFICATE-----
73+
CERT
74+
end
75+
```

‎data/infra/resources/chocolatey_installer.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ resource: chocolatey_installer
77
resource_description_list:
88
- markdown: Use the chocolatey_installer resource to install the Chocolatey package manager. Use the chocolatey_feature resource to customize
99
your install and the chocolatey_package resource to install packages.
10-
resource_new_in: '18.4'
10+
resource_new_in: '18.3'
1111
syntax_full_code_block: |-
1212
chocolatey_installer 'name' do
1313
chocolatey_version String

‎data/infra/resources/csh.yaml‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ resource_description_list:
1212
in which they are run. Use `not_if` and `only_if` to guard this resource for idempotence.
1313
syntax_full_code_block: |-
1414
csh 'name' do
15+
cgroup String
1516
code String
1617
command String, Array # default value: 'name' unless specified
1718
creates String
@@ -38,15 +39,23 @@ syntax_full_properties_list:
3839
- "`name` is the name given to the resource block."
3940
- "`action` identifies which steps Chef Infra Client will take to bring the node into
4041
the desired state."
41-
- "`code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`, `environment`,
42-
`flags`, `group`, `input`, `interpreter`, `live_stream`, `login`, `password`, `returns`,
43-
`timeout`, and `user` are the properties available to this resource."
42+
- "`cgroup`, `code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`,
43+
`environment`, `flags`, `group`, `input`, `interpreter`, `live_stream`, `login`,
44+
`password`, `returns`, `timeout`, and `user` are the properties available to this
45+
resource."
4446
actions_list:
4547
:nothing:
4648
shortcode: resources_common_actions_nothing.md
4749
:run:
4850
markdown: Run a command. (default)
4951
properties_list:
52+
- property: cgroup
53+
ruby_type: String
54+
required: false
55+
new_in: '19.0'
56+
description_list:
57+
- markdown: 'Linux only: Run the command within a specific cgroup, creating it if
58+
it doesn''t exist.'
5059
- property: code
5160
ruby_type: String
5261
required: true

‎data/infra/resources/dnf_package.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ properties_list:
8080
ruby_type: Hash
8181
required: false
8282
default_value: "{}"
83-
new_in: '18.8'
83+
new_in: '19.0'
8484
description_list:
8585
- markdown: A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'}
8686
to be set before running the command.

‎data/infra/resources/dpkg_package.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ properties_list:
5555
ruby_type: Hash
5656
required: false
5757
default_value: "{}"
58-
new_in: '18.8'
58+
new_in: '19.0'
5959
description_list:
6060
- markdown: A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'}
6161
to be set before running the command.

0 commit comments

Comments
 (0)