Reinstall an Edge site

Important 

In Collibra 2024.05, we launched a new user interface (UI) 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:

You always reinstall an Edge site by restoring a backup of that Edge site. Reinstallation may be necessary to resolve an issue or to upgrade the software included in the Edge site installer.

Warning If you have any existing connections, we highly recommend backing up your site and reinstalling the site from the backup. If you do not use a backup, you will need to manually re-enter passwords, encrypted text parameters, and any file parameters in each connection to restore full functionality.

Note This process is certified for restoring an Edge site to the Collibra environment on which the site was originally created, for example, restoring Development to Development or Production to Production. The process is not certified or tested for promoting an Edge site migration from one environment to another, for example, from Development to Production. These types of migrations require the reinstallation of the Edge application each time the migration is promoted.

  • Reinstall an Edge site on K3S
  • Reinstall an Edge site on managed Kubernetes

Steps

  1. Back up your current Edge site.

    On the server that runs your Edge site, run the following command:

    Copy
    ~$ edge backup -o /<path to folder where you want to save the backup file>/<backup-name>.yaml

    Edge creates a backup of your Edge site in the selected folder of the command.

    Important If the Edge command is not available, you will need to download the Edge tool and make it available in /usr/local/bin/edge

  2. If you are reusing the same server as your old Edge site:
    1. Use the Edge tool command to uninstall the old installation.
      Run the following Edge command from any location on the server Edge is installed on: uninstall-edge.sh --remove-local-data
    2. Recreate the Linux disk mount for the /var/lib/rancher/k3s directory.
      1. Create /var/lib/rancher/k3s with mkdir -p /var/lib/rancher/k3s
      2. Mount the disk with "mount -a"
      3. Delete the contents with rm -rf /var/lib/rancher/k3s/*
      Note This is the default installation path. If it is not created as a separate mount point after following the steps above, the installation will use 50 GB of disk space from either /var, or if not present, the root level of the drive.
  3. Redownload the installer.
    1. Go to the Edge site page in your Edge enviornment.
    2. Click ActionsSite Actions.
    3. Click Redownload Installer.
    4. Review and check the required acknowledgment checkbox.
    5. Click DownloadDownload Installer.
    6. Save the new installer to your server where the old installer was saved.

    Note This is a new installer for your Edge site. The previous installer will no longer work.

  4. Extract the installer.
    Copy
    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.
  5. If you use a custom setup, such as proxy.properties and ca.pem for forward proxies or classification, ensure that it is available or included as it was in the previous setup.
  6. Reinstall using the new installer with the backup option:
    Note Unified Data Classification is now the default classification method and is configured separately from the Edge site installation. This means Edge doesn't require additional setup for Unified Data Classification. You can use the deprecated data classification via Edge method until September 30.
    Copy
    sudo install-master.sh 
    --storage-path /var/edge/storage properties.yaml r registries.yaml
    --set collibra.classification.enabled=true 
    -b backup.yaml
    Copy
    sudo sh install-master.sh 
    --storage-path /path/mounted/storage properties.yaml -r registries.yaml 
    -b backup.yaml
    • If you want to use a private docker registry, add the following parameters to the install command:
      ParametersDescription
      --registry-url (required)

      The URL of your private docker registry.

      For example:

      https://edge-docker-delivery.repository.collibra.io

      --registry-host (optional)

      Where your private docker is hosted. If you do not specify this parameter, it is automatically derived from --registry-url

      For example:

      edge-docker-delivery.my-registry.docker.io

      --registry-user (optional)The username of the private docker registry. This parameter is not required if registry is public.
      --registry-pass (optional)The password of the private docker registry. This parameter is not required if registry is public.
      sudo sh install-master.sh 
--storage-path /var/edge/storage properties.yaml -r registries.yaml
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12

You can reinstall your Edge site on a managed Kubernetes cluster by using the Edge CLI tool.

Note Edge supports the following managed Kubernetes clusters:
  • AKS
  • AWS Fargate using EKS
  • EKS
  • GKE
  • OpenShift

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

Steps

  1. Back up your current Edge site.

    On the server from which you manage your managed, dedicated kubernetes cluster, run the following command:

    Copy
    ~$ edge backup -o /<path to folder where you want to save the backup file>/<backup-name>.yaml

    Edge creates a backup of your Edge site in the defined folder of the last command.

    Important If the Edge command is not available, you will need to download the Edge tool and make it available in /usr/local/bin/edge

  2. Redownload the installer and save it on your Linux server that has kubectl access to the k8s cluster.
    1. Go to the Edge site page in your Edge environment.
    2. Click ActionsSite Actions.
    3. Click Redownload Installer.
    4. Review and check the required acknowledgment checkbox.
    5. Click DownloadDownload Installer.
    6. Save the new installer to your server where the old installer was saved.

    Note This is a new installer for your Edge site. The previous installer no longer works.

  3. Extract the installer.
    Copy
    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.

  4. Use the Edge uninstall command, depending on your Edge site installation method, to uninstall the old installation.

    • If you installed your Edge site using the previous method, follow the path inside the extracted installer and run the following command:
      Copy
      extracted installer>/resources/installer-job/tools/uninstall-edge-on-managed-k8s.sh
    • If you installed your Edge site using the Edge CLI method, run one of the following command:
      • With terminal logging
        Copy
        ./edgecli uninstall

      • With terminal and file logging

        Copy
        ./edgecli uninstall 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"
  5. If you use a custom setup, such as proxy.properties and ca.pem for forward proxies or classification, ensure that it is available or included as it was in the previous setup.
  6. Reinstall using the new installer and backup:
    Note 
    • You can install your Edge site with either terminal logging or terminal and file logging. Both options log the output of your Edge site installation.
      • Terminal logging only saves the output to the Edge terminal.
      • Terminal and file logging saves the output both to the terminal and a separate file. This file will be saved in the current directory with the naming format: edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log
    • Unified Data Classification is now the default classification method and is configured separately from the Edge site installation. This means Edge doesn't require additional setup for Unified Data Classification. You can use the deprecated data classification via Edge method until September 30.

      • With terminal logging

        Copy
        ./edgecli install --set collibra.classification.enabled=true
      • With terminal and file logging…
        Copy
        ./edgecli install --set collibra.classification.enabled=true 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"
    • Copy
      ./edgecli install -b backup
    • Copy
      ./edgecli install -b backup 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"
    • If you want to use a private docker registry, add the following parameters to the install command:
      ParametersDescription
      --registry-url (required)

      The URL of your private docker registry.

      For example:

      https://edge-docker-delivery.repository.collibra.io

      --registry-host (optional)

      Where your private docker is hosted. If you do not specify this parameter, it is automatically derived from --registry-url

      For example:

      edge-docker-delivery.my-registry.docker.io

      --registry-user (optional)The username of the private docker registry. This parameter is not required if registry is public.
      --registry-pass (optional)The password of the private docker registry. This parameter is not required if registry is public.
      • With terminal logging:
        ./edgecli install 
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12
-b backup
      • With terminal and file logging:
        ./edgecli install 
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12
-b backup 
2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"
    Warning  Do not exclude -b backup.yaml from this command. If you exclude -b backup.yaml from the command, your Edge site will be reinstalled without your backup and previous configurations, such as passwords, encrypted text parameters, and any file parameters in each connection. Additionally, you will not be able to use that backup in any future reinstallations.