Verrazzano Enterprise Container Platform – Perform the Installation

Docs: Install With CLI

Mon, 01 Jan 0001 00:00:00 +0000

The following instructions show you how to install Verrazzano in a single Kubernetes cluster using the CLI.

Prerequisites

Find the Verrazzano prerequisite requirements here.
Review the list of the software versions supported and installed by Verrazzano.

NOTE

To avoid conflicts with Verrazzano system components, we recommend installing Verrazzano into an empty cluster.

Prepare for the installation

Before installing Verrazzano, see instructions on preparing Kubernetes platforms and installing the Verrazzano CLI (optional). Make sure that you have a valid kubeconfig file pointing to the Kubernetes cluster that you want to use for installing Verrazzano.

NOTE: Verrazzano can create network policies that can be used to limit the ports and protocols that pods use for network communication. Network policies provide additional security but they are enforced only if you install a Kubernetes Container Network Interface (CNI) plug-in that enforces them, such as Calico. For instructions on how to install a CNI plug-in, see the documentation for your Kubernetes cluster.

Perform the installation

Verrazzano provides a platform operator to manage the life cycle of Verrazzano installations. Using the Verrazzano custom resource, you can install, uninstall, and upgrade Verrazzano installations. When applying the Verrazzano custom resource, the Verrazzano CLI deploys and installs the Verrazzano platform operator; you need only to install Verrazzano as described in the following section.

Verrazzano supports the following installation profiles: development (dev), production (prod), and managed cluster (managed-cluster). For more information, see Installation Profiles.

This document shows how to create a basic Verrazzano installation using:

The development (dev) installation profile
Wildcard-DNS, where DNS is provided by nip.io (the default)

NOTE: Because the dev profile installs self-signed certificates, when installing Verrazzano on macOS, you might see: Your connection is not private. For a workaround, see this FAQ.

For an overview of how to configure Verrazzano, see Modify Verrazzano Installations. For a complete description of Verrazzano configuration options, see the Verrazzano Custom Resource Definition.

To use other DNS options, see Customizing DNS for more details.

Install Verrazzano

To create a Verrazzano installation as described in the previous section, run the following commands.

Install Verrazzano with its dev profile.
```
$ vz install -f - <<EOF
apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: example-verrazzano
spec:
  profile: dev
  defaultVolumeSource:
    persistentVolumeClaim:
      claimName: verrazzano-storage
  volumeClaimSpecTemplates:
    - metadata:
        name: verrazzano-storage
      spec:
        resources:
          requests:
            storage: 2Gi
EOF
```

This command installs the Verrazzano platform operator and applies the Verrazzano custom resource.

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

To use a different profile with the previous example, set the VZ_PROFILE environment variable to the name of the profile you want to install.

Next steps

Verify the installed Verrazzano using the vz CLI. See Verify using CLI.

Docs: Install With kubectl

Mon, 01 Jan 0001 00:00:00 +0000

The following instructions show you how to install Verrazzano in a single Kubernetes cluster using kubectl.

Prerequisites

Find the Verrazzano prerequisite requirements here.
Review the list of the software versions supported and installed by Verrazzano.

NOTE

To avoid conflicts with Verrazzano system components, we recommend installing Verrazzano into an empty cluster.

Prepare for the installation

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

Install the Verrazzano platform operator

Verrazzano provides a platform operator to manage the life cycle of Verrazzano installations. Using the Verrazzano custom resource, you can install, uninstall, and upgrade Verrazzano installations.

To install the Verrazzano platform operator:

Deploy the Verrazzano platform operator.
```
$ kubectl apply -f https://github.com/verrazzano/verrazzano/releases/download/master/verrazzano-platform-operator.yaml
```
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
```
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
```

Perform the installation

Verrazzano supports the following installation profiles: development (dev), production (prod), and managed cluster (managed-cluster). For more information, see Installation Profiles.

This document shows how to create a basic Verrazzano installation using:

The development (dev) installation profile
Wildcard-DNS, where DNS is provided by nip.io (the default)

NOTE: Because the dev profile installs self-signed certificates, when installing Verrazzano on macOS, you might see: Your connection is not private. For a workaround, see this FAQ.

For a complete description of Verrazzano configuration options, see the Verrazzano Custom Resource Definition.

To use other DNS options, see Customzing DNS for more details.

Install Verrazzano

To create a Verrazzano installation as described in the previous section, run the following commands.

$ kubectl apply -f - <<EOF
apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: example-verrazzano
spec:
  profile: ${VZ_PROFILE:-dev}
EOF

$ kubectl wait \
  --timeout=20m \
  --for=condition=InstallComplete verrazzano/example-verrazzano

NOTE: If you are installing Verrazzano in an Azure Kubernetes Service (AKS) cluster, add the following annotation for ingressNGINX to access Verrazzano endpoints on Azure.

$ kubectl apply -f - <<EOF
apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: example-verrazzano
spec:
  profile: dev
  components:
    ingressNGINX:
      overrides:
      - values:
          controller:
            service:
              annotations:
                service.beta.kubernetes.io/azure-load-balancer-health-probe-request-path: /healthz
    dns:
      wildcard:
        domain: nip.io
EOF

To use a different profile with the previous example, set the VZ_PROFILE environment variable to the name of the profile you want to install.

If an error occurs, check the log output of the installation. You can view the logs with the following command.

  $ kubectl logs -n verrazzano-install \
      -f $(kubectl get pod \
      -n verrazzano-install \
      -l app=verrazzano-platform-operator \
      -o jsonpath="{.items[0].metadata.name}") | grep '^{.*}$' \
      | jq -r '."@timestamp" as $timestamp | "\($timestamp) \(.level) \(.message)"'

Next steps

Verify the installed Verrazzano using kubectl. See Verify using CLI.

Docs: Installation Profiles

Mon, 01 Jan 0001 00:00:00 +0000

This document describes built-in configuration profiles that you can use to simplify a Verrazzano installation. An installation profile is a well-known configuration of Verrazzano settings that can be referenced by name, which then can be customized as needed.

The following table describes the Verrazzano installation profiles.

Profile	Description	Characteristics
`prod`	Full installation, production configuration.	Default profile: - Full installation. - Persistent storage. - Production OpenSearch cluster topology.
`dev`	Development or evaluation configuration.	Lightweight installation: - For evaluation purposes. - No persistence. - Single-node OpenSearch cluster topology.
`managed-cluster`	A specialized installation for managed clusters in a multicluster topology.	Minimal installation for a managed cluster: - Clusters must be registered with an admin cluster to use multicluster features.

Use an installation profile

To specify an installation profile when installing Verrazzano, set the profile name in the profile field of your Verrazzano custom resource.

For example, to use the dev profile:

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

To use a different profile, replace dev with prod, or managed-cluster.

Customize an installation profile

Regardless of the profile, you can override the profile settings for any component. The following example uses a customized dev profile to configure a small 8 Gi persistent volume for the MySQL instance used by Keycloak to provide more stability for the Keycloak service.

apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: custom-dev-example
spec:
  profile: dev
  components:
    keycloak:
      mysql:
        volumeSource:
          persistentVolumeClaim:
            claimName: mysql
  volumeClaimSpecTemplates:
  - metadata:
      name: mysql      
    spec:
      resources:
        requests:
          storage: 8Gi

For details on how to customize Verrazzano components, see Modify Verrazzano Installations.

Profile configurations

The following table lists the Verrazzano components that are enabled by default with each profile. Note that you can customize any Verrazzano installation regardless of the profile.

Component	dev	prod	managed-cluster
`applicationOperator`	✔️	✔️	✔️
`argoCD`
`authProxy`	✔️	✔️	✔️
`certManager`	✔️	✔️	✔️
`certManagerWebhookOCI`	️	️
`clusterAPI`	✔️	✔️
`clusterAgent`	✔️	✔️	✔️
`clusterIssuer`	✔️	✔️	✔️
`clusterOperator`	✔️	✔️	✔️
`coherenceOperator`	✔️	✔️	✔️
`console`	✔️	✔️
`dns`	✔️	✔️	✔️
`fluentbitOpensearchOutput`
`fluentd`	✔️	✔️	✔️
`fluentOperator`	️	️	️
`grafana`	✔️	✔️
`ingressNGINX`	✔️	✔️	✔️
`istio`	✔️	✔️	✔️
`jaegerOperator`
`keycloak`	✔️	✔️
`kiali`	✔️	✔️
`kubeStateMetrics`
`mySQLOperator`	✔️	✔️	✔️
`oam`	✔️	✔️	✔️
`opensearch`	✔️	✔️
`opensearchDashboards`	✔️	✔️
`prometheus`	✔️	✔️	✔️
`prometheusAdapter`
`prometheusNodeExporter`	✔️	✔️	✔️
`prometheusOperator`	✔️	✔️	✔️
`prometheusPushgateway`
`rancher`	✔️	✔️
`rancherBackup`
`thanos`
`velero`
`weblogicOperator`	✔️	✔️	✔️

Prometheus and Grafana configurations

The following table describes the Prometheus and Grafana configurations in each profile.

Profile	Prometheus	Grafana
`prod`	One replica (128 MB memory, 50 Gi storage)	One replica (48 MB memory, 50 Gi storage)
`dev`	One replica (128 MB memory, ephemeral storage)	One replica (48 MB memory, ephemeral storage)
`managed-cluster`	One replica (128 MB memory, 50 Gi storage)	Not installed

OpenSearch Dashboards and OpenSearch configurations

The following table describes the OpenSearch Dashboards and OpenSearch cluster topology in each profile.

Profile	OpenSearch	OpenSearch Dashboards
`prod`	Three master replicas (1.4 Gi memory, 50 Gi storage each) One ingest replica (2.5 Gi memory, no storage) Three data replicas (4.8 Gi memory, 50 Gi storage each)	One replica (192 MB memory, ephemeral storage)
`dev`	One master/data/ingest replica (1 Gi memory, ephemeral storage)	One replica (192 MB memory, ephemeral storage)
`managed-cluster`	Not installed	Not installed

NOTE

OpenSearch containers are configured to use 75% of the configured request memory for the Java min/max heap settings.

Profile-independent defaults

The following table shows the settings for components that are profile-independent (consistent across all profiles unless overridden).

Component	Default
DNS	Wildcard DNS provider nip.io.
Certificates	Uses the cert-manager self-signed ClusterIssuer for certificates.
Ingress-type	Defaults to `LoadBalancer` service type for the ingress.