Last modified November 29, 2024

'kubectl gs gitops add automatic-update' command reference

This command adds configuration to automatically update an App into a GitOps repository.

Prerequisites

Your GitOps repository should provide the following structural layers:

Basic structure (see init)
Management cluster (see add management-cluster)
Organization (see add organization)
Workload cluster (see add workload-cluster)
Apps (see add app)

Description

The structure created by this command is presented below. Resources enclosed in square brackets [] are considered optional.

management-clusters/MC_NAME/organizations/ORG_NAME/workload-clusters/[mapi/]
├── automatic-updates
│   └── imageupdate.yaml
└── apps
    ├── kustomization.yaml
    └── APP_NAME
        ├── appcr.yaml
        ├── imagepolicy.yaml
        └── imagerepository.yaml

Note, automatic update requires the appcr.yaml file and hence can only be configured for directly added apps. For apps coming from a base updates must be configured in the base instead, what is outside of the command’s scope.

Usage

Basic command syntax: kubectl gs gitops add automatic-update FLAGS.

Flags

--app – name of the App in the repository to configure automatic update for (required)
--management-cluster – name of the management cluster the workload cluster belongs to (required)
--organization – name of the organization the workload cluster belongs to (required)
--version-repository – the container image repository to update the version from. (required)
--workload-cluster – name of the workload cluster to configure the app for (required)
--skip-mapi – skip mapi directory when adding the app

The following flags are supported by all gitops subcommands:

--dry-run – Print files and directories instead of creating them.
--local-path – Path to the repository root folder (default “.”).

kubectl gs gitops add automatic-update \
  --local-path /tmp/gitops-demo \
  --management-cluster demomc \
  --organization demoorg \
  --workload-cluster demowc \
  --app hello-world \
  --version-repository giantswarmpublic.azurecr.io/giantswarm-catalog/hello-world \
  --repository gitops-demo \
  --dry-run

Output:

## CREATE ##
/tmp/gitops-demo/management-clusters/demomc/organizations/demoorg/workload-clusters/demowc/mapi/automatic-updates
/tmp/gitops-demo/management-clusters/demomc/organizations/demoorg/workload-clusters/demowc/mapi/automatic-updates/imageupdate.yaml
apiVersion: image.toolkit.fluxcd.io/v1beta1
kind: ImageUpdateAutomation
metadata:
  name: demomc-updates
  namespace: default
spec:
  git:
    checkout:
      ref:
        branch: main
    commit:
      author:
        email: fluxcdbot@users.noreply.github.com
        name: fluxcdbot
      messageTemplate: |
        automated app upgrades:
        {{ range $image, $_ := .Updated.Images -}}
        - {{ $image.Repository }} to {{ $image.Identifier }}
        {{ end -}}
    push:
      branch: main
  interval: 1m0s
  sourceRef:
    kind: GitRepository
    name: gitops-demo
  update:
    path: ./management-clusters/demomc
    strategy: Setters

/tmp/gitops-demo/management-clusters/demomc/organizations/demoorg/workload-clusters/demowc/mapi/apps/hello-world/imagepolicy.yaml
apiVersion: image.toolkit.fluxcd.io/v1beta1
kind: ImagePolicy
metadata:
  name: demowc-hello-world
spec:
  imageRepositoryRef:
    name: demowc-hello-world
  policy:
    semver:
      range: '>=0.0.0'

/tmp/gitops-demo/management-clusters/demomc/organizations/demoorg/workload-clusters/demowc/mapi/apps/hello-world/imagerepository.yaml
apiVersion: image.toolkit.fluxcd.io/v1beta1
kind: ImageRepository
metadata:
  name: demowc-hello-world
spec:
  image: giantswarmpublic.azurecr.io/giantswarm-catalog/hello-world
  interval: 10m0s


## MODIFY ##
/tmp/gitops-demo/management-clusters/demomc/organizations/demoorg/workload-clusters/demowc/mapi/apps/hello-world/appcr.yaml
apiVersion: application.giantswarm.io/v1alpha1
kind: App
metadata:
  name: demowc-hello-world
spec:
  catalog: giantswarm
  name: hello-world
  namespace: default
  version: 0.3.0 # {"$imagepolicy": "org-demoorg:demowc-hello-world:tag"}

/tmp/gitops-demo/management-clusters/demomc/organizations/demoorg/workload-clusters/demowc/mapi/apps/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
commonLabels:
  giantswarm.io/cluster: ${cluster_name}
  giantswarm.io/managed-by: flux
kind: Kustomization
namespace: org-${organization}
patches:
- path: patch_cluster_config.yaml
  target:
    kind: App
resources:
- hello-world/appcr.yaml
- hello-world/imagepolicy.yaml
- hello-world/imagerepository.yaml

Upon trying to configure automatic updates for app coming from a base, the command will return an error.

kubectl gs gitops add automatic-update \
  --local-path /tmp/gitops-demo \
  --management-cluster demomc \
  --organization demoorg \
  --workload-cluster demowc \
  --app hello-world \
  --version-repository giantswarmpublic.azurecr.io/giantswarm-catalog/hello-world \
  --repository gitops-demo \
  --dry-run

Output:

validation error: Operation cannot be fulfilled on directory missing the `appcr.yaml` file.

Remove the --dry-run flag and re-run it to apply the changes.

Need help, got feedback?

We listen to your Slack support channel. You can also reach us at support@giantswarm.io. And of course, we welcome your pull requests!