On This Page

Home / Stream/ Setting Up Cribl Stream/ Cribl.Cloud/ Enable Universal Subscription/Connect On-Prem Leaders to Cribl.Cloud

Connect On-Prem Leaders to Cribl.Cloud

If you have an on-prem Cribl Stream environment and a Cribl.Cloud account on certain plan/license tiers, you can use the Connected Environments option to establish a connection between the on-prem Leader and the Cribl.Cloud Leader. Then, use the Connections page in your Cribl.Cloud account to manage credit consumption for all of your on-prem environments from one Cribl.Cloud interface. This feature is called Universal Subscription.

This section provides instructions for connecting on-prem Cribl Stream Leaders to Cribl.Cloud.

For full access to Connected Environments, upgrade Cribl Stream to 4.8.2 or newer.

Before You Begin Connecting On-Prem Leaders
​

There are a few tasks you must complete before you can start connecting your on-prem Leader to Cribl.Cloud:

Create a Cribl.Cloud Account
​

To use Connected Environments, you must have a Cribl.Cloud account on a certain plan/license tier. See our documentation on Register Cribl.Cloud Organization.

Decide How You Want to Connect to the Leader
​

There are three ways to enable a Cribl.Cloud to on-prem Leader connection:

  • From the Cribl.Cloud account in Connections > Connected Environments.
  • From the on-prem Leader in Distributed Settings > Cloud Connection.
  • Using the command line or environment variable, from either the Cribl.Cloud Leader or on-prem Leader.

The setup instructions in this topic will cover each of the connection options.

Purchase Cribl.Cloud Enterprise Plan with Credits
​

Universal Subscription gives you the option to manage an existing on-prem license with Cribl.Cloud credits.

To do this, contact your sales team, who will help you convert your license to credits.

Add Connected Environments in Cribl.Cloud
​

To connect existing on-prem Cribl Stream Distributed deployments to Cribl.Cloud, select an on-prem Leader that is running Cribl Stream 4.7.x or newer, then use the following steps.

If you have multiple environments, such as staging and production enviroments when using GitOps, you must connect each environment individually.

  1. On the top bar, select Products, and then select Cribl.

  2. In the sidebar, select Workspace, and then select Connections.

  3. Select Configure New Environment and fill out the following fields:

    FieldDescriptionExample
    Environment name
    		A name for your environment. This name will display on the Connected Environments page. You can search for and filter environments by name.Goat Farm East Production
    Workspace hostname/ID
    Hostname of your Cribl.Cloud Workspace.
    This field is read-only.    		example.goat-farm-prod.cribl.cloud
    Workspace port numberPort number that the Workspace Leader uses to communicate with the on-prem Leader.4200
    Workspace tokenThe auth token of the Cribl.Cloud Leader. This field is read-only and is automatically populated.a12bcDEFgHiJKLmnOpQRstuvw3x4z56
    Script typeThe format of the script to connect to the on-prem Leader:
    • Environment variable
    • CLI
    		Environment variable:

    CRIBL_DEPLOYMENT=“Goat Farm West Production” 
    CRIBL_CLOUD_WORKSPACE_URL=“tls://a12bcDEFgHiJKLmnOpQRstuvw3x4z56@example.goat-farm-prod.cribl.cloud:4200”
    CLI:

    ./cribl cloud-workspace 
    -d “Goat Farm West Production” 
    -H example.goat-farm-prod.cribl.cloud 
    -p 4200 
    -u a12bcDEFgHiJKLmnOpQRstuvw3x4z56

  4. If you’re using the CLI option, follow these steps, in order:

    1. Select Copy Script.
    2. Open a command-line window, in the environment whose Leader you want to connect to Cribl.Cloud.
    3. cd into the $CRIBL_HOME/bin subdirectory.
    4. Paste the script results onto the command line, and run the script.

  5. If you’re using the environment variable, copy its output, and set it when (or before) you run cribl start. How you set this variable depends on your deployment.

For example, if your Cribl Stream deployment is running in a container, set the environment variable in the container via run call or configuration.

If you’re running your own server, you can set environment variables for the cribl user, or you can declare the variable along with the start command. For details, see our CLI Reference.

Enable the On-Prem Leader Connection to Cribl.Cloud
​

You can connect a Cribl Stream Leader to an existing Enterprise Cribl.Cloud Organization.

  1. In the sidebar, select Settings.

  2. On the Global tab, select Distributed Settings.

  3. Select Cloud Connection.

  4. Toggle Join Cribl.Cloud Workspace on.

  5. Fill in the required fields:

    FieldDescription
    Connection URLThe Cribl.Cloud URL to connect to this Leader. In your Cribl.Cloud Organization, locate this field value on the sidebar’s Workspace > Access tab.
    Connection portThe port for the Cribl.Cloud Leader. Default is 4200.
    Connection auth tokenThe authentication token for the Cribl.Cloud Leader.

  6. Select Save.

  7. In the Cribl Subscription Services Agreement modal, select Agree to accept the agreement.

  8. In the confirmation modal, select Yes to save changes and restart.

    Once you connect an on-prem Leader to a Cribl.Cloud Organization, the license type changes to a Cribl.Cloud billing account and the Licensing page will not be accessible. To return to using an on-prem license, toggle Join Cribl.Cloud Workspace off, select Save, and select Yes in the confirmation modal to save changes and restart.