Edge Command Line Interface (CLI)

The Edge Command Line Interface (CLI) is a tool that allows you to set up and manage aspects of your Edge site and is included when you download the Edge site installer.

Note Edge CLI is only available on Linux for x86_64 architecture.
  • K3S
  • Managed Kubernetes

How you can use the Edge CLI commands on k3S

Note This is not an exhaustive list of commands. If you want to see the full list of commands available via the Edge CLI, run the CLI help command.

Action Definition
Download a new Edge CLI

You may need to download an Edge CLI because you do not have it available locally yet or you need a newer version of the Edge CLI.

  • If you do not have the Edge CLI available locally, run the following command from wherever your Edge site is installed:
    Copy
    EDGE_CD_POD=$(sudo /usr/local/bin/kubectl get pod -n collibra-edge -l app.kubernetes.io/name=edge-cd -o jsonpath='{.items[0].metadata.name}')
    sudo /usr/local/bin/kubectl cp -n collibra-edge ${EDGE_CD_POD}:/edgecli edgecli
  • If you want to update your Edge CLI to the latest version, run the following command from the Edge CLI:
    Copy
    sudo ./edgecli edge-utils downloadEdgeCli -d <edgecli_dir>
Get Edge site diagnostics

Use this command from this command and provide the results to Collibra Support when troubleshooting issues on your Edge site:

Copy 
sudo ./edgecli diagnostics -d <diagfile.tgz>
Create an Edge site backup

Use this command to create a backup of your Edge site. This is required when you want to reinstall your Edge site.

Copy 
sudo ./edgecli recovery backup --path <backup_path>
Update the Edge user credentials in Collibra Data Intelligence Platform

Use this command to update the Edge user's username or password in Collibra Data Intelligence Platform:

Copy 
sudo ./edgecli config dgc --pass <password> --url <dgc url> --user <username>
Update forward proxy settings

Use this command to update forward proxy settings for your Edge site:

Copy 
sudo ./edgecli config proxy --path <path to proxy config>
Pull list of custom certificates

Use this command to pull a list of all custom certificates configured on your Edge site.

Copy 
sudo ./edgecli config ca list

Additional parameters:

  • --namespace: If your Edge site has a custom namespace, you must add this parameter and the namespace name to the command.
  • --raw: Pulls the raw data of the certificates. Without this, only the basic certificate information is returned.

  • You want to see the raw data for all of the custom certificates configured on your Edge site:
    sudo ./edgecli config ca list --raw
  • You want to see the custom certificates configured on an Edge site with a specific namespace:
    sudo ./edgecli config ca list --raw --namespace <my-namespace>
Add custom certificates to the Edge site truststore Use this command to add custom certificated to the Edge truststore after an Edge site has been installed:
Copy
sudo ./edgecli config merge --path certificate.pem

Important Your virtual machine must be rebooted after you run this command.

Additional parameter:

  • --namespace: If your Edge site has a custom namespace, you must add this parameter and the namespace name to the command.

  • You want to add a custom certificate to your Edge site truststore:
    sudo ./edgecli config ca merge --path certs.pem
  • You want to add the custom certificates that are configured on an Edge site with a specific namespace:
    sudo ./edgecli config merge --path certificate.pem --namespace <my-namespace>
Replace all existing custom certificates in the Edge site truststore

Use this command to replace all existing custom certificates in the Edge site truststore:

Copy 
sudo ./edgecli config replace --path certificate.pem
Important 
  • Your virtual machine must be rebooted after you run this command.
  • This command only replaces custom certificates. System certificates are not impacted by this command.

Additional parameter:

  • --namespace: If your Edge site has a custom namespace, you must add this parameter and the namespace name to the command.

  • You want to replace all custom certificates that are configured on an Edge site:
    sudo ./edgecli config ca replace --path certs.pem
  • You want to replace all custom certificates that are configured on an Edge site with a specific namespace:
    sudo ./edgecli config replace --path certificate.pem --namespace <my-namespace>
Setup and use Vaults with your Edge site

Important  This feature is available only in the latest UI.

Vault commands are dependent on which vault and authentication method you use. Visit the dedicated pages to learn what the Edge CLI commands are to:
Setup and manage shared files for the Shared Storage connection

The Shared Storage connection for technical lineage allows you to access data source files from a shared folder.

To setup and manage the folder and files used for the Shared Storage connection, use the following commands in the Edge CLI:

  • Upload a shared folder which contains multiple data source files:
    Copy
    sudo ./edgecli objects folder-upload
    --source <source-string>
    --target <target-string>
    --ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared folder and files.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the folder and files you have uploaded.
    <time> (optional)The number of seconds that the uploaded files will be available before being evicted, the default is 15552000 seconds (180 days).
  • Upload a single shared data source file:
    Copy
    sudo ./edgecli objects file-upload 
    --source <source-string>
    --target <target-string>
    --key <key-string>
    --ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared file.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the file you have uploaded.
    <key-string> (optional)The path of a specific file within a folder or nested within multiple folders. For example, you only want to upload the myFile.txt file, which is in the myFolders folder.

    If you do not specify this property, it will default to the file name.

    <time> (optional)The number of seconds that the uploaded file will be available before being evicted, the default is 15552000 seconds (180 days).
  • Upload multiple folders to their own shared folder:
    Copy
    sudo ./edgecli objects multi-folder-upload
    --parallelism <parallel-uploads>
    --source <source-string>
    --ttlSeconds <time>
    KeyDefinition
    <parallel-uploads> (optional)

    The number of files that are uploaded at the same time.

    For example, you want to upload 30 files that are in 3 folders and set the parallelism property to 10. Your files are uploaded to the shared storage connection 10 files at a time until all 30 files have been uploaded.

    <source-string>The data source folders you want to upload to your Shared Storage connection.
    <time> (optional)The number of seconds that the uploaded file will be available before being evicted, the default is 15552000 seconds (180 days).
  • Update or add a new file to an existing folder in Edge:
    Copy
    sudo ./edgecli objects file-upload --source <source-string>
    --target <target-string> \
    --key <key-string> \
    • Key Definition
    <source-string>

    The data source file you want to upload to replace an existing file or add to an existing folder in your Shared Storage connection.
    <target-string> The folder in your Edge site where you want to store the shared file.
    <key-string> (optional) The path of a specific file within a folder or nested within multiple folders. For example, you only want to upload the myFile.txt file, which is in the myFolders folder.

    If you do not specify this property, it will default to the file name.
  • Pull a list of all folders and files that have been uploaded to your Edge site:
    Copy
    sudo ./edgecli objects folder-list
  • Delete a shared folder or file from your Edge site:
    Copy
    sudo ./edgecli objects folder-delete
    --target <target-string>
    KeyDefinition
    <target-string>The name of the Edge shared folder you want to delete from your Edge site.

Access help

If you need help when using the Edge CLI tool, you can run the help command to:

  • View a full list of supported Edge CLI commands:
    Copy
    sudo ./edgecli -h
  • View the specific parameters and usage of a specific Edge CLI command. For example, running the following command will return help information for the delete shared folder command for the Shared Storage connection: 
    sudo ./edgecli objects folder-delete -h
Deletes shared folder that was uploaded, if it exists
			
Usage:
  edgecli objects folder-delete [flags]
			
Flags:
      --target string   The folder name specified in edge (DGC)
			
Global Flags:
  -h, --help

How to use Edge CLI commands on a Managed Kubernetes cluster

Note This is not an exhaustive list of commands. If you want to see the full list of commands available via the Edge CLI, run the CLI help command.

Actions Definitions
Install an Edge site

You can install your Edge site on a managed Kubernetes cluster by following the steps outlined in Install an Edge site, in addition to running one of the following commands:

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
    • You must add -n <my-namspace> to the command if your Edge site will be installed:
      • Via the Edge CLI using the restrictive method.
      • Via the Helm chart.
    • 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
    • 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"
    • You must add -n <my-namspace> to the command if your Edge site will be installed:
      • Via the Edge CLI using the restrictive method.
      • Via the Helm chart.
    • 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 and file logging:
        ./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
Uninstall an Edge site

If you have installed your Edge site using the Edge CLI method, you can uninstall your Edge site by using one of the following commands:

  • 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"
Note 
  • If your Edge site was installed using the old method, and not the Edge CLI method, use the uninstall command via the Edge tool.
  • If your Edge site is installed via the Edge CLI method and it has a custom namespace, you must add -n <my-namespace> to the command.
Download a new Edge CLI

You may need to download an Edge CLI because you do not have it available locally yet or you need a newer version of the Edge CLI.

  • If you do not have the Edge CLI available locally, run the following command from a Linux machine that has access to the Kubernetes cluster where your Edge site is installed.:
    Copy
    EDGE_CD_POD=$(kubectl -n <my-namespace> get pod -l app.kubernetes.io/name=edge-cd -o jsonpath='{.items[0].metadata.name}')
    kubectl cp -n collibra-edge ${EDGE_CD_POD}:/edgecli edgecli
  • If you want to update your Edge CLI to the latest version, run the following command from the Edge CLI:
    Copy
    ./edgecli edge-utils downloadEdgeCli -d <edgecli_dir> -n <my-namespace>

Note If your Edge site is installed on a dedicated cluster via the Edge CLI method and it does not have a custom namespace, you can remove -n <my-namespace> from the commands.
Get Edge site diagnostics

Use this command from this command and provide the results to Collibra Support when troubleshooting issues on your Edge site:

Copy 
./edgecli diagnostics -d <diagfile.tgz> -n <my-namespace>

Note If your Edge site is installed on a dedicated cluster via the Edge CLI method and it does not have a custom namespace, you can remove -n <my-namespace> from the command.
Create an Edge site backup

Use this command to create a backup of your Edge site. This is required when you want to reinstall your Edge site.

Copy 
./edgecli recovery backup --path <backup_path>
Update the Edge user credentials in Collibra Data Intelligence Platform

Use this command to update the Edge user's username or password in Collibra Data Intelligence Platform:

Copy 
./edgecli config dgc --pass <password> --url <dgc url> --user <username> -n <my-namespace>

Note If your Edge site is installed on a dedicated cluster via the Edge CLI method and it does not have a custom namespace, you can remove -n <my-namespace> from the command.
Update forward proxy settings

Use this command to update forward proxy settings for your Edge site:

Copy 
./edgecli config proxy --path <path to proxy config>
Pull list of custom certificates

Use this command to pull a list of all custom certificates configured on your Edge site.

Copy 
./edgecli config ca list

Additional parameters:

  • --namespace: If your Edge site has a custom namespace, you must add this parameter and the namespace name to the command.
  • --raw: Pull the raw data of the certificates. Without this, only the basic certificate information is returned.

  • You want to see the raw data for all of the custom certificates configured on your Edge site:
    ./edgecli config ca list --raw
  • You want to see the custom certificates configured on an Edge site with a specific namespace:
    ./edgecli config ca list --raw --namespace <my-namespace>e
Add custom certificates to the Edge site truststore Use this command to add custom certificated to the Edge truststore after an Edge site has been installed:
Copy
./edgecli config merge --path certificate.pem

Important Your virtual machine must be rebooted after you run this command.

Additional parameter:

  • --namespace: If your Edge site has a custom namespace, you must add this parameter and the namespace name to the command.

  • You want to add a custom certificate to your Edge site truststore:
    ./edgecli config ca merge --path certs.pem
  • You want to add the custom certificates that are configured on an Edge site with a specific namespace:
    ./edgecli config merge --path certificate.pem --namespace <my-namespace>
Replace all existing custom certificates in the Edge site truststore

Use this command to replace all existing custom certificates in the Edge site truststore:

Copy 
./edgecli config replace --path certificate.pem
Important 
  • Your virtual machine must be rebooted after you run this command.
  • This command only replaces custom certificates. System certificates are not impacted by this command.

Additional parameter:

  • --namespace: If your Edge site has a custom namespace, you must add this parameter and the namespace name to the command.

  • You want to replace all custom certificates that are configured on an Edge site:
    ./edgecli config ca replace --path certs.pem
  • You want to replace all custom certificates that are configured on an Edge site with a specific namespace:
    ./edgecli config replace --path certificate.pem --namespace <my-namespace>
Setup and use Vaults with your Edge site

Important  This feature is available only in the latest UI.

Vault commands are dependent on which vault and authentication method you use. Visit the dedicated pages to learn what the Edge CLI commands are to:
Setup and manage shared files for the Shared Storage connection

The Shared Storage connection for technical lineage allows you to access data source files from a shared folder.

To setup and manage the folder and files used for the Shared Storage connection, use the following commands in the Edge CLI:

  • Upload a shared folder which contains multiple data source files:
    Copy
    ./edgecli objects folder-upload
    --source <source-string>
    --target <target-string>
    --ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared folder and files.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the folder and files you have uploaded.
    <time> (optional)The number of seconds that the uploaded files will be available before being evicted, the default is 15552000 seconds (180 days).
  • Upload a single shared data source file:
    Copy
    ./edgecli objects file-upload 
    --source <source-string>
    --target <target-string>
    --key <key-string>
    --ttlSeconds <time>
    KeyDefinition
    <source-string>The data source file you want to upload for your Shared Storage connection.
    <target-string>The folder in your Edge site where you want to store the shared file.
    Note This folder does not have to already exist in your Edge site. If it does not, a folder with the name entered here will be created in your Edge site, containing the file you have uploaded.
    <key-string> (optional)The path of a specific file within a folder or nested within multiple folders. For example, you only want to upload the myFile.txt file, which is in the myFolders folder.

    If you do not specify this property, it will default to the file name.

    <time> (optional)The number of seconds that the uploaded file will be available before being evicted, the default is 15552000 seconds (180 days).
  • Upload multiple folders to their own shared folder:
    Copy
    ./edgecli objects multi-folder-upload
    --parallelism <parallel-uploads>
    --source <source-string>
    --ttlSeconds <time>
    KeyDefinition
    <parallel-uploads> (optional)

    The number of files that are uploaded at the same time.

    For example, you want to upload 30 files that are in 3 folders and set the parallelism property to 10. Your files are uploaded to the shared storage connection 10 files at a time until all 30 files have been uploaded.

    <source-string>The data source folders you want to upload to your Shared Storage connection.
    <time> (optional)The number of seconds that the uploaded file will be available before being evicted, the default is 15552000 seconds (180 days).
  • Update or add a new file to an existing folder in Edge:
    Copy
    ./edgecli objects file-upload --source <source-string>
    --target <target-string> \
    --key <key-string> \
    • Key Definition
    <source-string>

    The data source file you want to upload to replace an existing file or add to an existing folder in your Shared Storage connection.
    <target-string> The folder in your Edge site where you want to store the shared file.
    <key-string> (optional) The path of a specific file within a folder or nested within multiple folders. For example, you only want to upload the myFile.txt file, which is in the myFolders folder.

    If you do not specify this property, it will default to the file name.
  • Pull a list of all folders and files that have been uploaded to your Edge site:
    Copy
    ./edgecli objects folder-list
  • Delete a shared folder or file from your Edge site:
    Copy
    ./edgecli objects folder-delete
    --target <target-string>
    KeyDefinition
    <target-string>The name of the Edge shared folder you want to delete from your Edge site.

Access help

If you need help when using the Edge CLI tool, you can run the help command to:

  • View a full list of supported Edge CLI commands:
    Copy
    ./edgecli -h
  • View the specific parameters and usage of a specific Edge CLI command. For example, running the following command will return help information for the delete shared folder command for the Shared Storage connection: 
    ./edgecli objects folder-delete -h
Deletes shared folder that was uploaded, if it exists
			
Usage:
  edgecli objects folder-delete [flags]
			
Flags:
      --target string   The folder name specified in edge (DGC)
			
Global Flags:
  -h, --help