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 the 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 Hyperscale 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.
• We should have a “/var” partition in all VMs with minimum 80GB to load the docker images.

💡Note: Ensure that all the partitions are being used by the same user and user group.

Please follow the below steps to own the partitions by the same user and user group.

1. Create the group using – groupadd rvunet
2. Add the users to the group

• • usermod -aG rvunet root
  • usermod -aG rvunet vunet

3. To change the group ownership of /data, run the following command

• • chown -R :rvunet /data

4. Set group write permissions accordingly

• • chmod -R g+w /data

5. Set the setgid bit for the same partition

• • chmod g+s /data

Downloading the binary

1. Create a folder in the home directory and download the NG installation binary using the below command

• wget https://download.vunetsystems.com/_Downloads_/_vuDocker_/vuSmartMaps_NG_2_11.tar.gz  –user=<username> –password=<password>  –no-check-certificate

💡Note: If you don’t have access to the download server, download the binaries directly from this URL 

Please check with [email protected] for  getting the credentials for Download server.

2. Extract the tar file using

• • tar -xvzf vuSmartMaps_NG_2_11.tar.gz

3. Once extracted, start the launcher, using

• •  ./build/launcher_linux_x86_64

4. Once the launcher has started successfully, access the launcher User Interface from a web browser using the link available.

Welcome Page

• This will be the starting page for Installation.
• Click on Proceed to install button, to start with the actual NG installation.  

Upload License 

1. Here you need to provide a valid license. This license file will contain the services that are going to be installed along with required resources.
2. Upload the valid license and click on Continue. 

💡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 and click on Continue button.

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. Click on Continue once the details are updated.

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. Based on the previous step, 3 storage classes will be configured for each type of storage. Accordingly we need to assign the storage class and encryption setting for each disk.
2. Along with the disk storage, select Encrypted option here for the Hyperscale disk settings and click on Continue.

Mapping

VM to Service Mapping (with advanced Configuration)

1. Here you can override the Service mapping to VM.
2. By default, the vulauncher installation script will allocate resources to the available VM in the best possible way. Click on Continue if you’re fine with the default allocation.
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 is running on.
2. There may be cases where your enterprise requires you to run standard services on non standard ports. Please configure the port for these services here.
3. To override, click the edit button of the respective service, and then write the required port number.
4. 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 Continue, 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.
   

   💡Note: If for some reasons, your browser or laptop closes and you lose this page, please execute this command and restart your configuration deployment. Please restart launcher using ./build/launcher_linux_x86_640

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 Deployment Steps

1. Follow the below steps in the master node, once the deployment is successful.
2. 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.

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

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

Along with the above, please verify the below scenarios

Default Timezone

Each vuSmartMaps installation will have a default timezone configured in the About page. By default, this is set to UTC. This time zone serves as the base timezone for the platform and can only be updated by the Admin. The default timezone is used for:

• The user interface (observability): viewing Alerts, Dashboards, Reports, Log Analytics, and downloading Reports and Dashboards as PDFs with a Global timeselector.
• Scheduling: The timezone for the scheduled time for Alerts and Reports.
• Distributed channels: Timezone of the content sent via Emails, SMS, WhatsApp,ITSM, etc.

User specific Timezone

User-specific timezones can also be configured by each user from the Profile page,allowing customization of the timezone settings for individual preferences while the platform-wide operations adhere to the default timezone.

To specify the user-specific timezone, navigate to the User-Specific Timezone icon at the top right, which displays the timezone set by the user in their profile.

You can change this timezone by navigating to the profile section.

Select your desired timezone from the User Specific Timezone dropdown menu, and the system will update to reflect the chosen timezone.

Default Retention Settings

Each vuSmartMaps installation will have default data retention settings available under Platform Settings -> Data Retention -> Hyperscale DataStore.

Update the default settings accordingly as per the requirements