Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/stackit_beta_intake.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,11 @@ stackit beta intake [flags]
### SEE ALSO

* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
* [stackit beta intake create](./stackit_beta_intake_create.md) - Creates a new Intake
* [stackit beta intake delete](./stackit_beta_intake_delete.md) - Deletes an Intake
* [stackit beta intake describe](./stackit_beta_intake_describe.md) - Shows details of an Intake
* [stackit beta intake list](./stackit_beta_intake_list.md) - Lists all Intakes
* [stackit beta intake runner](./stackit_beta_intake_runner.md) - Provides functionality for Intake Runners
* [stackit beta intake update](./stackit_beta_intake_update.md) - Updates an Intake
* [stackit beta intake user](./stackit_beta_intake_user.md) - Provides functionality for Intake Users

59 changes: 59 additions & 0 deletions docs/stackit_beta_intake_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
## stackit beta intake create

Creates a new Intake

### Synopsis

Creates a new Intake.

```
stackit beta intake create [flags]
```

### Examples

```
Create a new Intake with required parameters
$ stackit beta intake create --display-name my-intake --runner-id xxx --catalog-uri "http://dremio.example.com" --catalog-warehouse "my-warehouse"

Create a new Intake with a description, labels, and Dremio authentication
$ stackit beta intake create --display-name my-intake --runner-id xxx --description "Production intake" --labels "env=prod,team=billing" --catalog-uri "http://dremio.example.com" --catalog-warehouse "my-warehouse" --catalog-auth-type "dremio" --dremio-token-endpoint "https://auth.dremio.cloud/oauth/token" --dremio-pat "MY_TOKEN"

Create a new Intake with manual partitioning by a date field
$ stackit beta intake create --display-name my-partitioned-intake --runner-id xxx --catalog-uri "http://dremio.example.com" --catalog-warehouse "my-warehouse" --catalog-partitioning "manual" --catalog-partition-by "day(__intake_ts)"
```

### Options

```
--catalog-auth-type string Authentication type for the catalog (e.g., 'none', 'dremio')
--catalog-namespace string The namespace to which data shall be written (default: 'intake')
--catalog-partition-by strings List of Iceberg partitioning expressions. Only used when --catalog-partitioning is 'manual'
--catalog-partitioning string The target table's partitioning. One of 'none', 'intake-time', 'manual'
--catalog-table-name string The table name to identify the table in Iceberg
--catalog-uri string The URI to the Iceberg catalog endpoint
--catalog-warehouse string The Iceberg warehouse to connect to
--description string Description
--display-name string Display name
--dremio-pat string Dremio personal access token. Required if auth-type is 'dremio'
--dremio-token-endpoint string Dremio OAuth 2.0 token endpoint URL. Required if auth-type is 'dremio'
-h, --help Help for "stackit beta intake create"
--labels stringToString Labels in key=value format, separated by commas. Example: --labels "key1=value1,key2=value2" (default [])
--runner-id string The UUID of the Intake Runner to use
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake

40 changes: 40 additions & 0 deletions docs/stackit_beta_intake_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit beta intake delete

Deletes an Intake

### Synopsis

Deletes an Intake.

```
stackit beta intake delete INTAKE_ID [flags]
```

### Examples

```
Delete an Intake with ID "xxx"
$ stackit beta intake delete xxx
```

### Options

```
-h, --help Help for "stackit beta intake delete"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake

43 changes: 43 additions & 0 deletions docs/stackit_beta_intake_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## stackit beta intake describe

Shows details of an Intake

### Synopsis

Shows details of an Intake.

```
stackit beta intake describe INTAKE_ID [flags]
```

### Examples

```
Get details of an Intake with ID "xxx"
$ stackit beta intake describe xxx

Get details of an Intake with ID "xxx" in JSON format
$ stackit beta intake describe xxx --output-format json
```

### Options

```
-h, --help Help for "stackit beta intake describe"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake

47 changes: 47 additions & 0 deletions docs/stackit_beta_intake_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## stackit beta intake list

Lists all Intakes

### Synopsis

Lists all Intakes for the current project.

```
stackit beta intake list [flags]
```

### Examples

```
List all Intakes
$ stackit beta intake list

List all Intakes in JSON format
$ stackit beta intake list --output-format json

List up to 5 Intakes
$ stackit beta intake list --limit 5
```

### Options

```
-h, --help Help for "stackit beta intake list"
--limit int Maximum number of entries to list
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake

54 changes: 54 additions & 0 deletions docs/stackit_beta_intake_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## stackit beta intake update

Updates an Intake

### Synopsis

Updates an Intake. Only the specified fields are updated.

```
stackit beta intake update INTAKE_ID [flags]
```

### Examples

```
Update the display name of an Intake with ID "xxx"
$ stackit beta intake update xxx --runner-id yyy --display-name new-intake-name

Update the catalog details for an Intake with ID "xxx"
$ stackit beta intake update xxx --runner-id yyy --catalog-uri "http://new.uri" --catalog-warehouse "new-warehouse"
```

### Options

```
--catalog-auth-type string Authentication type for the catalog (e.g., 'none', 'dremio')
--catalog-namespace string The namespace to which data shall be written
--catalog-table-name string The table name to identify the table in Iceberg
--catalog-uri string The URI to the Iceberg catalog endpoint
--catalog-warehouse string The Iceberg warehouse to connect to
--description string Description
--display-name string Display name
--dremio-pat string Dremio personal access token
--dremio-token-endpoint string Dremio OAuth 2.0 token endpoint URL
-h, --help Help for "stackit beta intake update"
--labels stringToString Labels in key=value format, separated by commas. Example: --labels "key1=value1,key2=value2". (default [])
--runner-id string The UUID of the Intake Runner to use
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake

38 changes: 38 additions & 0 deletions docs/stackit_beta_intake_user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## stackit beta intake user

Provides functionality for Intake Users

### Synopsis

Provides functionality for Intake Users.

```
stackit beta intake user [flags]
```

### Options

```
-h, --help Help for "stackit beta intake user"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
* [stackit beta intake user create](./stackit_beta_intake_user_create.md) - Creates a new Intake User
* [stackit beta intake user delete](./stackit_beta_intake_user_delete.md) - Deletes an Intake User
* [stackit beta intake user describe](./stackit_beta_intake_user_describe.md) - Shows details of an Intake User
* [stackit beta intake user list](./stackit_beta_intake_user_list.md) - Lists all Intake Users for an Intake
* [stackit beta intake user update](./stackit_beta_intake_user_update.md) - Updates an Intake User

49 changes: 49 additions & 0 deletions docs/stackit_beta_intake_user_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## stackit beta intake user create

Creates a new Intake User

### Synopsis

Creates a new Intake User, providing secure access credentials for applications to connect to a data stream.

```
stackit beta intake user create [flags]
```

### Examples

```
Create a new Intake User with a display name and password for a specific Intake
$ stackit beta intake user create --intake-id xxx --display-name my-intake-user --password "my-secret-password"

Create a new dead-letter queue user with a description and labels
$ stackit beta intake user create --intake-id xxx --display-name my-dlq-reader --password "another-secret" --type "dead-letter" --description "User for reading undelivered messages" --labels "owner=team-alpha,scope=dlq"
```

### Options

```
--description string Description
--display-name string Display name
-h, --help Help for "stackit beta intake user create"
--intake-id string ID of the Intake to which the user belongs
--labels stringToString Labels in key=value format, separated by commas. Example: --labels "key1=value1,key2=value2" (default [])
--password string User password
--type string Type of user, 'intake' for writing to the stream or 'dead-letter' for reading from the dead-letter queue
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake user](./stackit_beta_intake_user.md) - Provides functionality for Intake Users

41 changes: 41 additions & 0 deletions docs/stackit_beta_intake_user_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## stackit beta intake user delete

Deletes an Intake User

### Synopsis

Deletes an Intake User.

```
stackit beta intake user delete USER_ID [flags]
```

### Examples

```
Delete an Intake User with ID "xxx" from an Intake with ID "yyy"
$ stackit beta intake user delete xxx --intake-id yyy
```

### Options

```
-h, --help Help for "stackit beta intake user delete"
--intake-id string ID of the Intake to which the user belongs
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta intake user](./stackit_beta_intake_user.md) - Provides functionality for Intake Users

Loading