Flux: Missing documentation for annotations

[eimarfandino]

I miss in the flux documentation a full list of the different types of annotations that can be used. I see two examples but not a clear list of what can be used.

here the examples that are documented:

• https://github.com/weaveworks/flux/blob/91ec3fd66782289407bc88ca15885102dc52d9f3/site/fluxctl.md#using-annotations
• https://github.com/weaveworks/flux/blob/c2dfbf585252657b4ea4f0c4c54d4fe0c9d5bacf/site/annotations-tutorial.md

[stefanprodan]

I'll make the list here and do a PR for it after we decide on #1262

On/off:

# container image automated updates
flux.weave.works/automated: "true"

# lock image updates even if automated is enabled
flux.weave.works/locked: "true"
flux.weave.works/locked_msg: "Halt updates for now, latest release is buggy"
flux.weave.works/locked_user: "Stefan Prodan <[email protected]>"

# do not apply this manifest on the cluster
flux.weave.works/ignore: "true"

Deployment/StatefulSet/DaemonSet container image filters (automated must be enabled):

# semantic versioning
flux.weave.works/tag.<container-name>: semver:<expression>

# glob 
flux.weave.works/tag.<container-name>: glob:<expression>

# regular expression 
flux.weave.works/tag.<container-name>: regexp:<expression>

HelmRelease image filters (automated must be enabled):

Single image (top element):

kind: HelmRelease
metadata:
  annotations:
    flux.weave.works/automated: "true"
    flux.weave.works/tag.chart-image: semver:~4.0
spec:
  values:
    image:
      repository: bitnami/mongodb
      tag: 4.0.3

Named images:

kind: HelmRelease
metadata:
  annotations:
    flux.weave.works/automated: "true"
    flux.weave.works/tag.prometheus: semver:~2.3
    flux.weave.works/tag.alertmanager: glob:v0.15.*
    flux.weave.works/tag.nats: regex:^0.6.*
spec:
  values:
    prometheus:
      image: prom/prometheus:v2.3.1
    alertmanager:
      image: prom/alertmanager:v0.15.0
    nats:
      image: nats-streaming:0.6.0

[eimarfandino]

thanks @stefanprodan

[stefanprodan]

We now have:

• Deployments annotations docs: https://docs.fluxcd.io/en/stable/references/automated-image-update.html
• HelmReleses annotations docs: https://docs.fluxcd.io/en/stable/references/helm-operator-integration.html