From 2b7297b54fc108ad0bf3ee3db400e857c7ca0885 Mon Sep 17 00:00:00 2001 From: "chef-expeditor[bot]" <49165653+chef-expeditor[bot]@users.noreply.github.com> Date: Thu, 7 Dec 2023 13:36:18 -0500 Subject: [PATCH] Bump Hugo module chef-workstation to 23.12.1055. (#4218) * Bump Hugo module chef-workstation to 23.12.1055. This pull request was triggered automatically via Expeditor. This change falls under the obvious fix policy so no Developer Certificate of Origin (DCO) sign-off is required. * Update platforms page Signed-off-by: Ian Maddaus --------- Signed-off-by: Ian Maddaus Co-authored-by: Chef Expeditor Co-authored-by: Ian Maddaus --- .../content/workstation/chef_vault.md | 34 +++++++------ .../workstation/install_workstation.md | 51 ++++--------------- ...workstation_supported_derived_platforms.md | 4 ++ .../md/workstation_supported_platforms.md | 8 +++ _vendor/modules.txt | 2 +- content/platforms.md | 22 +++----- go.mod | 2 +- go.sum | 4 +- 8 files changed, 51 insertions(+), 76 deletions(-) create mode 100644 _vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_derived_platforms.md create mode 100644 _vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_platforms.md diff --git a/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/chef_vault.md b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/chef_vault.md index 2de4170447..2314e6cb31 100644 --- a/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/chef_vault.md +++ b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/chef_vault.md @@ -50,6 +50,8 @@ knife[:vault_admins] = [ 'example-alice', 'example-bob', 'example-carol' ] (These values can be overridden on the command line by using `-A`) +## `knife vault` + ### Syntax ``` shell @@ -197,7 +199,7 @@ knife vault update VAULT ITEM VALUES (options) ### Example Commands -### `create` +#### `create` Create a vault called passwords and put an item called `root` in it with the given values for `username` and `password` encrypted for clients `role:webserver`, `client1` and `client2` and admins `admin1` and `admin2`: @@ -247,7 +249,7 @@ A JSON file can be used in place of specifying the values on the command line, s {{< /note >}} -### `update` +#### `update` Update the values in `username` and `password` in the vault passwords and item root. Will overwrite existing values if values already exist! @@ -329,7 +331,7 @@ knife vault update passwords root -C "client1,client2" -A "admin1,admin2" ..Note:: A JSON file can be used in place of specifying the values on the command line, see global options below for details -### `remove` +#### `remove` Remove the values in `username` and `password` from the vault passwords and item root. @@ -403,7 +405,7 @@ Remove `admin1` and `admin2` from encrypted admins for the vault passwords and i knife vault remove passwords root -A "admin1,admin2" ``` -### `delete` +#### `delete` Delete the item root from the vault passwords @@ -411,7 +413,7 @@ Delete the item root from the vault passwords knife vault delete passwords root ``` -### `show` +#### `show` Show the items in a vault. @@ -443,7 +445,7 @@ Show the contents for the item user_pem in the vault certs. knife vault show certs user_pem "contents" ``` -### `edit` +#### `edit` Decrypt the entire root item in the passwords vault and open it in json format in your \$EDITOR. Writing and exiting out the editor will save and encrypt the vault item. @@ -451,7 +453,7 @@ Decrypt the entire root item in the passwords vault and open it in json format i knife vault edit passwords root ``` -### `download` +#### `download` Decrypt and download an encrypted file to the specified path. @@ -459,7 +461,7 @@ Decrypt and download an encrypted file to the specified path. knife vault download certs user_pem ~/downloaded_user_pem ``` -### `rotate keys` +#### `rotate keys` Rotate the shared key for the vault passwords and item root. The shared key is that which is used for the chef encrypted data bag item. @@ -473,7 +475,7 @@ To remove clients which have been deleted from Chef but not from the vault, add knife vault rotate keys passwords root --clean-unknown-clients ``` -### `rotate all keys` +#### `rotate all keys` Rotate the shared key for all vaults and items. The shared key is that which is used for the chef encrypted data bag item. @@ -487,7 +489,7 @@ Removes clients which have been deleted from Chef but not from the vault. knife vault rotate keys passwords root --clean-unknown-clients ``` -### `refresh` +#### `refresh` This command reads the search_query in the vault item, performs the search, and reapplies the results. @@ -501,7 +503,7 @@ To remove clients which have been deleted from Chef but not from the vault, add knife vault refresh passwords root --clean-unknown-clients ``` -### `isvault` +#### `isvault` This command checks if the given item is a vault or not, and exit with a status of 0 if it is and 1 if it is not. @@ -509,7 +511,7 @@ This command checks if the given item is a vault or not, and exit with a status knife vault isvault VAULT ITEM ``` -### `itemtype` +#### `itemtype` This command outputs the type of the data bag item: normal, encrypted or vault @@ -530,7 +532,7 @@ knife vault itemtype VAULT ITEM | `-F` `FORMAT` | `--format FORMAT` | Format for decrypted output | summary | `summary`, `json`, `yaml`, `pp` | `show` | | --clean-unknown-clients | none | Remove unknown clients during key rotation | none | none | `refresh`, `remove`, `rotate` | -## Options for knife bootstrap +### Options for knife bootstrap Use the following options with a validatorless bootstrap to specify items that are stored in Chef Vault: @@ -546,7 +548,7 @@ Use the following options with a validatorless bootstrap to specify items that a : A JSON string that contains a list of vaults and items to be updated. --bootstrap-vault-json '{ "vault1": \["item1", "item2"\], "vault2": "item2" }' -### Using Chef Vault in recipes +## Using Chef Vault in recipes To use this gem in a recipe to decrypt data you must first install the gem via a chef_gem resource. Once the gem is installed, `require` the gem and then you can create a new instance of Chef Vault. @@ -620,7 +622,7 @@ end This functionality is also available from the command line as `knife vault itemtype VAULT ITEM`. -### Stand Alone Usage +## Stand Alone Usage The `chef-vault` gem can be used as a stand-alone binary to decrypt values stored in Chef. It requires that Chef is installed on the system and that you have a valid `config.rb`. This is useful if you want to mix Chef Vault into non-Chef recipe code, for example some other script where you want to protect a password. @@ -634,7 +636,7 @@ Use `chef-vault --help` to see all all available options chef-vault -v passwords -i root -a password -k /etc/chef/config.rb ``` -### Testing +## Testing To stub vault items in ChefSpec, use the [chef-vault-testfixture](https://rubygems.org/gems/chef-vault-testfixtures) gem. diff --git a/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/install_workstation.md b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/install_workstation.md index cde1a262e2..6018c11f90 100644 --- a/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/install_workstation.md +++ b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/install_workstation.md @@ -19,46 +19,17 @@ aliases = ["/install_workstation.html", "/install_dk.html", "/workstation_window ## Supported Platforms -Supported Host Operating Systems: - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PlatformVersion
Amazon Linux2
Apple macOS10.15, 11, 12
Windows10, 11, Server 2012, Server 2012 R2, Server 2016, Server 2019, Server 2022
Red Hat Enterprise Linux / CentOS7.x, 8.x, 9.x
Ubuntu18.04, 20.04, 22.04
Debian10, 11
+The following table lists the commercially supported platforms and versions for Chef Workstation: + +{{< readfile file = "content/workstation/reusable/md/workstation_supported_platforms.md" >}} + +### Derived Platforms + +The following table lists supported derived platforms and versions for Chef Workstation. + +See our policy on [support for derived platforms](/platforms/#support-for-derived-platforms) for more information. + +{{< readfile file = "content/workstation/reusable/md/workstation_supported_derived_platforms.md" >}} ## System Requirements diff --git a/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_derived_platforms.md b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_derived_platforms.md new file mode 100644 index 0000000000..7eb3bb1efc --- /dev/null +++ b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_derived_platforms.md @@ -0,0 +1,4 @@ +| Platform | Architecture | Version | Parent platform | +| --- | --- | --- | --- | +| AlmaLinux | `x86_64` | `8.x` | CentOS | +| Rocky Linux | `x86_64` | `8.x` | CentOS | diff --git a/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_platforms.md b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_platforms.md new file mode 100644 index 0000000000..c23519a69c --- /dev/null +++ b/_vendor/github.com/chef/chef-workstation/docs-chef-io/content/workstation/reusable/md/workstation_supported_platforms.md @@ -0,0 +1,8 @@ +| Platform | Architecture | Version | +|-----------------------------------| ----------------| ---------------------------------------------------------------------------| +| Amazon Linux | x86_64 | 2.x | +| macOS | x86_64, arch64 | 11.x, 12.x | +| Debian | x86_64 | 10, 11 | +| Red Hat Enterprise Linux / CentOS | x86_64 | 7.x, 8.x, 9.x | +| Ubuntu | x86_64 | 18.04, 20.04, 22.04 | +| Windows | x64 | 10, 11, Server 2012, Server 2012 R2, Server 2016, Server 2019, Server 2022 | diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 3d3795f92e..158d3bb914 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -8,7 +8,7 @@ # github.com/inspec/inspec-azure/docs-chef-io v0.0.0-20220228040450-e1b23e65979a # github.com/inspec/inspec-habitat/docs-chef-io v0.0.0-20220218210405-bfd542da49fd # github.com/inspec/inspec-k8s/docs-chef-io v0.0.0-20230522203306-c23ca61f913f -# github.com/chef/chef-workstation/docs-chef-io v0.0.0-20230906065503-8f1a978813f8 +# github.com/chef/chef-workstation/docs-chef-io v0.0.0-20231204171850-c0bc9926378a # github.com/chef/supermarket/docs-chef-io v0.0.0-20231004141257-7ada2c50bece # github.com/chef/effortless/docs-chef-io v0.0.0-20230711123605-c8beb79aba4f # github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20231031143423-5ffd549d4a19 diff --git a/content/platforms.md b/content/platforms.md index d45df198eb..81055cb1e2 100644 --- a/content/platforms.md +++ b/content/platforms.md @@ -63,7 +63,7 @@ documentation for a list of supported platforms for Chef Automate HA. #### Commercial Support -The following table lists the commercially-supported platforms for Chef Backend, which is the high-availability solution for Chef Infra Server. +The following table lists the commercially supported platforms for Chef Backend, which is the high-availability solution for Chef Infra Server. | Platform | Architecture | Version | | --- | --- | --- | @@ -88,7 +88,7 @@ See our policy on [support for derived platforms](#support-for-derived-platforms #### Commercial Support -The following table lists the commercially-supported platforms and versions for Chef Infra Client. +The following table lists the commercially supported platforms and versions for Chef Infra Client. | Platform | Architecture | Version | | --- | --- | --- | @@ -152,7 +152,7 @@ The following platforms are supported only using the community. #### Commercial Support -The following table lists the commercially-supported platforms and versions for Chef InSpec. +The following table lists the commercially supported platforms and versions for Chef InSpec. {{< readfile file="content/inspec/reusable/md/support_commercial_platforms.md" >}} @@ -192,16 +192,9 @@ See our policy on [support for derived platforms](#support-for-derived-platforms #### Commercial Support -The following table lists the commercially-supported platforms and versions for the Chef Workstation. +The following table lists the commercially supported platforms and versions for the Chef Workstation. -| Platform | Architecture | Version | -| --- | --- | --- | -| Amazon Linux | `x86_64` | `2.x` | -| macOS | `x86_64`, `aarch64` | `10.15`, `11.x`, `12.x` | -| Debian | `x86_64` | `10`, `11` | -| Red Hat Enterprise Linux | `x86_64` | `7.x`, `8.x`, `9.x` | -| Ubuntu | `x86_64` | `18.04`, `20.04`, `22.04` | -| Windows | `x64` | `8.1`, `2012`, `2012 R2`, `2016`, `10 (all channels except "insider" builds)`, `2019 (Long-term servicing channel (LTSC), Desktop Experience only)`, `11`, `2022` | +{{< readfile file = "content/workstation/reusable/md/workstation_supported_platforms.md" >}} #### Derived platforms @@ -209,10 +202,7 @@ The following table lists supported derived platforms and versions for Chef Work See our policy on [support for derived platforms](#support-for-derived-platforms) for more information. -| Platform | Architecture | Version | Parent platform | -| --- | --- | --- | --- | -| AlmaLinux | `x86_64` | `8.x` | CentOS | -| Rocky Linux | `x86_64` | `8.x` | CentOS | +{{< readfile file = "content/workstation/reusable/md/workstation_supported_derived_platforms.md" >}} ## Platform End-of-Life Policy diff --git a/go.mod b/go.mod index 0545fbe549..8f02b70cba 100644 --- a/go.mod +++ b/go.mod @@ -5,7 +5,7 @@ go 1.18 require ( github.com/chef/automate/components/docs-chef-io v0.0.0-20231027151655-61e0a5d70b2c // indirect github.com/chef/chef-server/docs-chef-io v0.0.0-20231127093116-305bca610b36 // indirect - github.com/chef/chef-workstation/docs-chef-io v0.0.0-20230906065503-8f1a978813f8 // indirect + github.com/chef/chef-workstation/docs-chef-io v0.0.0-20231204171850-c0bc9926378a // indirect github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20231031143423-5ffd549d4a19 // indirect github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20230809063034-95b117807a75 // indirect github.com/chef/desktop-config/docs-chef-io v0.0.0-20230711052355-bad26ce3ac0b // indirect diff --git a/go.sum b/go.sum index 23024f944f..d1054d6a4a 100644 --- a/go.sum +++ b/go.sum @@ -5,8 +5,8 @@ github.com/chef/automate/components/docs-chef-io v0.0.0-20231027151655-61e0a5d70 github.com/chef/automate/components/docs-chef-io v0.0.0-20231027151655-61e0a5d70b2c/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU= github.com/chef/chef-server/docs-chef-io v0.0.0-20231127093116-305bca610b36 h1:yognvfb/VxihujSLSPmu3mFZ+fXgzDv/L4+84W9TA1o= github.com/chef/chef-server/docs-chef-io v0.0.0-20231127093116-305bca610b36/go.mod h1:gMSa25GUHmLimA0gjvRd3hs1buOBqkKPrdHzHvaJauY= -github.com/chef/chef-workstation/docs-chef-io v0.0.0-20230906065503-8f1a978813f8 h1:rMpqWWnaV+fzB5Qk+8sNdbMgBarjPmCGSF623V5SOqc= -github.com/chef/chef-workstation/docs-chef-io v0.0.0-20230906065503-8f1a978813f8/go.mod h1:gvoh6ov1YU98CVzBEWzEZeCLTRunfQ6r1VO7M3LFE9U= +github.com/chef/chef-workstation/docs-chef-io v0.0.0-20231204171850-c0bc9926378a h1:3Yo2eavBf3KWbUcDq71I1wsOPSjeGL9/MvB8bhMw0Ys= +github.com/chef/chef-workstation/docs-chef-io v0.0.0-20231204171850-c0bc9926378a/go.mod h1:gvoh6ov1YU98CVzBEWzEZeCLTRunfQ6r1VO7M3LFE9U= github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20231031143423-5ffd549d4a19 h1:EH5D0WGIvEi2m87pSHKdQPXCuiVrBHcyIenonB3YpTM= github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20231031143423-5ffd549d4a19/go.mod h1:fsG7S6r66ZW6Af/sqq+OL3WNP+BoO4V1/Evwu98Noig= github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20230809063034-95b117807a75 h1:+JauUFlgSpXfWw4k1csiOOihQsCbSgqTjRsx8rsbbPQ=