Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Update docs on annotations in HelmReleases #2670

Merged
merged 2 commits into from
Dec 10, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/references/helm-operator-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ values:
These can appear at the top level (immediately under `values:`), or in
a subsection (under a key, itself under `values:`). Other values
may be mixed in arbitrarily. Here's an example of a values section
that specifies two images, along with some other configuration:
that specifies two images:

```yaml
values:
Expand All @@ -88,25 +88,25 @@ If Flux does not automatically detect your image, it is possible to
map the image paths by alias with YAML dot notation annotations. An
alias overrules a detected image.

The following annotations are available, you need to at least specify
the `repository.fluxcd.io` annotation:
The following annotations are available, and `repository.fluxcd.io`
is required for any of these to take effect.

| Annotation | |
|-------------------------------|------------------|
|`registry.fludcd.io/<alias>` | `sub.reg` |
| `repository.fluxcd.io/<alias>`| `sub.repo` |
| `tag.fluxcd.io/<alias>` | `sub.tag` |
| `filter.fluxcd.io/<alias>` | `glob: master-*` |
| Annotation | Value | Required? |
|------------------------------------|------------------| :---: |
| **`repository.fluxcd.io/<alias>`** | `sub.repo` | ✅ |
| `registry.fluxcd.io/<alias>` | `sub.reg` | |
| `tag.fluxcd.io/<alias>` | `sub.tag` | |
| `filter.fluxcd.io/<alias>` | `glob: master-*` | |

Two images specified in a `HelmRelease` as an example:
The following example `HelmRelease` specifies two images:

```yaml
metadata:
annotations:
# image and tag
repository.fluxcd.io/app: appImage
tag.fluxcd.io/app: appTag
filter.tag/app: 'glob: *'
filter.fluxcd.io/app: 'glob: *'
# nested image with registry and tag
registry.fluxcd.io/submarine: sub.marinesystem.reg
repository.fluxcd.io/submarine: sub.marinesystem.img
Expand All @@ -125,7 +125,7 @@ spec:
tag: version
```

#### Filter
#### Filters

You can use the [same annotations](fluxctl.md) in
the `HelmRelease` as you would for a Deployment or other workload,
Expand All @@ -142,7 +142,7 @@ kind: HelmRelease
metadata:
annotations:
fluxcd.io/automated: "true"
fluxcd.io/tag.chart-image: semver:~4.0
filter.fluxcd.io/chart-image: semver:~4.0
spec:
values:
image:
Expand All @@ -157,8 +157,8 @@ kind: HelmRelease
metadata:
annotations:
fluxcd.io/automated: "true"
fluxcd.io/tag.prometheus: semver:~2.3
fluxcd.io/tag.alertmanager: glob:v0.15.*
filter.fluxcd.io/prometheus: semver:~2.3
filter.fluxcd.io/alertmanager: glob:v0.15.*
filter.fluxcd.io/nats: regex:^0.6.*
spec:
values:
Expand Down