Server on Kubernetes

Important

Before completing these deployment steps, please review the system requirements for a SAS Enterprise Session Monitor installation on Linux.

Warning

As with previous versions of Enterprise Session Monitor we recommend running the Server component of Enterprise Session Monitor off the cluster that you wish to monitor. While the system resources that the Server component requires are light, there are a number of scenarios where your Kubernetes cluster or application might be inaccessible. In this scenario, you would want to be able to get to the Enterprise Session Monitor interface to understand what happened in the hours, minutes, and seconds before an outage. If the Enterprise Session Monitor Server is deployed to the same in-operable cluster, this might not be possible.

kubectl

The following steps assume that you have the Kubectl command installed on the machine from where you are performing the installation and that your KUBECONFIG environment variable is correctly set for your target Kubernetes cluster.

Kubernetes Namepsaces

Where you see in the below instructions should be replaced with the value of the namespace within which you want to deploy the Enterprise Session Monitor Server. This could be the same namespace as your SAS® Viya deployment, or another namespace.

Obtain Installation Assets¶

The appropriate SAS Enterprise Session Monitor Server on Kubernetes installation media can be obtained from the kubernetes folder in the release folder on the Boemska Downloads site or by contacting SAS Technical Support.

Install the Server¶

Update line 8 of esm-server-license.yaml replacing the text YOURESMLICENSE with the contents of the ESM license string provided when you received the software download and license email.
Update line 9 on esm-server-ingress.yaml replacing the text ESM_SERVICE_HOST with the Fully Qualified Domain Name of your deployment, for example: sas.viya.example.com
Apply the Enterprise Session Monitor secret. This is required to authenticate to the image repository:
```
kubectl apply -f esm-secret.yaml -n <NAMESPACE>
```

Apply your SAS Enterprise Session Monitor Server license

kubectl apply -f esm-server-license.yaml -n <NAMESPACE>

Apply the SAS Enterprise Session Monitor Server PVC:

kubectl apply -f esm-server-pvc.yaml -n <NAMESPACE>

Apply the SAS Enterprise Session Monitor Server Deployment:

kubectl apply -f esm-server-deployment.yaml -n <NAMESPACE>

Deploy the Enterprise Session Monitor Server Cluster IP service:

kubectl apply -f esm-server-clusterip.yaml -n <NAMESPACE>

Deploy the Enterprise Session Monitor Server Ingress:

kubectl apply -f esm-server-ingress.yaml -n <NAMESPACE>

The initial deployment and starting of the Enterprise Session Monitor Server will take several minutes. Once the deployment is complete, you should be able to access the user interface of the application at: https://ESM_SERVICE_HOST/esm/ where ESM_SERVICE_HOST is the value that you replaced in step two above.

Validate the Server Installation¶

Ensure Connectivity to the User Interface¶

From a supported browser, open: http://esmserver/esm/. Replacing esmserver for either the hostname or IP address of the machine where you installed the Server.
The application will load and you will be presented with a login dialog. Enter the credentials used in step 7 of the installation process.
After successfully logging in, you will be taken to an empty Dashboard page.

Completing the above steps has successfully demonstrated connectivity to the Enterprise Session Monitor UI.

Ensure Connectivity to the Database¶

From a supported browser on the machine where the Server was installed, open: http://esmserver/esm/. Replacing esmserver for either the hostname or IP address of the machine where you installed the Server.
The application will load and you will be presented with a login dialog. Enter the credentials used in step 7 of the installation process.
After successfully logging in, from the main menu on the left, select "Admin Settings" ( icon).
Open the Database Maintenance tab. A page will be displayed showing the current size of the database and two sets of vertical bar charts. If this page displays data, a connection to the database has been successfully made.

Completing the above steps has successfully demonstrated connectivity to the Enterprise Session Monitor database.

Last update: July 20, 2023
Created: April 24, 2023