Edge Command Line Interface (CLI)

Note Edge CLI is only available on Linux for x86_64 architecture.

As an Edge administrator, you can use the Edge Command Line Interface (CLI) tool to set up and manage your Edge site and troubleshoot issues effeciently.

You can use the Edge CLI tool to manage already installed Edge sites on k3s or to install and manage your Edge site 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.

Note You can't use the Edge CLI to install Edge sites on bundled k3s.

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
    # Get the name of the pod from which we will copy edgecli , run: 
    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}')

    # Copy edgecli to provided path 
    sudo /usr/local/bin/kubectl cp --retries=-1 -n collibra-edge ${EDGE_CD_POD}:edgecli /usr/local/bin/edgecli

    # Make the downloaded binary executable
    sudo chmod +x /usr/local/bin/edgecli
  • If you want to update your Edge CLI to the latest version, run the following command from the Edge CLI:
    Copy
    sudo ./edgecli cli upgrade -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
Restart Edge components

Use this command if you need to restart an Edge component, but not restart the virtual machine:

Copy 
sudo ./edgecli restart
Download a JDBC job output file.
Copy 
sudo ./edgecli job download-cdata-log <jobIdentifier> <destinationFolder>
  • <jobIdentifier>: Enter the Job ID of the JDBC capability job. You can find this by running the following command, with your Edge site namespace and JDBC capability name. If your Edge site doesn't have a unique namespace, enter the default collibra-edge.
    Copy
    kubectl get pods -n {NAMESPACE} -l job-name -o jsonpath='{range .items[*]}{.metadata.labels.job-name}{"\n"}{end}' | sed -E 's/^job-//'
  • <destinationFolder>: Enter the folder path where you want to download the JDBC job output file.
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 certificates to the Edge truststore after an Edge site has been installed:

Copy 
sudo ./edgecli config ca merge --path certificate.pem
Note A custom "ca.pem" file cannot exceed 100kb.

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 ca 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 ca replace --path certificate.pem
Note 
  • This command only replaces custom certificates. System certificates are not impacted by this command.
  • A custom "ca.pem" file cannot exceed 100kb.

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 ca replace --path certificate.pem --namespace <my-namespace>
Deploy or replace a public key for trusted drivers.

Use this command to deploy a public key or to replace an existing key. Signature enforcement becomes active the moment this command succeeds. You don't need to restart the Edge site.

Warning When you deploy a key, it applies to every driver already configured on the Edge site, not just new ones. If existing connections use unsigned drivers, those connections will immediately start to fail. Re-sign all affected drivers before deploying a key to a live environment.

Copy 
sudo ./edgecli config signing-key set --file <path-to-public-key.pem> [--force]

Flag Required Description
--file Yes The path to a PEM file containing the public key.
  • The PEM file must contain exactly one PUBLIC KEY block.
  • Certificate files and private key files are rejected.
  • The key must be RSA (SHA256withRSA) and at least 1024 bits.
--force Only when replacing an existing key Confirms the overwrite. Without this flag, the command won't replace a key that is already deployed.

Warning Rotating a key invalidates all driver signatures made under the previous key. Re-sign affected drivers before rotating a key in a live environment, not after.

Check if a trusted driver signing key has been added to an Edge site

Use this command to confirm whether a signing key is configured on the Edge site. This command returns only the key algorithm and bit size, it never returns the key material itself.

Copy 
sudo ./edgecli config signing-key show
Remove a trusted driver signing key from an Edge site

Use this command to remove the signing key from the Edge site. This immediately disables all signature verification across the entire site.

Warning Removing the signing key immediately disables driver verification for every connection on the Edge site. After this command runs, any driver, whether signed or unsigned, is accepted.

Copy 
sudo ./edgecli config signing-key delete
Setup and use Vaults with your Edge site

This feature is available only in the latest UI.

Vault commands are dependent on which vault and authentication method you use. Visit the vault documentation pages to learn what the Edge CLI commands are to setup and use your vault integration.
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, the following command returns help information for the Shared Storage connection delete shared folder: 
    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
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

    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:

    Flag Description
    -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

    Add this flag to use a custom certificate, such as for a forward man-in-the-middle proxy.

    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.

    Some data sources require a custom certificat to connect to Edge. If a private Certificate Authority signed the certificate, add it to the 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 using a Collibra certified certificate.
    --disable-otel Add this flag to disable OpenTelemetry. Your metrics and logs will no longer be sent to Edge.
    Private container image registry Use these flags if you want to install your Edge site with a private container image registry to store and manage 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 registry Use 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
    Note If your registry password is in a JSON file, the JSON file must be flattened into a single line string.

    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>

    Add this flag to run all of your Edge site pods and containers with a specific user ID (UID).
    --group-id <group_id>

    Add this flag to run all of your Edge site pods and containers with a specific group ID (GID).
    --unset-run-as-ids Add this flag for OpenShift clusters to run all of your Edge site pods and containers from random UIDs and GIDs,
    --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.

    Add this flag to skip installing priority classes. 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.

    Add this flag and the following --set flags to configure custom priority classes for your Edge site pods:

    • --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
    --b <backup-file Add this flag if you have a backup you want to use to restore an Edge site. 
    ./edgecli install \
	--registry-url https://private-docker.registry.com \ 
	--registry-user user1 \
	--registry-pass pass12
  • Copy 
    ./edgecli install 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:

    Flag Description
    -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

    Add this flag to use a custom certificate, such as for a forward man-in-the-middle proxy.

    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.

    Some data sources require a custom certificat to connect to Edge. If a private Certificate Authority signed the certificate, add it to the 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 using a Collibra certified certificate.
    --disable-otel Add this flag to disable OpenTelemetry. Your metrics and logs will no longer be sent to Edge.
    Private container image registry Use these flags if you want to install your Edge site with a private container image registry to store and manage 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 registry Use 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
    Note If your registry password is in a JSON file, the JSON file must be flattened into a single line string.

    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>

    Add this flag to run all of your Edge site pods and containers with a specific user ID (UID).
    --group-id <group_id>

    Add this flag to run all of your Edge site pods and containers with a specific group ID (GID).
    --unset-run-as-ids Add this flag for OpenShift clusters to run all of your Edge site pods and containers from random UIDs and GIDs,
    --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.

    Add this flag to skip installing priority classes. 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.

    Add this flag and the following --set flags to configure custom priority classes for your Edge site pods:

    • --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
    --b <backup-file Add this flag if you have a backup you want to use to restore an Edge site. 
    ./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"
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 has a custom namespace, you must add -n <my-namespace> to the command.
  • The uninstall command automatically creates a backup of your Edge site. By default, the backup is generated in the current working directory, with following file name format: edge-backup-SITE_ID-YYYYMMDD-HHMMSS.yaml
    • You can specify the location by adding the following flag to the command: --path=/tmp/edge/backup
    • You can skip a backup being created by adding the following flag to the command: --no-backup
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
    # Get the name of the pod from which we will copy edgecli , run: 
    EDGE_CD_POD=$(kubectl get pod -n collibra-edge -l app.kubernetes.io/name=edge-cd \
        -o jsonpath='{.items[0].metadata.name}')

    # Copy edgecli to provided path  
    sudo /usr/local/bin/kubectl cp --retries=-1 -n collibra-edge ${EDGE_CD_POD}:edgecli /usr/local/bin/edgecli

    # Make the downloaded binary executable
    sudo chmod +x <PATH_TO_EXISTING EDGECLI>/edgecli
  • If you want to update your Edge CLI to the latest version, run the following command from the Edge CLI:
    Copy
    ./edgecli cli upgrade -n <my-namespace> -d <edgecli_dir>

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 -n <my-namespace> -d <diagfile.tgz>

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>
Restart Edge components

Use this command if you need to restart an Edge component, but not restart the virtual machine:

Copy 
./edgecli restart
Download a JDBC job output file.
Copy 
./edgecli job download-cdata-log <jobIdentifier> <destinationFolder>
  • <jobIdentifier>: Enter the Job ID of the JDBC capability job. You can find this by running the following command, with your Edge site namespace and JDBC capability name. If your Edge site doesn't have a unique namespace, enter the default collibra-edge.
    Copy
    kubectl get pods -n {NAMESPACE} -l job-name -o jsonpath='{range .items[*]}{.metadata.labels.job-name}{"\n"}{end}' | sed -E 's/^job-//'
  • <destinationFolder>: Enter the folder path where you want to download the JDBC job output file.
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 --namespace <my-namespace> --raw
Add custom certificates to the Edge site truststore

Use this command to add custom certificates to the Edge truststore after an Edge site has been installed:

Copy 
./edgecli config ca merge --path certificate.pem
Note  A custom "ca.pem" file cannot exceed 100kb.

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 ca merge --namespace <my-namespace> --path certificate.pem
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 ca replace --path certificate.pem
Note 
  • This command only replaces custom certificates. System certificates are not impacted by this command.
  • A custom "ca.pem" file cannot exceed 100kb.

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 ca replace --namespace <my-namespace> --path certificate.pem
Deploy or replace a public key for trusted drivers.

Use this command to deploy a public key or to replace an existing key. Signature enforcement becomes active the moment this command succeeds. You don't need to restart the Edge site.

Warning When you deploy a key, it applies to every driver already configured on the Edge site, not just new ones. If existing connections use unsigned drivers, those connections will immediately start to fail. Re-sign all affected drivers before deploying a key to a live environment.

Copy 
./edgecli config signing-key set --file <path-to-public-key.pem> [--force]

Flag Required Description
--file Yes The path to a PEM file containing the public key.
  • The PEM file must contain exactly one PUBLIC KEY block.
  • Certificate files and private key files are rejected.
  • The key must be RSA (SHA256withRSA) and at least 1024 bits.
--force Only when replacing an existing key Confirms the overwrite. Without this flag, the command won't replace a key that is already deployed.

Warning Rotating a key invalidates all driver signatures made under the previous key. Re-sign affected drivers before rotating a key in a live environment, not after.

Check if a trusted driver signing key has been added to an Edge site

Use this command to confirm whether a signing key is configured on the Edge site. This command returns only the key algorithm and bit size, it never returns the key material itself.

Copy 
./edgecli config signing-key show
Remove a trusted driver signing key from an Edge site

Use this command to remove the signing key from the Edge site. This immediately disables all signature verification across the entire site.

Warning Removing the signing key immediately disables driver verification for every connection on the Edge site. After this command runs, any driver, whether signed or unsigned, is accepted.

Copy 
./edgecli config signing-key delete
Setup and use Vaults with your Edge site

This feature is available only in the latest UI.

Vault commands are dependent on which vault and authentication method you use. Visit the vault documentation pages to learn what the Edge CLI commands are to setup and use your vault integration.

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.

Important 

Files are temporary and are automatically deleted in any of the following situations:

  • After a set time period. The default is 180 days.
  • When an Edge site update restarts the pod containing Shared Storage connection files.

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, the following command returns help information for the Shared Storage connection delete shared folder: 
    ./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