Merge branch 'main' into expeditor/chef-analyze0.1.134

chef · Mar 21, 2022 · c1e63a5 · c1e63a5
2 parents bf37ebb + 5705889
commit c1e63a5
Show file tree

Hide file tree

Showing 37 changed files with 213 additions and 148 deletions.
diff --git a/.expeditor/update_chef-workstation-app_to_latest.sh b/.expeditor/update_chef-workstation-app_to_latest.sh
@@ -22,8 +22,8 @@ version="${VERSION:-$default_version}"
 branch="expeditor/chef_workstation_app_${version}"
 git checkout -b "$branch"
 
-linux_checksum=$(jfrog rt s --apikey "$ARTIFACTORY_TOKEN" --url=https://artifactory.chef.co/artifactory "files-unstable-local/chef-workstation-app/${version}/chef-workstation-app-${version}-linux-x64.zip" | jq -r '.[] | .sha1')
-windows_checksum=$(jfrog rt s --apikey "$ARTIFACTORY_TOKEN" --url=https://artifactory.chef.co/artifactory "files-unstable-local/chef-workstation-app/${version}/chef-workstation-app-${version}-win32-x64.zip" | jq -r '.[] | .sha1')
+linux_checksum=$(jfrog rt s --apikey "$ARTIFACTORY_TOKEN" --url=https://artifactory-internal.ps.chef.co/artifactory "files-unstable-local/chef-workstation-app/${version}/chef-workstation-app-${version}-linux-x64.zip" | jq -r '.[] | .sha1')
+windows_checksum=$(jfrog rt s --apikey "$ARTIFACTORY_TOKEN" --url=https://artifactory-internal.ps.chef.co/artifactory "files-unstable-local/chef-workstation-app/${version}/chef-workstation-app-${version}-win32-x64.zip" | jq -r '.[] | .sha1')
 
 sed -i -r "s/^default_version \".+\"/default_version \"${version}\"/" omnibus/config/software/chef-workstation-app.rb
 sed -i -r "s/^source sha1\: \".+\" if linux\?$/source sha1: \"$linux_checksum\" if linux?/" omnibus/config/software/chef-workstation-app.rb

diff --git a/.vale.ini b/.vale.ini
@@ -0,0 +1,20 @@
+# Vale configuration file.
+#
+# For more information, see https://errata-ai.gitbook.io/vale/getting-started/configuration.
+
+StylesPath = docs-chef-io/chef-web-docs/tools/vale
+MinAlertLevel = warning
+SkippedScopes = code
+
+[*.md]
+BasedOnStyles = Microsoft, chef
+
+Microsoft.Contractions = NO
+Microsoft.Headings = NO
+Microsoft.GeneralURL = NO
+Microsoft.RangeFormat = NO
+Microsoft.HeadingAcronyms = NO
+Microsoft.Quotes = NO
+
+# Ignore SVG markup
+TokenIgnores = (\*\*\{\w*\}\*\*)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,15 +1,20 @@
 <!-- usage documentation: https://expeditor.chef.io/docs/reference/changelog/ -->
-<!-- latest_release 22.3.828 -->
-## [22.3.828](https://github.com/chef/chef-workstation/tree/22.3.828) (2022-03-16)
+<!-- latest_release 22.3.832 -->
+## [22.3.832](https://github.com/chef/chef-workstation/tree/22.3.832) (2022-03-21)
 
 #### Merged Pull Requests
-- Get docs lint config files, for precommit use [#2640](https://github.com/chef/chef-workstation/pull/2640) ([kagarmoe](https://github.com/kagarmoe))
+- Bump kitchen-vcenter to 2.11.12 [#2659](https://github.com/chef/chef-workstation/pull/2659) ([chef-expeditor[bot]](https://github.com/chef-expeditor[bot]))
 <!-- latest_release -->
 
 <!-- release_rollup since=22.2.807 -->
 ### Changes not yet released to stable
 
 #### Merged Pull Requests
+- Bump kitchen-vcenter to 2.11.12 [#2659](https://github.com/chef/chef-workstation/pull/2659) ([chef-expeditor[bot]](https://github.com/chef-expeditor[bot])) <!-- 22.3.832 -->
+- Added the sha1 and the latest ws-app version [#2658](https://github.com/chef/chef-workstation/pull/2658) ([nikhil2611](https://github.com/nikhil2611)) <!-- 22.3.831 -->
+- Remove extra periods from knife_client.md [#2657](https://github.com/chef/chef-workstation/pull/2657) ([IanMadd](https://github.com/IanMadd)) <!-- 22.3.830 -->
+- Update internal artifactory URL [#2656](https://github.com/chef/chef-workstation/pull/2656) ([vkarve-chef](https://github.com/vkarve-chef)) <!-- 22.3.829 -->
+- Edits to improve linting [#2631](https://github.com/chef/chef-workstation/pull/2631) ([kagarmoe](https://github.com/kagarmoe)) <!-- 22.3.829 -->
 - Get docs lint config files, for precommit use [#2640](https://github.com/chef/chef-workstation/pull/2640) ([kagarmoe](https://github.com/kagarmoe)) <!-- 22.3.828 -->
 - Bump chef-analyze CLI to 0.1.133 [#2647](https://github.com/chef/chef-workstation/pull/2647) ([chef-expeditor[bot]](https://github.com/chef-expeditor[bot])) <!-- 22.3.827 -->
 - Bump github.com/spf13/cobra from 1.3.0 to 1.4.0 in /components/main-chef-wrapper [#2645](https://github.com/chef/chef-workstation/pull/2645) ([dependabot[bot]](https://github.com/dependabot[bot])) <!-- 22.3.826 -->

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-22.3.828
+22.3.832
diff --git a/components/gems/Gemfile.lock b/components/gems/Gemfile.lock
@@ -21,7 +21,7 @@ GEM
     artifactory (3.0.15)
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.564.0)
+    aws-partitions (1.568.0)
     aws-sdk-alexaforbusiness (1.56.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
@@ -88,10 +88,10 @@ GEM
     aws-sdk-cognitoidentityprovider (1.53.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-configservice (1.74.0)
+    aws-sdk-configservice (1.75.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.129.0)
+    aws-sdk-core (3.130.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
@@ -105,7 +105,7 @@ GEM
     aws-sdk-dynamodb (1.74.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ec2 (1.302.0)
+    aws-sdk-ec2 (1.303.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-ecr (1.55.0)
@@ -114,7 +114,7 @@ GEM
     aws-sdk-ecrpublic (1.12.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ecs (1.97.0)
+    aws-sdk-ecs (1.98.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-efs (1.53.0)
@@ -123,7 +123,7 @@ GEM
     aws-sdk-eks (1.74.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-elasticache (1.74.0)
+    aws-sdk-elasticache (1.75.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-elasticbeanstalk (1.51.0)
@@ -165,7 +165,7 @@ GEM
     aws-sdk-kms (1.55.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-lambda (1.80.0)
+    aws-sdk-lambda (1.81.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-mq (1.40.0)
@@ -183,7 +183,7 @@ GEM
     aws-sdk-ram (1.26.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-rds (1.141.0)
+    aws-sdk-rds (1.142.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-redshift (1.79.0)
@@ -461,7 +461,7 @@ GEM
     equalizer (0.0.11)
     erubi (1.10.0)
     erubis (2.7.0)
-    excon (0.91.0)
+    excon (0.92.0)
     faraday (1.4.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -547,19 +547,19 @@ GEM
     ice_nine (0.11.2)
     inifile (3.0.0)
     iniparse (1.5.0)
-    inspec (4.52.9)
+    inspec (4.56.17)
       cookstyle
       faraday_middleware (>= 0.12.2, < 1.1)
-      inspec-core (= 4.52.9)
+      inspec-core (= 4.56.17)
       mongo (= 2.13.2)
       rake
       train (~> 3.0)
       train-aws (~> 0.2)
       train-habitat (~> 0.1)
       train-winrm (~> 0.2)
-    inspec-bin (4.52.9)
-      inspec (= 4.52.9)
-    inspec-core (4.52.9)
+    inspec-bin (4.56.17)
+      inspec (= 4.56.17)
+    inspec-core (4.56.17)
       addressable (~> 2.4)
       chef-telemetry (~> 1.0, >= 1.0.8)
       faraday (>= 0.9.0, < 1.5)
@@ -572,7 +572,7 @@ GEM
       parallel (~> 1.9)
       parslet (>= 1.5, < 2.0)
       pry (~> 0.13)
-      rspec (>= 3.9, < 3.11)
+      rspec (>= 3.9, <= 3.11)
       rspec-its (~> 1.2)
       rubyzip (>= 1.2.2, < 3.0)
       semverse (~> 3.0)
@@ -588,7 +588,7 @@ GEM
     json (2.6.1)
     jwt (2.3.0)
     kartograph (0.2.8)
-    kitchen-azurerm (1.10.0)
+    kitchen-azurerm (1.10.1)
       azure_mgmt_network (~> 0.18, >= 0.18.2)
       azure_mgmt_resources (~> 0.17, >= 0.17.2)
       inifile (~> 3.0, >= 3.0.0)
@@ -623,7 +623,7 @@ GEM
       test-kitchen (>= 1.4.1, < 4)
     kitchen-vagrant (1.11.0)
       test-kitchen (>= 1.4, < 4)
-    kitchen-vcenter (2.11.9)
+    kitchen-vcenter (2.11.12)
       net-ping (>= 2.0.0, < 3.0)
       rbvmomi (>= 1.11, < 4.0)
       test-kitchen (>= 1.16, < 4)
@@ -857,22 +857,22 @@ GEM
     retriable (3.1.2)
     retryable (3.0.5)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
+      rspec-support (~> 3.11.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.3)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
     rubocop (1.25.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)

diff --git a/cspell.json b/cspell.json
@@ -0,0 +1,46 @@
+{
+  // Version of the setting file.  Always 0.1
+  "version": "0.2",
+  // language - current active spelling language
+  "language": "en_US",
+  "dictionaries": [
+    "chef",
+    "docs"
+  ],
+  "dictionaryDefinitions": [
+    {
+      "name": "chef",
+      "path": "./chef_dictionary.txt",
+      "description": "Custom Chef Dictionary"
+    },
+    {
+      "name": "docs",
+      "path": "./docs_dictionary.txt",
+      "description": "Custom Docs Dictionary"
+    }
+  ],
+  // words - list of words to be always considered correct
+  // "words": [
+  // ],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": [
+    "hte"
+  ],
+  "ignorePaths": [
+    ".expeditor/**/*",
+    "**/*.yml",
+    "**/*.toml",
+    "archetypes/*.md"
+  ],
+  "ignoreRegExpList": [
+    "/'s\\b/",
+    "/'d\\b/",
+    "/^\\s*```[\\s\\S]*?^\\s*```/gm",
+    "/{{(.+)(?=}})/gm",
+    "/<(?=(.*)>)/gm"
+  ],
+  "words": [
+  ]
+}
diff --git a/docs-chef-io/content/workstation/_index.md b/docs-chef-io/content/workstation/_index.md
@@ -46,7 +46,7 @@ Chef Infra defines a common workflow for cookbook development:
 
 1. Create a skeleton cookbook by running `chef generate cookbook MY_COOKBOOK_NAME`. This generates a cookbook with a single recipe and testing configuration for Test Kitchen with Chef InSpec.
 1. Write cookbook recipes or resources and lint and debug them with Cookstyle and Test Kitchen. Making your own cookbooks is an iterative process where you develop, test, find and fix bugs, and then develop and test some more. A text editor---Visual Studio Code, Atom, vim, or any other preferred text editor---is the only tool that you need to author your cookbooks.
-1. Test in acceptance. Test your work in an environment that matches your production environment as closely as possible.
+1. Test in acceptance. Test your work in an environment that matches your production environment.
 1. Deploy your cookbooks to the production environment, but only after they pass all the acceptance tests and are verified to work in the desired manner.
 
 ## Tools

diff --git a/docs-chef-io/content/workstation/berkshelf.md b/docs-chef-io/content/workstation/berkshelf.md
@@ -16,20 +16,22 @@ aliases = ["/berkshelf.html", "/berkshelf/"]
 
 <!-- markdownlint-disable-file MD024 -->
 
+{{< warning >}}
+[Policyfiles](/policyfile/) are the preferred pattern for creating immutable collections of cookbooks, cookbook dependencies, and attributes. Berkshelf is no longer under active development. Please replace Berkshelf with Policyfiles
+
+This document is no longer maintained.
+{{< /warning >}}
+
 Berkshelf is a dependency manager for Chef cookbooks. With it, you can
-easily depend on community cookbooks and have them safely included in
+ depend on community cookbooks and include them in
 your workflow. You can also ensure that your CI systems reproducibly
 select the same cookbook versions, and can upload and bundle cookbook
 dependencies without needing a locally maintained copy. Berkshelf is
 included in Chef Workstation.
 
 {{< note >}}
 
-For new users, we strongly recommend using
-[Policyfiles](/policyfile/) rather than Berkshelf. Policyfiles
-provide more predictability, since dependencies are only resolved once,
-and a much improved way of promoting cookbooks from dev to testing, and
-then to production.
+[Policyfiles](/policyfile/) are the recommended pattern for including and resolving cookbooks. Policyfiles provide more predictability, since dependencies are only resolved once, and a much improved way of promoting cookbooks from dev to testing, and then to production.
 
 {{< /note >}}
 
@@ -91,7 +93,7 @@ a cookbook. It is used in conjunction with the `berks` command.
 ### Syntax
 
 A Berksfile is a Ruby file, in which sources, dependencies, and options
-may be specified. Berksfiles are modeled closely on Bundler's Gemfile.
+may be specified. Berksfiles are modeled on Bundler's Gemfile.
 The syntax is as follows:
 
 ``` ruby
@@ -289,9 +291,7 @@ By default, the solver selection depends on your environment. When the
 `gecode` solver is used. Otherwise, the `ruby` solver is utilized by
 default.
 
-The `gecode` solver matches the engine used by the Chef Infra Server, so
-will more closely reflect the behavior of the Chef Infra Server in
-selecting cookbooks:
+The `gecode` solver matches the engine used by the Chef Infra Server, so it reflects the behavior of the Chef Infra Server in selecting cookbooks:
 
 ``` ruby
 solver :gecode
@@ -642,7 +642,7 @@ This command has the following options:
 
 `--no-freeze`
 
-: A frozen cookbook requires changes to that cookbook to be submitted as a new version of that cookbook. Use this option to prevent this cookbook from being frozen. Default value: `false` (i.e. "frozen").
+: A frozen cookbook requires changes to that cookbook to be submitted as a new version of that cookbook. Use this option to prevent this cookbook from being frozen. Default value: `false` (that is, "frozen").
 
 `--ssl-verify`
 
@@ -675,7 +675,7 @@ This command has the following options:
 
 `--delete`
 
-: Use to clean the directory in which vendored cookbooks will be placed prior to executing this command.
+: Use to clean the directory in which vendored cookbooks will be placed before executing this command.
 
 `-e [GROUP, GROUP, ...]`, `--except [GROUP, GROUP, ...]`
 

diff --git a/docs-chef-io/content/workstation/chef-workstation-app.md b/docs-chef-io/content/workstation/chef-workstation-app.md
@@ -12,7 +12,7 @@ gh_repo = "chef-workstation"
     weight = 61
 +++
 
-The Chef Workstation App (CWA) is an early-release desktop application that provides additional services for Chef Workstation:
+The Chef Workstation App (CWA) is an early release desktop application that provides additional services for Chef Workstation:
 
 * Update checking and notifications
 * Chef Workstation version information

diff --git a/docs-chef-io/content/workstation/chef_run.md b/docs-chef-io/content/workstation/chef_run.md
@@ -166,9 +166,9 @@ Running `chef-run host1 really_complicated::first` collects all the `really_comp
 
 You can specify different cookbook sources in `Policyfile.rb`, including a private supermarket. See the [Policyfile documentation](/config_rb_policyfile/) for examples.
 
-## Connecting to Automate 2
+## Connecting to Chef Automate 2
 
-You can configure remote nodes managed with `chef-run` to send run information to Automate. First, [generate an auth token](/automate/api_tokens/#creating-api-tokens).
+You can configure remote nodes managed with `chef-run` to send run information to Chef Automate. First, [generate an auth token](/automate/api_tokens/#creating-api-tokens).
 
 Next, add the token to [config.toml]({{< ref "config.md#data_collector" >}}), specifying the appropriate [url](/automate/data_collection/) and [token](/automate/api_tokens/#creating-api-tokens) for the automate server:
 
@@ -178,4 +178,4 @@ url="https://127.0.0.1/data-collector/v0/"
 token="abc123="
 ```
 
-Target nodes need network access to port 443 of the Automate instance for sending `chef-client` run information.
+Target nodes need network access to port 443 of the Chef Automate instance for sending `chef-client` run information.
diff --git a/docs-chef-io/content/workstation/chef_shell.md b/docs-chef-io/content/workstation/chef_shell.md
@@ -82,7 +82,7 @@ This command has the following options:
 
 `-S CHEF_SERVER_URL`, `--server CHEF_SERVER_URL`
 
-: The URL for the Chef Infra Server.
+: The URL of the Chef Infra Server.
 
 `-v`, `--version`
 

diff --git a/docs-chef-io/content/workstation/chef_vault.md b/docs-chef-io/content/workstation/chef_vault.md
@@ -32,7 +32,7 @@ Neither PUB key nor PRIV key:: nested asn1 error
 
 {{< /warning >}}
 
-### Configuring config.rb for Chef Vault
+## Configuring config.rb for Chef Vault
 
 To set 'client' as the default mode, add the following line to the config.rb file.