Reinstall an Edge site

Important 

Choose an option below to explore the documentation for the latest user interface (UI) or the 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 reinstall the Edge site without a backup, and the Edge site is unhealthy, you will need to delete the Edge site key and manually re-enter passwords, encrypted text parameters, and any file parameters in each connection to restore full functionality.
  • Go to the Edge site page in your Edge environment.
  • Click Site Actions.
  • Click Delete Edge site key.
  • Review and check the required acknowledgment checkbox.
  • Click Delete.
    A new Edge site key is generated.
  • Click the Connections tab.
  • For each active connection, re-enter the connection credentials to ensure the credentials are encrypted with the newly created Edge site key

Note This process is certified for restoring an Edge site to the CPSH 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
    sudo ./edgecli recovery backup
    Note By default, the backup is generated in the current working directory. If you want to specify where the backup is generated, add the following flag to the command: --path <backup>.

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

  2. If you are reusing the same server as your old Edge site:
    1. Run the uninstall command to uninstall the old installation.

      Go to the /resources/tools directory where the uninstall-edge.sh script is located, and run the following command:

      Copy
      uninstall-edge.sh --remove-local-data
      Note You can run the command from any location if you specify the location of the uninstall script: {uncompressed_installer_directory}/resources/tools/uninstall-edge.sh --remove-local-data
      Example /home/user/centos/installer/resources/tools/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 environment.
    2. Click Site Actions.
    3. Click Redownload Installer.
    4. Review and check the required acknowledgment checkbox.
    5. Click Download 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 downloaded installer to an empty folder.
    Copy
    tar -xf installer-<edge-site-id>.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. Reinstall using the new installer with the backup option, including any additional installation scripts:
    Copy
    sudo sh install-master.sh -r registries.yaml -b <backup_path>
    FlagDescription
    --proxy

    If you are using a forward proxy, add this flag to the installation prerequisite script.

    Note If your proxy properties are not in the default proxy.properties file in the root of the installer, you must add the file path the installation prerequisite script. For example:

    --proxy temp/proxy/proxyproperties

    --ca

    If you want to use a custom certificate, for example to configure a forward man-in-the-middle proxy, add this flag to the installation prerequisite script.

    Note If your custom certificate are not in the default ca.pem file in the root of the installer, you must add the file path the installation prerequisite script. For example:

    --ca temp/certs

    You can also use this flag to add a custom certificate for data sources.

    Your data source may require the injection of a custom certificate in order to connect with your Edge site. This custom certificate is typically signed by a private, untrusted Certificate Authority, and therefore must be added to your Edge site truststore.

    As you may not have a list of all required certificates at the time of installation, we recommend the sudo ./edgecli config ca merge --path command shown in the Edge CLI topic.

    The process functions as follows:

    1. Edge and the data source connect using the data source certificate.
    2. Edge communicates the data source metadata to your Collibra Platform Self-Hosted using a CPSH certified certificate.
    Private container image registryUse the following flags if you want to install your Edge site with a private container image registry, which stores and manages the container images included in an Edge site installation.
    --registry-url <registry-url>

    The URL of your registry.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

    --registry-user <registry-user>

    Your registry account username.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

    --registry-pass <registry-pass>

    Your registry account password.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

    Private Helm registryUse the following flags if you want to install your Edge site with a private Helm registry, which stores and manage the Helm charts included in an Edge site installation.
    --helm-url <helm-registry-url

    The URL of your registry.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

    --helm-user <helm-registry-user>

    Your registry account username. This may look different depending on your authentication method, for example:

    • Username
    • Token name
    • Service principal ID
    • JSON key

    For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

    --helm-pass <helm-registry-pass>

    Your registry account password. This may look different depending on your authentication method, for example:

    • Password
    • Token password
    • Service principal secret
    • Path to JSON file

    For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

    --user-id <user_id>

    If you want to run all of your Edge site pods and containers with a specific user ID (UID), add this flag to the installation script.

    --group-id <group_id>

    If you want to run all of your Edge site pods and containers with a specific group ID (GID), add this flag to the installation script.

    sudo sh install-master.sh -r registries.yaml -b backup.yaml
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12
Tip 
What is your Edge site installation method?
Which Edge CLI method do you want to use?

How to reinstall an Edge site via the Edge CLI method

Note The default Edge CLI method is an easier solution for installing your Edge site via the Edge CLI. Edge creates the cluster level objects, such as namespaces and priority classes for you. This method can be used for both dedicated and shared clusters.

Note The restrictive Edge CLI method allows you or your company to create the cluster level objects, such as namespaces and priority classes, for your Edge site. This method may be required if your company has security requirements or process that do not allow Edge sites to create the cluster level objects for you. This method can be used for both dedicated and shared clusters.

Steps

  1. 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 Site Actions.
    3. Click Redownload Installer.
    4. Review and check the required acknowledgment checkbox.
    5. Click Download 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.

  2. Extract the downloaded installer to an empty folder.
    Copy
    tar -xf installer-<edge-site-id>.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.

  3. 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 commands:
      • Copy
        ./edgecli uninstall
        Note 
        • By default, the backup file name is in the following format: edge-backup-SITE_ID-YYYYMMDD-HHMMSS.yaml. However, if you want to specify where your backup is stored, add the following flag to the uninstall command:
          Copy
          ./edgecli uninstall --path=/tmp/edge/backup
          Copy
          ./edgecli uninstall --path=/tmp/edge/backup/mybackup.yaml
        • If you don't want a backup to be taken, you can add the following flag to the command:--no-backup
          However, we strongly recommend you take a backup of your Edge site if you plan to reinstall it. If you don't create a backup of your Edge site, and then later try to reinstall it, your site will be unhealthy and you will need to manually re-enter all of your connection credentials.
        • Optional, if you used a custom namespace, you must add -n <my-namespace> to the command, replacing <my-namespace> with your custom Edge site namespace.
          Example:
          ./edgecli uninstall -n <my-namespace>
      • Copy
        ./edgecli uninstall 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"
        Note 
        • By default, the backup is generated in the current working directory, with following file name format: edge-backup-SITE_ID-YYYYMMDD-HHMMSS.yaml. However, if you want to specify where your backup is stored, add the following flag to the uninstall command:
          Copy
          ./edgecli uninstall ./edgecli uninstall 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" --path=/tmp/edge/backup
          Copy
          ./edgecli uninstall ./edgecli uninstall 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" --path=/tmp/edge/backup/mybackup.yaml
        • If you don't want a backup to be taken, you can add the following flag to the command: --no-backup
          However, we strongly recommend you take a backup of your Edge site if you plan to reinstall it. If you don't create a backup of your Edge site, and then later try to reinstall it, your site will be unhealthy and you will need to manually re-enter all of your connection credentials.
        • Optional, if you used a custom namespace, you must add -n my-namespace> to the command, replacing my-namespace> with your custom Edge site namespace.
          Example
          ./edgecli uninstall 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" -n my-namespace
  4. 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.
  5. 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
    • Copy
      ./edgecli install -b <backup-file-path>

      Add additional flags to the install command as needed. For example, if you have a custom namespace or want to use a private docker registry:

      FlagDescription
      -n <my-namespace>If you created a custom namespace, add -n <my-namespace> to the command. For example: 
      ./edgecli install -n <my-namespace>
      --proxy

      If you are using a forward proxy, add this flag to the installation prerequisite script.

      Note If your proxy properties are not in the default proxy.properties file in the root of the installer, you must add the file path the installation prerequisite script. For example:

      --proxy temp/proxy/proxyproperties

      --ca

      If you want to use a custom certificate, for example to configure a forward man-in-the-middle proxy, add this flag to the installation prerequisite script.

      Note If your custom certificate are not in the default ca.pem file in the root of the installer, you must add the file path the installation prerequisite script. For example:

      --ca temp/certs

      You can also use this flag to add a custom certificate for data sources.

      Your data source may require the injection of a custom certificate in order to connect with your Edge site. This custom certificate is typically signed by a private, untrusted Certificate Authority, and therefore must be added to your Edge site truststore.

      As you may not have a list of all required certificates at the time of installation, we recommend the ./edgecli config ca merge --path command shown in the Edge CLI topic.

      The process functions as follows:

      1. Edge and the data source connect using the data source certificate.
      2. Edge communicates the data source metadata to your Collibra Platform Self-Hosted using a CPSH certified certificate.
      --is-openshift

      If you are using an OpenShift cluster, add this flag to deploy Security Context Constraints (SCC) which provide the Edge service accounts with the required permissions.

      --disable-otelIf you don't want to send your metrics and logs to Edge, add this flag to the installation command to disable OpenTelemetry.
      Private container image registryUse the following flags if you want to install your Edge site with a private container image registry, which stores and manages the container images included in an Edge site installation.
      --registry-url <registry-url>

      The URL of your registry.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

      --registry-user <registry-user>

      Your registry account username.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

      --registry-pass <registry-pass>

      Your registry account password.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

      Private Helm registryUse the following flags if you want to install your Edge site with a private Helm registry, which stores and manage the Helm charts included in an Edge site installation.
      --helm-url <helm-registry-url

      The URL of your registry.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

      --helm-user <helm-registry-user>

      Your registry account username. This may look different depending on your authentication method, for example:

      • Username
      • Token name
      • Service principal ID
      • JSON key

      For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

      --helm-registry-pass <helm-pass>

      Your registry account password. This may look different depending on your authentication method, for example:

      • Password
      • Token password
      • Service principal secret
      • Path to JSON file

      For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

      --user-id <user_id>

      If you want to run all of your Edge site pods and containers with a specific user ID (UID), add this flag to the installation script.

      --group-id <group_id>

      If you want to run all of your Edge site pods and containers with a specific group ID (GID), add this flag to the installation script.

      --unset-run-as-idsIf your Edge site is installed on an OpenShift Kubernetes cluster, and you want to run all of your Edge site pods and containers from random UIDs and GIDs, add this flag to the installation script.
      --no-priority-class-install
      Warning  Don't skip priority class configuration unless you have an experienced Kubernetes engineer in your organization, as doing so may result in Edge site failures.

      If you need to skip installing priority classes, add this flag to the installation script. Running this flag sets all Edge site pods to the default priority (0).

      --use-custom-priority-class
      Warning  Don't configure custom priority classes unless you have an experienced Kubernetes engineer in your organization, as doing so may result in Edge site failures.

      If you want to configure custom priority classes for your Edge site pods, add this flag, along with the following --set flags, to the installation script:

      • --set global.priorityClassName.platform=<priority>: This flags sets the custom priority class name for Edge platform pods. This should be the highest priority class in Edge.
      • --set global.priorityClassName.application=<priority>: This flag sets the custom priority class name for Edge application pods. This should be the second highest priority class in Edge.
      • --set global.priorityClassName.job=<priority>:This flag sets the custom priority class name for Edge job pods. This should be the third highest priority class in Edge.
      --set global.priorityClassName.platform=critical-priority
--set global.priorityClassName.application=high-priority
--set global.priorityClassName.job=low-priority
      • ./edgecli install -b backup.yaml
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12

       

    • Copy
      ./edgecli install -b <backup-file-path> 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"

      Add additional flags to the install command as needed. For example, if you have a custom namespace or want to use a private docker registry:

      FlagDescription
      -n <my-namespace>If you created a custom namespace, add -n <my-namespace> to the command. For example: 
      ./edgecli install -n <my-namespace>
      --proxy

      If you are using a forward proxy, add this flag to the installation prerequisite script.

      Note If your proxy properties are not in the default proxy.properties file in the root of the installer, you must add the file path the installation prerequisite script. For example:

      --proxy temp/proxy/proxyproperties

      --ca

      If you want to use a custom certificate, for example to configure a forward man-in-the-middle proxy, add this flag to the installation prerequisite script.

      Note If your custom certificate are not in the default ca.pem file in the root of the installer, you must add the file path the installation prerequisite script. For example:

      --ca temp/certs

      You can also use this flag to add a custom certificate for data sources.

      Your data source may require the injection of a custom certificate in order to connect with your Edge site. This custom certificate is typically signed by a private, untrusted Certificate Authority, and therefore must be added to your Edge site truststore.

      As you may not have a list of all required certificates at the time of installation, we recommend the ./edgecli config ca merge --path command shown in the Edge CLI topic.

      The process functions as follows:

      1. Edge and the data source connect using the data source certificate.
      2. Edge communicates the data source metadata to your Collibra Platform Self-Hosted using a CPSH certified certificate.
      --is-openshift

      If you are using an OpenShift cluster, add this flag to deploy Security Context Constraints (SCC) which provide the Edge service accounts with the required permissions.

      --disable-otelIf you don't want to send your metrics and logs to Edge, add this flag to the installation command to disable OpenTelemetry.
      Private container image registryUse the following flags if you want to install your Edge site with a private container image registry, which stores and manages the container images included in an Edge site installation.
      --registry-url <registry-url>

      The URL of your registry.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

      --registry-user <registry-user>

      Your registry account username.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

      --registry-pass <registry-pass>

      Your registry account password.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

      Private Helm registryUse the following flags if you want to install your Edge site with a private Helm registry, which stores and manage the Helm charts included in an Edge site installation.
      --helm-url <helm-registry-url

      The URL of your registry.

      For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

      --helm-user <helm-registry-user>

      Your registry account username. This may look different depending on your authentication method, for example:

      • Username
      • Token name
      • Service principal ID
      • JSON key

      For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

      --helm-registry-pass <helm-pass>

      Your registry account password. This may look different depending on your authentication method, for example:

      • Password
      • Token password
      • Service principal secret
      • Path to JSON file

      For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

      --user-id <user_id>

      If you want to run all of your Edge site pods and containers with a specific user ID (UID), add this flag to the installation script.

      --group-id <group_id>

      If you want to run all of your Edge site pods and containers with a specific group ID (GID), add this flag to the installation script.

      --unset-run-as-idsIf your Edge site is installed on an OpenShift Kubernetes cluster, and you want to run all of your Edge site pods and containers from random UIDs and GIDs, add this flag to the installation script.
      --no-priority-class-install
      Warning  Don't skip priority class configuration unless you have an experienced Kubernetes engineer in your organization, as doing so may result in Edge site failures.

      If you need to skip installing priority classes, add this flag to the installation script. Running this flag sets all Edge site pods to the default priority (0).

      --use-custom-priority-class
      Warning  Don't configure custom priority classes unless you have an experienced Kubernetes engineer in your organization, as doing so may result in Edge site failures.

      If you want to configure custom priority classes for your Edge site pods, add this flag, along with the following --set flags, to the installation script:

      • --set global.priorityClassName.platform=<priority>: This flags sets the custom priority class name for Edge platform pods. This should be the highest priority class in Edge.
      • --set global.priorityClassName.application=<priority>: This flag sets the custom priority class name for Edge application pods. This should be the second highest priority class in Edge.
      • --set global.priorityClassName.job=<priority>:This flag sets the custom priority class name for Edge job pods. This should be the third highest priority class in Edge.
      --set global.priorityClassName.platform=critical-priority
--set global.priorityClassName.application=high-priority
--set global.priorityClassName.job=low-priority
      • ./edgecli install -b backup.yaml
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12
2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"
    Warning  Do not exclude -b <backup-file-path> from this command. If you exclude -b <backup-file-path> 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.

How to reinstall an Edge site via the Helm Chart method

Warning Collibra Support will not assist with custom Helm or Kubernetes configurations. The following steps are an example, and any assistance for configurations or issues outside of these steps is unsupported. We recommend using the Edge CLI method for managed Kubernetes installations.

A common example of custom Helm configurations is, but not limited to, using an unsupported private repository. For more information, go to our supported private helm registries documentation.

Steps

  1. Back up your current Edge site. If you don't create a backup before you reinstall your Edge site, your Edge site will become unhealthy and your connection credentials will be lost.
    Copy
    kubectl get -n <my-namespace> secrets -l edge.collibra.com/backup -o yaml > <PATH_OF_BACKUP_FILE>
    PropertyDescription
    <my-namespace>

    The Edge site namespace.

    • If your Edge site has a custom namespace, add it here.
    • If your Edge site does not have a custom namespace, add the default namespace, collibra-edge.
    <PATH_OF_BACKUP_FILE>The name of the output yaml file containing your Edge site backup. For example, myBackupFile.yaml.
  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 Site Actions.
    3. Click Redownload Installer.
    4. Review and check the required acknowledgment checkbox.
    5. Click Download 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 downloaded installer to an empty folder.
    Copy
    tar -xf installer-<edge-site-id>.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. From the extracted TGZ archive directory, run the uninstall command.
    Note For each of the following commands, replace <my-namespace> with the name of your Edge site namespace.
    • If you installed your Edge site prior to the 2025.06 release and used the edge-cd helm chart, use the following command:
      Copy
      sh edge-cd-helm-chart/helm-uninstall.sh --namespace <my-namespace>
    • If you installed your Edge site from or after the 2025.06 release, using the collibra-edge helm art, use the following command:
      Copy
      sh collibra-edge-helm-chart/helm-uninstall.sh --namespace <my-namespace>

  5. Run the following command to apply the Edge site backup file:

    Copy 
    kubectl apply -f <PATH_OF_BACKUP_FILE>
  6. From inside the extracted TGZ archive directory , run the helm installer prerequisite script, including any additional helm install script flags you may need to configure. For example, if you want to use a custom namespace or install your Edge site on an OpenShift cluster.

    Collibra-edge is the single helm chart containing the Edge site. The following prerequisites are handled in 1 execution step via a bash script:

    • Cluster scoped resourced, such as namespace, priority classes, and, if you have an OpenShift cluster, SCC, must be installed on the managed Kubernetes cluster.
    • Secrets, such as repository access for Collibra and Datadog, must be preprocessed and installed.
    • Forward proxy and custom ca information must be preprocessed in order for proxy.properties and ca.pem to be installed in the managed Kubernetes cluster.
    • Many helm chart values are generated in the site-values.yaml file based on the optional flags added to the install prerequsite script. This means you don't manually have to specify this information in the installation script.

    Copy
    sh collibra-edge-helm-chart/helm-install-prerequisites.sh --namespace <my-namespace> --installer .
    Note When you run the installation command, a list of all of these flags are listed. When you run the full command, every command and property run is listed.
    FlagDescription
    --installer <path_to_extracted_installer>
    Note This property is required for all Edge site installations
    		The path to the downloaded, extracted Edge installer.
    --namespace <my-namespace>

    The identifier of the Edge site.

    • If you are installing multiple Edge sites in the same Kubernetes cluster, each Edge site namespace must be unique. For example, --namespace edge-namespace.
    • If you do not specify a namespace, the default collibra-edge namespace is used.
    Note Throughout the remaining installation steps, replace <my-namespace> in the provided scripts with this new namespace name. Example scripts will have edge-namespace as an example namespace name.
    --is-openshift

    If you are using an OpenShift cluster, add this flag to deploy Security Context Constraints (SCC) which provide the Edge service accounts with the required permissions.

    --proxy

    If you are using a forward proxy, add this flag to the install prerequisite script.

    Note If your proxy properties are not in the default proxy.properties file in the root of the Edge installer, you must:

    1. Add your proxy properties to a folder relative to the Edge installer.
    2. Add the file path of the proxy properties file, relative to the Edge installer, to the install prerequisite script. For example, if you added the proxy properties file to a folder called proxy within the Edge installer folder, add the following to the script:
      --proxy proxy/myproxy.properties

    --ca

    If you want to use a custom certificate, for example to configure a forward man-in-the-middle proxy, add this flag to the install prerequisite script.

    Note If your custom certificate is not in the default ca.pem file in the root of the Edge installer, you must:

    1. Add your certificate file to a folder relative to the Edge installer.
    2. Add the file path of the custom certificate file, relative to the Edge installer, to the installation prerequisite script. For example, if you added the custom certificate file to a folder called mycerts within the Edge installer folder, add the following to the script:
      --ca mycerts/certs.pem

    --disable-otelIf you don't want to send your metrics and logs to Edge, add this flag to the install prerequisite script to disable OpenTelemetry.
    Private container image registryUse the following flags if you want to install your Edge site with a private container image registry, which stores and manages the container images included in an Edge site installation.
    --registry-url <registry-url>

    The URL of your registry.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

    --registry-user <registry-user>

    Your registry account username.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

    --registry-pass <registry-pass>

    Your registry account password.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private container image registry documentation.

    Private Helm registryUse the following flags if you want to install your Edge site with a private Helm registry, which stores and manage the Helm charts included in an Edge site installation.
    --helm-url <helm-registry-url

    The URL of your registry.

    For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

    --helm-user <helm-registry-user>

    Your registry account username. This may look different depending on your authentication method, for example:

    • Username
    • Token name
    • Service principal ID
    • JSON key

    For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

    --helm-pass <helm-registry-pass>

    Your registry account password. This may look different depending on your authentication method, for example:

    • Password
    • Token password
    • Service principal secret
    • Path to JSON file

    For more information about the flags and format required for the supported registries and authentication methods, go to the private Helm registry documentation.

    --user-id <user_id>

    If you want to run all of your Edge site pods and containers with a specific user ID (UID), add this flag to the install prerequisite script.

    --group-id <group_id>

    If you want to run all of your Edge site pods and containers with a specific group ID (GID), add this flag to the install prerequisite script.

    --unset-run-as-idsIf your Edge site is installed on an OpenShift Kubernetes cluster, and you want to run all of your Edge site pods and containers from random UIDs and GIDs, add this flag to the installation script.
    --no-priority-class-install
    Warning  Don't skip priority class configuration unless you have an experienced Kubernetes engineer in your organization, as doing so may result in Edge site failures.

    If you need to skip installing priority classes, add this flag to the install script. Running this flag sets all Edge site pods to the default priority (0).

    --use-custom-priority-class
    Warning  Don't configure custom priority classes unless you have an experienced Kubernetes engineer in your organization, as doing so may result in Edge site failures.

    If you want to configure custom priority classes for your Edge site pods, add this flag, along with the following priority class name flags, to the install script:

    • --global.priorityClassName.platform <priority>: This flags sets the custom priority class name for Edge platform pods. This should be the highest priority class in Edge.
    • --global.priorityClassName.application <priority>: This flag sets the custom priority class name for Edge application pods. This should be the second highest priority class in Edge.
    • --global.priorityClassName.job <priority>:This flag sets the custom priority class name for Edge job pods. This should be the third highest priority class in Edge.
    --use-custom-priority-class 
--global.priorityClassName.platform critical-priority
--global.priorityClassName.application high-priority
--global.priorityClassName.job low-priority

  7. Install your Edge site using the Helm installer script, replacing <my-namepsace> with your Edge site namespace.:

    Copy 
    helm install collibra-edge collibra-edge-helm-chart/collibra-edge -n <my-namespace> --values site-values.yaml
    Note 
    • If you need to review the default collibra-edge chart values included when you run the Helm installer script, you can either inspect the values.yaml or README.md files in ./collibra-edge-helm-chart/collibra-edge. If you need to override, manually add the value to the command using the --set flag.

How to reinstall an Edge site via the Zarf package method

Important The Zarf package method is only supported if you have an Air-gapped Collibra Platform and environment.

Steps

  1. Create a backup of your Air-gapped Edge site.

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

    Copy
    ./edgecli recovery backup --path <backup_path>

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

  2. From the Downloads page, click the latest Collibra Zarf package.
    Note If you do not see Collibra CPSH extended capabilities please reach out to your Collibra account team.
  3. From the CollibraZarf package page, click and download the Edge ZARF package.
  4. If you don't plan to install Technical lineage Collibra Platform Self-Hosted, apply these priority classes with kubectl apply -f cpsh-priority-classes.yaml and /cpsh-platform-zarf-package/resources/cpsh-priority-classes.yaml:
    Copy
    apiVersion: scheduling.k8s.io/v1
    kind: PriorityClass
    metadata:
      name: platform
    value: 10000000
    description: "Platform supporting services level"
    ---
    apiVersion: scheduling.k8s.io/v1
    kind: PriorityClass
    metadata:
      name: application
    value: 100000
    description: "Application level"
    ---
    apiVersion: scheduling.k8s.io/v1
    kind: PriorityClass
    metadata:
      name: job
    value: 1000
    description: "Job level"
  5. Set up your kubeconfig or kubecontext so that it points to your Kubernetes cluster.
  6. Using the Zarf CLI:
    1. Copy and paste the following command in the ZARF CLI:
      Copy
      zarf package deploy <ZARF_PACKAGE_FILE> \
          --set PLATFORM_ID=<DIC_PLATFORM_URL> \
          --set PLATFORM_USER=<DIC_PLATFORM_USER> \
          --set PLATFORM_PASSWORD=<DIC_PLATFORM_PASSWORD> \
          --set SITE_NAME=<SITE_NAME> \
          --set EDGE_BACKUP_FILE=<EDGE_BACKUP_FILE>
    2. Enter the relevant details for each installation flag. For example, enter your Collibra Platform Self-Hosted URL for <DGC URL>.
      FlagDescription
      zarf package deploy <PATH TO ZARF PACKAGE>The path Edge site Zarf package you downloaded.
      --set PLATFORM_ID=<DIC URL>The URL of your Collibra Platform Self-Hosted.
      --set PLATFORM_USER=<DIC ADMIN NAME>The username of your Collibra admin.
      --set PLATFORM_PASSWORD=<DIC ADMIN PASSWORD>The password of your Collibra admin.
      --set SITE_NAME=<SITE_NAME>The desired name of your Edge site.
      Important 
      • If you don't enter a site name, your Air-gapped Edge site is created with the default name: CPSH-Collibra-Edge.
      • If you plan to have more than 1 Air-gapped Edge site on the same Collibra Platform, ensure that each site has a unique name. If you have multiple Air-gapped Edge sites with the same name on the same Collibra Platform, your sites may fail to deploy.
      --set EDGE_BACKUP_FILE=<EDGE_BACKUP_FILE>If you have stored the Edge site backup file somewhere other than the default location, specify the file path to your Edge site backup.
      Copy
      zarf package deploy zarf/edgefolder \
          --set PLATFORM_ID=https://mycollibra.com \
          --set PLATFORM_USER=EdgeUser1 \
          --set PLATFORM_PASSWORD=Pass1234 \
          --set SITE_NAME=EdgeSite1234 \
          --set EDGE_BACKUP_FILE=edgebackupfile.yaml
    3. Run the command to reinstall the Edge site.
      Your Air-gapped Edge site is reinstalled and deployed.
      Note  If an Air-gapped Edge site fails to install on your Kubernetes cluster, a site is still created in Edge. You can choose to do one of the following:
      • Remove the failed Edge site from your Kubernetes cluster and Edge by running the following command:
        Copy
        zarf package remove ZARF_PACKAGE_FILE/ZARF_PACKAGE_NAME
      • Remove the failed Edge site from your Kubernetes cluster, but keep the Edge site in Edge by running the following command:
        Copy
         ZARF_VAR_KEEP_CPSH_EDGE_SITE=true \
             zarf package remove ZARF_PACKAGE_FILEZARF_PACKAGE_NAME
        When you try to install or reinstall the failed Air-gapped Edge site installation, you can use the same name to reuse the Edge site in Edge.