Customize clusterAPI

Customize clusterAPI settings

The clusterAPI component allows you to quickly create managed clusters and manage them in the Verrazzano console. See Cluster API for more information.

You can customize the clusterAPI component using component overrides in the Verrazzano custom resource. Refer to the clusterAPI reference to see which overrides are available.

Upgrade providers

You can upgrade the individual providers that make up the clusterAPI component. This allows you to take advantage of new features in the providers without upgrading your entire Verrazzano installation.

This example customizes the clusterAPI component as follows:

  • Sets the version of both the OCNE bootstrap provider and the OCNE control plane provider to 1.6.1

    NOTE: Because the OCNE bootstrap and OCNE control plane providers are bundled together, make sure to set their overrides to the same version or it may lead to unexpected behavior.

  • Sets the version of the OCI infrastructure provider to 0.9.0

apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: example-verrazzano
spec:
  profile: dev
  components:
   clusterAPI:
       enabled: true
       overrides:
       - values:
           defaultProviders:
               ocneBootstrap:
                   version: 1.6.1
               ocneControlPlane:
                   version: 1.6.1
               oci:
                   version: v0.9.0

Use a private registry

If you want to upgrade the clusterAPI providers but your Verrazzano instance is installed in a disconnected environment, you can configure the clusterAPI component to retrieve the provider assets from another location, instead of the public repository.

  1. Place the provider assets in a location that is accessible by your disconnected Verrazzano environment.
  2. For each provider that you want to upgrade, add a url override and then enter the path to the provider assets in the private registry for your environment.

For example:

apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: example-verrazzano
spec:
  profile: dev
  components:
   clusterAPI:
       enabled: true
       overrides:
       - values:
           defaultProviders:
               ocneBootstrap:
                   url: https://my.private.network/cluster-api-provider-ocne/releases/tag/v1.6.1
               ocneControlPlane:
                   url: https://my.private.network/cluster-api-provider-ocne/releases/tag/v1.6.1
               oci:
                   url: https://my.private.network/cluster-api-provider-oci/releases/tag/v0.9.0