From fdf72fc46db5c8ee019f8424a72501ae35660d55 Mon Sep 17 00:00:00 2001 From: Shane Sveller Date: Fri, 4 Sep 2020 17:04:49 -0500 Subject: [PATCH] Add Homebrew instructions to Installation guide --- docs/guides/installation.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/guides/installation.md b/docs/guides/installation.md index 5d795785..597c2820 100644 --- a/docs/guides/installation.md +++ b/docs/guides/installation.md @@ -8,6 +8,8 @@ to manage one or more Kubernetes clusters. You will need a Kubernetes cluster version **1.16** or newer and kubectl version **1.18** or newer. +### Automatic Installation + Install the toolkit CLI with: ```sh @@ -18,6 +20,21 @@ The install script downloads the gotk binary to `/usr/local/bin`. Binaries for macOS and Linux AMD64/ARM64 are available for download on the [release page](https://github.com/fluxcd/toolkit/releases). +### Homebrew Installation + +The toolkit CLI may alternatively be installed by MacOS or Linux users via +[Homebrew](https://brew.sh/). This method is currently community-supported and may not provide the latest possible release. + +``` bash +brew tap fluxcd/toolkit +# Install latest tagged release +brew install fluxcd/toolkit/gotk +# Install unstable versions from source +brew install --HEAD fluxcd/toolkit/gotk +``` + +### Cluster Requirements Check + Verify that your cluster satisfies the prerequisites with: ```sh