actions/fluxcd-flux2
3
0
Fork 0
mirror of https://github.com/fluxcd/flux2.git synced 2026-02-27 09:54:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Update image automation guide to v1alpha2 APIs

Browse source 
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
This commit is contained in:
Stefan Prodan 2021-04-22 20:10:32 +03:00
parent 4f66da84d6
commit fb3a434f95
No known key found for this signature in database
GPG key ID: 3299AEB0E4085BAF
1 changed files with 47 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
docs/guides/image-update.md
View file

@ -138,7 +138,7 @@ flux create image repository podinfo \
The above command generates the following manifest:
```yaml
apiVersion: image.toolkit.fluxcd.io/v1alpha1
apiVersion: image.toolkit.fluxcd.io/v1alpha2
kind: ImageRepository
metadata:
name: podinfo
@ -177,7 +177,7 @@ flux create image policy podinfo \
The above command generates the following manifest:
```yaml
apiVersion: image.toolkit.fluxcd.io/v1alpha1
apiVersion: image.toolkit.fluxcd.io/v1alpha2
kind: ImagePolicy
metadata:
name: podinfo
@ -258,21 +258,25 @@ flux create image update flux-system \
The above command generates the following manifest:
```yaml
apiVersion: image.toolkit.fluxcd.io/v1alpha1
apiVersion: image.toolkit.fluxcd.io/v1alpha2
kind: ImageUpdateAutomation
metadata:
name: flux-system
namespace: flux-system
spec:
checkout:
branch: main
gitRepositoryRef:
name: flux-system
commit:
authorEmail: fluxcdbot@users.noreply.github.com
authorName: fluxcdbot
messageTemplate: '{{range .Updated.Images}}{{println .}}{{end}}'
interval: 1m0s
sourceRef:
kind: GitRepository
name: flux-system
git:
checkout:
ref:
branch: main
commit:
author:
email: fluxcdbot@users.noreply.github.com
name: fluxcdbot
messageTemplate: '{{range .Updated.Images}}{{println .}}{{end}}'
push:
branch: main
update:
@ -387,21 +391,20 @@ images:
## Push updates to a different branch
With `.spec.push.branch` you can configure Flux to push the image updates to different branch
With `.spec.git.push.branch` you can configure Flux to push the image updates to different branch
than the one used for checkout. If the specified branch doesn't exist, Flux will create it for you.
```yaml
apiVersion: image.toolkit.fluxcd.io/v1alpha1
kind: ImageUpdateAutomation
metadata:
name: flux-system
spec:
git:
checkout:
ref:
branch: main
gitRepositoryRef:
name: flux-system
push:
branch: image-updates
branch: flux-image-updates
```
You can use CI automation e.g. GitHub Actions such as
@ -412,17 +415,17 @@ This way you can manually approve the image updates before they are applied on y
## Configure the commit message
The `.spec.commit.messageTemplate` field is a string which is used as a template for the commit message.
The `.spec.git.commit.messageTemplate` field is a string which is used as a template for the commit message.
The message template is a [Go text template](https://golang.org/pkg/text/template/) that
lets you range over the objects and images e.g.:
```yaml
apiVersion: image.toolkit.fluxcd.io/v1alpha1
kind: ImageUpdateAutomation
metadata:
name: flux-system
spec:
git:
commit:
messageTemplate: |
Automated image update
@ -443,8 +446,9 @@ spec:
{{ range .Updated.Images -}}
- {{.}}
{{ end -}}
authorEmail: flux@example.com
authorName: flux
author:
email: fluxcdbot@users.noreply.github.com
name: fluxcdbot
```
## Trigger image updates with webhooks
@ -884,7 +888,7 @@ Create a directory in your control repository and save this `kustomization.yaml`
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- git@github.com/fluxcd/flux2//manifests/integrations/registry-credentials-sync/azure
- https://github.com/fluxcd/flux2/manifests/integrations/registry-credentials-sync/azure?ref=main
patchesStrategicMerge:
- config-patches.yaml
```