Deployment on Existing Kubernetes Cluster

In the case of vuSmartMaps’ deployment in the existing kubernetes cluster, please follow below steps:

Pre Requisites

• Kubeconfig to access kubernetes environment should be there with super-admin access
• vuLauncher license should have correct github username and token to pull the images.
• For AKS, static IP address from the same resource group where AKS is provisioned, which will be used to expose services such as kafka, traefik, minio etc Using this IP we will be creating load balancer service.
• For AKS, If you’re going to use premium storage for clickhouse hot volume, please make sure you have the appropriate machine type which supports attaching premium volumes.
• To make sure sitemanager runs properly after the deployment, open the config.yaml file in launcher/static-files/config.yaml, change user, build_dir and executable_path for the current user of vuSiteManager as shown below
• Run the below commands in the master node to create data partitions

• • sudo mkdir /data1
  • sudo chown -R vunet:vunet /data1
  • sudo mkdir /data2
  • sudo chown -R vunet:vunet /data2
  • sudo mkdir /data3
  • sudo chown -R vunet:vunet /data3

💡Note: Provide data1, data2 and data3 only if there is no data partitions available.

Provide user name/user group according to the environment.

Upload License 

1. Here you need to provide a valid license. This license file will contain the services that are going to be installed and its required resources.
2. Upload the valid license and click on Continue. If the license is invalid, please check the license format and retry.

💡Note: Please get the updated license files from [email protected].

Also, mention the kind of setup (single node/multi node)  you’re doing for the deployment.

Installation Environment

1. Here, you will be prompted to select your installation environment choice
2. You can select K3S/AKS for the existing kubernetes environment.

Upload Kubeconfig file

1. Upload kubeconfig which has the super-admin access to the kubernetes cluster.

💡Note: Only YAML file should be uploaded here.

2. On clicking the continue button, vuLauncher will verify the access to the cluster and get the details of the nodes.

K8s Nodes Selection

1. Here, you can exclude some of the nodes where you don’t want to run the services.
2. This is helpful in case we don’t want to schedule our services on Master node OR in case of AKS we have a reserved pool of nodes where by default, it doesn’t allow scheduling of any pods.

Configure IP

1. In case you have a Loadbalancer available in your kubernetes cluster(mostly available in case of Managed Kubernetes), you can create a static IP address which will be then used to expose the services.
2. If you don’t have the Load Balancer, we can expose the services on worker nodes. In this case you can skip this step.

Configure Disk 

1. In this step, we will assign the storage classes to different tiers of hyperscale configuration. We have below tiers:

• • Hot: Most frequently used data will be stored here, so preferably choose a storage class which has high Disk IOPS.
  • Warm: We store data here which is not mostly accessed. So a default storage class would suffice.
  • Cold: This is where we will store data for Archival purposes. We store this data in S3 bucket (Minio).

2. For now, we only support storing data as unencrypted.

Mapping

VM to Service Mapping (with advanced Configuration)

1. Here you can override the Service mapping to VM
2. By default, the backend will allocate resources to the available VM in the best possible way. If a user wishes to override this allocation, they can do so on this page.
3. If the user wishes to override, they can click the ‘Edit’ button. This will prompt them with a list of VMs, where they can increase or decrease the count as needed.
4. In the Advanced Configuration section, choose the set of VMs for a service. If a VM goes down, then kubernetes will choose the given set of VMs to bring up this service.  By default, all the nodes are chosen.

Customize

1. Here users can override the port that the service uses.
2. To override, click the edit button of the respective service, and then write the required port number
3. Click Continue to proceed.

Install

1. Here this page shows the summary of the information that the user provided.
2. You can click the edit button on the details page, to move back to their respective section and override the change.
3. You can also click the name of the stepper window to move.
4. Then click Start Deployment, to start the deployment procedure.

💡Note: Once you start the deployment, you cannot edit the configuration you provided.

Installation Process

1. The installation shows each event that is going to be performed.
2. Users can click the “View Information” text button, to view the installation information.
3. Users can click Cancel Installation to stop the ongoing installation. Additionally, they can retry if the process is halted or if the installation stops.
4. Once the installation is successful, a prompt will open. Here, users can click Go to vuSmartMaps, and it will redirect to the vuSmartMaps login page.
5. Use the Login credentials displayed here, to login to the UI.

Post Welcome Page

1. Once the user reaches the installation step, they can close the browser window and come back again to see the status.
2. The post-welcome page is displayed below. Users have the option to click ‘View Information’ to access detailed installation status.

Post Deployment Steps

Follow the below steps in the master node, once the deployment is successful.

1. To find out which node is the master node, execute the following command in the node where the Kubernetes cluster is running. These details are provided during the initial deployment.

• • kubectl get nodes -n vsmaps

In the above output, the e2e-69-187 node is the master node, since the Role is assigned as Master.

2. Run the following command to own the kube config file

sudo chown -R vunet:vunet /etc/kubernetes/admin.conf