Skip to content

Commit

Permalink
Add migrateResources field to API docs
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
  • Loading branch information
stefanprodan committed Aug 29, 2024
1 parent 5fef8e0 commit 5e6e6ea
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/api/v1/fluxinstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,16 @@ stringData:
secretkey: "my-secretkey"
```

### Resources migration configuration

The `.spec.migrateResources` field is optional and instructs the operator to migrate
the Flux custom resources stored in Kubernetes etcd to the latest API version as
specified in the Flux CRDs. The migration runs after the Flux distribution is upgraded
from a minor version to another and only when a new API version is introduced.

By default, the field value is set to `true`. Note that disabling the migration may
result in upgrade failures due to deprecated API versions being removed in future Flux releases.

## FluxInstance Status

### Conditions
Expand Down

0 comments on commit 5e6e6ea

Please sign in to comment.