These docs are for Cribl Edge 4.12 and are no longer actively maintained.
See the latest version (4.13).
Upgrading Cribl Edge on Linux (CLI)
Learn how to upgrade Edge Nodes manually using a command line interface (CLI).
Prior to upgrading, review Specific Considerations for Linux environments.
Upgrading a Linux Standalone/Single-Instance
This path requires upgrading only the single/standalone Node:
Stop Edge.
Download the package on your instance of choice here.
Uncompress the new version on top of the old one, for example in the
/opt/cribl-edge
directory:tar xvzf cribl-<version>-<build>-<arch>.tgz
- On some Linux systems,
tar
might complain with:cribl/bin/cribl: Cannot open: File exists
. In this case, please removecribl/bin/cribl
and untar again. - If you have custom functions in
cribl/bin/cribl
, please move them to$CRIBL_HOME/local/cribl/functions/
before untarring again.
- On some Linux systems,
Restart Edge.
The current upgrade process creates a new Cribl Edge installation in
/opt/cribl
by default, requiring you to manually move it to your existing Cribl Edge directory (usually/opt/cribl-edge
) and adjust permissions. For a simpler upgrade, the new version should be extracted directly into your existing Cribl Edge directory, overwriting the old one.
Upgrading a Distributed Deployment on Linux
For a Distributed Deployment, the general order of upgrade is:
- Upgrade the Leader Node.
- Upgrade the Edge Nodes.
- Commit and deploy the changes on the Leader.
For distributed environments with a second Leader configured for failover, this is the upgrade order:
- Stop both Leaders.
- Upgrade the primary Leader.
- Upgrade the second Leader.
- Upgrade each Edge Node, respectively.
Upgrading the Leader Node
Commit and deploy your desired last version. (This version will be your most recent checkpoint.)
- Optionally,
git push
to your configured remote repo.
- Optionally,
Stop Cribl Edge.
Back up the entire
$CRIBL_HOME
directory (recommended, but optional).Check that the Edge Nodes are still functioning as expected. In the absence of the Leader Node, they should continue to work with their last deployed configurations (optional).
Download the package on your instance of choice here.
Uncompress the new Edge version on top of the old one, for example in the
/opt/cribl-edge
directory:tar xvzf cribl-<version>-<build>-<arch>.tgz
Restart Edge and log back in.
Wait for all the Edge Nodes to report to the Leader, and ensure that they are correctly reporting the last committed configuration version.
Cribl Edge’s UI will not be available until the Edge version has been upgraded to match the version on the Leader. Errors will appear until the Edge Nodes are upgraded.
Upgrading the (Linux) Edge Nodes
These are the same basic steps as when upgrading a Single Instance, above:
Stop Cribl Edge on each Edge Node.
Download the package on your instance of choice here. If the Leader is on a prior release, see Cribl Past Releases for older packages.
Uncompress the new Edge version on top of the old one, for example in the
/opt/cribl-edge
directory:tar xvzf cribl-<version>-<build>-<arch>.tgz
Restart Edge.
Commit and Deploy Changes from the Leader Node
Ensure that newly upgraded Edge Nodes report to the Leader with their new software version.
Commit and deploy the newly updated configuration only after all Edge Nodes have upgraded.