Running Edge tools

This section contains an overview on how to use the Edge tools, for example to create a backup of your Edge site.

Prepare the Edge tools on K3S

On K3S, the Edge tool is downloaded at the end of a successful installation.

Alternatively, you can download it from the cluster:

TOOLS_POD=$(sudo /usr/local/bin/kubectl -n collibra-edge get pod -l edge.collibra.com/contains=tools -o jsonpath='{.items[0].metadata.name}')

sudo /usr/local/bin/kubectl cp collibra-edge/$TOOLS_POD:edge /usr/local/bin/edge

sudo chmod +x /usr/local/bin/edge

The Edge command is in /usr/local/bin on the host. This is your first worker node, so you run the Edge command on the actual host where K3S runs.

Overview Edge commands on K3S

Edge tool	Command for K3S
Uninstall Edge	`/usr/local/bin/uninstall-edge.sh`
Create Edge diagnostics file	Edge site is not yet installed: `<extracted installer directory>/resources/tools/edge-diagnostics.sh -d <file name>.tgz` Edge site is up and running: `edge diagnostics -d <file name>.tgz`
Create an Edge site backup	`edge backup -o /<path to folder>/<backup-name>.yaml`
Set Edge storage cache ttl	`edge cachettl --ttl <value in days>`
Retrieve logs from a catalog connector	`edge catalog-connector --jobid <Edge job ID> \ --dst <path to destination>`
Update Collibra credentials	Interactive way: `edge update-dgc-creds -i` Explicit update: `edge update-dgc-creds <username> <password> <url collibra environment>`
Update forward proxy settings	`edge update-outbound-proxy --update-outbound-proxy /path/to/proxy.properties`
Get help to set up no_proxy configuration	Edge site is not yet installed: `<extracted installer directory>/resources/tools/edge-get-noproxy.sh k3s` Edge site is up and running: `edge get-noproxy k3s`

Prepare Edge tools on EKS

Edge is installed from a Linux machine that has access to the actual K8S cluster.

There is no automatic download of the Edge tool after installation because we don’t want to enforce it in some location. Therefore, you have to download the Edge tool to your Linux machine, for example in your current folder:

TOOLS_POD=$(kubectl -n collibra-edge get pod -l edge.collibra.com/contains=tools -o jsonpath='{.items[0].metadata.name}')

kubectl cp collibra-edge/$TOOLS_POD:edge edge

chmod +x edge

You can now run Edge commands from your current folder.

Note As you are not on the worker node itself, you cannot collect worker node diagnostics. If you need these diagnostics, create a support ticket.

Overview Edge commands on EKS

Edge tool	Command for EKS
Uninstall Edge	`<extracted installer>/resources/installer-job/tools/uninstall-edge-on-managed-k8s.sh`
Create Edge diagnostics file	Edge site is not yet installed: `<extracted installer directory>/resources/tools/edge-diagnostics.sh -d <file name>.tgz` Edge site is up and running: `edge diagnostics -d <file name>.tgz`
Create an Edge site backup	`edge backup -o /<path to folder>/<backup-name>.yaml`
Set Edge storage cache ttl	`edge cachettl <value in seconds>`
Retrieve logs from a catalog connector	`edge catalog-connector --jobid <Edge job ID> \ --dst <path to destination>/<file name>.txt`
Update Collibra credentials	Interactive way: `edge update-dgc-creds -i` Explicit update: `edge update-dgc-creds <username> <password> <url collibra environment>`
Update forward proxy settings	`edge update-outbound-proxy --update-outbound-proxy /path/to/proxy.properties`
Get help to set up no_proxy configuration	Edge site is not yet installed: `<extracted installer directory>/resources/tools/edge-get-noproxy.sh eks <clustername>` Edge site is up and running: `edge get-noproxy eks <clustername>`