Upgrade Advisory

This documentation is for Flux (v1) and Helm Operator (v1). Both projects are in maintenance mode and will soon reach end-of-life. We strongly recommend you familiarise yourself with the newest Flux and start looking at your migration path.

For documentation regarding the latest Flux, please refer to this section.

Providing your own SSH key

Flux connects to the repository using an SSH key it retrieves from a Kubernetes secret, if the configured (--k8s-secret-name) secret has no identity key/value pair, it will generate new private key.

With this knowledge, providing your own SSH key is as simple as creating the configured secret in the expected format.

create a Kubernetes secret from your own private key:

kubectl create secret generic flux-git-deploy --from-file=identity=/full/path/to/private_key

this will result in a secret that has the structure:

apiVersion: v1
data:
  identity: <base64 encoded RSA PRIVATE KEY>
kind: Secret
type: Opaque
metadata:
  ...

(optional) if you created the secret with a non-default name (default: flux-git-deploy), set the --k8s-secret-name flag to the name of your secret (i.e. --k8s-secret-name=foo).

The SSH key must be configured to have R/W access to the repository. More specifically, the SSH key must be able to create and update tags. E.g. in Gitlab, that means it requires Maintainer permissions. The Developer permission can create tags, but not update them.

Last modified 2021-06-02: Adapt flux docs to show up properly - add relevant frontmatter for docs to show up - configure version info - bring navbar partial closer to what's upstream effectively re-add version selector and all - Legacy docs use 'docs' template, but we show a warning at the top. Plus some small display fixes. - change old notes to new alerts - adapt nav to be like on docs.fluxcd.io, re-add requirements.md (c1afa31)