Skip to content

Commit 4ff69ef

Browse files
committed
Document CAPIProvider EnableAutomaticUpdate feature
Signed-off-by: Andrea Mazzotti <[email protected]>
1 parent 3d5ebbd commit 4ff69ef

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/next/modules/en/pages/reference/capiprovider.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ metadata:
2929
spec:
3030
name: aws
3131
type: infrastructure
32+
enableAutomaticUpdate: true
3233
credentials:
3334
rancherCloudCredential: aws-creds # Rancher credentials secret for AWS
3435
configSecret:
@@ -52,11 +53,17 @@ The key fields in the `CAPIProvider` spec are:
5253
* `features` - Enabled provider features.
5354
* `variables` - Variables is a map of environment variables to add to the content of the `configSecret`.
5455
* `version` - Version indicates the provider version.
56+
* `enableAutomaticUpdate` - Allow the provider to update automatically. Only enabled by default on Turtles chart installed providers.
5557
* `fetchConfig` - FetchConfig determines how the operator will fetch the components and metadata for the provider.
5658
** `oci` - OCI to be used for fetching the provider’s components and metadata from an OCI artifact. You must set `providerSpec.Version` field for operator to pick up desired version of the release from GitHub. If the providerSpec.Version is missing, latest provider version from clusterctl defaults is used.
5759
** `selector` - Selector to be used for fetching provider’s components and metadata from ConfigMaps stored inside the cluster. Each ConfigMap is expected to contain components and metadata for a specific version only.
5860
** `url` - URL to be used for fetching the provider’s components and metadata from a remote Github repository.
5961

62+
== Version pinning and automatic updates
63+
64+
The `CAPIProvider` `version` can be set at any time to pin the provider to a specific version. +
65+
Additionally, `automaticUpdates` can be toggled to allow automatic updates to the latest version available. The latest version available is determined by the embedded clusterctl configuration for xref:../overview/certified.adoc[certified] providers, and it can be overridden or configured for custom providers using xref:../reference/clusterctlconfig.adoc[ClusterctlConfig].
66+
6067
== Deletion
6168

6269
When a `CAPIProvider` resource is deleted, the Kubernetes garbage collection will clean up all the generated provider resources that it owns. This includes:

0 commit comments

Comments
 (0)