Create and manage Intake Runners

Prerequisites

To begin creating and managing your Intake Runners via the STACKIT CLI, ensure you have the following in place:

• You have a STACKIT customer account: Create a customer Account
• You have a STACKIT user account: Create a user account
• You have a STACKIT project: Create a project
• You have installed the STACKIT CLI on your system: User Guide

Create an Intake runner

The Intake Runner is the engine for your data ingestion. You must create an Intake Runner before you can create an Intake.

Decide on throughput capacity

At first you need to determine the maximum throughput capacity your Intake Runner should be able to sustain across all its intakes. We provide hints on how to Plan your Intake Runner.

You establish the maximum throughput capacity for your Intake Runner by defining two parameters:

• max-message-size-kib: The maximum size, in kibibytes, for a single message.
• max-message-size-per-hour: The maximum number of messages the runner can process per hour.

STACKIT CLI

Flags

Flag	Description	Options	Default	Optional
display-name	a human readable name for the Intake Runner	String, not longer than 32 characters
max-message-size-kib	the maximum size for a single message in kibibytes, for a single message	Integer, between 1 and 1024. Product with max-messages-per-hour not allowed to exceed 20 GiB/h
max-messages-per-hour	the maximum number of messages that can be processed across all Intakes, per hour	Integer, at least 1. Product with max-message-size-kib not allowed to exceed 20 GiB/h
description	a textual description of the Runner’s purpose	String, not longer than 1024 characters	""	✓
labels	labels in key=value format. Allows one to classify the purpose of the Intake Runner	key=value format, separated by commas. Example: “key1=value1,key2=value2”	[]	✓

Execute the creation command

To create your Intake Runner, execute the command providing the relevant flags:

stackit beta intake runner create --display-name <DISPLAY_NAME> --max-message-size-kib <MAX_MESSAGE_SIZE> --max-messages-per-hour <MAX_MESSAGES> --description <DESCRIPTION> --labels <LABELS>

After executing the command you need to confirm with y. When the instance is created succesfully, the CLI will return the instance ID:

Created Intake Runner for project "...". Runner ID: af1b6d5b-9dc5-4dee-ab48-e944a7a17a2b

Examples

Create an Intake Runner with minimal amount of flags:

stackit beta intake runner create --display-name minimal-runner --max-message-size-kib 5 --max-messages-per-hour 10000

Create an Intake Runner with labels:

stackit beta intake runner create --display-name minimal-runner --max-message-size-kib 5 --max-messages-per-hour 10000 --labels "dept=billing,stage=test"

List all Intake Runners

STACKIT CLI

To list all Intake Runners in a cloud project, call the list command:

stackit beta intake runner list

This will result in output like the following:

ID                                   │ NAME
─────────────────────────────────────┼────────────────
ef907939-6fcd-42b0-a635-1b33d3ba7cf3 │ minimal-runner

View an Intake Runner

STACKIT CLI

You can check the status and details of any Intake Runner using the describe command.

Argument	Description
INTAKE_RUNNER_ID	The ID of the Intake Runner you would like to describe

stackit beta intake runner describe <INTAKE_RUNNER_ID>

This will result in an output like the following:

ID                     │ ef907939-6fcd-42b0-a635-1b33d3ba7cf3
State                  | active
Name                   │ minimal-runner
Description            │
Max Message Size (KiB) │ 5
Max Messages/Hour      │ 10000
Ingestion URI          │ ef907939-6fcd-42b0-a635-1b33d3ba7cf3.intake.eu01.onstackit.cloud:9094
flags                  | dept=billing,stage=test

Examples

stackit beta intake runner describe ef907939-6fcd-42b0-a635-1b33d3ba7cf3

Update an Intake Runner

STACKIT CLI

You can update the display name, description, labels, or increase the throughput capacity of an existing Intake Runner using the update command.

Argument	Description
INTAKE_RUNNER_ID	The ID of the Intake Runner you would like to update

Flag	Description	Options
display-name	a human readable name for the Intake Runner	String, not longer than 32 characters
max-message-size-kib	the maximum size for a single message in kibibytes, for a single message	Integer, between 1 and 1024. Product with max-messages-per-hour not allowed to exceed 20 GiB/h or to shrink.
max-messages-per-hour	the maximum number of messages that can be processed across all Intakes, per hour	Integer, at least 1. Product with max-message-size-kib not allowed to exceed 20 GiB/h or to shrink.
description	a textual description of the Runner’s purpose	String, not longer than 1024 characters
labels	labels in key=value format. Allows one to classify the purpose of the Intake Runner	key=value format, separated by commas. Example: “key1=value1,key2=value2”

Execute the update command

To update your Intake Runner, execute the command providing the ID of the Intake Runner and the relevant flags:

stackit beta intake runner update <INTAKE_RUNNER_ID> --display-name <DISPLAY_NAME> --max-message-size-kib <MAX_MESSAGE_SIZE> --max-messages-per-hour <MAX_MESSAGES> --description <DESCRIPTION> --labels <LABELS>

When the update command has been sent, the CLI will return respond with a text like this:

Update request for Intake Runner "af1b6d5b-9dc5-4dee-ab48-e944a7a17a2b" sent successfully.

Examples

Change the labels of an Intake Runner:

stackit beta intake runner update af1b6d5b-9dc5-4dee-ab48-e944a7a17a2b --labels "dept=billing,stage=test"

Delete an Intake Runner

STACKIT CLI

Deleting an Intake Runner is an irreversible operation. It will also delete all associated Intakes and Intake users if you pass in the —force flag. If you do not pass force, the state of the runner will change to deleting. IIt will stay in that state and continue to function until all associated Intakes have been deleted by you manually.

Argument	Description
INTAKE_RUNNER_ID	The ID of the Intake Runner you would like to delete

Flag	Description
force	Delete the Intakes and Intake user as well

stackit beta intake runner delete <INTAKE_RUNNER_ID> --force

You have to confirm the deletion of the Intake Runner by pressing y. The delete command will result in output like this:

Deletion request for Intake Runner "ef907939-6fcd-42b0-a635-1b33d3ba7cf3" sent successfully.