You can install Synergy and DSPM in an air-gapped environment that is not directly connected to the Internet.

Single Node Installation

Install K3s

The steps below you guide you through the air-gap installation of K3s, a lightweight Kubernetes distribution created by Rancher Labs:

1. Extract the downloaded file:

2. Prepare K3s for air-gap installation:

3. Before installation, it’s recommended to run automatic checks (as root; PRODUCT_NAME is either “synergy” (endpoint agent) or “dspm“ (dspm without endpoint agent) or “ultimate“ (dspm + endpoint agent). If unsure use “ultimate“):

   cat scripts/k3s.sh | PRODUCT_NAME=ultimate ONLY_PRECHECK=true bash -

   Install K3s:

4. Wait for the 30s and check if K3s is running with the command: kubectl get pods -A and systemctl status k3s.service

Import Docker images

The steps below will manually deploy the necessary images to the cluster.

1. Import Docker images locally:

Install Helm charts

The following steps guide you through the installation of the dependencies required by DSPM and Synergy (Endpoint Agent).

1. Install Getvisibility Essentials and set the daily UTC backup hour (0-23) for performing backups.

2. Install Monitoring CRD:

3. Install Monitoring:

4. Check all pods are Running with the command: kubectl get pods -A

Install DSPM/Synergy (Endpoint Agent) Helm Chart

Replace the following variables:

• $VERSION with the version that is present in the bundle that has been downloaded

• $RESELLER with the reseller code (either getvisibility or forcepoint)

• $PRODUCT with the product being installed (synergy, dspm, enterprise or ultimate)

Install custom artifact bundles

Models and other artifacts, like custom agent versions or custom consul configuration can be shipped inside auto deployable bundles. These bundles are docker images that contain the artifacts to be deployed alongside scripts to deploy them. To create a new bundle or modify an existing one follow this guide first: https://getvisibility.atlassian.net/wiki/spaces/GS/pages/65372391/Model+deployment+guide#1.-Create-a-new-model-bundle-or-modify-an-existing-one . The list of all the available bundles is inside the bundles/ directory on the models-ci project on github.

After the model bundle is published, for example images.master.k3s.getvisibility.com/models:company-1.0.1 You’ll have to generate a public link to this image by running the k3s-air-gap Publish ML models GitHub CI task. The task will ask you for the docker image URL.

Once the task is complete you’ll get a public URL to download the artifact on the summary of the task. After that you have to execute the following commands.

Replace the following variables:

• $URL with the URL to the model bundle provided by the task

• $BUNDLE with the name of the artifact, in this case company-1.0.1

Now you’ll need to execute the artifact deployment job. This job will unpack the artifacts from the docker image into a MinIO bucket inside the on premise cluster and restart any services that use them.

Replace the following variables:

• $GV_DEPLOYER_VERSION with the version of the model deployer available under charts/

• $BUNDLE_VERSION with the version of the artifact, in this case company-1.0.1

You should be able to verify that everything went alright by locating the ml-model job that was launched. The logs should look like this:

In addition you can enter the different services that consume these artifacts to check if they have been correctly deployed. For example for the models you can open a shell inside the classifier containers and check the /models directory or check the models-data bucket inside MinIO. Both should contain the expected models.

Multiple Node Installation (High Availability)

Prerequisites

Firewall Rules for Internal Communication

K3s needs the following ports to be accessible (Inbound and Outbound) by all other nodes running in the same cluster:

All nodes in the cluster must have:

1. Domain Name Service (DNS) configured

2. Network Time Protocol (NTP) configured

3. Fixed private IPv4 address

4. Globally unique node name (use --node-name when installing K3s in a VM to set a static node name)

Firewall Rules for External Communication

The following port must be publicly exposed in order to allow users to access Synergy (Endpoint Agent) or DSPM product:

The user must not access the K3s nodes directly, instead, there should be a load balancer sitting between the end user and all the K3s nodes (master and worker nodes):

Open

The load balancer must operate at Layer 4 of the OSI model and listen for connections on port 443. After the load balancer receives a connection request, it selects a target from the target group (which can be any of the master or worker nodes in the cluster) and then attempts to open a TCP connection to the selected target (node) on port 443.

The load balancer must have health checks enabled which are used to monitor the health of the registered targets (nodes in the cluster) so that the load balancer can send requests to healthy nodes only.

The recommended health check configuration is:

• Timeout: 10 seconds

• Healthy threshold: 3 consecutive health check successes

• Unhealthy threshold: 3 consecutive health check failures

• Interval: 30 seconds

• Balance mode: round-robin

VM Count

At least 4 machines are required to provide high availability of the Getvisibility platform. The HA setup supports a single-node failure.

Install K3s

The steps below you guide you through the air-gap installation of K3s, a lightweight Kubernetes distribution created by Rancher Labs:

1. Create at least 4 VMs with the same specs

2. Extract the downloaded file: tar -xf gv-platform-$VERSION.tar to all the VMs

3. Create a local DNS entry private-docker-registry.local across all the nodes resolving to the master1 node :

4. Prepare the K3s for air-gap installation files:

5. Update the registries.yaml file across all the nodes.

6. Install K3s in the 1st master node:
   To get started launch a server node using the cluster-init flag:

   Check for your first master node status, it should have the Ready state:

   Use the following command to copy the TOKEN from this node that will be used to join the other nodes to the cluster:

   Also, copy the IP address of the 1st master node which will be used by the other nodes to join the cluster.

7. Install K3s in the 2nd master node:

   Run the following command and assign the contents of the file: /var/lib/rancher/k3s/server/node-token from the 1st master node to the K3S_TOKEN variable.

   Set --node-name to “master2”

   Set --server to the IP address of the 1st master node

   Check the node status:

8. Install K3s in the 3rd master node:

   Run the following command and assign the contents of the file: /var/lib/rancher/k3s/server/node-token from the 1st master node to the K3S_TOKEN variable.

   Set --node-name to “master3”

   Set --server to the IP address of the 1st master node

   Check the node status:

9. Install K3s in the 1st worker node:
   Use the same approach to install K3s and to connect the worker node to the cluster group.
   The installation parameter would be different in this case. Run the following command:
   Set --node-name to “worker1” (where n is the nth number of the worker node)

   Check the node status:

Deploy Private Docker Registry and Import Docker images

1. Extract and Import the Docker images locally to the master1 node

2. Install gv-private-registry helm chart in the master1 node:
   Replace $VERSION with the version that is present in the bundle that has been downloaded.
   To check all the charts that have been download run ls charts.

3. Tag and push the docker images to the local private docker registry deployed in the master1 node:

Install Helm charts

The following steps guide you through the installation of the dependencies required by DSPM and Synergy (Endpoint Agent).

1. Install Getvisibility Essentials and set the daily UTC backup hour (0-23) for performing backups.

2. Install Monitoring CRD:

3. Install Monitoring:

4. Check all pods are Running with the command:
   kubectl get pods -A

Install DSPM/Synergy (Endpoint Agent) Helm Chart

Replace the following variables:

• $VERSION with the version that is present in the bundle that has been downloaded

• $RESELLER with the reseller code (either getvisibility or forcepoint)

• $PRODUCT with the product being installed (synergy or dspm or ultimate)

Install Kube-fledged

1. Install gv-kube-fledged helm chart.
   Replace $VERSION with the version that is present in the bundle that has been downloaded.
   To check all the charts that have been download run ls charts.

2. Create and deploy imagecache.yaml

Install custom artifacts

Models and other artifacts, like custom agent versions or custom consul configuration can be shipped inside auto deployable bundles. The procedure to install custom artifact bundles on an HA cluster is the same as in the single node cluster case. Take a look at the guide for single-node clusters above.

Upgrade

View current values in config file for each chart

• Before upgrading each chart, you can check the settings used in the current installation with
  helm get values <chartname>.

• If the current values are different from the defaults, you will need to change the parameters of the
  helm upgrade command for the chart in question.

• For example, if the backup is currently set to run at 2 AM instead of the 1 AM default, change
  --set backup.hour=1 to --set backup.hour=2.

• Below is a mostly default config.

Open

DSPM/Synergy/Ultimate Helm Chart

To upgrade DSPM/Synergy/Ultimate you must:

1. Download the new bundle

2. Import Docker images

3. Install DSPM/Synergy/Ultimate Helm Chart

GetVisibility Essentials Helm Chart

To upgrade the GV Essential chart you must:

1. Download the new bundle

2. Import Docker images

3. Run the command from Install Getvisibility Essentials under Install Helm charts section

Install custom artifacts

Models and other artifacts, like custom agent versions or custom consul configuration can be shipped inside auto deployable bundles. The procedure to upgrade custom artifact bundles is the same as the installation one, take a look at the guides above for single-node and multi-node installations.