[release-19.1] Making the docs match the codebase (#163)

content/integrations/windows.md

@@ -48,29 +48,11 @@ have access to Chef Infra Server using HTTPS. The Chef Infra Client can be
 used to manage machines that run on the following versions of Microsoft
 Windows:
 
-<table>
-<colgroup>
-<col style="width: 33%" />
-<col style="width: 33%" />
-<col style="width: 33%" />
-</colgroup>
-<thead>
-<tr class="header">
-<th>Operating System</th>
-<th>Architecture</th>
-<th>Version</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>Windows</td>
-<td><code>x86</code>, <code>x64</code></td>
-<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>
-</tr>
-</tbody>
-</table>
+| Operating System | Architecture | Version                                                 |
+| ---------------- | ------------ | ------------------------------------------------------- |
+| Windows          | `x64`        | `10`, `11`, `Server 2016`, `Server 2019`, `Server 2022` |
 
-After Chef Infra Client is installed, it's located at `C:\opscode`. The
+After Chef Infra Client is installed, it's located at `C:\hab`. The
 main configuration file for Chef Infra Client is located at
 `C:\chef\client.rb`.
 

content/resources/bundled/chef_client_hab_ca_cert.md

@@ -0,0 +1,19 @@
++++
+title = "chef_client_hab_ca_cert Resource"
+draft = false
+robots = ""
+
+data_path = ["infra","resources","chef_client_hab_ca_cert"]
+layout = "infra_resource"
+toc_layout = "infra_resource_toc"
+
+[menu]
+  [menu.resources]
+    title = "chef_client_hab_ca_cert"
+    identifier = "resources/bundled/chef_client_hab_ca_cert"
+    parent = "resources/bundled"
++++
+
+<!-- The contents of this page are automatically generated from the chef_client_hab_ca_cert.yaml file in the data/infra/resources directory. -->
+<!-- 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. -->
+<!-- markdownlint-disable-file -->

content/resources/bundled/macos_pkg.md

@@ -0,0 +1,19 @@
++++
+title = "macos_pkg Resource"
+draft = false
+robots = ""
+
+data_path = ["infra","resources","macos_pkg"]
+layout = "infra_resource"
+toc_layout = "infra_resource_toc"
+
+[menu]
+  [menu.resources]
+    title = "macos_pkg"
+    identifier = "resources/bundled/macos_pkg"
+    parent = "resources/bundled"
++++
+
+<!-- The contents of this page are automatically generated from the macos_pkg.yaml file in the data/infra/resources directory. -->
+<!-- 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. -->
+<!-- markdownlint-disable-file -->

data/infra/resources/apt_package.yaml

@@ -80,7 +80,7 @@ properties_list:
   ruby_type: Hash
   required: false
   default_value: "{}"
-  new_in: '18.8'
+  new_in: '19.0'
   description_list:
   - markdown: A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'}
       to be set before running the command.

data/infra/resources/bash.yaml

@@ -12,6 +12,7 @@ resource_description_list:
     in which they are run. Use `not_if` and `only_if` to guard this resource for idempotence.
 syntax_full_code_block: |-
   bash 'name' do
+    cgroup           String
     code             String
     command          String, Array # default value: 'name' unless specified
     creates          String
@@ -38,15 +39,23 @@ syntax_full_properties_list:
 - "`name` is the name given to the resource block."
 - "`action` identifies which steps Chef Infra Client will take to bring the node into
   the desired state."
-- "`code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`, `environment`,
-  `flags`, `group`, `input`, `interpreter`, `live_stream`, `login`, `password`, `returns`,
-  `timeout`, and `user` are the properties available to this resource."
+- "`cgroup`, `code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`,
+  `environment`, `flags`, `group`, `input`, `interpreter`, `live_stream`, `login`,
+  `password`, `returns`, `timeout`, and `user` are the properties available to this
+  resource."
 actions_list:
   :nothing:
     shortcode: resources_common_actions_nothing.md
   :run:
     markdown: Run a command. (default)
 properties_list:
+- property: cgroup
+  ruby_type: String
+  required: false
+  new_in: '19.0'
+  description_list:
+  - markdown: 'Linux only: Run the command within a specific cgroup, creating it if
+      it doesn''t exist.'
 - property: code
   ruby_type: String
   required: true

data/infra/resources/chef_client_hab_ca_cert.yaml

@@ -0,0 +1,75 @@
+---
+resource_reference: true
+resources_common_guards: true
+resources_common_notification: true
+resources_common_properties: true
+resource: chef_client_hab_ca_cert
+resource_description_list:
+- markdown: Use the **chef_client_hab_ca_cert** resource to add certificates to the
+    Habitat Chef Infra Client's CA bundle. This allows Chef Infra Client to communicate
+    with internal encrypted resources without errors. To make sure these CA certs
+    take effect, configure the `ssl_ca_file` to point to the CA cert file path of
+    the `core/cacerts` Habitat package.
+resource_new_in: '19.1'
+syntax_full_code_block: |-
+  chef_client_hab_ca_cert 'name' do
+    cert_name        String # default value: 'name' unless specified
+    certificate      String
+    action           Symbol # defaults to :add if not specified
+  end
+syntax_properties_list:
+syntax_full_properties_list:
+- "`chef_client_hab_ca_cert` is the resource."
+- "`name` is the name given to the resource block."
+- "`action` identifies which steps Chef Infra Client will take to bring the node into
+  the desired state."
+- "`cert_name` and `certificate` are the properties available to this resource."
+actions_list:
+  :nothing:
+    shortcode: resources_common_actions_nothing.md
+  :add:
+    markdown: Add a local certificate to the Habitat Chef Infra Client's CA bundle.
+      (default)
+properties_list:
+- property: cert_name
+  ruby_type: String
+  required: false
+  default_value: The resource block's name
+  description_list:
+  - markdown: The name to use for the certificate. If not provided, the name of the
+      resource block will be used instead.
+- property: certificate
+  ruby_type: String
+  required: true
+  description_list:
+  - markdown: The text of the certificate file including the BEGIN/END comment lines.
+examples: |
+  **Trust a self-signed certificate**:
+
+  ```ruby
+  chef_client_hab_ca_cert 'self-signed.badssl.com' do
+    certificate <<~CERT
+    -----BEGIN CERTIFICATE-----
+    MIIDeTCCAmGgAwIBAgIJAPziuikCTox4MA0GCSqGSIb3DQEBCwUAMGIxCzAJBgNV
+    BAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNp
+    c2NvMQ8wDQYDVQQKDAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTAeFw0x
+    OTEwMDkyMzQxNTJaFw0yMTEwMDgyMzQxNTJaMGIxCzAJBgNVBAYTAlVTMRMwEQYD
+    VQQIDApDYWxpZm9ybmlhMRYwFAYDVQQHDA1TYW4gRnJhbmNpc2NvMQ8wDQYDVQQK
+    DAZCYWRTU0wxFTATBgNVBAMMDCouYmFkc3NsLmNvbTCCASIwDQYJKoZIhvcNAQEB
+    BQADggEPADCCAQoCggEBAMIE7PiM7gTCs9hQ1XBYzJMY61yoaEmwIrX5lZ6xKyx2
+    PmzAS2BMTOqytMAPgLaw+XLJhgL5XEFdEyt/ccRLvOmULlA3pmccYYz2QULFRtMW
+    hyefdOsKnRFSJiFzbIRMeVXk0WvoBj1IFVKtsyjbqv9u/2CVSndrOfEk0TG23U3A
+    xPxTuW1CrbV8/q71FdIzSOciccfCFHpsKOo3St/qbLVytH5aohbcabFXRNsKEqve
+    ww9HdFxBIuGa+RuT5q0iBikusbpJHAwnnqP7i/dAcgCskgjZjFeEU4EFy+b+a1SY
+    QCeFxxC7c3DvaRhBB0VVfPlkPz0sw6l865MaTIbRyoUCAwEAAaMyMDAwCQYDVR0T
+    BAIwADAjBgNVHREEHDAaggwqLmJhZHNzbC5jb22CCmJhZHNzbC5jb20wDQYJKoZI
+    hvcNAQELBQADggEBAGlwCdbPxflZfYOaukZGCaxYK6gpincX4Lla4Ui2WdeQxE95
+    w7fChXvP3YkE3UYUE7mupZ0eg4ZILr/A0e7JQDsgIu/SRTUE0domCKgPZ8v99k3A
+    vka4LpLK51jHJJK7EFgo3ca2nldd97GM0MU41xHFk8qaK1tWJkfrrfcGwDJ4GQPI
+    iLlm6i0yHq1Qg1RypAXJy5dTlRXlCLd8ufWhhiwW0W75Va5AEnJuqpQrKwl3KQVe
+    wGj67WWRgLfSr+4QG1mNvCZb2CkjZWmxkGPuoP40/y7Yu5OFqxP5tAjj4YixCYTW
+    EVA0pmzIzgBg+JIe3PdRy27T0asgQW/F4TY61Yk=
+    -----END CERTIFICATE-----
+    CERT
+  end
+  ```

data/infra/resources/chocolatey_installer.yaml

@@ -7,7 +7,7 @@ resource: chocolatey_installer
 resource_description_list:
 - markdown: Use the chocolatey_installer resource to install the Chocolatey package manager. Use the chocolatey_feature resource to customize
     your install and the chocolatey_package resource to install packages.
-resource_new_in: '18.4'
+resource_new_in: '18.3'
 syntax_full_code_block: |-
   chocolatey_installer 'name' do
     chocolatey_version      String

data/infra/resources/csh.yaml

@@ -12,6 +12,7 @@ resource_description_list:
     in which they are run. Use `not_if` and `only_if` to guard this resource for idempotence.
 syntax_full_code_block: |-
   csh 'name' do
+    cgroup           String
     code             String
     command          String, Array # default value: 'name' unless specified
     creates          String
@@ -38,15 +39,23 @@ syntax_full_properties_list:
 - "`name` is the name given to the resource block."
 - "`action` identifies which steps Chef Infra Client will take to bring the node into
   the desired state."
-- "`code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`, `environment`,
-  `flags`, `group`, `input`, `interpreter`, `live_stream`, `login`, `password`, `returns`,
-  `timeout`, and `user` are the properties available to this resource."
+- "`cgroup`, `code`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`,
+  `environment`, `flags`, `group`, `input`, `interpreter`, `live_stream`, `login`,
+  `password`, `returns`, `timeout`, and `user` are the properties available to this
+  resource."
 actions_list:
   :nothing:
     shortcode: resources_common_actions_nothing.md
   :run:
     markdown: Run a command. (default)
 properties_list:
+- property: cgroup
+  ruby_type: String
+  required: false
+  new_in: '19.0'
+  description_list:
+  - markdown: 'Linux only: Run the command within a specific cgroup, creating it if
+      it doesn''t exist.'
 - property: code
   ruby_type: String
   required: true

data/infra/resources/dnf_package.yaml

@@ -80,7 +80,7 @@ properties_list:
   ruby_type: Hash
   required: false
   default_value: "{}"
-  new_in: '18.8'
+  new_in: '19.0'
   description_list:
   - markdown: A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'}
       to be set before running the command.

data/infra/resources/dpkg_package.yaml

@@ -55,7 +55,7 @@ properties_list:
   ruby_type: Hash
   required: false
   default_value: "{}"
-  new_in: '18.8'
+  new_in: '19.0'
   description_list:
   - markdown: A Hash of environment variables in the form of {'ENV_VARIABLE' => 'VALUE'}
       to be set before running the command.

data/infra/resources/execute.yaml

@@ -58,6 +58,7 @@ syntax_properties_list:
   that file already exists'
 syntax_full_code_block: |-
   execute 'name' do
+    cgroup           String
     command          String, Array # default value: 'name' unless specified
     creates          String
     cwd              String
@@ -80,15 +81,22 @@ syntax_full_properties_list:
 - "`name` is the name given to the resource block."
 - "`action` identifies which steps Chef Infra Client will take to bring the node into
   the desired state."
-- "`command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`, `environment`,
-  `group`, `input`, `live_stream`, `login`, `password`, `returns`, `timeout`, and
-  `user` are the properties available to this resource."
+- "`cgroup`, `command`, `creates`, `cwd`, `default_env`, `domain`, `elevated`,
+  `environment`, `group`, `input`, `live_stream`, `login`, `password`, `returns`,
+  `timeout`, and `user` are the properties available to this resource."
 actions_list:
   :nothing:
     shortcode: resources_common_actions_nothing.md
   :run:
     markdown: Run a command. (default)
 properties_list:
+- property: cgroup
+  ruby_type: String
+  required: false
+  new_in: '19.0'
+  description_list:
+  - markdown: 'Linux only: Run the command within a specific cgroup, creating it if
+      it doesn''t exist.'
 - property: command
   ruby_type: String, Array
   required: false

data/infra/resources/file.yaml

@@ -360,7 +360,7 @@ remote_file_unc_path: false
 ps_credential_helper: false
 ruby_style_basics_chef_log: false
 debug_recipes_chef_shell: false
-examples: |2
+examples: |-
    **Create a file**
 
     ```ruby

data/infra/resources/gem_package.yaml

@@ -16,6 +16,7 @@ resource_description_list:
 syntax_full_code_block: |-
   gem_package 'name' do
     clear_sources               true, false
+    environment                 Hash
     gem_binary                  String
     include_default_source      true, false
     options                     String, Hash, Array
@@ -31,8 +32,9 @@ syntax_full_properties_list:
 - "`name` is the name given to the resource block."
 - "`action` identifies which steps Chef Infra Client will take to bring the node into
   the desired state."
-- "`clear_sources`, `gem_binary`, `include_default_source`, `options`, `package_name`,
-  `source`, `timeout`, and `version` are the properties available to this resource."
+- "`clear_sources`, `environment`, `gem_binary`, `include_default_source`, `options`,
+  `package_name`, `source`, `timeout`, and `version` are the properties available
+  to this resource."
 actions_list:
   :install:
     markdown: Install a package. If a version is specified, install the specified
@@ -52,6 +54,14 @@ properties_list:
   description_list:
   - markdown: Set to `true` to download a gem from the path specified by the `source`
       property (and not from RubyGems).
+- property: environment
+  ruby_type: Hash
+  required: false
+  new_in: '19.0'
+  description_list:
+  - markdown: 'A Hash of environment variables in the form of `({''ENV_VARIABLE''
+      => ''VALUE''})`. **Note**: These variables must exist for a command to be run
+      successfully.'
 - property: gem_binary
   ruby_type: String
   required: false

data/infra/resources/inspec_input.yaml

@@ -38,7 +38,7 @@ properties_list:
   default_value: The resource block's name
   description_list:
   - markdown:
-examples: |2
+examples: |-
 
   **Activate the default input in the openssh cookbook's compliance segment**:
 

data/infra/resources/ksh.yaml

@@ -28,6 +28,7 @@ syntax_description: |
   - `code` specifies the command to run.
 syntax_full_code_block: |-
   ksh 'name' do
+    cgroup                     String
     code                       String
     creates                    String
     cwd                        String
@@ -48,7 +49,7 @@ syntax_full_properties_list:
 - "`name` is the name given to the resource block."
 - "`action` identifies which steps Chef Infra Client will take to bring the node into
   the desired state."
-- "`code`, `creates`, `cwd`, `environment`,
+- "`cgroup`, `code`, `creates`, `cwd`, `environment`,
   `flags`, `group`, `input`, `path`, `returns`,
   `timeout`, `user`, and `umask` are the properties available to this resource."
 actions_list:
@@ -57,6 +58,13 @@ actions_list:
   :run:
     markdown: Run a command. (default)
 properties_list:
+- property: cgroup
+  ruby_type: String
+  required: false
+  new_in: '19.0'
+  description_list:
+  - markdown: 'Linux only: Run the command within a specific cgroup, creating it if
+      it doesn''t exist.'
 - property: code
   ruby_type: String
   required: true