Verrazzano Enterprise Container Platform – Register Managed Clusters

Docs: Use the Verrazzano Console

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

To register a cluster, complete the following steps:

Enable syncClusters.
For information about syncClusters, see Enable syncClusters.
```
kubectl apply -f - <<EOF
apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: admin
spec:
  profile: prod
  components:
    clusterOperator:
      overrides:
      - values:
          syncClusters:
            enabled: true
EOF
```
On the admin cluster, open the Rancher console.
You can find the Rancher console URL for your cluster by following the instructions here.
Select Cluster Management, and then click Import Existing Cluster.
Provide a name for your managed cluster, for example, managed1.
Optional. In your Verrazzano configuration, if you specified a cluster label selector, then under Labels & Annotations provide the label and value for the cluster. The label and value information must match the cluster selection matchExpression in your Verrazzano configuration for selective cluster registration to occur.
Click Create.
On the next screen, follow the on-screen instructions to complete the registration by running the provided command against the managed cluster.

After the cluster reaches the Active state in the console, synchronization with Verrazzano will happen automatically and a VerrazzanoManagedCluster resource will be created in the verrazzano-mc namespace.

Run the following command to view the details and status of Verrazzano’s multicluster initialization operations:

$ kubectl get vmc -n verrazzano-mc <Rancher_cluster_name> -o yaml

For more information, see Registering Existing Clusters in the Rancher documentation.

NOTE: You can also register managed clusters using kubectl, see Register Managed Clusters using kubectl.

Next steps

Verify your multicluster Verrazzano environment set up by following the instructions at Verify Multicluster Installation.
Deploy multicluster example applications. See Examples of using Verrazzano in a multicluster environment.

NOTE

To deregister a managed cluster, see Deregister a Managed Cluster.

Docs: Use Kubernetes Custom Resources

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

To register managed clusters using the VerrazzanoManagedCluster resource, complete the following steps:

Create the environment variables, KUBECONFIG_ADMIN, KUBECONTEXT_ADMIN, KUBECONFIG_MANAGED1, and KUBECONTEXT_MANAGED1, and point them to the kubeconfig files and contexts for the admin and managed cluster, respectively. You will use these environment variables in subsequent steps when registering the managed cluster. The following shows an example of how to set these environment variables.
```
$ export KUBECONFIG_ADMIN=/path/to/your/adminclusterkubeconfig
$ export KUBECONFIG_MANAGED1=/path/to/your/managedclusterkubeconfig

# Lists the contexts in each kubeconfig file
$ kubectl --kubeconfig $KUBECONFIG_ADMIN config get-contexts -o=name
$ kubectl --kubeconfig $KUBECONFIG_MANAGED1 config get-contexts -o=name

# Choose the right context name for your admin and managed clusters from the output shown and set the KUBECONTEXT
# environment variables
$ export KUBECONTEXT_ADMIN=<admin-cluster-context-name>
$ export KUBECONTEXT_MANAGED1=<managed-cluster-context-name>
```
To begin the registration process for a managed cluster named managed1, apply the VerrazzanoManagedCluster resource on the admin cluster.
```
# On the admin cluster
$ kubectl --kubeconfig $KUBECONFIG_ADMIN --context $KUBECONTEXT_ADMIN \
    apply -f <<EOF -
apiVersion: clusters.verrazzano.io/v1alpha1
kind: VerrazzanoManagedCluster
metadata:
  name: managed1
  namespace: verrazzano-mc
spec:
  description: "Test VerrazzanoManagedCluster resource"
EOF
```
Wait for the VerrazzanoManagedCluster resource to reach the Ready status. At that point, it will have generated a YAML file that must be applied on the managed cluster to complete the registration process.
```
# On the admin cluster
$ kubectl --kubeconfig $KUBECONFIG_ADMIN --context $KUBECONTEXT_ADMIN \
    wait --for=condition=Ready \
    vmc managed1 -n verrazzano-mc
```
Export the YAML file created to register the managed cluster.
```
# On the admin cluster
$ kubectl --kubeconfig $KUBECONFIG_ADMIN --context $KUBECONTEXT_ADMIN \
    get secret verrazzano-cluster-managed1-manifest \
    -n verrazzano-mc \
    -o jsonpath={.data.yaml} | base64 --decode > register.yaml
```
Apply the registration file exported in the previous step, on the managed cluster.
```
# On the managed cluster
$ kubectl --kubeconfig $KUBECONFIG_MANAGED1 --context $KUBECONTEXT_MANAGED1 \
    apply -f register.yaml

# After the command succeeds, you may delete the register.yaml file
$ rm register.yaml
```

Docs: Synchronize Managed Clusters Registration

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

You can synchronize cluster registration across Verrazzano by enabling syncClusters in the Verrazzano custom resource. Any clusters imported in the Rancher console will be synchronized across the rest of Verrazzano, including in Verrazzano managed cluster resources, Rancher, and Argo CD. Additionally, you can use a label selector to filter the clusters you want registered.

Register managed clusters automatically

The following illustrates an admin cluster Verrazzano resource that enables syncClusters.

apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: admin
spec:
  profile: prod
  components:
    clusterOperator:
      overrides:
      - values:
          syncClusters:
            enabled: true

When enabled is set to true, Verrazzano will synchronize the registration of clusters across Verrazzano, Rancher, and Argo CD.
If enabled is set to false (the default), then Verrazzano will not synchronize the registration of clusters across Verrazzano.

Filter cluster selection

Optionally, to determine which clusters imported into Rancher will be automatically registered by Verrazzano, you can provide a label selector in the Verrazzano resource. This lets you filter which clusters you want to be synchronized.

The following illustrates an admin cluster Verrazzano resource that supports cluster label selection.

apiVersion: install.verrazzano.io/v1beta1
kind: Verrazzano
metadata:
  name: admin
spec:
  profile: prod
  components:
    clusterOperator:
      overrides:
      - values:
          syncClusters:
            enabled: true
            clusterSelector:
              matchExpressions:
              - key: verrazzanomulticluster
                operator: In
                values: [supported]

The syncClusters enabled field must be set to true to use cluster label selection. Verrazzano will automatically register all clusters with labels that match the clusterSelector field.

The clusterSelector field is optional.
If enabled is set to true and the clusterSelector field is omitted, then all clusters imported into Rancher will be automatically registered.

When you import a cluster into Rancher, you can provide a label and value for the cluster. If the label matches this label selector, then the cluster will be synchronized.