Skip to main content

Omnitruck API

[edit on GitHub]

Chef’s Omnitruck API powers the Chef Software Install script as well as downloads.chef.io site. It can be used to query available versions of Chef Software Inc. products and to provide direct download URLs.

Syntax

The URL from which these downloads can be obtained has the following syntax:

https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/download?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest&prerelease=false&nightlies=false

or:

https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/metadata?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest&prerelease=false&nightlies=false

where the difference between these URLs is the metadata and download options. Use the metadata option to verify the build before downloading it. Use the download option to download the package in a single step.

Downloads

The /metadata and/or /download endpoints can be used to download packages for all products:

https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/download?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest

or:

https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/metadata?p=$PLATFORM&pv=$PLATFORM_VERSION&m=$MACHINE_ARCH&v=latest

where:

  • <CHANNEL> is the release channel to install from. See Chef Software Inc Packages for full details on the available channels.
  • <PRODUCT> is the Chef Software Inc product to install. A list of valid product keys can be found at https://github.com/chef/mixlib-install/blob/master/PRODUCT_MATRIX.md
  • p is the platform. Possible values: debian, el (for RHEL derivatives), freebsd, mac_os_x, solaris2, sles, suse, ubuntu or windows.
  • pv is the platform version. Possible values depend on the platform. For example, Ubuntu: 18.04, or 20.04 or for macOS: 10.15 or 11.
  • m is the machine architecture for the machine on which the product will be installed. Possible values depend on the platform. For example, for Ubuntu or Debian: i386 or x86_64 or for macOS: x86_64.
  • v is the version of the product 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. One-part (x) and two-part (x.y) versions are allowed. For more information about application versioning, see https://semver.org/. Default value: latest.

Platforms

Omnitruck accepts the following platforms:

Platformpmpv
AIXaixpowerpc6.1, 7.1, 7.2
Amazon Linuxamazonx86_64,aarch64201X, 2
Cisco IOS XRios_xrx86_646
Cisco NX-OSnexusx86_647
Debiandebiani386, x86_64, aarch646, 7, 8, 9, 10
FreeBSDfreebsdx86_649, 10, 11, 12
macOSmac_os_xx86_64, aarch6410.6, 10.7, 10.8, 10.9, 10.10, 10.11, 10.12, 10.13, 10.14, 10.15, 11
Solarissolaris2i386, sparc5.10, 5.11
SUSE Linux Enterprise Serverslesx86_64, s390x, aarch6411, 12, 15
Red Hat Enterprise Linux / CentOS / Oracle Linuxeli386, x86_64, ppc64, ppc64le, aarch645, 6, 7, 8
Ubuntuubuntui386, x86_64, aarch64, ppc64le10.04, 10.10, 11.04, 11.10, 12.04, 12.10, 13.04, 13.10, 14.04, 14.10, 16.04, 16.10, 17.04, 17.10, 18.04, 18.10, 19.04, 20.04, 20.10, 21.04
Microsoft Windowswindowsx86_64, i3867, 8, 10, 2008r2, 2012, 2012r2, 2016, 2019

Examples

Get the Latest Build

To get the latest supported build for Ubuntu 20.04, enter the following:

https://omnitruck.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64

to return something like:

sha1	32516ce8fe7ba09ea96d1e32e7f64087338a3b48
sha256	156057bb0a39b73a9abc2ea940b38210dcf02da4a1b5a461bff3e714a290cc02
url	https://packages.chef.io/files/stable/chef/16.10.17/ubuntu/20.04/chef_16.10.17-1_amd64.deb
version	16.10.17

Download Directly

To use cURL to download a package directly, enter the following:

curl -LOJ 'https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/download?p=debian&pv=10&m=x86_64'

To use GNU Wget to download a package directly, enter the following:

wget --content-disposition https://omnitruck.chef.io/<CHANNEL>/<PRODUCT>/download?p=debian&pv=10&m=x86_64

Was this page helpful?









Search Results