Onboard Intake (1/3): introduce intake runner command #952

yago-123 · 2025-09-03T08:34:33Z

Description

This PR onboards the new STACKIT Intake (ticket) service into the CLI.

Intake is composed of three components:

Intake Runners: dedicated, isolated runtime data ingestion environment
Intakes: a specific data stream or topic within an Intake Runner
Intake Users: provides secure access credentials for your applications to connect to your Intake

This PR contains the Intake Runners part only to make a quicker and less overwhelming review. The remaining code (2/3) can be submitted as part of this PR once the first batch has been reviewed/approved or we can open a different PR for it (as the maintainer please).

The commands are designed to work as follows:

$ stackit-cli beta intake runner create ... 
$ stackit-cli beta intake create ... 
$ stackit-cli beta intake user create...

Most customers will use intakes hence why we decided to go with this command structure. The folder structure will look like the following due to the hierachy desired:

$ ls stackit-cli/internal/cmd/intake
common    
instance    # command for intakes 
intake.go        
runner   
user

Checklist

Issue was linked above
Code format was applied: make fmt
Examples were added / adjusted (see e.g. here)
Docs are up-to-date: make generate-docs (will be checked by CI)
Unit tests got implemented or updated
Unit tests are passing: make test (will be checked by CI)
No linter issues: make lint (will be checked by CI)

yago-123 · 2025-09-03T08:37:23Z

Sample CLI usage:

% ./bin/stackit intake runner create --display-name "runner-example" --max-message-size-kib 1024 --max-messages-per-hour 1000 --project-id xxx
Are you sure you want to create an Intake Runner for project "STACKIT Intake PROD"? [y/N] y
Created Intake Runner for project "STACKIT Intake PROD". Runner ID: yyy

% ./bin/stackit intake runner describe yyy  --project-id xxx                                                 
 
 ATTRIBUTE              │ VALUE                                                                 
────────────────────────┼───────────────────────────────────────────────────────────────────────
 ID                     │ yyy                                  
 Name                   │ runner-example                                                        
 Description            │                                                                       
 Max Message Size (KiB) │ 1024                                                                  
 Max Messages/Hour      │ 1000                                                                  
 Ingestion URI          │ yyy.intake.eu01.onstackit.cloud:9094 
 
% ./bin/stackit intake runner list  --project-id xxx          
 
 ID                                   │ NAME           
──────────────────────────────────────┼────────────────
 aaa  │ testyago       
 bbb │ runner1        
 zzz │ mytestrunner   
 ddd │ runner-example 
 fff │ runner1        
 yyy │ test-yago      
 
% ./bin/stackit intake runner update yyy --display-name runner-updated  --project-id xxx
Update request for Intake Runner "yyy" sent successfully.

% ./bin/stackit intake runner delete yyy  --project-id xxx                           
Are you sure you want to delete Intake Runner "yyy"? [y/N] y
Deletion request for Intake Runner "yyy" sent successfully.

internal/cmd/intake/runner/create/create.go

internal/cmd/intake/runner/delete/delete.go

internal/cmd/intake/runner/list/list.go

internal/cmd/beta/intake/runner/list/list_test.go

internal/cmd/intake/intake.go

internal/cmd/intake/common/util.go

internal/cmd/intake/runner/update/update.go

internal/pkg/config/config.go

yago-123 · 2025-09-15T16:04:43Z

PS: notice that I messed up the branch by mistake, I had to cherry-pick until 7868e56 (last commit reviewed) and force push.

internal/cmd/intake/runner/update/update.go

internal/pkg/services/intake/client/client.go

internal/cmd/intake/runner/delete/delete.go

internal/cmd/intake/runner/update/update.go

rubenhoenle · 2025-09-19T13:37:14Z

Rest looks good to me. :)

github-actions · 2025-10-03T02:42:41Z

This PR was marked as stale after 7 days of inactivity and will be closed after another 7 days of further inactivity. If this PR should be kept open, just add a comment, remove the stale label or push new commits to it.

yago-123 · 2025-10-03T06:59:50Z

keep PR open

rubenhoenle

Please check the failing CI pipeline

internal/cmd/beta/intake/runner/create/create_test.go

internal/cmd/intake/runner/create/create_test.go

internal/cmd/beta/intake/runner/delete/delete.go

go.mod

internal/cmd/intake/runner/list/list.go

internal/cmd/beta/intake/runner/describe/describe.go

internal/cmd/beta/intake/runner/update/update_test.go

# Conflicts: # go.mod # go.sum

… officially

yago-123 · 2025-10-16T14:52:29Z

internal/cmd/beta/intake/wait/wait.go

@@ -0,0 +1,162 @@
+package wait


This will be removed once the new SDK is published.

github-actions · 2025-10-25T02:48:28Z

This PR was marked as stale after 7 days of inactivity and will be closed after another 7 days of further inactivity. If this PR should be kept open, just add a comment, remove the stale label or push new commits to it.

github-actions · 2025-11-04T02:56:02Z

This PR was marked as stale after 7 days of inactivity and will be closed after another 7 days of further inactivity. If this PR should be kept open, just add a comment, remove the stale label or push new commits to it.

internal/cmd/beta/intake/runner/create/create.go

internal/cmd/beta/intake/runner/delete/delete.go

internal/cmd/beta/intake/runner/update/update.go

Co-authored-by: Ruben Hönle <[email protected]>

rubenhoenle · 2025-11-06T08:52:34Z

internal/cmd/beta/intake/runner/create/create.go

+}
+
+func outputResult(p *print.Printer, outputFormat, projectLabel string, resp *intake.IntakeRunnerResponse) error {
+	switch outputFormat {


Please use p.OutputResult() instead. This saves yourself all the boilerplate code for the JSON/YAML output.

See the refactoring PR for reference: #1030

So your outputResult func here would look like this instead:

func outputResult(p *print.Printer, outputFormat, projectLabel string, resp *intake.IntakeRunnerResponse) error { return p.OutputResult(outputFormat, resp, func() error { if resp == nil { p.Outputf("Created Intake Runner for project %q, but no runner ID was returned.\n", projectLabel) return nil } p.Outputf("Created Intake Runner for project %q. Runner ID: %s\n", projectLabel, utils.PtrString(resp.Id)) return nil } }

Please also apply this to all other subcommands 😅

rubenhoenle · 2025-11-06T08:55:33Z

internal/cmd/beta/intake/runner/create/create_test.go

+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			p := print.NewPrinter()


Please use the new testutils.TestParseInput func here to save us the boilerplate code.

stackit-cli/internal/cmd/image/list/list_test.go

Line 137 in d68210b

testutils.TestParseInput(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, tt.isValid)

see also the PR #1033 for reference

rubenhoenle · 2025-11-06T08:55:48Z

internal/cmd/beta/intake/runner/delete/delete_test.go

+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			p := print.NewPrinter()


Please use the new testutils.TestParseInput func here to save us the boilerplate code.

stackit-cli/internal/cmd/image/list/list_test.go

Line 137 in d68210b

testutils.TestParseInput(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, tt.isValid)

see also the PR #1033 for reference

rubenhoenle · 2025-11-06T08:55:56Z

internal/cmd/beta/intake/runner/describe/describe_test.go

+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			p := print.NewPrinter()


Please use the new testutils.TestParseInput func here to save us the boilerplate code.

stackit-cli/internal/cmd/image/list/list_test.go

Line 137 in d68210b

testutils.TestParseInput(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, tt.isValid)

see also the PR #1033 for reference

rubenhoenle · 2025-11-06T08:56:10Z

internal/cmd/beta/intake/runner/list/list_test.go

+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			p := print.NewPrinter()


Please use the new testutils.TestParseInput func here to save us the boilerplate code.

stackit-cli/internal/cmd/image/list/list_test.go

Line 137 in d68210b

testutils.TestParseInput(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, tt.isValid)

see also the PR #1033 for reference

rubenhoenle · 2025-11-06T08:56:19Z

internal/cmd/beta/intake/runner/update/update_test.go

+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			p := print.NewPrinter()


Please use the new testutils.TestParseInput func here to save us the boilerplate code.

stackit-cli/internal/cmd/image/list/list_test.go

Line 137 in d68210b

testutils.TestParseInput(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, tt.isValid)

see also the PR #1033 for reference

rubenhoenle · 2025-11-06T08:58:43Z

internal/pkg/services/intake/client/client.go

+)
+
+// ConfigureClient creates and configures a new Intake API client
+func ConfigureClient(p *print.Printer, cliVersion string) (*intake.APIClient, error) {


Please use our new genericclient.ConfigureClientGeneric util func here to save the boilerplate code, see the SKE example below how to use it:

stackit-cli/internal/pkg/services/ske/client/client.go

Lines 12 to 14 in d68210b

func ConfigureClient(p *print.Printer, cliVersion string) (*ske.APIClient, error) {

return genericclient.ConfigureClientGeneric(p, cliVersion, viper.GetString(config.SKECustomEndpointKey), false, genericclient.CreateApiClient[*ske.APIClient](ske.NewAPIClient))

}

Refactoring PR for reference: #1058

rubenhoenle · 2025-11-06T09:14:29Z

internal/cmd/beta/intake/runner/delete/delete.go

+			if model.Async {
+				operationState = "Triggered deletion of"
+			}
+			p.Printer.Info("%s stackit Intake Runner %s \n", operationState, model.RunnerId)


Suggested change

p.Printer.Info("%s stackit Intake Runner %s \n", operationState, model.RunnerId)

p.Printer.Outputf("%s stackit Intake Runner %s \n", operationState, model.RunnerId)

p.Printer.Info prints to stderr, while p.Printer.Outputf prints to stdout. I guess you want to print to stdout here.

yago-123 requested a review from a team as a code owner September 3, 2025 08:34

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/cmd/intake/intake.go Outdated Show resolved Hide resolved

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/cmd/intake/common/util.go Outdated Show resolved Hide resolved

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/cmd/intake/runner/update/update.go Outdated Show resolved Hide resolved

rubenhoenle reviewed Sep 4, 2025

View reviewed changes

internal/pkg/config/config.go Show resolved Hide resolved

rubenhoenle added the needs-work PR needs work from author. label Sep 4, 2025

yago-123 requested a review from rubenhoenle September 8, 2025 10:57

yago-123 force-pushed the yg/onboard-intake branch 2 times, most recently from 732eff1 to 669dbb9 Compare September 15, 2025 15:21

rubenhoenle previously approved these changes Sep 19, 2025

View reviewed changes

rubenhoenle reviewed Sep 19, 2025

View reviewed changes

internal/cmd/intake/runner/delete/delete.go Outdated Show resolved Hide resolved

rubenhoenle reviewed Sep 19, 2025

View reviewed changes

internal/cmd/intake/runner/update/update.go Outdated Show resolved Hide resolved

yago-123 dismissed rubenhoenle’s stale review via c29876e September 25, 2025 14:35

yago-123 requested a review from rubenhoenle September 25, 2025 14:58

github-actions bot added the Stale label Oct 3, 2025

github-actions bot removed the Stale label Oct 4, 2025

rubenhoenle previously approved these changes Oct 6, 2025

View reviewed changes

Yago Carlos Fernandez Gou added 7 commits October 6, 2025 15:42

Onboard Intake (1/3): introduce intake runner command

bb2ed83

address review comments

a04878f

address review comments: fix listing being empty

244a94f

address review comments: be able to configure custom endpoints

6be700c

update docs

ef3f641

remove option for clearing labels

535dfb6

# Conflicts: # go.mod # go.sum

Bump Intake OpenAPI to 0.2.0 and address update fixes

1abf8da

rubenhoenle added the needs-work PR needs work from author. label Oct 14, 2025

yago-123 mentioned this pull request Oct 15, 2025

Introduce waiters for Intake Runner, Intake and Intake User stackitcloud/stackit-sdk-go#3655

Open

11 tasks

Yago Carlos Fernandez Gou added 3 commits October 16, 2025 16:34

Dirty commit: add SDK dependency locally until is merged and released…

0cb825f

… officially

Address review: add waiters to create/update/delete operations

e23654d

Add state in Intake Runner listing

d87e6c5

yago-123 commented Oct 16, 2025

View reviewed changes

Small adjustment: use correct package alias

a5d0c3c

github-actions bot added the Stale label Oct 25, 2025

rubenhoenle removed the Stale label Oct 27, 2025

github-actions bot added the Stale label Nov 4, 2025

rubenhoenle added has internal tracking issue and removed Stale labels Nov 4, 2025

rubenhoenle reviewed Nov 4, 2025

View reviewed changes

devanshcache and others added 7 commits November 5, 2025 09:44

Update internal/cmd/beta/intake/runner/create/create.go

45f92be

Co-authored-by: Ruben Hönle <[email protected]>

Update internal/cmd/beta/intake/runner/create/create.go

db3fd03

Co-authored-by: Ruben Hönle <[email protected]>

Update internal/cmd/beta/intake/runner/delete/delete.go

5b0dfb9

Co-authored-by: Ruben Hönle <[email protected]>

Update internal/cmd/beta/intake/runner/delete/delete.go

3e886fc

Co-authored-by: Ruben Hönle <[email protected]>

Update internal/cmd/beta/intake/runner/delete/delete.go

af26ad2

Co-authored-by: Ruben Hönle <[email protected]>

Update internal/cmd/beta/intake/runner/update/update.go

ffa03e7

Co-authored-by: Ruben Hönle <[email protected]>

Update internal/cmd/beta/intake/runner/update/update.go

4dce577

Co-authored-by: Ruben Hönle <[email protected]>

rubenhoenle reviewed Nov 6, 2025

View reviewed changes

	func ConfigureClient(p print.Printer, cliVersion string) (ske.APIClient, error) {
	return genericclient.ConfigureClientGeneric(p, cliVersion, viper.GetString(config.SKECustomEndpointKey), false, genericclient.CreateApiClient[*ske.APIClient](ske.NewAPIClient))
	}

	p.Printer.Info("%s stackit Intake Runner %s \n", operationState, model.RunnerId)
	p.Printer.Outputf("%s stackit Intake Runner %s \n", operationState, model.RunnerId)

Onboard Intake (1/3): introduce intake runner command #952

Are you sure you want to change the base?

Onboard Intake (1/3): introduce intake runner command #952

Uh oh!

Conversation

yago-123 commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

yago-123 commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yago-123 commented Sep 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rubenhoenle commented Sep 19, 2025

Uh oh!

github-actions bot commented Oct 3, 2025

Uh oh!

yago-123 commented Oct 3, 2025

Uh oh!

rubenhoenle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 25, 2025

Uh oh!

github-actions bot commented Nov 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

yago-123 commented Sep 3, 2025 •

edited

Loading

yago-123 commented Sep 3, 2025 •

edited

Loading