About Edge

Edge provides seamless native integrations and on-site data processing solutions that prioritize security and proximity to the data, while keeping the processing of your data within your own environment. Edge securely connects to your data sources either hosted in an on-premises or cloud environment. Edge capabilities process the data source information and send the results to CPSH.

For example, as an Edge Administrator, Data Architect, or Security Administrator, you can use Edge to ensure data remains securely within your private network while still providing metadata to the Collibra Platform Self-Hosted for governance.

Available features and capabilities depend on your Edge site type:

  • Standard: The standard type of Edge site. All default features are available.
  • Air-gapped: Air-gapped Edge sites are available for Collibra Platform Self-Hosted Edge.
    • They are installed in an Air-gapped environment, which allows you to deploy Edge sites without reliance on the public internet, utilizing only secure, private network connections for communication with Collibra Platform and local data sources.
    • This type of Edge site is best for organizations that require Federal Information Processing Standards (FIPS) compliance in an IPv6 network.
    • Edge components are downloaded via a Zarf packaged for a seamless installation and deployment process in Air-gapped environments. Air-gapped Edge sites, as well as their supported connections and capabilities, are FIPs compliant. Therefore, some features and capabilities are not supported for Air-gapped Edge sites.

Steps Overview: Setup and use a site

Creating and setting up a site allows you to connect your data sources with your Collibra Platform.

# Step Description

1

Create an Edge site in the UI

Create or request a site to manage your connections and capabilities.

  • Edge sites: When you create an Edge site, you can choose to either upgrade automatically whenever a new version is released, or upgrade manually in order to control when and to which version your sites are upgraded. Once you create your Edge site in the UI, you must install it in your organization's environment.

  • Air-gapped Edge sites: If you have an Air-gapped environment, your Edge site is not created on the Edge management UI. Instead, it is created via the Zarf installation package in step 3.
2 Give the required permissions

Assign the Manage Edge sites global permission to at least one user. This permission allows the user install your sites and manage your connections and capabilities in your site.

Assign the following global permissions to at least one user:

  • Manage Edge sites allows a user to create an Edge site or request a Collibra Cloud site.
  • Install Edge sites and the User Administration allow a user to install an Edge site.
  Install an Edge site Install your Edge site in your organization's environment. You may need to work with your administrators, IT team, and Kubernetes experts to install your Edge sites and meet your organization's system and security requirements.
4 Prepare your site for data sources

Once you have a site, create connections from the site to your data sources, and define capabilities that you want to run on these connections.

For example, you create a connection to Databricks Unity Catalog and add a capability that allows you to integrate the metadata from Databricks Unity Catalog in CPSH.

If you are installing your Edge site on a managed Kubernetes cluster, you must use the Edge Command Line Interface (CLI). The Edge CLI is the primary Edge utility tool that allows you to set up and manage certain aspects of your Edge site and is included when you download the Edge site installer.

4a
Create a connection

Create a connection which links your site with your data source. Once a connection is available, capability jobs can run through this connection to send information to CPSH.

For more information, go to our list of available connections.
4b
Create a capability

Create a capability which calls your data source via the connection to get requested information from the data source and sends the information to CPSH. The results can be assets, such as Schema or Table assets, or extra information about the assets.

For more information, go to our list of available capabilities.
5 Upgrade your Edge site

Ensure you are on a supported version of Edge. Occasionally, Edge launches a new functionality or Kubernetes support that requires you to upgrade or reinstall your Edge site.

Collibra communicates about this in the release notes and the Edge compatibility table.

Note 
  • If you have automatic upgrades enabled for your Edge site, you don't need to do anything when an upgrade is required. However, if a reinstallation is required, you may still need to perform this action.
  • If you have an Air-gapped Edge site, you can get the latest Zarf package from the Downloads page.
6 Maintain your Edge site

Use the Edge UI or the Edge CLI to maintain and update certain aspects of your Edge site.

For example, set up a forward proxy or update vault credentials.

Note If you have an Air-gapped Edge site, you can't use the Edge CLI to install or delete your site. You must instead use the Zarf CLI.