Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Install Script Changes for Omnitruck Documents #4288

Merged
merged 26 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
1eeddf5
added updated for download script steps
vviveksharma Jul 11, 2024
ac86825
Added the changes for omnitruck changes
vviveksharma Jul 18, 2024
62bf18f
removing linting issues
vviveksharma Jul 22, 2024
d7d2c59
added refactored changes
vviveksharma Jul 22, 2024
5ca583f
added refactored changes
vviveksharma Jul 22, 2024
3a37a66
updated the docs with latest script changes
vviveksharma Jul 25, 2024
2eb1307
added notes
vviveksharma Jul 26, 2024
3f5ff72
updated the docs
vviveksharma Aug 5, 2024
4836f3a
updated the docs
vviveksharma Aug 5, 2024
6cb9f09
updated the licenseId note
vviveksharma Aug 5, 2024
d40218c
added new docs changes
vviveksharma Aug 7, 2024
0d819d3
removed lines
vviveksharma Aug 8, 2024
87486d9
updated the typo
vviveksharma Aug 9, 2024
53b910b
reverted changes in airgap file
vviveksharma Aug 14, 2024
f4476d0
reverted changes in airgap file
vviveksharma Aug 14, 2024
26a34e2
reverted changes in airgap file
vviveksharma Aug 14, 2024
82c14b6
Editing
IanMadd Aug 21, 2024
c344867
Update other docs with install script changes
IanMadd Aug 21, 2024
99e8ce8
Reorganization
IanMadd Aug 23, 2024
27e4475
added the correct flags
vviveksharma Aug 26, 2024
e1d2d66
Add more updates to inspec docs
IanMadd Aug 26, 2024
adc73ba
updated the production url spellings
vviveksharma Sep 9, 2024
6b35644
rebased the branch
vviveksharma Sep 11, 2024
2db17e6
URL typo fixes
sandhi18 Sep 12, 2024
2eb74a2
Merge branch 'sandhi/url-typo-fixes' into vivekSharma/omnitruck-docs
IanMadd Sep 19, 2024
cd45844
Minor changes
IanMadd Sep 19, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

191 changes: 179 additions & 12 deletions content/chef_install_script.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,203 @@
+++
title = "Chef Software Install Script"
title = "Chef Software install script"
draft = false
gh_repo = "chef-web-docs"
aliases = ["/install_omnibus.html", "/install_omnibus/"]
product = ["automate", "client", "server", "habitat", "inspec", "supermarket", "workstation"]

[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=<LICENSE_ID> | sudo bash
```

Replace `<LICENSE_ID>` 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=<LICENSE_ID> | sudo bash -s -- -P <PROJECT>
```

Replace:

- `<LICENSE_ID>` with your license ID
- `<PROJECT>` 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=<LICENSE_ID> } | iex; install
```

Replace `<LICENSE_ID>` 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=<LICENSE_ID> } | iex; install -project <PROJECT>
```

Replace:

- `<LICENSE_ID>` with your license ID
- `<PROJECT>` 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 <PROJECT>
```

Replace `<PROJECT>` 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 <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=<LICENSE_ID> | sudo bash -s -- -v 15.8.23
```

Replace `<LICENSE_ID>` 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=<LICENSE_ID> } | iex; install -channel current -project chef-workstation
```

Replace `<LICENSE_ID>` with your license ID.
Loading
Loading