Upgrade Verrazzano

It is important to distinguish between updating the Verrazzano platform operator versus upgrading the Verrazzano installation. The platform operator contains the newer component charts and image versions, so it must be updated prior to upgrading the installation. Updating the platform operator has no effect on an existing installation until you initiate the Verrazzano installation upgrade. Currently, there is no way to roll back either the platform operator update or the Verrazzano installation upgrade.

NOTE: For upgrading to Verrazzano v1.7 or later, before initiating an upgrade, we recommend that you back up your existing OpenSearch cluster using Velero. For the backup process, follow the Backup documentation for your existing Verrazzano version, not the version to which you are upgrading. Also, before you start the upgrade, we advise that you make sure that the OpenSearch cluster health is green.

You can upgrade Verrazzano using the Verrazzano CLI or with kubectl. See the following respective sections.

Upgrade Verrazzano using the CLI

In one simple step, you can upgrade to a specified version of Verrazzano using this command.

  1. Update the Verrazzano resource to the desired version.

    To update to the latest version (default): 

    $ vz upgrade

    To update to a specific version, where <version> is the desired version:

    $ vz upgrade --version <version>

  2. Wait for the upgrade to complete. Upgrade logs will be streamed to the command window until the upgrade has completed or until the default timeout (30m) has been reached.

Upgrade using kubectl

Upgrading an existing Verrazzano installation using kubectl is a two-step process:

  • Update the Verrazzano platform operator to the Verrazzano release version to which you want to upgrade.
  • Upgrade the Verrazzano installation.

Update the Verrazzano platform operator

In order to upgrade an existing Verrazzano installation, you must first update the Verrazzano platform operator.

  1. Update the Verrazzano platform operator.

    NOTE: If you are using a private container registry, then to update the platform operator, follow the instructions at Install Verrazzano in a Disconnected Environment.

    To update to the latest version: 

    $ kubectl apply -f https://github.com/verrazzano/verrazzano/releases/download/v1.7.2/verrazzano-platform-operator.yaml

    To update to a specific version, where <version> is the desired version: 

    # To update to the desired version:
$ kubectl apply -f https://github.com/verrazzano/verrazzano/releases/download/<version>/verrazzano-platform-operator.yaml

  2. Wait for the deployment to complete. 

    $ kubectl -n verrazzano-install rollout status deployment/verrazzano-platform-operator

    # Expected response
deployment "verrazzano-platform-operator" successfully rolled out

  3. Confirm that the operator pod is correctly defined and running. 

    $ kubectl -n verrazzano-install get pods

    # Sample output
NAME                                            READY   STATUS    RESTARTS   AGE
verrazzano-platform-operator-59d5c585fd-lwhsx   1/1     Running   0          114s

Upgrade Verrazzano

To upgrade the Verrazzano installation, you need to change the version of your installed Verrazzano resource to the version supported by the Verrazzano platform operator.

NOTE: You may only change the version field during an upgrade; changes to other fields or component configurations are not supported at this time.

In one simple step, you can upgrade to a specified version of Verrazzano using this command. 

$ kubectl patch vz example-verrazzano -p '{"spec":{"version":"v1.7.2"}}' --type=merge

Alternatively, you can upgrade the Verrazzano installation using the following steps.

  1. Update the Verrazzano resource to the desired version.

    To upgrade the Verrazzano components, you must update the version field in your Verrazzano resource specification to match the version supported by the platform operator to which you upgraded and apply it to the cluster.

    The value of the version field in the resource specification must be a Semantic Versioning value corresponding to a valid Verrazzano release version.

    To update the resource, do one of the following:

    a. Edit the YAML file you used to install Verrazzano and set the version field to the latest version.

    For example, to upgrade to v1.7.2, your YAML file should be edited to add or update the version field. 

    apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: example-verrazzano
spec:
   profile: dev
   version: v1.7.2

    Then, apply the resource to the cluster (if you have not edited the resource in-place using kubectl edit). 

    $ kubectl apply -f example-verrazzano.yaml
    b. Edit the Verrazzano resource directly using kubectl and set the version field directly, for example: 
    $ kubectl edit verrazzano example-verrazzano
# In the resource editor, add or update the version field to "version: v1.7.2", then save.

  2. Wait for the upgrade to complete. 

    $ kubectl wait \
    --timeout=30m \
    --for=condition=UpgradeComplete verrazzano/example-verrazzano