ON THIS PAGE

Home / Stream/ Setting Up Cribl Stream/ On-Prem Deployment/ Distributed Deployment/Manage Worker Groups

Manage Worker Groups

Worker Groups are collections of Worker Nodes that share the same configuration. They facilitate authoring and management of configuration settings.

You configure data flow, including Routes, Pipelines, Sources, Destinations, per Worker Group. Each Worker Group also has separate version control.

A Cribl.Cloud deployment with a certain plan tier also allows you to create Cribl-managed Worker Groups in Cribl.Cloud. See Managing Cribl.Cloud Worker Groups for more details.

Create a Worker Group
​

To create a new Worker Group:

  1. In the sidebar, select Worker Groups.
  2. Select Add Group.
  3. If you are on Cribl.Cloud and see the Worker Group type field, select Hybrid.
  4. Enter a unique Group name.
  5. Optionally, you can Enable teleporting to Workers to allow UI access for individual Worker Nodes.
  6. Optionally, type in a Description and select Tags.
Creating a New Group
Creating a New Group

To use the Cribl API to create a new Worker Group, see the API Reference.

Configuring multiple Worker Groups, or configuring more than 10 Worker Processes, requires a Cribl Stream on-prem deployment with a certain license tier.

To explicitly set passwords for Worker Groups, see User Authentication.

Clone a Worker Group
​

Cloning a Worker Group copies everything configured on the original Group: Sources, Pipelines, Packs, Routes, and Destinations.

To clone a Worker Group:

  1. In the sidebar, select Worker Groups.
  2. In the Actions column, select ••• (Options).
  3. Select Clone.
  4. Configure the cloned group by choosing its name, and optionally description and tags.

Recover a Worker Group
​

If you delete a Worker Group, you can no longer access its Version Control menu. As a result, you also lose the option to directly recover the Worker Group.

You can, however, still recover a deleted Worker Group, using one of the following two methods:

Create a New Worker Group with the Same Name
​

When you create a new Worker Group with the same name as a deleted one, it will restore that group with all of its configuration.

  1. In the sidebar, select Worker Groups, then select Add Group.
  2. Set Group name to be exactly the same as the deleted group. Fill in the remaining information and Save.
  3. If you previously committed the deletion of the original Worker Group, open the Version Control menu.
  4. Select a previous version of the deleted Worker Group and confirm with Done.

Revert Commit via Command Line
​

You can restore a deleted Worker Group by reverting the deletion commit in version control via command line.

  1. Stop the Cribl server.
  2. Using command line, look at the version control history for the Leader Node and identify the commit which deleted the Worker Group.
  3. Revert to the last commit before the Group was deleted.
  4. Restart the Cribl server.