Install an Edge site

Important

In Collibra 2024.02, we've launched a new user interface (UI) in beta for Collibra Data Intelligence Platform! You can learn more about this latest UI in the UI overview.

Use the following options to see the documentation in the latest UI or in the previous, classic UI:

Latest UI (beta) Classic UI

After you have created the Edge site in Collibra Data Intelligence Platform, you have to install the Edge software on a server.

Tip

Every time you download an Edge site installer, the previously downloaded Edge site installer becomes outdated. If you use this outdated installer, the Edge site cannot communicate with Collibra.

Prerequisites

You have a global role with the Install Edge sites and the User Administration global permission, for example Edge site administrator.
You have created an Edge site.
You have configured the forward proxy, if a forward proxy is required for Edge to connect to Collibra, Datadog, OpenTelemetry and jFrog. Contact your network administrator if this is applicable.
Your server meets all system requirements.

Steps

K3S
Managed Kubernetes

Download the installer:
1. Open an Edge site.
  1. On the main toolbar, click , and then click Settings.
    The Collibra settings page opens.
  2. Click Edge.
    The Edge sites overview opens.
  3. Click the name of an Edge site in the Edge site overview.
    The Edge site page opens.
2. Click Download in the Installer and properties files section.Click Download Installer.
  Tip When you download the installer, an Edge user is automatically created in Collibra.
3. Depending on your operating system and browser, follow the regular steps for downloading files.
  The installer file is a TGZ archive that contains the files proxy.properties, properties.yaml and registries.yaml.
  Warning If you download an installer, the previously downloaded Edge site installer becomes invalid.
Extract the TGZ archive on the server on which you want to install the Edge site software.
```
tar -xf <edge-site-id>-installer.tgz
```
Note
- Keep the installer or the contents of the extracted installer in a secure location on your server. These contents contain various tools that you may need later, for example to troubleshoot issues.
- If you want to run a script or executable file from the extracted directory, ensure that the directory is not mounted as noexec. If a directory is mounted as noexec, scripts and executable files will be prevented from being run within the directory.

Run the installation. Use the correct path to the mounted storage as described in the prerequisites.

Important

If the Edge site has to connect via a forward HTTP proxy, then first configure the forward proxy before executing the installation.

Installation with profiling and classification enabled:

sudo sh install-master.sh --storage-path /path/mounted/storage properties.yaml -r registries.yaml --set collibra_edge.collibra.classification.enabled=true

for example:

sudo sh install-master.sh --storage-path /var/edge/storage properties.yaml -r registries.yaml --set collibra_edge.collibra.classification.enabled=true

Installation with profiling and classification disabled:

sudo sh install-master.sh --storage-path /path/mounted/storage properties.yaml -r registries.yaml

for example:

sudo sh install-master.sh --storage-path /var/edge/storage properties.yaml -r registries.yaml

In the Edge sites overview, you can see the status of the deployment.

Run the following commands to verify the status of the installation.
- To ensure that Kubernetes is running and that there is an existing node:
```
sudo /usr/local/bin/kubectl get nodes
```
- To ensure the state of all pods are installed and running:
```
sudo /usr/local/bin/kubectl get pods --all-namespaces
```

Tip If you have already installed the Edge site and you want to enable classification afterwards, see this article.

Note Edge supports the following managed, dedicated Kubernetes clusters:

AKS
AWS Fargate using EKS
EKS
GKE
OpenShift

Follow the steps below if you use a supported dedicated Kubernetes cluster.

Download the installer:
1. Open an Edge site.
  1. On the main toolbar, click , and then click Settings.
    The Collibra settings page opens.
  2. Click Edge.
    The Edge sites overview opens.
  3. Click the name of an Edge site in the Edge site overview.
    The Edge site page opens.
2. Click Download in the Installer and properties files section.Click Download Installer.
  Tip When you download the installer, an Edge user is automatically created in Collibra.
3. Depending on your operating system and browser, follow the regular steps for downloading files.
  The installer file is a TGZ archive that contains the files proxy.properties, properties.yaml and registries.yaml.
  Warning If you download an installer, the previously downloaded Edge site installer becomes invalid.
Extract the TGZ archive on the server on which you want to install the Edge site.
```
tar -xf <edge-site-id>-installer.tgz
```
Note
- Keep the installer or the contents of the extracted installer in a secure location on your server. These contents contain various tools that you may need later, for example to troubleshoot issues.
- If you want to run a script or executable file from the extracted directory, ensure that the directory is not mounted as noexec. If a directory is mounted as noexec, scripts and executable files will be prevented from being run within the directory.
Run the installation on the machine that has the Kubernetes connection.
1. Clean installation:
```
./run-installer-job.sh properties.yaml
```
2. Installation with classification enabled:
```
./run-installer-job.sh properties.yaml --set collibra_edge.collibra.classification.enabled=true
```
In the Edge sites overview, you can see the status of the installation.
Run the following commands to verify the status of the installation.
- To ensure that Kubernetes is running and that there is an existing node:
```
kubectl get nodes
```
- To ensure the state of the installation is either running or finished:
```
kubectl get pods --all-namespaces
```

Tip If you have already installed the Edge site and you want to enable classification afterwards, see this article.