Install an Edge site

After you have created the Edge site in Collibra Data Intelligence Cloud, 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 invalid.
  • If you want to use a custom CA to secure the communication between your Edge site and Collibra, first read the Use a custom CA topic.

Prerequisites

  • You have a global role with the Install Edge sites and the User Administration global permission, for example Edge site administrator
  • You have a global role that has the System administration global permission.
  • You have created an Edge site.
  • You have configured the outbound proxy, if necessary.
  • Your server meets the system requirements.
    Tip If you are an early adopter or you use Edge for beta testing purposes, we highly recommend to disable SELinux.
  • On the server, you have 50 GB of free space available on the file system where /var/lib/rancher/k3s is located.
  • On the server, you have mounted at least 500 GB of dedicated storage for the Edge sites on a freely chosen mountpoint, for example /var/edge/storage.
    mkdir -p /var/edge/storage
    mkfs.xfs /dev/<block-device-name>
    mount /dev/<block-device-name> /var/edge/storage
    echo '/dev/<block-device-name> /var/edge/storage xfs defaults 0 0' >> /etc/fstab
    Note 
    • Change <block-device-name> to the name of the device that contains the storage.
    • You cannot use / or $HOME/... as mount point.
  • If a firewall is enabled, run the following commands to add the cni0 and loopback interfaces to a trusted zone, so that Kubernetes can use it between its services:
    firewall-cmd --zone=trusted --change-interface=cni0 --permanent
    firewall-cmd --zone=trusted --change-interface=lo --permanent
    firewall-cmd --reload
  • If you want to use a certificate, issued by a custom Certificate Authority, ensure that you have the certificate saved on your server.

Steps

  1. Download the installer:
    1. Open an Edge site.
      1. In the main menu, click , then Settings.
        The Collibra settings page appears.
      2. Click Edge
        The Edge sites overview appears.
      3. In the Edge site overview, click the name of an Edge site.
        The Edge site page appears.
    2. In the Installer and properties files section, click Download.

      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.

      Note If you download an installer, the previously downloaded Edge site installer becomes invalid.

  2. Extract the TGZ archive on the server on which you are going to install the Edge site.

    tar -xf <edge-site-id>-installer.tgz

    Tip Keep the installer or the content of the extracted installer somewhere safe on your server. It contains various tools that you may need later, for example to troubleshoot issues.

  3. Execute the installation.

    Note  If the Edge site has to connect via an outbound HTTP proxy, then first configure the outbound proxy before executing the installation.
    • Use Collibra certificates or use a custom CA certificate, that is saved in the Edge site installer directory:
      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
    • Use a custom CA certificate, that is not saved in the Edge site installer directory:
      sudo sh install-master.sh --storage-path /path/mounted/storage properties.yaml -r registries.yaml --ca /path/to/<custom-ca-cert.pem file>

      for example:

      sudo sh install-master.sh --storage-path /var/edge/storage properties.yaml -r registries.yaml --ca /path/to/<custom-ca-cert.pem file>
    In the Edge sites overview, you can see the status of the installation.
  4. 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 the installation is either running or finished:
      sudo /usr/local/bin/kubectl get pods --all-namespaces
  5. Optionally, enable classification via Edge.

    sudo /usr/local/bin/kubectl patch  --type=merge -n kube-system HelmChart edge-install -p '{"spec":{"set":{"collibra_edge.collibra.classification.enabled":"true"}}}'