Configure an Edge site with a private registry using username and password authentication

This topic is a reference for how to configure your Edge site with a supported private container image registry using username and password authentication method.

Edge supports the following private container image registries using username and password authentication method. If your registry is not listed, you can attempt to authenticate with it, but Collibra Support cannot provide assistance for untested registries.

  • JFrog
  • Nexus

Before installing your Edge site, ensure the following:

  • Your registry uses HTTPS for all communication.
  • If you're installing your Edge site on k3s, you must store any certificates required to communicate to the registry in /etc/ssl/certs/cert.crt on the k3s virtual machine, and then restart k3s by running the following command:
    Copy
    sudo systemctl restart k3s

Use the following command flag when installing your Edge site to authenticate your Edge site with a private container image registry using username and password authentication:

Copy 
--registry-url <url_for_registry/custom_folder> \
    --registry-user <username> \
    --registry-pass <password>
Command flag Description
<url_for_registry/custom_folder>

The registry URL.

Optionally, if you have a custom folder within your registry that you want to pull the Edge images into, add that to the end of the URL.
username The registry username.
password The registry password.
Example 
--registry-url nexus.company.com/edge-registry \
    --registry-user NexusEdge \
    --registry-pass NexusEdge12

Currently, Edge only supports using the JFrog private Helm registry with username and password authentication.

Before installing your Edge site, ensure the following:

  • Your registry uses HTTPS for all communication.
  • If you're installing your Edge site on k3s, you must store any certificates required to communicate to the registry in /etc/ssl/certs/cert.crt on the k3s virtual machine, and then restart k3s by running the following command:
    Copy
    sudo systemctl restart k3s
  • If you upload the Helm chart as an OCI artifact, the url must be in the OCI format: oci://.

Use the following command flag when installing your Edge site to authenticate your Edge site with a private Helm registry using the username and password authentication method:

Copy 
--helm-url <url_for_registry/custom_folder> \
    --helm-user <username> \
    --helm-pass <password>
Command flag Description
<oci_url_for_helm_registry/custom_folder>

The registry URL.

Optionally, if you have a custom folder within your registry that you want to pull the Edge images into, add that to the end of the URL.
username The registry username.
password The registry password.
Example 
--helm-url jfrog.company.com/artifactory/edge-registry \
    --helm-user jfrogEdge \
    --helm-pass jfrogEdge12