Skip to content

Commit

Permalink
Add flux CLI container image to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Prodan <[email protected]>
  • Loading branch information
stefanprodan committed Apr 8, 2021
1 parent 8e27490 commit 531b65a
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 13 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ Arch Linux (AUR) packages:
Binaries for macOS, Windows and Linux AMD64/ARM are available to download on the
[release page](https:/fluxcd/flux2/releases).

A container image with `kubectl` and `flux` is available on Docker Hub and GitHub:

* `docker.io/fluxcd/flux-cli:<version>`
* `ghcr.io/fluxcd/flux-cli:<version>`

Verify that your cluster satisfies the prerequisites with:

```sh
Expand Down
26 changes: 15 additions & 11 deletions docs/guides/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ are also supported with their own sub-commands.
Binaries for macOS, Windows and Linux AMD64/ARM are available for download on the
[release page](https:/fluxcd/flux2/releases).

A container image with `kubectl` and `flux` is available on DockerHub and GitHub:

* `docker.io/fluxcd/flux-cli:<version>`
* `ghcr.io/fluxcd/flux-cli:<version>`

Verify that your cluster satisfies the prerequisites with:

```sh
Expand All @@ -46,10 +51,16 @@ If the Flux components are present on the cluster, the bootstrap
command will perform an upgrade if needed. The bootstrap is
idempotent, it's safe to run the command as many times as you want.

!!! hint "Multi-arch images"
The component images are published as [multi-arch container images](https://docs.docker.com/docker-for-mac/multi-arch/)
with support for Linux `amd64`, `arm64` and `armv7` (e.g. 32bit Raspberry Pi)
architectures.
The Flux component images are published to DockerHub and GitHub Container Registry
as [multi-arch container images](https://docs.docker.com/docker-for-mac/multi-arch/)
with support for Linux `amd64`, `arm64` and `armv7` (e.g. 32bit Raspberry Pi)
architectures.

If your Git provider is **GitHub**, **GitLab** or **Azure DevOps** please follow the specific bootstrap procedure:

* [GitHub.com and GitHub Enterprise](#github-and-github-enterprise)
* [GitLab.com and GitLab Enterprise](#gitlab-and-gitlab-enterprise)
* [Azure DevOps](../use-cases/azure.md#flux-installation-for-azure-devops)

### Generic Git Server

Expand Down Expand Up @@ -91,13 +102,6 @@ flux bootstrap git \
If your Git server uses a self-signed TLS certificate, you can specify the CA file with
`--ca-file=<path/to/ca.crt>`.

If you wish to install a specific version, use the Flux
[release tag](https:/fluxcd/flux2/releases) e.g. `--version=v0.12.0`.

If you wish to deploy the Flux components onto
[tainted Kubernetes nodes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/),
you can specify the toleration keys with `--toleration-keys=node.kubernetes.io/dedicated-to-flux`.

With `--path` you can configure the directory which will be used to reconcile the target cluster.
To control multiple clusters from the same Git repository, you have to set a unique path per
cluster e.g. `clusters/staging` and `clusters/production`:
Expand Down
10 changes: 8 additions & 2 deletions docs/use-cases/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ az aks create \
When working with the Azure CLI, it can help to set a default `location`, `group`, and `acr`.
See `az configure --help`, `az configure --list-defaults`, and `az configure --defaults key=value`.

## Flux Installation with Azure DevOps Repos
## Flux Installation for Azure DevOps

Ensure you can login to [dev.azure.com](https://dev.azure.com) for your proper organization,
and create a new repository to hold your Flux install and other Kubernetes resources.
Expand All @@ -72,7 +72,7 @@ Create a directory inside the repository:
mkdir -p ./clusters/my-cluster/flux-system
```

Generate the Flux manifests with:
Download the [Flux CLI](../guides/installation.md#install-the-flux-cli) and generate the manifests with:

```sh
flux install \
Expand Down Expand Up @@ -166,6 +166,12 @@ cd ./clusters/my-cluster/flux-system && kustomize create --autodetect
git add -A && git commit -m "add sync manifests" && git push
```

Wait for Flux to reconcile your previous commit with:

```sh
watch flux get kustomization flux-system
```

### Flux Upgrade

To upgrade the Flux components to a newer version, download the latest `flux` binary,
Expand Down

0 comments on commit 531b65a

Please sign in to comment.