Install Verrazzano in a Disconnected Environment

If you are running in a disconnected environment (without access to the internet), then you will need to install Verrazzano using a private container registry. However, you may choose to install Verrazzano using a private registry even if you are not running in a disconnected environment.

Prerequisites

You will need to connect to the internet to download the Verrazzano images and Verrazzano distribution.
You will need a way to transfer the images to your private registry and the distribution to the disconnected environment.
Your workstation must have at least 20 GB of disk space.
You must have the following software installed:
- Docker
- kubectl
- jq

Installing Verrazzano using a private Docker-compliant container registry requires the following:

Loading all the required Verrazzano container images into your own registry and repositories.
Installing Verrazzano with the private registry and a common prefix for all the repositories used to load the images.

Get Verrazzano

You can download Verrazzano from the Verrazzano GitHub releases page. Oracle customers also can get Verrazzano from the Oracle Software Delivery Cloud. Follow the respective download instructions:

NOTE: You will need to connect to the internet to download the Verrazzano images and Verrazzano distribution.

From GitHub
From the Oracle Software Delivery Cloud

From GitHub

Download the desired Verrazzano distribution from the GitHub releases page.

a. In your browser, go to Verrazzano releases.

b. Download the distribution TAR file, verrazzano-<major>.<minor>.<patch>-<operating system>-<architecture>.tar.gz, and the corresponding checksum file.

c. In the downloaded directory, validate that the checksum and TAR files match. For example, if you have downloaded verrazzano-1.7.2-linux-amd64.tar.gz:
```
$ sha256sum -c verrazzano-1.7.2-linux-amd64.tar.gz.sha256
# Sample output
verrazzano-1.7.2-linux-amd64.tar.gz: OK
```
NOTE: Use the sha256sum command on Linux and shasum on MacOS.

d. Expand the TAR file to access the release artifacts.

The following example, extracts the distribution archive verrazzano-1.7.2-linux-amd64.tar.gz into the current directory.
```
$ tar xvf verrazzano-1.7.2-linux-amd64.tar.gz
```
After a successful extraction, the release artifacts will be under the verrazzano-1.7.2 directory.

e. Define an environment variable DISTRIBUTION_DIR.
```
 $ DISTRIBUTION_DIR=<path to the current directory>/verrazzano-1.7.2
```
Download the Verrazzano images defined in the BOM, ${DISTRIBUTION_DIR}/manifests/verrazzano-bom.json, using the script, ${DISTRIBUTION_DIR}/bin/vz-registry-image-helper.sh.
```
$ sh ${DISTRIBUTION_DIR}/bin/vz-registry-image-helper.sh \
  -b ${DISTRIBUTION_DIR}/manifests/verrazzano-bom.json \
  -f ${DISTRIBUTION_DIR}/images  
```
The previous command downloads all the images to the ${DISTRIBUTION_DIR}/images directory.

From the Oracle Software Delivery Cloud

Download the Verrazzano ZIP file.
- Download the Verrazzano ZIP file from the Oracle Software Delivery Cloud for major or minor releases.
  
  a. In your browser, go to the Oracle Software Delivery Cloud and log in with your credentials.
  
  b. In the drop-down menu preceding the search bar, select All Categories.
  
  c. In the search bar, enter Verrazzano Enterprise Container Platform and click Search.
  
  d. Select the REL: Verrazzano Enterprise Container Platform 1.7.0.0.0 link. This will add it to your download queue.
  
  e. At the top of the page, select the Continue link.
  
  f. Review the Download Queue, then click Continue.
  
  g. Accept the license agreement and click Continue.
  
  h. Download the file:
  - To download the ZIP file directly, select the file link in the list.
  - To download the ZIP file using Oracle Download Manager, click Download and run the Oracle Download Manager executable.
- Download the Verrazzano ZIP file from My Oracle Support for cumulative patches.
  
  a. In your browser, go to My Oracle Support and log in with your credentials.
  
  b. Select the Patches & Updates tab.
  
  c. In the Patch Search panel, select the link Product or Family (Advanced).
  
  d. In the search bar for Product is, enter Oracle Verrazzano Enterprise Container Platform.
  
  e. The previous step populates the available releases for Verrazzano in the drop-down menu Release is. Select the desired release(s) and click Search.
  
  f. A new panel with Patch Advanced Search Results will open listing all the patches for the release. Select the link for the desired patch, under the Patch Name.
  
  g. From the page providing details about the patch, click Download.
  
  h. Download the ZIP file by selecting the file link.
Prepare to do the private registry installation.

a. Extract the ZIP archive to a desired directory location. There will be two files: a compressed TAR file containing the product files and a checksum file.

b. Define an environment variable DISTRIBUTION_DIR.
```
$ DISTRIBUTION_DIR=<path to the current directory>/verrazzano-1.7.2
```
c. In the expanded archive directory, validate that the checksum and TAR files match. For example,
```
$ sha256sum -c verrazzano-1.7.2.tar.gz.sha256
# Sample output
verrazzano-1.7.2.tar.gz: OK
```
NOTE: Use the sha256sum command on Linux and shasum on MacOS.

Load the images

Load the product images into your private registry.

NOTE: You will need a way to transfer the images to your private registry and the distribution to the disconnected environment.

To log in to the Docker registry, run docker login <SERVER> with your credentials.
For use with the examples in this document, define the following variables with respect to your target registry and image prefix: MYREG, MYPREFIX.

These identify the target Docker registry and image prefix. For example, using a target registry of myreg.io and a target image prefix of myrepo/v8o:
```
$ MYREG=myreg.io
$ MYPREFIX=myrepo/v8o
```
Run the ${DISTRIBUTION_DIR}/bin/vz-registry-image-helper.sh script to push the images to the registry:
```
 $ sh ${DISTRIBUTION_DIR}/bin/vz-registry-image-helper.sh \
  -t $MYREG -r $MYPREFIX -l ${DISTRIBUTION_DIR}/images
```
Although most images can be protected using credentials stored in an image pull secret, some images must be public. Use the following commands to get the list of public images:
- The Rancher Agent image.
```
$ cat ${DISTRIBUTION_DIR}/manifests/verrazzano-bom.json \
 | jq -r '.components[].subcomponents[] | select(.name == "rancher") | .images[] | select(.image == "rancher-agent") | "\(.image):\(.tag)"'
```
- All the Rancher images in the rancher/additional-rancher subcomponent.
```
$ cat ${DISTRIBUTION_DIR}/manifests/verrazzano-bom.json \
 | jq -r '.components[].subcomponents[] | select(.name == "additional-rancher") | .images[] | "\(.image):\(.tag)"'
```
- All the Cluster API (CAPI) images.
```
$ cat ${DISTRIBUTION_DIR}/manifests/verrazzano-bom.json \
 | jq -r '.components[].subcomponents[] | select(.name | startswith("capi-")) | .images[] | "\(.image):\(.tag)"'
```
- For all the Verrazzano Docker images in the private registry that are not explicitly marked public, you will need to create the secret verrazzano-container-registry in the verrazzano-install namespace, with the appropriate credentials for the registry, identified by $MYREG. For example:
```
$ kubectl create namespace verrazzano-install
$ kubectl create secret docker-registry verrazzano-container-registry -n verrazzano-install \
  --docker-server=$MYREG --docker-username=myreguser \
  --docker-password=xxxxxxxx --docker-email=me@example.com
```

Install Verrazzano

Use the Verrazzano CLI to install Verrazzano from your private registry.

NOTE

You must copy the downloaded Verrazzano distribution to the disconnected environment.
To ensure that the host names used for the system consoles are resolvable, you must configure one of the following:
- If running within a public cloud, use the cloud provider’s DNS, for example, OCI DNS.
- If running within a disconnected environment, use a custom DNS server that can resolve the host names. See Customize DNS for more information.

To install Verrazzano, you will need the Verrazzano platform operator manifests file. This file is in the distribution at ${DISTRIBUTION_DIR}/manifests/k8s/verrazzano-platform-operator.yaml.
Install Verrazzano using the Verrazzano CLI.
- If you downloaded Verrazzano from the Verrazzano GitHub releases page, then you can find the CLI in the distribution archive at ${DISTRIBUTION_DIR}/bin/vz.
- If you downloaded Verrazzano from the Oracle Software Delivery Cloud, then you can find the CLI in the distribution archive at ${DISTRIBUTION_DIR}/bin/<platform>/vz.
  For example, for the Linux operating system on AMD architecture, the path to the CLI is ${DISTRIBUTION_DIR}/bin/linux-amd64/vz. This path is used in all the sample commands.
```
$ ${DISTRIBUTION_DIR}/bin/linux-amd64/vz install \
     --image-registry "${MYREG}" \
     --image-prefix "${MYPREFIX}" \
     --manifests ${DISTRIBUTION_DIR}/manifests/k8s/verrazzano-platform-operator.yaml
```

NOTE:

The --manifests flag is used in this example to provide the location of the Verrazzano platform operator manifests file. If you omit this flag, the vz CLI will attempt to download the manifests file, which requires access to the internet.
The --filename flag is used to specify a Verrazzano custom resource. See Edit the Verrazzano resource.

For the complete list of flags supported by vz install command, run ${DISTRIBUTION_DIR}/bin/linux-amd64/vz/install -h.

Verrazzano supports customizing installation configurations. See Modify Verrazzano Installations.

For example, to install Verrazzano using the prod profile, run the following command:

$ ${DISTRIBUTION_DIR}/bin/linux-amd64/vz install \
   --set profile=prod \
   --image-registry "${MYREG}" \
   --image-prefix "${MYPREFIX}" \
   --manifests ${DISTRIBUTION_DIR}/manifests/k8s/verrazzano-platform-operator.yaml

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.