On This Page

Home / Edge/ Administration/ Upgrade Cribl Edge/Roll Back Cribl Edge

Roll Back Cribl Edge ​

Roll back a Cribl Edge deployment to an older version.

You can roll back a Cribl Edge deployment or individual Edge Nodes to an older version either to mitigate a failed upgrade, or manually, at will.

Automatically Roll Back Failed Upgrades ​

When you initiate an upgrade through the UI, Cribl first stores a backup of your current stable deployment. Should the upgrade fail, Cribl will automatically roll back to the older version using this backup.

In Cribl.Cloud, the backup and rollback happen automatically. In an on-prem deployment, this behavior is also enabled by default, but you can configure it in detail (or disable it) using the following settings located in Settings > Global Settings > System > General Settings > Upgrade & Share Settings:

  • Enable automatic rollback: Toggle off to disable the automatic rollback of a failed upgrade.

  • Rollback timeout (ms): Time to wait, after an upgrade, before checking each Node’s health to determine whether to perform the rollback. Defaults to 30000 milliseconds (30 seconds).

  • Rollback condition retries: Number of times to retry the health check before performing a rollback. Defaults to 5 attempts.

  • Check interval (ms): Time to wait between health-check retries. Defaults to 1000 milliseconds (1 second).

  • Backups directory: Specify where to store backups. Defaults to $CRIBL_HOME/state/backups.

  • Backup persistence: A relative time expression specifying how long to keep backups after each upgrade. Defaults to 24h.

Manual Rollback ​

If you need to roll back an Edge Node or a whole on-prem deployment to an older version, or if an automatic rollback fails, you can attempt a manual rollback. However, Cribl recommends first considering other options - an upgrade, or working with Cribl Support - before performing a manual rollback.

You can’t roll back a Cribl.Cloud Leader.

Do not manually roll back any Cribl Edge instance running in a container. Instead, locate, download, and launch a container image hosting the earlier version you want.

Before running a manual rollback, especially if you are also rolling back the Leader, we recommend backing up all your configurations.

  1. Ideally, link your deployment to a Git remote repo, and commit and push your Leader’s configuration to that remote. The repo will provide a stable location from which to restore your config, if necessary. Refer to Connect to External Git Repositories for more information.
  2. Stop the Leader instance. (From $CRIBL_HOME/bin/, execute ./cribl stop. If you are running the Leader using systemd, use sudo systemctl stop cribl.)
  3. Create a local backup of your Leader’s whole $CRIBL_HOME directory. This backup is crucial if you are rolling back from a version that included configuration schema changes.

Once the backup is ready, you can proceed to roll back each Node (Edge Nodes and Leader) individually. Make sure that Edge Nodes do not run a newer version than the Leader Node.

  1. Download the package for your desired version. Navigate to https://cribl.io/download/, scroll down to the Cribl Past Releases section, and locate the version that you want to roll back to.

  2. Select the proper release version for your environment and copy the link to the release binary.

  3. Stop the Edge Node. (From $CRIBL_HOME/bin/, execute ./cribl stop. If you are running the Node using systemd, use sudo systemctl stop cribl-edge.)

  4. In your Node’s host, in the parent of your $CRIBL_HOME directory, run the install command for this version. For example, on a Linux host, run:

    sudo curl -Lso - https://cdn.cribl.io/dl/4.18.0/cribl-4.18.0-dfc74421-linux-x64.tgz | tar zxv

  5. If the version you are rolling back from included configuration schema changes, restore your configuration from the backed-up $CRIBL_HOME directory.

Once the rollback is complete, repeat the same steps for all Nodes you want to return to an older version.