diff --git a/_vendor/github.com/chef/chef-server/docs-chef-io/content/server/upgrades.md b/_vendor/github.com/chef/chef-server/docs-chef-io/content/server/upgrades.md index ce96f31e88..9ea7f451a9 100644 --- a/_vendor/github.com/chef/chef-server/docs-chef-io/content/server/upgrades.md +++ b/_vendor/github.com/chef/chef-server/docs-chef-io/content/server/upgrades.md @@ -206,7 +206,7 @@ The following External PostgreSQL upgrade steps are provided as a courtesy only. apt-get update apt install ruby apt install make - curl -L https://chefdownload-commerical.chef.io/install.sh?license_id= | sudo bash -s -- -P chef-workstation + curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash -s -- -P chef-workstation export PATH=$PATH:/root/.chef-workstation/gem/ruby/2.6.0/bin apt-get -y install gcc postgresql libpq-dev /opt/chef-workstation/embedded/bin/gem install knife-ec-backup -- --with-pg-config=/opt/opscode/embedded/postgresql/9.6/bin/pg_config diff --git a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/install.md b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/install.md index 17d1ed7b6e..e191330991 100644 --- a/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/install.md +++ b/_vendor/github.com/inspec/inspec/docs-chef-io/content/inspec/install.md @@ -22,9 +22,13 @@ To see which platforms and platform versions Chef InSpec is supported on, see th You can install Chef InSpec using a curl script. ```bash -curl https://omnitruck.chef.io/install.sh | sudo bash -s -- -P inspec +curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash -s -- -P inspec ``` +Replace `` with your license ID. + +For more information about the install script, see the [Chef Install Script documentation](/chef_install_script/). + ## Windows ### Installer @@ -37,9 +41,13 @@ then double-click on the `.msi` file to launch the installer and follow the prom You can install Chef InSpec using the following Powershell script. ```powershell -. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -project inspec +. { iwr -useb https://chefdownload-commercial.chef.io/install.ps1?license_id= } | iex; install -project inspec ``` +Replace `` with your license ID. + +For more information about the install script, see the [Chef Install Script documentation](/chef_install_script/). + Once you have installed Chef InSpec, run `inspec version` to verify that the installation was successful. @@ -50,9 +58,13 @@ was successful. The following curl script will install Chef InSpec for Ubuntu and Red Hat Enterprise Linux: ```bash -curl https://omnitruck.chef.io/install.sh | sudo bash -s -- -P inspec +curl https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash -s -- -P inspec ``` +Replace `` with your license ID. + +For more information about the install script, see the [Chef Install Script documentation](/chef_install_script/). + If you prefer, you can use a package manager to install Chef InSpec. Once you downloaded the latest [Chef InSpec package](https://www.chef.io/downloads) relevant to your Linux-based platform, use the command for the respective package diff --git a/content/chef_install_script.md b/content/chef_install_script.md index 155be7c485..55b60d8bc7 100644 --- a/content/chef_install_script.md +++ b/content/chef_install_script.md @@ -1,5 +1,5 @@ +++ -title = "Chef Software Install Script" +title = "Chef Software install script" draft = false gh_repo = "chef-web-docs" aliases = ["/install_omnibus.html", "/install_omnibus/"] @@ -7,30 +7,197 @@ product = ["automate", "client", "server", "habitat", "inspec", "supermarket", " [menu] [menu.overview] - title = "Chef Software Install Script" - identifier = "overview/packages_&_platforms/chef_install_script.md Install using Chef Software Install Script" + title = "Install script" + identifier = "overview/packages_&_platforms/Install Script" parent = "overview/packages_&_platforms" - weight = 40 + weight = 30 +++ -{{< readfile file="content/reusable/md/packages_install_script.md" >}} +You can use the Chef Software install script to install +any Chef software---including Chef Infra Client, Chef Infra Server, and Chef InSpec---on UNIX, Linux, and Windows platforms. -## Run the Chef Software Install Script +This script does the following: -{{< readfile file="content/reusable/md/packages_install_script_run.md" >}} +- Detects the platform, version, and architecture of the machine on which the installer is being executed. +- Fetches the appropriate package, for the requested product and version. +- Validates the package content by comparing SHA-256 checksums. +- Installs the package. + +## Install using the Commercial API + +Commercial users can use the install script from the [Chef Commercial API](/download/commercial/) to install Chef software. + +### Prerequisites + +You must have a license ID to use the install script from the Chef Commercial API. You can get your license ID from the [Chef Downloads portal](https://chef.io/downloads). ### UNIX, Linux, and macOS -{{< readfile file="content/reusable/md/packages_install_script_run_unix_linux.md" >}} +Use the Chef install script to install packages on UNIX, Linux, and macOS systems: + +By default the script installs the latest version of Chef Infra Client: + +```bash +curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash +``` + +Replace `` with your license ID. + +Use the `-P` option to specify a Chef software application to install: + +```bash +curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash -s -- -P +``` + +Replace: + +- `` with your license ID +- `` with the application you want to install + +For additional script install options, see the [script options](#script-options). ### Windows -{{< readfile file="content/reusable/md/packages_install_script_run_windows.md" >}} +On Windows systems, you can install Chef software using the Powershell install script. + +By default the script installs the latest version of Chef Infra Client: + +```powershell +. { iwr -useb https://chefdownload-commercial.chef.io/install.ps1?license_id= } | iex; install +``` + +Replace `` with your license ID. + +Use the `-project` option to specify a Chef software application to install: + +```powershell +. { iwr -useb https://chefdownload-commercial.chef.io/install.ps1?license_id= } | iex; install -project +``` + +Replace: + +- `` with your license ID +- `` with the application you want to install + +For additional script install options, see the [script options](#script-options). + +## Install using the Community API + +Community users can use the install script from the [Chef Community API](/download/community/) to install Chef software. + +### UNIX, Linux, and macOS + +Use the Chef install script to install packages on UNIX, Linux, and macOS systems. + +By default the script installs the latest available version of Chef Infra Client: + +```bash +curl -L https://chefdownload-community.chef.io/install.sh | sudo bash +``` + +Use the `-P` option to specify a Chef application to install: + +```bash +curl -L https://chefdownload-community.chef.io/install.sh | sudo bash -s -- -P +``` + +Replace `` with the application you want to install. + +For additional script install options, see the [script options](#script-options). + +### Windows -## Chef Software Install Script Options +On Windows systems, you can install Chef software using the Powershell install script. -{{< readfile file="content/reusable/md/packages_install_script_options.md" >}} +By default the script installs the latest available version of Chef Infra Client: + +```powershell +. { iwr -useb https://chefdownload-community.chef.io/install.ps1 } | iex; install +``` + +Use the `-project` option to specify a Chef application to install: + +```powershell +. { iwr -useb https://chefdownload-community.chef.io/install.ps1 } | iex; install -project +``` + +For additional script install options, see the [script options](#script-options). + +## Script options + +In addition to the default install behavior, the Chef Software install script supports the following options: + +`-c` (`-channel` on Windows) + +: The [release channel](#release-channels) from which a package is pulled. + + The Commercial Download API supports the `current` or `stable` channels. + The Community Download API only supports the `stable` channel. + + Default value: `stable`. + +`-d` (`-download_directory` on Windows) + +: The directory into which a package is downloaded. When a package + already exists in this directory and the checksum matches, the + package is not re-downloaded. When `-d` and `-f` are not specified, + a package is downloaded to a temporary directory. + +`-f` (`-filename` on Windows) + +: The name of the file and the path at which that file is located. + When a filename already exists at this path and the checksum + matches, the package is not re-downloaded. When `-d` and `-f` are + not specified, a package is downloaded to a temporary directory. + +`-P` (`-project` on Windows) + +: The product name to install. Supported versions of Chef products are + `chef`,`chef-backend`,`chef-server`,`inspec`,`chef-workstation`,`manage` and + `supermarket`. Default value: `chef`. + +`-s` (`-install_strategy` on Windows) + +: The method of package installations. The default strategy is to + always install when the install.sh script runs. Set to "once" to + skip installation if the product is already installed on the node. + +`-l` (`-download_url_override` on Windows) + +: Install package downloaded from a direct URL. + +`-a` (`-checksum` on Windows) + +: The SHA256 for download_url_override + +`-v` (`-version` on Windows) + +: The version of the package to be installed. A version always takes + the form x.y.z, where x, y, and z are decimal numbers that are used + to represent major (x), minor (y), and patch (z) versions. A + two-part version (x.y) is also allowed. For more information about + application versioning, see [semver.org](https://semver.org/). + +## Release channels + +{{< readfile file="content/reusable/md/release_channels.md" >}} ## Examples -{{< readfile file="content/reusable/md/packages_install_script_examples.md" >}} +The following examples show how to use the Chef Software install script. + +Use the `-v` option to install Chef Infra Client 15.8.23 on Unix, Linux, or macOS hosts: + +```bash +curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash -s -- -v 15.8.23 +``` + +Replace `` with your license ID. + +To install the latest version of Chef Workstation on Windows from the `current` channel: + +```powershell +. { iwr -useb https://chefdownload-commercial.chef.io/install.ps1?license_id= } | iex; install -channel current -project chef-workstation +``` + +Replace `` with your license ID. diff --git a/content/download/commercial.md b/content/download/commercial.md index 253494f90f..19edbcd217 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -12,12 +12,18 @@ gh_repo = "chef-web-docs" Commercial customers can use Chef's Commercial API to download Chef software packages and view software package metadata. +## Install script + +You can also use an install script from the API to download and install Chef packages. See the [Chef install script documentation](/chef_install_script/) for more information. + ## License -You must use a license to download packages and review metadata with this API. -If you don't already have one, [contact Chef](https://www.chef.io/contact-us) to get a license. +You must use a license ID to download packages and review metadata with this API. -See [Chef's licensing documentation]({{< relref "chef_license" >}}) for more information on the Chef license. +You can get your license ID from the [Chef Downloads portal](https://chef.io/downloads), +or [contact Chef](https://www.chef.io/contact-us) if you don't already have one. + +See [Chef's licensing documentation]({{< relref "licensing" >}}) for more information on the Chef license. ## Endpoints @@ -40,7 +46,7 @@ The `architectures` endpoint returns a valid list of architecture that Chef prod Any of these architectures can be used in the `m` [query string](#parameters) value in various endpoints below. ```plain -https://chefdownload-commerical.chef.io/architectures +https://chefdownload-commercial.chef.io/architectures ``` ### platforms @@ -48,7 +54,7 @@ https://chefdownload-commerical.chef.io/architectures The `platforms` endpoint returns a list of valid platform keys along with full friendly names. Any of these platform keys can be used in the `p` [query string](#parameters) value in various endpoints below. ```plain -https://chefdownload-commerical.chef.io/platforms +https://chefdownload-commercial.chef.io/platforms ``` ### products @@ -56,13 +62,13 @@ https://chefdownload-commerical.chef.io/platforms The `products` endpoint returns a list of valid product keys. In the following endpoints, you can replace the `` string with a product key in the response of this endpoint. ```plain -https://chefdownload-commerical.chef.io/products +https://chefdownload-commercial.chef.io/products ``` Use `eol=true` to return EOL products. ```plain -https://chefdownload-commerical.chef.io/products?eol=true +https://chefdownload-commercial.chef.io/products?eol=true ``` ### packages @@ -72,13 +78,13 @@ Use `packages` to get a full list of all packages for a particular release chann By default, it returns packages for the latest version. ```plain -https://chefdownload-commerical.chef.io///packages?license_id= +https://chefdownload-commercial.chef.io///packages?license_id= ``` You can specify a version number with the `v` query string to get packages for a particular product version. ```plain -https://chefdownload-commerical.chef.io///packages?v=&license_id= +https://chefdownload-commercial.chef.io///packages?v=&license_id= ``` ### versions/all @@ -86,7 +92,7 @@ https://chefdownload-commerical.chef.io///packages?v=//versions/all?license_id= +https://chefdownload-commercial.chef.io///versions/all?license_id= ``` ### versions/latest @@ -94,7 +100,7 @@ https://chefdownload-commerical.chef.io///versions/all?license Use `versions/latest` to return the latest version of a product from a particular release channel. ```plain -https://chefdownload-commerical.chef.io///versions/latest?license_id= +https://chefdownload-commercial.chef.io///versions/latest?license_id= ``` ### metadata @@ -102,7 +108,7 @@ https://chefdownload-commerical.chef.io///versions/latest?lice The `metadata` endpoint returns data about a particular package of a Chef product. ```plain -https://chefdownload-commerical.chef.io///metadata?p=&pv=&m=&v=&license_id= +https://chefdownload-commercial.chef.io///metadata?p=&pv=&m=&v=&license_id= ``` ### download @@ -110,7 +116,7 @@ https://chefdownload-commerical.chef.io///metadata?p=//download?p=&pv=&m=&v=&license_id= +https://chefdownload-commercial.chef.io///download?p=&pv=&m=&v=&license_id= ``` ## Parameters @@ -118,7 +124,7 @@ https://chefdownload-commerical.chef.io///download?p=` -: The release channel to install from. See [Chef Software Packages](/packages/) for full details on the available channels. +: The release channel to install from. For the available channels, see [release channels](#release-channels). `` : The Chef Software product to install. @@ -164,11 +170,10 @@ The API accepts the following parameters in a query string. ## Chef product names -See the [Supported Versions]({{< relref "versions" >}}) documentation for information about the support status of individual products. - -This is a list of currently supported products that you can install with this API. +Use the following product keys to download packages or retrieve data for different Chef products. +You can also use the [products endpoint](#products) -| Product | Product Key | +| Product | Product key | | ------- | ------------ | | Chef Automate | automate | | Chef Infra Client | chef | @@ -180,22 +185,28 @@ This is a list of currently supported products that you can install with this AP | Management Console | manage | | Supermarket | supermarket | +See the [supported versions]({{< relref "versions" >}}) documentation for information about the support status of individual products. + +### Release channels + +{{< readfile file="content/reusable/md/release_channels.md" >}} + ## Examples ### Get the latest build To get the latest supported build of Chef Infra Client for Ubuntu 20.04, enter the following: -```plain -https://chefdownload-commerical.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64&license_id= +```sh +https://chefdownload-commercial.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64&license_id= ``` -which will return something like: +which returns something like: ```json sha1 "8e8ae315d4695f9c95efc0a1437d2d453f7ab116" sha256 "86f14ae08237b4e24201436ecb83c08c29b68aed1d6ede0953a1b4547a920e36" -url "https://chefdownload-commerical.chef.io/stable/chef/download?license_id=&m=x86_64&p=ubuntu&pv=20.04" +url "https://chefdownload-commercial.chef.io/stable/chef/download?license_id=&m=x86_64&p=ubuntu&pv=20.04" version "18.2.7" ``` @@ -204,11 +215,11 @@ version "18.2.7" To use cURL to download a package directly, enter the following: ```bash -curl -LOJ 'https://chefdownload-commerical.chef.io///download?p=&pv=&m=&license_id=' +curl -LOJ 'https://chefdownload-commercial.chef.io///download?p=&pv=&m=&license_id=' ``` To use GNU Wget to download a package directly, enter the following: ```bash -wget --content-disposition https://chefdownload-commerical.chef.io///download?p=&pv=&m=&license_id= +wget --content-disposition https://chefdownload-commercial.chef.io///download?p=&pv=&m=&license_id= ``` diff --git a/content/download/community.md b/content/download/community.md index c56937b25e..090a001843 100644 --- a/content/download/community.md +++ b/content/download/community.md @@ -65,7 +65,7 @@ https://chefdownload-community.chef.io/products?eol=true ### packages -Use `packages` to get a list of all packages for a particular release channel and product. +Use `packages` to get a list of all packages for a particular product. By default, it returns packages for the latest version. @@ -81,7 +81,7 @@ https://chefdownload-community.chef.io/stable//packages?v=/versions/all @@ -89,7 +89,7 @@ https://chefdownload-community.chef.io/stable//versions/all ### versions/latest -Use `versions/latest` to return the latest version of a product from a particular release channel. +Use `versions/latest` to return the latest version of a product. ```plain https://chefdownload-community.chef.io/stable//versions/latest @@ -153,7 +153,7 @@ The API accepts the following parameters in a query string. ## Chef product names -See the [Supported Versions]({{< relref "versions" >}}) documentation for information about the support status of individual products. +See the [Supported Versions documentation]({{< relref "versions" >}}) for information about the support status of individual products. This is a list of currently supported products that you can install with this API. diff --git a/content/packages.md b/content/packages.md index 1daee68705..bc0fd3a527 100644 --- a/content/packages.md +++ b/content/packages.md @@ -13,86 +13,61 @@ product = ["automate", "client", "server", "habitat", "inspec", "supermarket", " weight = 10 +++ -Packages for Chef Software products may be installed using -platform-native package repositories or the Chef Software Install script. Both -installation methods support the following release channels: - - ---- - - - - - - - - - - - - - - - - -
ChannelDescription
stableA build from this channel is an "official" release that has passed full user acceptance testing. Artifacts in this channel are retained indefinitely.
currentA build from this channel is an "integration" build that has passed full testing, but has not been officially released. Artifacts in this channel are retained for 30 days and then removed automatically.
- -Chef recommends using the stable channel when installing any of these -products on production systems. - -## Package Repositories - -The `stable` and `current` release channels support the following -package repositories: - -- Apt (Debian and Ubuntu platforms) +You can install packages for Chef Software products using platform-native package repositories. + +## Release channels + +{{< readfile file="content/reusable/md/release_channels.md" >}} + +## Package repositories + +The `stable` and `current` release channels support the following package repositories: + +- APT (Debian and Ubuntu platforms) - Yum (Enterprise Linux platforms) -Chef Software's GPG public key can be downloaded -[here](https://packages.chef.io/chef.asc). +You can download Chef Software's GPG public key from [packages.chef.io](https://packages.chef.io/chef.asc). ### Debian / Ubuntu -To set up an Apt package repository for Debian and Ubuntu platforms: +To set up an APT package repository for Debian and Ubuntu platforms: -1. Enable Apt to fetch packages over HTTPS: +1. Enable APT to fetch packages over HTTPS: ```bash sudo apt-get install apt-transport-https ``` -2. Install the public key for Chef Software: +1. Install the public key for Chef Software: ```bash wget -qO - https://packages.chef.io/chef.asc | sudo apt-key add - ``` -3. Create the Apt repository source file: +1. Create the APT repository source file: ```bash echo "deb https://packages.chef.io/repos/apt/ main" > chef-.list ``` - Replace `` with the release channel: `stable` or `current`. + Replace: - Replace `` with the appropriate distribution name: + - `` with the release channel: `stable` or `current`. + - `` with the appropriate distribution name. For example: - - For Debian 9: `stretch` - - For Debian 10: `buster` - - For Debian 11: `bullseye` - - For Ubuntu 18.04: `bionic` - - For Ubuntu 20.04: `focal` + - for Debian 9: `stretch` + - for Debian 10: `buster` + - for Debian 11: `bullseye` + - for Ubuntu 18.04: `bionic` + - for Ubuntu 20.04: `focal` -4. Update the package repository list: +1. Update the package repository list: ```bash sudo mv chef-stable.list /etc/apt/sources.list.d/ ``` -5. Update the cache for the package repository: +1. Update the cache for the package repository: ```bash sudo apt-get update @@ -108,7 +83,7 @@ To set up a Yum package repository for Enterprise Linux platforms: sudo rpm --import https://packages.chef.io/chef.asc ``` -2. Create the Yum repository source file: +1. Create the Yum repository source file: ```bash cat >chef-.repo <` with the release channel: `stable` or `current`. + Replace: - Replace `` with your Enterprise Linux version; the - allowable versions are `6`, `7`, or `8`. + - `` with the release channel: `stable` or `current`. + - `` with the version Enterprise Linux version. -3. Update the package repository list: +1. Update the package repository list: ```bash sudo yum-config-manager --add-repo chef-stable.repo @@ -141,27 +116,3 @@ To set up a Yum package repository for Enterprise Linux platforms: ```bash sudo mv chef-stable.repo /etc/yum.repos.d/ ``` - -## Chef Software Install Script - -{{< readfile file="content/reusable/md/packages_install_script.md" >}} - -### Run the Chef Software Install Script - -{{< readfile file="content/reusable/md/packages_install_script_run.md" >}} - -#### UNIX and Linux - -{{< readfile file="content/reusable/md/packages_install_script_run_unix_linux.md" >}} - -#### Windows - -{{< readfile file="content/reusable/md/packages_install_script_run_windows.md" >}} - -### Chef Software Install Script Options - -{{< readfile file="content/reusable/md/packages_install_script_options.md" >}} - -### Examples - -{{< readfile file="content/reusable/md/packages_install_script_examples.md" >}} diff --git a/content/platforms.md b/content/platforms.md index 1360bd17a3..ef801aebd9 100644 --- a/content/platforms.md +++ b/content/platforms.md @@ -1,5 +1,5 @@ +++ -title = "Platforms" +title = "Supported platforms" draft = false gh_repo = "chef-web-docs" aliases = ["/platforms.html", "/supported_platforms.html"] @@ -7,7 +7,7 @@ product = ["automate", "client", "server", "habitat", "inspec", "workstation"] [menu] [menu.overview] - title = "Platforms" + title = "Supported platforms" identifier = "overview/packages_&_platforms/platforms.md Platforms" parent = "overview/packages_&_platforms" weight = 20 diff --git a/content/reusable/md/packages_install_script.md b/content/reusable/md/packages_install_script.md deleted file mode 100644 index 86b331db55..0000000000 --- a/content/reusable/md/packages_install_script.md +++ /dev/null @@ -1,8 +0,0 @@ -The Chef Software install script can be used to install any Chef Software, including things like Chef Infra Client, Chef Infra Server, Chef InSpec. This script does the following: - -- Detects the platform, version, and architecture of the machine on - which the installer is being executed -- Fetches the appropriate package, for the requested product and - version -- Validates the package content by comparing SHA-256 checksums -- Installs the package diff --git a/content/reusable/md/packages_install_script_examples.md b/content/reusable/md/packages_install_script_examples.md deleted file mode 100644 index 474202fb11..0000000000 --- a/content/reusable/md/packages_install_script_examples.md +++ /dev/null @@ -1,14 +0,0 @@ -The following examples show how to use the Chef Software Install script. - -To install Chef Infra Client 15.8.23: - -```bash -curl -L https://omnitruck.chef.io/install.sh | sudo bash -s -- -v 15.8.23 -``` - -To install the latest version of Chef Workstation on Windows -from the `current` channel: - -```powershell -. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -channel current -project chef-workstation -``` diff --git a/content/reusable/md/packages_install_script_options.md b/content/reusable/md/packages_install_script_options.md deleted file mode 100644 index 94ea36616d..0000000000 --- a/content/reusable/md/packages_install_script_options.md +++ /dev/null @@ -1,50 +0,0 @@ -In addition to the default install behavior, the Chef Software Install script -supports the following options: - -`-c` (`-channel` on Windows) - -: The release channel from which a package is pulled. Possible values: - `current` or `stable`. Default value: `stable`. - -`-d` (`-download_directory` on Windows) - -: The directory into which a package is downloaded. When a package - already exists in this directory and the checksum matches, the - package is not re-downloaded. When `-d` and `-f` are not specified, - a package is downloaded to a temporary directory. - -`-f` (`-filename` on Windows) - -: The name of the file and the path at which that file is located. - When a filename already exists at this path and the checksum - matches, the package is not re-downloaded. When `-d` and `-f` are - not specified, a package is downloaded to a temporary directory. - -`-P` (`-project` on Windows) - -: The product name to install. Supported versions of Chef products are - `automate`, `chef`, `chef-server`, `inspec`, `chef-workstation`, - `chefdk`, `supermarket`, `chef-backend`, `push-jobs-client`, and - `push-jobs-server`. Default value: `chef`. - -`-s` (`-install_strategy` on Windows) - -: The method of package installations. The default strategy is to - always install when the install.sh script runs. Set to "once" to - skip installation if the product is already installed on the node. - -`-l` (`-download_url_override` on Windows) - -: Install package downloaded from a direct URL. - -`-a` (`-checksum` on Windows) - -: The SHA256 for download_url_override - -`-v` (`-version` on Windows) - -: The version of the package to be installed. A version always takes - the form x.y.z, where x, y, and z are decimal numbers that are used - to represent major (x), minor (y), and patch (z) versions. A - two-part version (x.y) is also allowed. For more information about - application versioning, see . diff --git a/content/reusable/md/packages_install_script_run.md b/content/reusable/md/packages_install_script_run.md deleted file mode 100644 index c3f452fe43..0000000000 --- a/content/reusable/md/packages_install_script_run.md +++ /dev/null @@ -1 +0,0 @@ -The Chef Software Install script can be run on UNIX, Linux, and Windows platforms. The terms 'omnibus' and 'omnitruck' are only relevant to the build processes used internally at Chef Software. diff --git a/content/reusable/md/packages_install_script_run_unix_linux.md b/content/reusable/md/packages_install_script_run_unix_linux.md deleted file mode 100644 index 011ddea3b9..0000000000 --- a/content/reusable/md/packages_install_script_run_unix_linux.md +++ /dev/null @@ -1,7 +0,0 @@ -On UNIX, Linux, and macOS systems, invoke the Chef Software Install script with: - -```bash -curl -L https://omnitruck.chef.io/install.sh | sudo bash -``` - -and then enter the local password when prompted. diff --git a/content/reusable/md/packages_install_script_run_windows.md b/content/reusable/md/packages_install_script_run_windows.md deleted file mode 100644 index 163ea05bbd..0000000000 --- a/content/reusable/md/packages_install_script_run_windows.md +++ /dev/null @@ -1,6 +0,0 @@ -On Windows systems, invoke the Chef Software Install script using -Windows PowerShell: - -```powershell -. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -``` diff --git a/content/reusable/md/release_channels.md b/content/reusable/md/release_channels.md new file mode 100644 index 0000000000..ed3da0fa65 --- /dev/null +++ b/content/reusable/md/release_channels.md @@ -0,0 +1,8 @@ +Chef releases packages from the following release channels: + +| Channel | Description | +|--- |--- | +| `stable` | A build from this channel is an "official" release that has passed full user acceptance testing. Artifacts in this channel are retained indefinitely. | +| `current`| A build from this channel is an "integration" build that has passed full testing, but has not been officially released. Artifacts in this channel are retained for 30 days and then removed automatically. | + +Use the stable channel when installing Chef products on production systems. diff --git a/content/upgrade_client.md b/content/upgrade_client.md index 7197e622d9..b8d0bc48b1 100644 --- a/content/upgrade_client.md +++ b/content/upgrade_client.md @@ -16,46 +16,65 @@ aliases = ["/upgrade_client.html"] The following sections describe the upgrade process for Chef Infra Client. If you are also [upgrading the Chef Infra Server]({{< relref "/server/upgrades" >}}) complete that process **first** and **then** upgrade the Chef Infra Client. -## Command Line Upgrades +## Prerequisites -To upgrade Chef Infra Client on a node from the command line, run the install script to install the latest Chef Infra Client release: +Commercial users must have a license ID. You can get your license ID from the [Chef Downloads portal](https://chef.io/downloads). -Linux, macOS, and Unix-based hosts: +For community users, see the [Chef install script documentation](/chef_install_script/). -```bash -curl -L https://chef.io/chef/install.sh | sudo bash -``` +## Command line upgrades -Windows hosts: +Use the [Chef install script](/chef_install_script/) to upgrade to the latest version of Chef Infra Client on a node from the command line. -```powershell -. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -``` +- On Linux, macOS, and Unix-based hosts: -### Specifying the Version to Install + ```bash + curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash + ``` -The install script accepts arguments to allow installing specific versions of Chef Infra Client on systems. + Replace `` with your license ID. -Linux, macOS, and Unix-based hosts: +- On Windows hosts: -```bash -curl -L https://chef.io/chef/install.sh | sudo bash -s -- -v 17.9.26 -``` + ```powershell + . { iwr -useb https://chefdownload-commercial.chef.io/install.ps1?license_id= } | iex; install + ``` -Windows hosts: + Replace `` with your license ID. -```powershell -. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -version 17.9.26 -``` +### Specify the install version + +You can install a specific version of Chef Infra Client using the [Chef install script](/chef_install_script/). + +- Use the `-v` option to install a specific version on Linux, macOS, and Unix-based hosts. For example: -### Upgrading Multiple Hosts with Knife + ```bash + curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash -s -- -v 17.9.26 + ``` -The `knife ssh` command in Chef Workstation can be used to execute the install script on multiple Linux, macOS, and Unix-based hosts at once: + Replace `` with your license ID. + +- Use the `-version` option to install a specific version on Windows hosts. For example: + + ```powershell + . { iwr -useb https://chefdownload-commercial.chef.io/install.ps1?license_id= } | iex; install -version 17.9.26 + ``` + + Replace `` with your license ID. + +### Upgrade multiple hosts with knife + +You can use the [`knife ssh` command](/workstation/knife_ssh/) in Chef Workstation to execute the install script on multiple Linux, macOS, and Unix-based hosts at once. ```bash -knife ssh 'name:*' 'curl -L https://chef.io/chef/install.sh | sudo bash' +knife ssh 'curl -L https://chefdownload-commercial.chef.io/install.sh?license_id= | sudo bash' ``` -## Cookbook-Based Upgrade +Replace: + +- `` with your license ID +- `` with a [node search query](/chef_search/) + +## Cookbook-based upgrade -The [chef_client_updater](https://supermarket.chef.io/cookbooks/chef_client_updater) cookbook can be used to install or upgrade Chef Infra Client package on a node. +Use the [chef_client_updater cookbook](https://supermarket.chef.io/cookbooks/chef_client_updater) to install or upgrade Chef Infra Client on a node. diff --git a/content/versions.md b/content/versions.md index 93c8b31d80..a658d9a3e3 100644 --- a/content/versions.md +++ b/content/versions.md @@ -1,5 +1,5 @@ +++ -title = "Supported Versions" +title = "Supported versions" draft = false gh_repo = "chef-web-docs" aliases = ["/versions.html"] @@ -7,10 +7,10 @@ product = ["automate", "client", "server", "habitat", "inspec", "supermarket", " [menu] [menu.overview] - title = "Supported Versions" + title = "Supported versions" identifier = "overview/packages_&_platforms/versions.md Supported Versions" parent = "overview/packages_&_platforms" - weight = 30 + weight = 10 +++ This section lists the free and commercial Chef products and versions we diff --git a/go.mod b/go.mod index 733f3caba0..06239c182e 100644 --- a/go.mod +++ b/go.mod @@ -20,7 +20,7 @@ require ( github.com/inspec/inspec-azure/docs-chef-io v0.0.0-20240122032234-c1394fc25525 // indirect github.com/inspec/inspec-habitat/docs-chef-io v0.0.0-20220218210405-bfd542da49fd // indirect github.com/inspec/inspec-k8s/docs-chef-io v0.0.0-20240122032042-421355eaf502 // indirect - github.com/inspec/inspec/docs-chef-io v0.0.0-20240725161417-9e8c62dc0c3f // indirect + github.com/inspec/inspec/docs-chef-io v0.0.0-20240826082411-e34d735e7a5f // indirect github.com/swiftype/swiftype-autocomplete-jquery v0.0.0-20190222215504-a90008d64b30 // indirect github.com/swiftype/swiftype-search-jquery v1.1.0 // indirect github.com/twitter/hogan.js v3.0.2+incompatible // indirect diff --git a/go.sum b/go.sum index b99f9f9362..760f8cf94b 100644 --- a/go.sum +++ b/go.sum @@ -32,8 +32,8 @@ github.com/inspec/inspec-habitat/docs-chef-io v0.0.0-20220218210405-bfd542da49fd github.com/inspec/inspec-habitat/docs-chef-io v0.0.0-20220218210405-bfd542da49fd/go.mod h1:Q4E7QBY4b7HDE2psfGT9jqvnLq1yfg5e9KWK4VTtI/M= github.com/inspec/inspec-k8s/docs-chef-io v0.0.0-20240122032042-421355eaf502 h1:l3NT3O2TWWbp1XTeolWRNreLWoWornD4S8+h9uIVIc0= github.com/inspec/inspec-k8s/docs-chef-io v0.0.0-20240122032042-421355eaf502/go.mod h1:JwjkNHKgELWxc9esXuK3ELEGL371pK496OKrK+te3Lk= -github.com/inspec/inspec/docs-chef-io v0.0.0-20240725161417-9e8c62dc0c3f h1:fYKOoUx0n7VTPDHF9aWh3W++5XrI6YfhqSDuZFbWZuo= -github.com/inspec/inspec/docs-chef-io v0.0.0-20240725161417-9e8c62dc0c3f/go.mod h1:k41HVhnK+v9/X2qCX+axYBM6eME3kFeatloWoMLxXQU= +github.com/inspec/inspec/docs-chef-io v0.0.0-20240826082411-e34d735e7a5f h1:UTHOiIMiMOKdbwMTLAeMfB//tiHQQSxpb01NMZP8ilo= +github.com/inspec/inspec/docs-chef-io v0.0.0-20240826082411-e34d735e7a5f/go.mod h1:k41HVhnK+v9/X2qCX+axYBM6eME3kFeatloWoMLxXQU= github.com/swiftype/swiftype-autocomplete-jquery v0.0.0-20190222215504-a90008d64b30 h1:dhqLFBINtD1rMwwd5s9INu4BkciCvQUd+r+CWUYWIB4= github.com/swiftype/swiftype-autocomplete-jquery v0.0.0-20190222215504-a90008d64b30/go.mod h1:qnxTyatkwE84LvoaQLPaLB4h5M3n6Q2z+SB/96DcAK8= github.com/swiftype/swiftype-search-jquery v1.1.0 h1:VRYyWPQtf3Vl3B5W2xQJuFVoUBlBFGQ4tOTu94b8mNU=