Create Kubernetes Site

Deploying a Site as a pod on an existing K8s cluster using kubectl requires you to perform the following sequence of actions:

• Create a Site token.
• Prepare a manifest file with the parameters required for Site provisioning.
• Deploy the Site using the kubeconfig of the K8s cluster and the manifest file.
• Perform Site registration.
• Verify that Distributed Cloud Services are running.

Deploying a Site as pod on an existing K8s cluster using Helm requires you to perform the following sequence of actions:

• Create a Site token and set Site token environment variable.
• Clone the F5 Distributed Cloud Services Site on K8s Repo.
• Deploy the Site using the Helm installation command.
• Perform Site registration.
• Verify that Distributed Cloud Services are running.

• Log into F5® Distributed Cloud Console.

• Click Multi-Cloud Network Connect.

Figure: Console Homepage

• Select Manage > Site Management > Site Tokens.

• Click Add Site Token to create a new token.

Figure: Site Tokens

• In the Name field, enter the token name.

• In the Description field, enter a description for the token.

• Click Save and Exit.

Figure: Site Token Form

• Find the token previously created or choose an existing token from the list of tokens displayed.

• Click > to expand the token details in JSON format and note down the value of the uid field.

Figure: UID Field

Download the sample Manifest Template.

• Edit the configuration of the manifest file per the following guidelines:

  • In the ClusterName field, type your cluster name.

  • In the Latitude and Longitude fields, type the latitude and longitude values.

  • In the Token field, type the Site token.

  • In the replicas field, enter 1 for a single-node Site or 3 for a multi-node Site.

• Save your changes.

This image provides a manifest file example:

Figure: Manifest Configuration Example

Note: You can also set the cluster name, latitude, and longitude when you register a Site.

• Type kubectl apply -f <manifest>.yml.

kubectl apply -f <manifest>.yml

This example displays the sample output of the command:

namespace/ves-system created
serviceaccount/volterra-sa created
role.rbac.authorization.k8s.io/volterra-admin-role created
rolebinding.rbac.authorization.k8s.io/volterra-admin-role-binding created
daemonset.apps/volterra-ce-init created
serviceaccount/vpm-sa created
role.rbac.authorization.k8s.io/vpm-role created
rolebinding.rbac.authorization.k8s.io/vpm-role-binding created
clusterrolebinding.rbac.authorization.k8s.io/ver created
configmap/vpm-cfg created
statefulset.apps/vp-manager created
service/vpm created

Verify that the pod with the vp-manager-0 under the NAME column indicates that the Site pod was created.

• Type kubectl get pods -n ves-system -o=wide.

This example displays the sample output of the command with minikube for a single-node Site:

NAME                     READY   STATUS    RESTARTS   AGE     IP            NODE       NOMINATED NODE   READINESS GATES
volterra-ce-init-g8bd7   1/1     Running   0          7m15s   172.16.11.6   minikube   <none>           <none>
vp-manager-0             1/1     Running   0          6m19s   172.17.0.7    minikube   <none>           <none>

This example displays the sample output of the command with minikube for a multi-node Site:

NAME                     READY   STATUS    RESTARTS   AGE     IP             NODE       NOMINATED NODE   READINESS GATES
volterra-ce-init-sgklz   1/1     Running   0          4m      172.16.11.12   minikube   <none>           <none>
vp-manager-0             1/1     Running   0          3m59s   172.17.0.3     minikube   <none>           <none>
vp-manager-1             1/1     Running   0          3m24s   172.17.0.4     minikube   <none>           <none>
vp-manager-2             1/1     Running   0          3m16s   172.17.0.5     minikube   <none>           <none>

You can check the request status from the Console or the kubectl CLI tool.

• To check with Console:

  • Log into Console and then click Multi-Cloud Network Connect.

  • Click Manage > Site Management > Registrations > Pending Registrations.

• To check with kubectl:

  • Type kubectl logs vp-manager-0 -n ves-system.

kubectl logs vp-manager-0 -n ves-system

This example provides the sample output of the command:

Current state: PENDING, registration fe5b5157-7066-4052-95f3-5b9d68e072c6 must be manually APPROVED and then automatically ADMITTED. Object status: &StatusType{ObjectStatus:&ves_io_schema4.StatusType{Status:,Reason:,Code:0,},CurrentState:PENDING,};2022-03-09 21:28:17.07967128 +0000 UTC m=+1318333.138793540,, waiting 15.716434773s before next try

The site-name is a name of your choice. The site-token is the token created in the Create Site Token section.

Enter the following commands:

• export SITE_NAME=<site-name>

• export SITE_TOKEN=<site-token>

Enter the following commands to clone the repo and change to its directory:

• git clone https://gitlab.com/volterra.io/volterra-ce.git && cd volterra-ce

Enter the following command for AWS, Azure, GCP, and Minikube:

helm upgrade --install $SITE_NAME ./helm --set vpm.clusterName="$SITE_NAME" --set vpm.token="$SITE_TOKEN" --set vpm.latitude="50" --set vpm.longitude="50" --set siteToSiteNodePort.enabled=false

Enter the following command for OCP:

helm upgrade --install $SITE_NAME ./helm --set vpm.clusterName="$SITE_NAME" --set vpm.token="$SITE_TOKEN" --set vpm.latitude="50" --set vpm.longitude="50" --set siteToSiteNodePort.enabled=true

The following is a sample output for the above command:

Release "alexminikube2" does not exist. Installing it now.
NAME: alexminikube2
LAST DEPLOYED: Thu Dec  8 18:31:36 2022
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Please open https://console.ves.volterra.io/ and proceed to site registration.

• Log into Console.

• Click Multi-Cloud Network Connect.

• Click Manage > Site Management > Registrations.

Registration requests are displayed in the Pending Registrations tab.

• Click Accept to accept the registration requests from the master-0, master-1, and master-2 nodes. The node names differ.

• Enter the same values for the following parameters for all the registration requests:

  • In the Cluster name field, enter a name for the cluster. Ensure that all control nodes have the same name.

  • In the Cluster size field, enter 3. Ensure that all control nodes have the same cluster size.

• Enter all mandatory fields marked with the asterisk (*) character.

• Click Save and Exit.

It may take a few minutes for the Site health and connectivity score information to update.

• Click Overview > Infrastructure > Sites.

• Click on your Site name. The Dashboard tab appears, along with many other tabs to inspect your Site.

• Click the Site Status tab to verify the following:

  • The Update Status field has a Successful value for the F5 OS Status section.

  • The Update Status field has a Successful value for the F5 Software Status section.

  • The Tunnel status and Control Plane fields under the RE Connectivity section have up values.

Note: The factory reset functionality is not supported. To update a Site node, power off and then destroy it. Perform the same procedure as above to recreate a virtual machine (VM).

• Log into Console.

• Click Multi-Cloud Network Connect.

• Click Manage > Site Management > Registrations.

Registration requests are displayed in the Pending Registrations tab.

• Click Accept to accept the registration request for the node.

• In the form that appears, enter all mandatory fields marked with the asterisk (*) character.

• Enter latitude and longitude values if you did not previously.

• Enter other configuration information, if needed.

• Click Save and Exit.

It may take a few minutes for the Site health and connectivity score information to update.

• Click Overview > Infrastructure > Sites.

• Click on your Site name. The Dashboard tab appears, along with many other tabs to inspect your Site.

• Click the Site Status tab to verify the following:

  • The Update Status field has a Successful value for the F5 OS Status section.

  • The Update Status field has a Successful value for the F5 Software Status section.

  • The Tunnel status and Control Plane fields under the RE Connectivity section have up values.

Note: The factory reset functionality is not supported. To update a Site node, power off and then destroy it. Perform the same procedure as above to recreate a virtual machine (VM).

• Log into Console.

• Click Multi-Cloud Network Connect.

Figure: Console Homepage

• Click Manage > Site Management > Registrations.

• Click the Other Registrations tab.

• Find your Site and then click ....

• Click Decommission.

Figure: Decommission Site

• Click Decommission in the confirmation window to confirm the operation. After a few minutes, the Current State column displays RETIRED.

Figure: Confirm Decommission Site

• In the terminal, use the kubectl tool to delete if Site is created using the manifest file.

Type kubectl delete -f <vpm-manifest>.yml.

kubectl delete -f <vpm-manifest>.yml

• Use the cloud provider commands to delete the resources if Site is created using Helm. The following are sample commands for AWS, Azure, and GCP.

eksctl delete cluster --name $SITE_NAME  --region us-west-2

gcloud container clusters delete --region us-west1 $SITE_NAME

az aks delete --resource-group $SITE_NAME --name $SITE_NAME

• Click Sites > Site List.

• Find your Site from the list and then click ....

• Click Manage Configuration to open the Site edit form.

• Click Delete Site.

Figure: Delete Site

• Click Delete in the confirmation window to complete the operation.

Figure: Confirm Delete Site

• Type kubectl --kubeconfig=<kubeconfig-of-existing-k8s-cluster> edit statefulset/vp-manager -n ves-system.

kubectl --kubeconfig=<kubeconfig-of-existing-k8s-cluster> edit statefulset/vp-manager -n ves-system

• In the kubeconfig file replicas field, enter a new number.

• Save the file. The changes apply automatically.

• Type kubectl get pods -o=wide -n ves-system.

kubectl get pods -o=wide -n ves-system

This example assumes that the replicas are set to 2:

NAME                           READY   STATUS      RESTARTS   AGE   IP            NODE                                NOMINATED NODE   READINESS GATES
etcd-5bcbfc8689-8fx4g          2/2     Running     0          19h   10.244.1.23   aks-nodepool1-29573508-vmss000001   <none>           <none>
etcd-defrag-1587184200-dg765   0/1     Completed   0          42m   10.244.1.52   aks-nodepool1-29573508-vmss000001   <none>           <none>
ver-0                          13/13   Running     2          16h   10.244.0.12   aks-nodepool1-29573508-vmss000000   <none>           <none>
ver-1                          13/13   Running     0          17m   10.244.1.53   aks-nodepool1-29573508-vmss000001   <none>           <none>
volterra-ce-init-5wsmb         1/1     Running     0          26h   10.240.0.5    aks-nodepool1-29573508-vmss000001   <none>           <none>
volterra-ce-init-sbjqp         1/1     Running     0          26h   10.240.0.4    aks-nodepool1-29573508-vmss000000   <none>           <none>
vp-manager-0                   1/1     Running     0          12m   10.244.1.54   aks-nodepool1-29573508-vmss000001   <none>           <none>
vp-manager-1                   1/1     Running     2          15m   10.244.0.14   aks-nodepool1-29573508-vmss000000   <none>           <none>