Flux

https://fluxcd.io/flux
Admin
Flux is an open and extensible continuous delivery solution for Kubernetes that keeps clusters in...
Tokens:622,163
Snippets:5,134
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### flux install usage examples

Source: https://fluxcd.io/flux/cmd/flux_install

A collection of example invocations of the flux install command. The examples show how to install the latest version in a specific namespace, select a set of components, add extra components, tolerate taints, perform a dry-run install, and write the manifests to a file. They illustrate common use cases and flags.

```shell
  # Install the latest version in the flux-system namespace
  flux install --namespace=flux-system

  # Install a specific series of components
  flux install --components="source-controller,kustomize-controller"

  # Install all components including the image automation ones
  flux install --components-extra="image-reflector-controller,image-automation-controller"

  # Install all components including source-watcher
  flux install --components-extra="source-watcher"

  # Install Flux onto tainted Kubernetes nodes
  flux install --toleration-keys=node.kubernetes.io/dedicated-to-flux

  # Dry-run install
  flux install --export | kubectl apply --dry-run=client -f-

  # Write install manifests to file
  flux install --export > flux-system.yaml

```

--------------------------------

### flux get sources bucket examples

Source: https://fluxcd.io/flux/cmd/flux_get_sources_bucket

Provides two example invocations: one to list all Buckets and their status, and another to list buckets from all namespaces using the --all-namespaces flag. Note that the second example uses 'helm' instead of 'bucket'.

```bash
  # List all Buckets and their status
  flux get sources bucket

 # List buckets from all namespaces
  flux get sources helm --all-namespaces

```

--------------------------------

### flux get image repository examples

Source: https://fluxcd.io/flux/cmd/flux_get_images_repository

Examples of listing image repositories and their status, including across all namespaces.

```bash
  # List all image repositories and their status
  flux get image repository

```

```bash
 # List image repositories from all namespaces
  flux get image repository --all-namespaces

```

--------------------------------

### flux check usage examples

Source: https://fluxcd.io/flux/cmd/flux_check

Two usage examples: run pre-installation checks with the --pre flag, and run installation checks without flags.

```bash
  # Run pre-installation checks
  flux check --pre

  # Run installation checks
  flux check

```

--------------------------------

### flux bootstrap github examples

Source: https://fluxcd.io/flux/cmd/flux_bootstrap_github

Provides multiple usage examples for flux bootstrap github, covering personal access token setup, private/public repositories, GitHub Enterprise, and team access. Each example shows a different configuration scenario.

```bash
  # Create a GitHub personal access token and export it as an env var
  export GITHUB_TOKEN=<my-token>

```

```bash
  # Run bootstrap for a private repository owned by a GitHub organization
  flux bootstrap github --owner=<organization> --repository=<repository name> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository and assign organization teams to it
  flux bootstrap github --owner=<organization> --repository=<repository name> --team=<team1 slug> --team=<team2 slug> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository and assign organization teams with their access level(e.g maintain, admin) to it
  flux bootstrap github --owner=<organization> --repository=<repository name> --team=<team1 slug>:<access-level> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a public repository on a personal account
  flux bootstrap github --owner=<user> --repository=<repository name> --private=false --personal=true --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository hosted on GitHub Enterprise using SSH auth
  flux bootstrap github --owner=<organization> --repository=<repository name> --hostname=<domain> --ssh-hostname=<domain> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository hosted on GitHub Enterprise using HTTPS auth
  flux bootstrap github --owner=<organization> --repository=<repository name> --hostname=<domain> --token-auth --path=clusters/my-cluster

```

```bash
  # Run bootstrap for an existing repository with a branch named main
  flux bootstrap github --owner=<organization> --repository=<repository name> --branch=main --path=clusters/my-cluster

```

--------------------------------

### flux get sources oci examples

Source: https://fluxcd.io/flux/cmd/flux_get_sources_oci

Examples of listing OCIRepositories and their status, including listing across all namespaces using the --all-namespaces flag.

```shell
  # List all OCIRepositories and their status
  flux get sources oci

  # List OCIRepositories from all namespaces
  flux get sources oci --all-namespaces

```

--------------------------------

### flux get all usage examples

Source: https://fluxcd.io/flux/cmd/flux_get_all

Two example invocations: one lists resources in a specific namespace using --namespace, the other lists resources across all namespaces using --all-namespaces.

```bash
  # List all resources in a namespace
  flux get all --namespace=flux-system

  # List all resources in all namespaces
  flux get all --all-namespaces

```

--------------------------------

### Flux CLI examples: check, install, create, get, reconcile, export, suspend, resume, delete, uninstall

Source: https://fluxcd.io/flux/cmd/flux

Shows common flux commands for managing GitRepository sources and Kustomizations, including creating a source from a public Git repo, reconciling, exporting, suspending, resuming, deleting, and uninstalling. Use these to perform typical GitOps operations.

```bash
  # Check prerequisites
  flux check --pre

  # Install the latest version of Flux
  flux install

  # Create a source for a public Git repository
  flux create source git webapp-latest \
    --url=https://github.com/stefanprodan/podinfo \
    --branch=master \
    --interval=3m

  # List GitRepository sources and their status
  flux get sources git

  # Trigger a GitRepository source reconciliation
  flux reconcile source git flux-system

  # Export GitRepository sources in YAML format
  flux export source git --all > sources.yaml

  # Create a Kustomization for deploying a series of microservices
  flux create kustomization webapp-dev \
    --source=webapp-latest \
    --path="./deploy/webapp/" \
    --prune=true \
    --interval=5m \
    --health-check="Deployment/backend.webapp" \
    --health-check="Deployment/frontend.webapp" \
    --health-check-timeout=2m

  # Trigger a git sync of the Kustomization's source and apply changes
  flux reconcile kustomization webapp-dev --with-source

  # Suspend a Kustomization reconciliation
  flux suspend kustomization webapp-dev

  # Export Kustomizations in YAML format
  flux export kustomization --all > kustomizations.yaml

  # Resume a Kustomization reconciliation
  flux resume kustomization webapp-dev

  # Delete a Kustomization
  flux delete kustomization webapp-dev

  # Delete a GitRepository source
  flux delete source git webapp-latest

  # Uninstall Flux and delete CRDs
  flux uninstall

```

--------------------------------

### flux get sources chart examples

Source: https://fluxcd.io/flux/cmd/flux_get_sources_chart

Examples of listing all Helm charts and their status, and listing from all namespaces.

```bash
  # List all Helm charts and their status
  flux get sources chart

 # List Helm charts from all namespaces
  flux get sources chart --all-namespaces

```

--------------------------------

### flux get sources git examples

Source: https://fluxcd.io/flux/cmd/flux_get_sources_git

Two example invocations of flux get sources git: one to list all Git repositories and their status, and another to list them from all namespaces using the --all-namespaces flag.

```bash
  # List all Git repositories and their status
  flux get sources git

 # List Git repositories from all namespaces
  flux get sources git --all-namespaces

```

--------------------------------

### Delivery example for Helm chart (HelmRepository and HelmRelease)

Source: https://fluxcd.io/flux/guides/repository-structure

Defines a HelmRepository pointing to the chart repository and a HelmRelease that installs the app chart with version 1.x and sets replicas to 2.

```yaml
apiVersion: source.toolkit.fluxcd.io/v1
kind: HelmRepository
metadata:
  name: apps
spec:
  url: https://<host>/<org>/charts
---
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: app
spec:
  chart:
    spec:
      chart: app
      version: "1.x"
      sourceRef:
        kind: HelmRepository
        name: apps
  values:
    replicas: 2

```

--------------------------------

### Install Flux Mirror plugin

Source: https://fluxcd.io/flux/cli-plugins/flux-mirror

Installs the Flux Mirror plugin using the Flux CLI.

```bash
flux plugin install mirror

```

--------------------------------

### Options for flux plugin install

Source: https://fluxcd.io/flux/cmd/flux_plugin_install

Lists the options available for the install command, including the help flag.

```bash
  -h, --help   help for install
```

--------------------------------

### kubecfg workflow steps (excerpt)

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

The three new steps added in the Jsonnet Render Action example: setup the kubecfg CLI, render the Jsonnet file to production.yaml, and prepare the target branch. These steps are inserted between the Checkout repo and Commit changes steps.

```yaml
# excerpted from above - workflow steps 3, 4, and 5
- name: Setup kubecfg CLI
  uses: kingdonb/kubecfg/action@main

- name: kubecfg show
  run: kubecfg show manifests/example.jsonnet > output/production.yaml

- name: Prepare target branch
  run: ./ci/rake.sh deploy

```

--------------------------------

### Flux validation failure output for missing namespaces

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Example output from `flux get kustomization` when the Jsonnet-generated manifests fail validation because objects are created before their namespaces. To get past this error, temporarily set `validation: none` on the Flux Kustomization.

```text
validation failed: namespace/dev created (server dry run)
namespace/prod created (server dry run)
...
Error from server (NotFound): error when creating "14f54b89-2456-4c15-862e-34670dfcda79.yaml": namespaces "dev" not found
Error from server (NotFound): error when creating "14f54b89-2456-4c15-862e-34670dfcda79.yaml": namespaces "prod" not found

```

--------------------------------

### flux resume kustomization examples

Source: https://fluxcd.io/flux/cmd/flux_resume_kustomization

Examples for resuming one or multiple Kustomizations using the 'ks' alias.

```bash
  # Resume reconciliation for an existing Kustomization
  flux resume ks podinfo

  # Resume reconciliation for multiple Kustomizations
  flux resume ks podinfo-1 podinfo-2

```

--------------------------------

### Examples of flux debug kustomization

Source: https://fluxcd.io/flux/cmd/flux_debug_kustomization

Three examples showing how to use the command: print status, export final variables, and print reconciliation history. The --show-vars example redirects output to a file.

```shell
  # Print the status of a Flux Kustomization
  flux debug ks podinfo --show-status

  # Export the final variables used for post-build substitutions composed from referred ConfigMaps and Secrets
  flux debug ks podinfo --show-vars > vars.env

  # Print the reconciliation history of a Flux Kustomization
  flux debug ks podinfo --show-history

```

--------------------------------

### Example output of kubectl get clusters

Source: https://fluxcd.io/flux/use-cases/karmada

Example output from the kubectl get clusters command, showing three member clusters with their versions, modes (Push/Pull), readiness, and age.

```text
NAME      VERSION   MODE   READY   AGE
member1   v1.23.4   Push   True    7m38s
member2   v1.23.4   Push   True    7m35s
member3   v1.23.4   Pull   True    7m27s

```

--------------------------------

### flux create kustomization examples

Source: https://fluxcd.io/flux/cmd/flux_create_kustomization

Examples of creating Kustomization resources with various sources and options, including GitRepository, OCIRepository, and Bucket, with dependencies, namespaces, and health checks.

```bash
  # Create a Kustomization resource from a source at a given path
  flux create kustomization kyverno \
    --source=GitRepository/kyverno \
    --path="./config/release" \
    --prune=true \
    --interval=60m \
    --wait=true \
    --health-check-timeout=3m

  # Create a Kustomization resource that depends on the previous one
  flux create kustomization kyverno-policies \
    --depends-on=kyverno \
    --source=GitRepository/kyverno-policies \
    --path="./policies/flux" \
    --prune=true \
    --interval=5m

  # Create a Kustomization using a source from a different namespace
  flux create kustomization podinfo \
    --namespace=default \
    --source=GitRepository/podinfo.flux-system \
    --path="./kustomize" \
    --prune=true \
    --interval=5m

  # Create a Kustomization resource that references an OCIRepository
  flux create kustomization podinfo \
    --source=OCIRepository/podinfo \
    --target-namespace=default \
    --prune=true \
    --interval=5m

  # Create a Kustomization resource that references a Bucket
  flux create kustomization secrets \
    --source=Bucket/secrets \
    --prune=true \
    --interval=5m

```

--------------------------------

### Start GitRepositoryWatcher controller in main

Source: https://fluxcd.io/flux/gitops-toolkit/source-watcher

Starts the GitRepositoryWatcher controller in the main function by creating an instance with the manager's client and HTTP retry count, then calling SetupWithManager. On error, it logs and exits with status 1.

```go
func main()  {

	if err = (&controllers.GitRepositoryWatcher{
		Client:    mgr.GetClient(),
		HttpRetry: httpRetry,
	}).SetupWithManager(mgr); err != nil {
		setupLog.Error(err, "unable to create controller", "controller", "GitRepositoryWatcher")
		os.Exit(1)
	}

}
```

--------------------------------

### flux get sources external usage examples

Source: https://fluxcd.io/flux/cmd/flux_get_sources_external

Example invocations of the flux get sources external command. The first lists all ExternalArtifacts and their status, while the second lists them from all namespaces using the --all-namespaces flag.

```bash
  # List all ExternalArtifacts and their status
  flux get sources external

  # List ExternalArtifacts from all namespaces
  flux get sources external --all-namespaces

```

--------------------------------

### App repository Kustomize overlays example

Source: https://fluxcd.io/flux/guides/repository-structure

Shows the directory structure of an app repository with Kustomize overlays for base, production, and staging.

```text
├── src
└── deploy
    ├── base
    ├── production 
    └── staging

```

--------------------------------

### k8s.yml example with Deployment and Service

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Example k8s.yml file containing a Deployment and Service for the any-old-app. This file is updated by the sed command in update-k8s.sh and is not meant to be applied by Flux, but serves as a developer reference template.

```yaml
# k8s.yml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: any-old-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: any-old-app
  template:
    metadata:
      labels:
        app: any-old-app
    spec:
      containers:
      - image: kingdonb/any-old-app:4f314627
        name: any-old-app
---
apiVersion: v1
kind: Service
metadata:
  name: any-old-app
spec:
  type: ClusterIP
  ports:
  - name: "any-old-app"
    port: 3000
  selector:
    app: any-old-app

```

--------------------------------

### Jsonnet example defining two Flux environments

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Jsonnet example that defines two Flux Kustomizations (test and prod) in separate namespaces, both using the same version ConfigMap and GitRepository. The example omits some front-matter for brevity and is intentionally verbose, replicating the original single-environment config into two environments that differ only in name.

```jsonnet
# Any Old App Jsonnet example 0.10.2-alpha1 - manifests/example.jsonnet
# Replicate a section of config and change nothing else about it

// ...

{
  version_configmap: kube.ConfigMap('any-old-app-version') {
    metadata+: {
      namespace: 'flux-system',
    },
    data+: {
      VERSION: std.extVar('VERSION'),
    },
  },
  test_flux_kustomization: example.kustomization('any-old-app-test') {
    metadata+: {
      namespace: 'flux-system',
    },
    spec+: {
      path: './flux-config/',
      postBuild+: {
        substituteFrom+: [
          {
            kind: 'ConfigMap',
            name: 'any-old-app-version',
          },
        ],
      },
      targetNamespace: 'test-tenant',
    },
  },
  prod_flux_kustomization: example.kustomization('any-old-app-prod') {
    metadata+: {
      namespace: 'flux-system',
    },
    spec+: {
      path: './flux-config/',
      postBuild+: {
        substituteFrom+: [
          {
            kind: 'ConfigMap',
            name: 'any-old-app-version',
          },
        ],
      },
      targetNamespace: 'prod-tenant',
    },
  },
  flux_gitrepository: example.gitrepository('any-old-app-prod') {
    metadata+: {
      namespace: 'flux-system',
    },
    spec+: {
      url: 'https://github.com/kingdonb/any_old_app',
    },
  },
}

```

--------------------------------

### Jsonnet example for tenant with image pull secrets

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Jsonnet example that creates a prod namespace, adds the encrypted pull secret, and applies a kustomization to set the imagePullSecret on ServiceAccounts. It also creates a staging kustomization that renames the namespace to 'stg'. Requires the kubecfg and kustomize libraries and the tenant.yaml and sops-image-pull-secret.yaml files.

```jsonnet
# Any Old App Jsonnet example 0.10.4 - manifests/example.jsonnet

local kubecfg = import 'kubecfg.libsonnet';
local kustomize = import 'kustomize.libsonnet';

local tenant =
  kubecfg.parseYaml(importstr 'examples/tenant.yaml');
local pull_secrets =
  kubecfg.parseYaml(importstr 'examples/sops-image-pull-secret.yaml');

local prod_ns = 'prod';
local staging_ns = 'stg';
local image_pull_secret = 'prod-docker-pull-secret';

// Set the Image Pull Secret on each ServiceAccount
local updateConfig(o) = (
  if o.kind == 'ServiceAccount' then o {
    imagePullSecrets: [{ name: image_pull_secret }],
  } else o
);

// Create a namespace, and add to it Namespace and Secret
local prod_tenant = [
  kube.Namespace(prod_ns),
] + pull_secrets + tenant;

// Prod kustomization - apply the updateConfig
local prod_kustomization = kustomize.applyList([
  updateConfig,
]);

// Stg kustomization - apply the updateConfig and "stg" ns
local staging_kustomization = kustomize.applyList([
  updateConfig,
  kustomize.namespace(staging_ns),
]);

// Include both kustomizations in the Jsonnet object
{
  prod: std.map(prod_kustomization, prod_tenant),
  stg: std.map(staging_kustomization, prod_tenant),
}

```

--------------------------------

### Examples: create source chart for HelmRepository, GitRepository, Bucket, and OCI

Source: https://fluxcd.io/flux/cmd/flux_create_source_chart

Examples of creating a HelmChart source for charts in a HelmRepository, GitRepository, Bucket, or OCI with signature verification.

```shell
  # Create a source for a chart residing in a HelmRepository
  flux create source chart podinfo \
    --source=HelmRepository/podinfo \
    --chart=podinfo \
    --chart-version=6.x

```

```shell
  # Create a source for a chart residing in a Git repository
  flux create source chart podinfo \
    --source=GitRepository/podinfo \
    --chart=./charts/podinfo

```

```shell
  # Create a source for a chart residing in a S3 Bucket
  flux create source chart podinfo \
    --source=Bucket/podinfo \
    --chart=./charts/podinfo

```

```shell
  # Create a source for a chart from OCI and verify its signature
  flux create source chart podinfo \
    --source HelmRepository/podinfo \
    --chart podinfo \
    --chart-version=6.6.2 \
    --verify-provider=cosign \
    --verify-issuer=https://token.actions.githubusercontent.com \
    --verify-subject=https://github.com/stefanprodan/podinfo/.github/workflows/release.yml@refs/tags/6.6.2

```

--------------------------------

### Jsonnet manifest generation with list comprehension for Flux

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Jsonnet manifest generation example for Flux, using kube.libsonnet, kubecfg, and kustomize-libsonnet. It composes a ConfigMap and a GitRepository, parses YAML with kubecfg.parseYaml (which always returns an array), and uses a list comprehension to generate per-environment Kustomization objects. The example requires the external files example.libsonnet, kubecfg.libsonnet, kustomize.libsonnet, and examples/configMap.yaml.

```jsonnet
# Any Old App Jsonnet example 0.10.2 - manifests/example.jsonnet

// This is a simple manifest generation example to demo some simple tasks that
// can be automated through Flux, with Flux configs rehydrated through Jsonnet.

// This example uses kube.libsonnet from Bitnami.  There are other
// Kubernetes libraries available, or write your own!
local kube = import 'https://github.com/bitnami/kube-libsonnet/raw/73bf12745b86718083df402e89c6c903edd327d2/kube.libsonnet';

// The declaration below adds configuration to a more verbose base, defined in
// more detail at the neighbor libsonnet file here:
local example = import 'example.libsonnet';
local kubecfg = import 'kubecfg.libsonnet';
local kustomize = import 'kustomize.libsonnet';

local config_ns = 'flux-system';

local flux_config = [
  kube.ConfigMap('any-old-app-version') {
    data+: {
      VERSION: std.extVar('VERSION'),
    },
  },
  example.gitrepository('any-old-app-prod') {
    spec+: {
      url: 'https://github.com/kingdonb/any_old_app',
    },
  },
] + kubecfg.parseYaml(importstr 'examples/configMap.yaml');

local kustomization = kustomize.applyList([
  kustomize.namespace(config_ns),
]);

local kustomization_output = std.map(kustomization, flux_config);

{ flux_config: kustomization_output } + {

  local items = ['test', 'prod'],

  joined: {
    [ns + '_flux_kustomization']: {
      data: example.any_old_app(ns) {
        spec+: {
          prune: if ns == 'prod' then false else true,
        },
      },
    }
    for ns in items

    // Credit:
    // https://groups.google.com/g/jsonnet/c/ky6sjYj4UZ0/m/d4lZxWbhAAAJ
    // thanks Dave for showing how to do something like this in Jsonnet
  },
}
```

--------------------------------

### Build artifact from directory and single manifest, list files

Source: https://fluxcd.io/flux/cmd/flux_build_artifact

Examples for building an artifact from a directory or a single manifest file, and listing the files in the artifact using tar.

```bash
  # Build the given manifests directory into an artifact
  flux build artifact --path ./path/to/local/manifests --output ./path/to/artifact.tgz

```

```bash
  # Build the given single manifest file into an artifact
  flux build artifact --path ./path/to/local/manifest.yaml --output ./path/to/artifact.tgz

```

```bash
  # List the files bundled in the artifact
  tar -ztvf ./path/to/artifact.tgz

```

--------------------------------

### Example output of kubectl get --raw /openid/v1/jwks

Source: https://fluxcd.io/flux/integrations/cross-cloud

Example output of `kubectl get --raw /openid/v1/jwks` showing the JWKS document structure with a single RSA signing key. The public key string is redacted for brevity.

```json
{
  "keys": [
    {
      "use": "sig",
      "kty": "RSA",
      "kid": "BfK54vFk8UqizgJVa1BfRfNl-C5c3mWwQ1o_-bA-yAo",
      "alg": "RS256",
      "n": "qN1iYk24aS<... very long redacted public key string ...>IvUY8e4wSaw",
      "e": "AQAB"
    }
  ]
}

```

--------------------------------

### flux bootstrap gitea examples

Source: https://fluxcd.io/flux/cmd/flux_bootstrap_gitea

Multiple examples demonstrating different bootstrap scenarios: exporting a Gitea token, bootstrapping for organizations, teams, public repositories, Gitea Enterprise with SSH/HTTPS, and existing repositories.

```bash
  # Create a Gitea personal access token and export it as an env var
  export GITEA_TOKEN=<my-token>

```

```bash
  # Run bootstrap for a private repository owned by a Gitea organization
  flux bootstrap gitea --owner=<organization> --repository=<repository name> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository and assign organization teams to it
  flux bootstrap gitea --owner=<organization> --repository=<repository name> --team=<team1 slug> --team=<team2 slug> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository and assign organization teams with their access level(e.g maintain, admin) to it
  flux bootstrap gitea --owner=<organization> --repository=<repository name> --team=<team1 slug>:<access-level> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a public repository on a personal account
  flux bootstrap gitea --owner=<user> --repository=<repository name> --private=false --personal=true --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository hosted on Gitea Enterprise using SSH auth
  flux bootstrap gitea --owner=<organization> --repository=<repository name> --hostname=<domain> --ssh-hostname=<domain> --path=clusters/my-cluster

```

```bash
  # Run bootstrap for a private repository hosted on Gitea Enterprise using HTTPS auth
  flux bootstrap gitea --owner=<organization> --repository=<repository name> --hostname=<domain> --token-auth --path=clusters/my-cluster

```

```bash
  # Run bootstrap for an existing repository with a branch named main
  flux bootstrap gitea --owner=<organization> --repository=<repository name> --branch=main --path=clusters/my-cluster

```

--------------------------------

### Docker Login Action with Private Registry

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Example of adding a registry setting to the Docker Login Action when using a private registry instead of the implicit Docker Hub registry.

```yaml
# for example
with:
  registry: registry.cloud.okteto.net

```

--------------------------------

### Delivery example for Kustomize overlays (GitRepository and Kustomization)

Source: https://fluxcd.io/flux/guides/repository-structure

Defines a GitRepository pointing to the app repo and a Kustomization that uses the production overlay from ./deploy/production.

```yaml
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
  name: app
spec:
  url: https://<host>/<org>/app
  ref:
    branch: main
---
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
  name: app
spec:
  sourceRef:
    kind: GitRepository
    name: app
  path: ./deploy/production

```

--------------------------------

### Deployment PodSpec using ${GIT_SHA} variable

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Example Deployment PodSpec that references the image using the ${GIT_SHA} variable, which is substituted from the ConfigMap by the Flux Kustomization. This is a template that should be adapted to your own deployment specifications.

```yaml
# flux/ some-example-deployment.yaml
spec:
  replicas: 1
  selector:
    matchLabels:
      app: any-old-app
  template:
    metadata:
      labels:
        app: any-old-app
    spec:
      containers:
      - image: kingdonb/any-old-app:${GIT_SHA}
        name: any-old-app

```

--------------------------------

### flux resume image repository usage examples

Source: https://fluxcd.io/flux/cmd/flux_resume_image_repository

Examples demonstrating the resume command for a single ImageRepository and for multiple ImageRepositories.

```bash
  # Resume reconciliation for an existing ImageRepository
  flux resume image repository alpine

  # Resume reconciliation for multiple ImageRepositories
  flux resume image repository alpine-1 alpine-2

```

--------------------------------

### Create orphan deploy branch

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

Commands to create an orphan deploy branch with an empty initial commit, used to prepare a separate deploy branch in the fleet-infra repository so the checkout starts with an empty workspace.

```bash
git checkout --orphan deploy
git reset --hard
git commit --allow-empty -m'initial empty commit'
git push origin deploy

```

--------------------------------

### Export Kustomization resources examples

Source: https://fluxcd.io/flux/cmd/flux_export_kustomization

Examples of exporting Kustomization resources. Use --all to export all resources to a file, or specify a name to export a single Kustomization.

```bash
  # Export all Kustomization resources
  flux export kustomization --all > kustomizations.yaml

  # Export a Kustomization
  flux export kustomization my-app > kustomization.yaml

```

--------------------------------

### Output of kubectl get helmrelease for podinfo

Source: https://fluxcd.io/flux/components/helm/helmreleases

Expected output of `kubectl get helmrelease` after applying the example, showing the podinfo HelmRelease is ready and its Helm tests succeeded.

```text
NAME      AGE   READY   STATUS
podinfo   15s   True    Helm test succeeded for release default/podinfo.v1 with chart podinfo@6.5.3: 3 test hooks completed successfully

```

--------------------------------

### Preview using a local flux kustomization file

Source: https://fluxcd.io/flux/cmd/flux_diff_kustomization

Example showing how to preview using a local flux kustomization file. Uses the --kustomization-file flag to specify the path to the local YAML file.

```shell
# Preview using a local flux kustomization file
flux diff kustomization my-app --path ./path/to/local/manifests \
	--kustomization-file ./path/to/local/my-app.yaml

```

--------------------------------

### Tenant ServiceAccount manifest from flux create tenant

Source: https://fluxcd.io/flux/use-cases/gh-actions-manifest-generation

ServiceAccount manifest generated by `flux create tenant prod --with-namespace prod --export`, used as a tenant for the prod namespace. For this example, discard the Namespace and ClusterRoleBinding; only the ServiceAccount is needed to patch.

```yaml
---
# manifests/examples/tenant.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  labels:
    toolkit.fluxcd.io/tenant: prod
  name: prod
  namespace: prod

```

--------------------------------

### flux get helmreleases showing install retries exhausted

Source: https://fluxcd.io/flux/cheatsheets/troubleshooting

Command to list Helm releases and identify 'install retries exhausted' errors, indicating health check failures.

```bash
$ flux get helmreleases --all-namespaces
NAMESPACE	NAME   	READY	MESSAGE
default  	podinfo	False 	install retries exhausted

```

--------------------------------

### flux create source git examples

Source: https://fluxcd.io/flux/cmd/flux_create_source_git

Examples of creating GitRepository sources with various configurations: public repositories, tags, semver ranges, SSH authentication with different key options, basic authentication, and cloud providers (AWS and Azure).

```bash
  # Create a source from a public Git repository master branch
  flux create source git podinfo \
    --url=https://github.com/stefanprodan/podinfo \
    --branch=master

  # Create a source for a Git repository pinned to specific git tag
  flux create source git podinfo \
    --url=https://github.com/stefanprodan/podinfo \
    --tag="3.2.3"

  # Create a source from a public Git repository tag that matches a semver range
  flux create source git podinfo \
    --url=https://github.com/stefanprodan/podinfo \
    --tag-semver=">=3.2.0 <3.3.0"

  # Create a source for a Git repository using SSH authentication
  flux create source git podinfo \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --branch=master

  # Create a source for a Git repository using SSH authentication and an
  # ECDSA P-521 curve public key
  flux create source git podinfo \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --branch=master \
    --ssh-key-algorithm=ecdsa \
    --ssh-ecdsa-curve=p521

  # Create a source for a Git repository using SSH authentication and a
  #	passwordless private key from file
  # The public SSH host key will still be gathered from the host
  flux create source git podinfo \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --branch=master \
    --private-key-file=./private.key

  # Create a source for a Git repository using SSH authentication and a
  # private key with a password from file
  # The public SSH host key will still be gathered from the host
  flux create source git podinfo \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --branch=master \
    --private-key-file=./private.key \
    --password=<password>

  # Create a source for a Git repository using basic authentication
  flux create source git podinfo \
    --url=https://github.com/stefanprodan/podinfo \
    --branch=master \
    --username=username \
    --password=password

  # Create a source for a Git repository using AWS CodeCommit with IAM credentials
  flux create source git podinfo \
    --url=https://git-codecommit.<region>.amazonaws.com/v1/repos/podinfo \
    --branch=master \
    --provider=aws

  # Create a source for a Git repository using azure provider
  flux create source git podinfo \
    --url=https://dev.azure.com/foo/bar/_git/podinfo \
    --branch=master \
    --provider=azure
```

--------------------------------

### flux bootstrap bitbucket-server usage examples

Source: https://fluxcd.io/flux/cmd/flux_bootstrap_bitbucket-server

Provides example invocations of the flux bootstrap bitbucket-server command for various scenarios: exporting a Bitbucket Server API token, bootstrapping a private repository with HTTPS token authentication, bootstrapping with SSH authentication, bootstrapping a public repository on a personal account, and bootstrapping an existing repository with a branch named main. Each example uses placeholder values for owner, username, repository, hostname, and path.

```bash
  # Create a Bitbucket Server API token and export it as an env var
  export BITBUCKET_TOKEN=<my-token>

  # Run bootstrap for a private repository using HTTPS token authentication
  flux bootstrap bitbucket-server --owner=<project> --username=<user> --repository=<repository name> --hostname=<domain> --token-auth --path=clusters/my-cluster

  # Run bootstrap for a private repository using SSH authentication
  flux bootstrap bitbucket-server --owner=<project> --username=<user> --repository=<repository name> --hostname=<domain> --path=clusters/my-cluster

  # Run bootstrap for a public repository on a personal account
  flux bootstrap bitbucket-server --owner=<user> --repository=<repository name> --private=false --personal --hostname=<domain> --token-auth --path=clusters/my-cluster

  # Run bootstrap for an existing repository with a branch named main
  flux bootstrap bitbucket-server --owner=<project> --username=<user> --repository=<repository name> --branch=main --hostname=<domain> --token-auth --path=clusters/my-cluster

```

--------------------------------

### flux get sources helm usage examples

Source: https://fluxcd.io/flux/cmd/flux_get_sources_helm

Two usage examples: the first lists all Helm repositories and their status, the second lists Helm repositories from all namespaces using the --all-namespaces flag.

```bash
  # List all Helm repositories and their status
  flux get sources helm

 # List Helm repositories from all namespaces
  flux get sources helm --all-namespaces

```

--------------------------------

### List all Providers and their status

Source: https://fluxcd.io/flux/cmd/flux_get_alert-providers

Example command to list all Providers and their status using flux get alert-providers.

```bash
  # List all Providers and their status
  flux get alert-providers

```

--------------------------------

### kubectl get helmchart output

Source: https://fluxcd.io/flux/components/source/helmcharts

Example output of `kubectl get helmchart` showing the HelmChart podinfo with version '5.*', source HelmRepository podinfo, and status 'pulled 'podinfo' chart with version '5.2.1''.

```text
NAME      CHART     VERSION   SOURCE KIND      SOURCE NAME   AGE   READY   STATUS                                     
podinfo   podinfo   5.*       HelmRepository   podinfo       53s   True    pulled 'podinfo' chart with version '5.2.1'

```

--------------------------------

### flux tree kustomization examples

Source: https://fluxcd.io/flux/cmd/flux_tree_kustomization

Two examples: one prints resources managed by the root Kustomization, and the other prints only Flux resources using the --compact flag.

```bash
  # Print the resources managed by the root Kustomization
  flux tree kustomization flux-system

  # Print the Flux resources managed by the root Kustomization
  flux tree kustomization flux-system --compact

```

--------------------------------

### Get Azure Event Hub Connection String

Source: https://fluxcd.io/flux/components/notification/providers

Command to get the default Root SAS connection string for an Azure Event Hub. The output is shown as an example. The default Root SAS is NOT supposed to be used in production.

```bash
az eventhubs namespace authorization-rule keys list --resource-group <rg-name> --namespace-name <namespace-name> --name RootManageSharedAccessKey -o tsv --query primaryConnectionString
# The output should look something like this:
Endpoint=sb://fluxv2.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yoursaskeygeneatedbyazure;EntityPath=youreventhub

```

--------------------------------

### flux get sources all - list all sources

Source: https://fluxcd.io/flux/cmd/flux_get_sources_all

The first block is the command syntax for the flux get sources all command id. The second block shows two examples of using the command with flags to list sources in a specific namespace or across all namespaces.

```bash
flux get sources all [flags]
```

```bash
  # List all sources in a namespace
  flux get sources all --namespace=flux-system

  # List all sources in all namespaces
  flux get sources all --all-namespaces
```

--------------------------------

### Display Deployment manifest with image reference

Source: https://fluxcd.io/flux/migration/flux-v1-automation-migration

Shows the example Deployment manifest with the image reference highlighted. The image repository is the image reference minus its tag.

```bash
$ cat $CLUSTER_PATH/app/my-app.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
  namespace: default
  annotations:
    fluxcd.io/automated: "true"
    fluxcd.io/tag.app: semver:^5.0
spec:
  template:
    spec:
      containers:
      - name: app
        image: ghcr.io/stefanprodan/podinfo:5.0.0 # <-- image reference

```

--------------------------------

### List image policies with flux get image policy

Source: https://fluxcd.io/flux/cmd/flux_get_images_policy

Two example invocations of the flux get image policy command. The first lists all image policies and their status; the second lists image policies from all namespaces using the --all-namespaces flag.

```bash
  # List all image policies and their status
  flux get image policy

```

```bash
 # List image policies from all namespaces
  flux get image policy --all-namespaces

```

--------------------------------

### Export Provider resources examples

Source: https://fluxcd.io/flux/cmd/flux_export_alert-provider

Examples of exporting all Provider resources to a file and exporting a single Provider by name.

```bash
  # Export all Provider resources
  flux export alert-provider --all > alert-providers.yaml

  # Export a Provider
  flux export alert-provider slack > slack.yaml

```

--------------------------------

### Import a Flux package with go get

Source: https://fluxcd.io/flux/releases/packages

Use this command to import or update a Flux package in a Go project. The example fetches the runtime package at version v1.0.0.

```shell
go get github.com/fluxcd/pkg/runtime@v1.0.0

```

--------------------------------

### Explain a resource with the ecosystem catalog (short form)

Source: https://fluxcd.io/flux/cli-plugins/flux-schema/explain

Use `-s ecosystem` to explain a resource from the hosted catalog. This example uses the short resource name `hr`.

```bash
flux schema explain hr.spec -s ecosystem

```

--------------------------------

### Output Format of flux schema build

Source: https://fluxcd.io/flux/cli-plugins/flux-schema/manifests-build

Example output of the flux schema build command. Each document is preceded by a # Source: comment, and resources built from a file also get an # Origin: comment.

```yaml
---
# Source: clusters/production
# Origin: apps/base/podinfo/release.yaml
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
...
---
# Source: infrastructure/sources.yaml
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
...
```

--------------------------------

### List image objects with flux get images all

Source: https://fluxcd.io/flux/cmd/flux_get_images_all

Examples of listing image objects in a specific namespace or across all namespaces. Use --namespace to filter by namespace and --all-namespaces to list across all namespaces.

```bash
  # List all image objects in a namespace
  flux get images all --namespace=flux-system

  # List all image objects in all namespaces
  flux get images all --all-namespaces

```

--------------------------------

### flux mirror sync configuration source examples

Source: https://fluxcd.io/flux/cli-plugins/flux-mirror/sync

Examples of providing the config path: as a positional argument, via stdin with `-`, or via the `FLUX_MIRROR_CONFIG` environment variable. If neither is set, the command errors.

```bash
flux mirror sync ./flux-mirror.yaml

```

```bash
flux mirror sync - < ./flux-mirror.yaml

```

```bash
FLUX_MIRROR_CONFIG=./flux-mirror.yaml flux mirror sync

```

--------------------------------

### Setup Flux CLI in GitHub Actions

Source: https://fluxcd.io/flux/flux-gh-action

Use this GitHub Actions workflow step to install the Flux CLI in your CI pipeline. The `version` input defaults to the latest stable release, and `bindir` defaults to a path relative to `$RUNNER_TOOL_CACHE`.

```yaml
- name: Setup Flux CLI
  uses: fluxcd/flux2/action@main
  with:
    # Flux CLI version e.g. 2.0.0.
    # Defaults to latest stable release.
    version: 'latest'

    # Alternative download location for the Flux CLI binary.
    # Defaults to path relative to $RUNNER_TOOL_CACHE.
    bindir: ''

```

--------------------------------

### flux create secret git examples

Source: https://fluxcd.io/flux/cmd/flux_create_secret_git

Examples of creating Git SSH and basic authentication secrets, exporting to a file, printing the deploy key, and encrypting with SOPS.

```bash
  # Create a Git SSH authentication secret using an ECDSA P-521 curve public key

  flux create secret git podinfo-auth \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --ssh-key-algorithm=ecdsa \
    --ssh-ecdsa-curve=p521

  # Create a Git SSH authentication secret with a passwordless private key from file
  # The public SSH host key will still be gathered from the host
  flux create secret git podinfo-auth \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --private-key-file=./private.key

  # Create a Git SSH authentication secret with a passworded private key from file
  # The public SSH host key will still be gathered from the host
  flux create secret git podinfo-auth \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --private-key-file=./private.key \
    --password=<password>

  # Create a secret for a Git repository using basic authentication
  flux create secret git podinfo-auth \
    --url=https://github.com/stefanprodan/podinfo \
    --username=username \
    --password=password

  # Create a Git SSH secret on disk
  flux create secret git podinfo-auth \
    --url=ssh://git@github.com/stefanprodan/podinfo \
    --export > podinfo-auth.yaml

  # Print the deploy key
  yq eval '.stringData."identity.pub"' podinfo-auth.yaml

  # Encrypt the secret on disk with Mozilla SOPS
  sops --encrypt --encrypted-regex '^(data|stringData)$' \
    --in-place podinfo-auth.yaml

```

--------------------------------

### AmazonS3ReadOnlyAccess policy JSON

Source: https://fluxcd.io/flux/integrations/aws

Example of an AWS-managed policy document that grants read-only access to S3 and S3 Object Lambda. The policy allows Get, List, and Describe actions on all resources. This is the structure of the policy named AmazonS3ReadOnlyAccess with ARN arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:Get*",
                "s3:List*",
                "s3:Describe*",
                "s3-object-lambda:Get*",
                "s3-object-lambda:List*"
            ],
            "Resource": "*"
        }
    ]
}
```

--------------------------------

### Example: Trigger reconciliation for an existing source

Source: https://fluxcd.io/flux/cmd/flux_reconcile_source_oci

Example command to trigger a reconciliation for an existing OCIRepository source named 'podinfo'.

```bash
# Trigger a reconciliation for an existing source
flux reconcile source oci podinfo

```
Tokens:
Raw