The Edge tool
This section contains an overview on how to use the Edge tools, for example to create a backup of your Edge site.
- K3S
- Managed kubernetes
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 | Commands |
---|---|
Uninstall Edge | /usr/local/bin/uninstall-edge.sh |
Create Edge diagnostics file |
|
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> \
|
Update Collibra credentials |
|
Update forward proxy settings | edge update-outbound-proxy --update-outbound-proxy /path/to/proxy.properties
|
Get help to set up no_proxy configuration |
|
Edge CLI |
From the 2024.05 release, the Edge CLI tool is included with the Edge site installer. As such, you should only need to download the Edge CLI tool from the Edge tool if:
Note The Edge CLI tool is only available in the linux/amd64 binary. |
Prepare Edge tools on managed Kubernetes
Select the managed Kubernetes cluster your Edge site is installed on:
Managed Kubernetes cluster
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 a specific location. Therefore, on your Linux machine, download the Edge tool to a folder of your choice. For example:
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 EKSAKS AWS Fargate using EKSGKEOpenShift
Edge tool | Commands for |
---|---|
Uninstall Edge | <extracted installer>/resources/installer-job/tools/uninstall-edge-on-managed-k8s.sh
|
Create Edge diagnostics file |
|
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> \
|
Update Collibra credentials |
|
Update forward proxy settings | edge update-outbound-proxy --update-outbound-proxy /path/to/proxy.properties
|
Get help to set up no_proxy configuration |
|
Edge CLI |
From the 2024.05 release, the Edge CLI tool is included with the Edge site installer and is the primary installation method for Edge sites on managed Kubernetes clusters. As such, you should only need to download the Edge CLI tool from the Edge tool if:
Note The Edge CLI tool is only available in the linux/amd64 binary. |