CLI Setup

Install the Verrazzano command-line tool (optional)

The Verrazzano command-line tool, vz, is available for Linux and Mac systems. Download the binary you want from the Releases page.

Install the vz CLI

These instructions demonstrate installing the CLI on Linux AMD64 machines.

Download the latest release

 $ curl -LO

Validate the binary (optional)

Download the vz checksum file.

 $ curl -LO

Validate the vz binary against the checksum file.

$ sha256sum -c verrazzano-1.7.1-linux-amd64.tar.gz.sha256

Unpack and copy the vz binary

 $ tar xvf verrazzano-1.7.1-linux-amd64.tar.gz

The following command needs to be run as root.

 $ sudo cp verrazzano-1.7.1/bin/vz /usr/local/bin

Test to ensure that the version you installed is up-to-date

 $ vz version

The resulting output should be similar to the following.

Version: v1.7.1
BuildDate: 2023-02-12T21:07:26Z
GitCommit: cb0778bbf7a2cd90e1ae8458abd242f9da27a100

Use the vz CLI

Verrazzano provides a command-line tool for managing a Verrazzano environment using the Verrazzano and Kubernetes API.

Common use cases include installing, upgrading, and uninstalling Verrazzano, as well as analyzing failures in a running Verrazzano environment.

Usage information

Use the following syntax to run vz commands from your terminal window.

vz [command] [flags]

Available commands

Command Definition
analyze Analyze cluster
bug-report Collect information from the cluster to report an issue
completion Generate the autocompletion script for the specified shell
help Help about any command
install Install Verrazzano
status Status of the Verrazzano installation and access endpoints
uninstall Uninstall Verrazzano
upgrade Upgrade Verrazzano
version Verrazzano version information

Available Flags

These flags apply to all the commands.

Flag Definition
--context string The name of the kubeconfig file context to use.
-h, --help Help for vz.
--kubeconfig string Path to the kubeconfig file to use.