Install 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:

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.

  • K3S
  • Managed Kubernetes

Prerequisites

Steps

  1. Download the installer:
    1. Open an Edge site.
      1. On the main toolbar, click Products icon, and then click Cogwheel icon Settings.
        The Collibra settings page opens.
      2. In the tab pane, click Edge.
        The Sites tab opens and shows a table with an overview of the Edge sites.
      3. In the Edge site overview, click the name of an Edge site.
        The Edge site page appears.
    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.

  2. Extract the TGZ archive on the server on which you want to install the Edge site software.
    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.
  3. 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.
    Copy
    sudo sh install-master.sh properties.yaml -r registries.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 properties.yaml -r registries.yaml
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12
    • Optional, if you want to use a proxy, add --proxy <path to properties file> to the install command.
      • You want to install your Edge site with a forward proxy.
        1. Prepare the proxy.properties file to point to your proxy server address, port, and credentials.
        2. Run the following command:
          Copy
          sudo sh install-master.sh properties.yaml --proxy proxy.properties
    • Optional, if you want to use a custom certificate, add --ca ca.pem to the install command.
      1. You want to install your Edge site with a forward man-in-the-middle (MITM) proxy.
        1. Prepare the proxy.properties file to point to your MITM proxy server address, port, and credentials.
        2. Prepre the ca.pem certificate file. This is the Certificate Authority that the forward MITM proxy uses to sign Certificates.
        3. Run the following command:
          Copy
          sudo sh install-master.sh properties.yaml --proxy proxy.properties --ca ca.pem
    In the Edge sites overview, you can see the status of the deployment.
  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:
      Copy
      sudo /usr/local/bin/kubectl get nodes
    • To ensure the state of all pods are installed and running:
      Copy
      sudo /usr/local/bin/kubectl get pods --all-namespaces
Tip 
What is your Edge site installation method?
Which Edge CLI method do you want to use?

Important 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, CRDs, and priority classes for you. This method can be used for both dedicated and shared clusters.

Important The restrictive Edge CLI method allows you or your company to create the cluster level objects, such as namespaces, CRDs, 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.

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. At this time, we only support a JFrog repository.

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.
  • You will install your Edge site on a supported Kubernetes cluster.
  • You must have namespace level access to the Kubernetes cluster where you want to install your Edge site.
  • You must have admin level access to your the Kubernetes cluster where you want to install your Edge site.
  • You must have admin privileges to create the collibra-edge namespace, priority classes, and CRD’s when executing the install script.
  • You must run the following commands on a virtual machine where yq and jq can be executed.

Steps

  1. Download the installer:
    1. Open an Edge site.
      1. On the main toolbar, click Products icon, and then click Cogwheel icon Settings.
        The Collibra settings page opens.
      2. In the tab pane, click Edge.
        The Sites tab opens and shows a table with an overview of the Edge sites.
      3. In the Edge site overview, click the name of an Edge site.
        The Edge site page appears.
    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.

  2. Extract the TGZ archive on the server on which you want to install the Edge site.
    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.
  3. Set the EDGE_INSTALLER_PATH environment variable to the path of the root of the extracted installer.
    1. Go to the extracted installer and run pwd.The result should look similar to this:
      /path/to/installer/installer-111e8a59-b842-4f57-970c-32aa72000598
    2. Set the environment variable to the result: 
      export EDGE_INSTALLER_PATH=/path/to/installer/installer-111e8a59-b842-4f57-970c-32aa72000598
  4. Run the following command to confirm that the Kubeconfig environment variable has been set to a valid kubeconfig:
    Copy
    echo $KUBECONFIG  
  5. Deploy cluster level objects:
    • Create the namespace for collibra-edge.
      Note Clusters that have more than one Edge site installed must have unique namespaces.
      1. Copy the following command, replacing <my-namespace> with a unique name for the namespace:
        Copy
        apiVersion: v1
        kind: Namespace
        metadata:
          labels:
              name: <my-namespace>
            pod-security.kubernetes.io/enforce: baseline
            pod-security.kubernetes.io/enforce-version: v1.27
        name: <my-namespace>
      2. Store this copied yaml into a new file called collibra-edge-ns.yaml.
      3. Create the namespace using kubectl:
        Copy
        kubectl apply -f collibra-edge-ns.yaml <my-namespace>
      Note Throughout the remaining installation steps, replace <my-namespace> in the provided commands with this new namespace name. Example commands will have edge-namespace as an example namespace name.
    • If you are using an Openshift cluster, deploy Security Context Constraints (SCC) which provide Edge service accounts with the required permissions.
      1. Create the SCC file, for example, edge-scc-minimal.yaml, and paste the following information into it:
        Copy
        # File : edge-scc-minimal.yaml
        ---
        apiVersion: security.openshift.io/v1
        kind: SecurityContextConstraints
        metadata:
          annotations:
          name: edge-scc-minimal
        allowHostDirVolumePlugin: false
        allowHostIPC: false
        allowHostNetwork: false
        allowHostPID: false
        allowHostPorts: false
        allowPrivilegeEscalation: false
        allowPrivilegedContainer: false
        allowedCapabilities:
          - "NET_BIND_SERVICE"
        allowedUnsafeSysctls: []
        defaultAddCapabilities: null
        fsGroup:
          type: RunAsAny
        priority: null
        # switch for capabilities
        readOnlyRootFilesystem: false
        requiredDropCapabilities: null
        runAsUser:
          type: MustRunAs
          uid:1000
        seLinuxContext:
          type: RunAsAny
        seccompProfiles:
          - '*'
        supplementalGroups:
          type: RunAsAny
        users:
        volumes: ["*"]
      2. Create the SCC-role file, for example, edge-scc-role-minimal.yaml, and paste the following information into it:
        Copy
        # File: edge-scc-role-minimal.yaml
        apiVersion: rbac.authorization.k8s.io/v1
        kind: Role
        metadata:
          name: edge-scc-minimal
        rules:
        - apiGroups:
          - security.openshift.io
          resourceNames:
          - edge-scc-minimal
          resources:
          - securitycontextconstraints
          verbs:
          - use
        ---
        apiVersion: rbac.authorization.k8s.io/v1
        kind: RoleBinding
        metadata:
          name: edge-scc-minimal
        subjects:
        - kind: Group
          name: system:serviceaccounts
          apiGroup: rbac.authorization.k8s.io
        roleRef:
          kind: Role
          name: edge-scc-minimal
          apiGroup: rbac.authorization.k8s.io
      3. Deploy both the SCC and SCC-role files:
        Copy
        kubectl apply -f edge-scc-minimal.yaml
        kubectl apply -f edge-scc-role-minimal.yaml -n <my-namespace>
    • For all cluster types, deploy Custom Resource Definitions (CRDs).
      Note If you already have Argo Workflow CRDs on your cluster, you only need to add the priority class to your existing CRDs.

      Extract and deploy the installer to the directory on your Linux machine where your Edge site will be installed:

      Copy
      kubectl apply -f "resources/crds/*.yaml"
    • For all cluster types, deploy priority classes:
      Copy
      kubectl apply -f resources/custom/priorityclass.yaml
  6. Run one of the following installation commands on the machine that has the Kubernetes connection:
    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 -n <my-namespace>
      • Optional, 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.
        ./edgecli install
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12
      • Optional, if you want to use a proxy, add --proxy <path to properties file> to the install command.
        • You want to install your Edge site with a forward proxy.
          1. Prepare the proxy.properties file to point to your proxy server address, port, and credentials.
          2. Run the following command:
            Copy
            ./edgecli install --proxy proxy.properties
      • Optional, if you want to use a custom certificate, add --ca ca.pem to the install command.
        1. You want to install your Edge site with a forward man-in-the-middle (MITM) proxy.
          1. Prepare the proxy.properties file to point to your MITM proxy server address, port, and credentials.
          2. Prepre the ca.pem certificate file. This is the Certificate Authority that the forward MITM proxy uses to sign Certificates.
          3. Run the following command:
            Copy
            ./edgecli install --proxy proxy.properties --ca ca.pem
    • Copy
      ./edgecli install 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" -n <my-namespace>
      • Optional, 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.
        ./edgecli install
--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"
      • Optional, if you want to use a proxy, add --proxy <path to properties file> to the install command.
        • You want to install your Edge site with a forward proxy.
          1. Prepare the proxy.properties file to point to your proxy server address, port, and credentials.
          2. Run the following command:
            Copy
            ./edgecli install 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" --proxy proxy.properties
      • Optional, if you want to use a custom certificate, add --ca ca.pem to the install command.
        1. You want to install your Edge site with a forward man-in-the-middle (MITM) proxy.
          1. Prepare the proxy.properties file to point to your MITM proxy server address, port, and credentials.
          2. Prepre the ca.pem certificate file. This is the Certificate Authority that the forward MITM proxy uses to sign Certificates.
          3. Run the following command:
            Copy
            ./edgecli install 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" --proxy proxy.properties --ca ca.pem
    In the Edge sites overview, you see the status of the installation.
  7. Run the following command to verify the status of the installation.
    Copy
    kubectl get pods -n <my-namespace>
  1. Download the installer:
    1. Open an Edge site.
      1. On the main toolbar, click Products icon, and then click Cogwheel icon Settings.
        The Collibra settings page opens.
      2. In the tab pane, click Edge.
        The Sites tab opens and shows a table with an overview of the Edge sites.
      3. In the Edge site overview, click the name of an Edge site.
        The Edge site page appears.
    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.

  2. Extract the TGZ archive on the server on which you want to install the Edge site.
    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.
  3. Set the EDGE_INSTALLER_PATH environment variable to the path of the root of the extracted installer.
    1. Go to the extracted installer and run pwd.The result should look similar to this: 
      /path/to/installer/installer-111e8a59-b842-4f57-970c-32aa72000598
    2. Set the environment variable to the result:
      export EDGE_INSTALLER_PATH=/path/to/installer/installer-111e8a59-b842-4f57-970c-32aa72000598
  4. Run the following command to confirm that the Kubeconfig environment variable has been set to a valid kubeconfig:
    Copy
    echo $KUBECONFIG 
  5. If you intend to have multiple Edge sites in your Kubernetes cluster, you must give each Edge site a unique namespace.
    1. Copy the following command, replacing <my-namespace> with a unique name for the namespace:
      Copy
      apiVersion: v1
      kind: Namespace
      metadata:
        labels:
            name: <my-namespace>
          pod-security.kubernetes.io/enforce: baseline
          pod-security.kubernetes.io/enforce-version: v1.27
      name: <my-namespace>
    2. Store this copied yaml into a new file called collibra-edge-ns.yaml.
    3. Create the namespace using kubectl:
      Copy
      kubectl apply -f collibra-edge-ns.yaml <my-namespace>
    Note Throughout the remaining installation steps, add this new namespace to the provided commands.
  6. If you are using an Openshift cluster, deploy Security Context Constraints (SCC) which provide Edge service accounts with the required permissions.
    1. Create the SCC file, for example, edge-scc-minimal.yaml, and paste the following information into it:
      Copy
      # File : edge-scc-minimal.yaml
      ---
      apiVersion: security.openshift.io/v1
      kind: SecurityContextConstraints
      metadata:
        annotations:
        name: edge-scc-minimal
      allowHostDirVolumePlugin: false
      allowHostIPC: false
      allowHostNetwork: false
      allowHostPID: false
      allowHostPorts: false
      allowPrivilegeEscalation: false
      allowPrivilegedContainer: false
      allowedCapabilities:
        - "NET_BIND_SERVICE"
      allowedUnsafeSysctls: []
      defaultAddCapabilities: null
      fsGroup:
        type: RunAsAny
      priority: null
      # switch for capabilities
      readOnlyRootFilesystem: false
      requiredDropCapabilities: null
      runAsUser:
        type: MustRunAs
        uid:1000
      seLinuxContext:
        type: RunAsAny
      seccompProfiles:
        - '*'
      supplementalGroups:
        type: RunAsAny
      users:
      volumes: ["*"]
    2. Create the SCC-role file, for example, edge-scc-role-minimal.yaml, and paste the following information into it:
      Copy
      # File: edge-scc-role-minimal.yaml
      apiVersion: rbac.authorization.k8s.io/v1
      kind: Role
      metadata:
        name: edge-scc-minimal
      rules:
      - apiGroups:
        - security.openshift.io
        resourceNames:
        - edge-scc-minimal
        resources:
        - securitycontextconstraints
        verbs:
        - use
      ---
      apiVersion: rbac.authorization.k8s.io/v1
      kind: RoleBinding
      metadata:
        name: edge-scc-minimal
      subjects:
      - kind: Group
        name: system:serviceaccounts
        apiGroup: rbac.authorization.k8s.io
      roleRef:
        kind: Role
        name: edge-scc-minimal
        apiGroup: rbac.authorization.k8s.io
    3. Deploy both the SCC and SCC-role files:
      Copy
      kubectl apply -f edge-scc-minimal.yaml
      kubectl apply -f edge-scc-role-minimal.yaml -n <my-namespace>
  7. Run one of the following installation commands on the machine that has the Kubernetes connection:
    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
      • If you created a custom namespace, add -n <my-namespace> to the command. For example: 
        ./edgecli install -n <my-namespace>
      • Optional, 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.
        ./edgecli install
--registry-url https://private-docker.registry.com 
--registry-user user1 
--registry-pass pass12
      • Optional, if you want to use a proxy, add --proxy <path to properties file> to the install command.
        • You want to install your Edge site with a forward proxy.
          1. Prepare the proxy.properties file to point to your proxy server address, port, and credentials.
          2. Run the following command:
            Copy
            ./edgecli install --proxy proxy.properties
      • Optional, if you want to use a custom certificate, add --ca ca.pem to the install command.
        1. You want to install your Edge site with a forward man-in-the-middle (MITM) proxy.
          1. Prepare the proxy.properties file to point to your MITM proxy server address, port, and credentials.
          2. Prepre the ca.pem certificate file. This is the Certificate Authority that the forward MITM proxy uses to sign Certificates.
          3. Run the following command:
            Copy
            ./edgecli install --proxy proxy.properties --ca ca.pem
    • Copy
      ./edgecli install 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log"
      • If you created a custom namespace, add -n <my-namespace> to the command. For example: 
        ./edgecli install 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" -n <my-namespace>
      • Optional, 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.
        ./edgecli install
--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"
      • Optional, if you want to use a proxy, add --proxy <path to properties file> to the install command.
        • You want to install your Edge site with a forward proxy.
          1. Prepare the proxy.properties file to point to your proxy server address, port, and credentials.
          2. Run the following command:
            Copy
            ./edgecli install 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" --proxy proxy.properties
      • Optional, if you want to use a custom certificate, add --ca ca.pem to the install command.
        1. You want to install your Edge site with a forward man-in-the-middle (MITM) proxy.
          1. Prepare the proxy.properties file to point to your MITM proxy server address, port, and credentials.
          2. Prepre the ca.pem certificate file. This is the Certificate Authority that the forward MITM proxy uses to sign Certificates.
          3. Run the following command:
            Copy
            ./edgecli install 2>&1 | tee "edge-installer-$(date +"%Y-%m-%d_%H-%M-%S").log" --proxy proxy.properties --ca ca.pem
    In the Edge sites overview, you see the status of the installation.
  8. Run the following command to verify the status of the installation.
    Copy
    kubectl get pods -n collibra-edge
  1. Download the installer:
    1. Open an Edge site.
      1. On the main toolbar, click Products icon, and then click Cogwheel icon Settings.
        The Collibra settings page opens.
      2. In the tab pane, click Edge.
        The Sites tab opens and shows a table with an overview of the Edge sites.
      3. In the Edge site overview, click the name of an Edge site.
        The Edge site page appears.
    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.

  2. Extract the TGZ archive on the server on which you want to install the Edge site.
    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.
  3. Run the helm installer 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.
    Copy
    sh helm-install-prerequisites.sh --installer <path_to_extracted_installer>
    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 commands with this new namespace name. Example commands 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.

    --custom-ca If you use a forward proxy with a custom CA, set the global.customCA.enabled value to true.
    Copy
    yq e  -i '.global.customCA.enabled=true' properties.yaml
    --disable-otelIf you don't want to send your metrics and logs to Edge, add this flag to the installation command to disable OpenTelemetry.
    --registry-url <registry-url>

    The URL of your registry.

    Add this flag if you use a private docker registry either with or without authentication.

    For example:

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

    --registry-user <registry-user>

    Your registry account username.

    Add this flag if you use a private docker registry with authentication.

    --registry-pass <registry-pass>

    Your registry account password.

    Add this flag if you use a private docker registry with authentication.

  4. Install your Edge site with helm:
    • Without a custom docker registry:
      Copy
      helm install edge-cd edge-cd-helm-chart/edge-cd -n <my-namespace> --set edgecd.collibraEdgeReleaseName=collibra-edge
    • With a custom docker registry:
      Copy
      helm install edge-cd edge-cd-helm-chart/edge-cd -n <my-namespace> --set edgecd.image.repository=<registry_url> --set edgecd.collibraEdgeReleaseName=collibra-edge