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
1 change: 1 addition & 0 deletions docs/stackit_beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ stackit beta [flags]

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit beta alb](./stackit_beta_alb.md) - Manages application loadbalancers
* [stackit beta edge-cloud](./stackit_beta_edge-cloud.md) - Provides functionality for edge services.
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
* [stackit beta kms](./stackit_beta_kms.md) - Provides functionality for KMS
* [stackit beta sfs](./stackit_beta_sfs.md) - Provides functionality for SFS (stackit file storage)
Expand Down
37 changes: 37 additions & 0 deletions docs/stackit_beta_edge-cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## stackit beta edge-cloud

Provides functionality for edge services.

### Synopsis

Provides functionality for STACKIT Edge Cloud (STEC) services.

```
stackit beta edge-cloud [flags]
```

### Options

```
-h, --help Help for "stackit beta edge-cloud"
```

### 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](./stackit_beta.md) - Contains beta STACKIT CLI commands
* [stackit beta edge-cloud instance](./stackit_beta_edge-cloud_instance.md) - Provides functionality for edge instances.
* [stackit beta edge-cloud kubeconfig](./stackit_beta_edge-cloud_kubeconfig.md) - Provides functionality for edge kubeconfig.
* [stackit beta edge-cloud plans](./stackit_beta_edge-cloud_plans.md) - Provides functionality for edge service plans.
* [stackit beta edge-cloud token](./stackit_beta_edge-cloud_token.md) - Provides functionality for edge service token.

38 changes: 38 additions & 0 deletions docs/stackit_beta_edge-cloud_instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## stackit beta edge-cloud instance

Provides functionality for edge instances.

### Synopsis

Provides functionality for STACKIT Edge Cloud (STEC) instance management.

```
stackit beta edge-cloud instance [flags]
```

### Options

```
-h, --help Help for "stackit beta edge-cloud instance"
```

### 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 edge-cloud](./stackit_beta_edge-cloud.md) - Provides functionality for edge services.
* [stackit beta edge-cloud instance create](./stackit_beta_edge-cloud_instance_create.md) - Creates an edge instance
* [stackit beta edge-cloud instance delete](./stackit_beta_edge-cloud_instance_delete.md) - Deletes an edge instance
* [stackit beta edge-cloud instance describe](./stackit_beta_edge-cloud_instance_describe.md) - Describes an edge instance
* [stackit beta edge-cloud instance list](./stackit_beta_edge-cloud_instance_list.md) - Lists edge instances
* [stackit beta edge-cloud instance update](./stackit_beta_edge-cloud_instance_update.md) - Updates an edge instance

43 changes: 43 additions & 0 deletions docs/stackit_beta_edge-cloud_instance_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## stackit beta edge-cloud instance create

Creates an edge instance

### Synopsis

Creates a STACKIT Edge Cloud (STEC) instance. The instance will take a moment to become fully functional.

```
stackit beta edge-cloud instance create [flags]
```

### Examples

```
Creates an edge instance with the name "xxx" and plan-id "yyy"
$ stackit beta edge-cloud instance create --name "xxx" --plan-id "yyy"
```

### Options

```
-d, --description string A user chosen description to distinguish multiple instances.
-h, --help Help for "stackit beta edge-cloud instance create"
-n, --name string The displayed name to distinguish multiple instances.
--plan-id string Service Plan configures the size of the Instance.
```

### 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 edge-cloud instance](./stackit_beta_edge-cloud_instance.md) - Provides functionality for edge instances.

45 changes: 45 additions & 0 deletions docs/stackit_beta_edge-cloud_instance_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## stackit beta edge-cloud instance delete

Deletes an edge instance

### Synopsis

Deletes a STACKIT Edge Cloud (STEC) instance. The instance will be deleted permanently.

```
stackit beta edge-cloud instance delete [flags]
```

### Examples

```
Delete an edge instance with id "xxx"
$ stackit beta edge-cloud instance delete --id "xxx"

Delete an edge instance with name "xxx"
$ stackit beta edge-cloud instance delete --name "xxx"
```

### Options

```
-h, --help Help for "stackit beta edge-cloud instance delete"
-i, --id string The project-unique identifier of this instance.
-n, --name string The displayed name to distinguish multiple instances.
```

### 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 edge-cloud instance](./stackit_beta_edge-cloud_instance.md) - Provides functionality for edge instances.

45 changes: 45 additions & 0 deletions docs/stackit_beta_edge-cloud_instance_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## stackit beta edge-cloud instance describe

Describes an edge instance

### Synopsis

Describes a STACKIT Edge Cloud (STEC) instance.

```
stackit beta edge-cloud instance describe [flags]
```

### Examples

```
Describe an edge instance with id "xxx"
$ stackit beta edge-cloud instance describe --id <ID>

Describe an edge instance with name "xxx"
$ stackit beta edge-cloud instance describe --name <NAME>
```

### Options

```
-h, --help Help for "stackit beta edge-cloud instance describe"
-i, --id string The project-unique identifier of this instance.
-n, --name string The displayed name to distinguish multiple instances.
```

### 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 edge-cloud instance](./stackit_beta_edge-cloud_instance.md) - Provides functionality for edge instances.

44 changes: 44 additions & 0 deletions docs/stackit_beta_edge-cloud_instance_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## stackit beta edge-cloud instance list

Lists edge instances

### Synopsis

Lists STACKIT Edge Cloud (STEC) instances of a project.

```
stackit beta edge-cloud instance list [flags]
```

### Examples

```
Lists all edge instances of a given project
$ stackit beta edge-cloud instance list
Lists all edge instances of a given project and limits the output to two instances
$ stackit beta edge-cloud instance list --limit 2
```

### Options

```
-h, --help Help for "stackit beta edge-cloud instance 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 edge-cloud instance](./stackit_beta_edge-cloud_instance.md) - Provides functionality for edge instances.

50 changes: 50 additions & 0 deletions docs/stackit_beta_edge-cloud_instance_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## stackit beta edge-cloud instance update

Updates an edge instance

### Synopsis

Updates a STACKIT Edge Cloud (STEC) instance.

```
stackit beta edge-cloud instance update [flags]
```

### Examples

```
Updates the description of an edge instance with id "xxx"
$ stackit beta edge-cloud instance update --id "xxx" --description "yyy"

Updates the plan of an edge instance with name "xxx"
$ stackit beta edge-cloud instance update --name "xxx" --plan-id "yyy"

Updates the description and plan of an edge instance with id "xxx"
$ stackit beta edge-cloud instance update --id "xxx" --description "yyy" --plan-id "zzz"
```

### Options

```
-d, --description string A user chosen description to distinguish multiple instances.
-h, --help Help for "stackit beta edge-cloud instance update"
-i, --id string The project-unique identifier of this instance.
-n, --name string The displayed name to distinguish multiple instances.
--plan-id string Service Plan configures the size of the Instance.
```

### 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 edge-cloud instance](./stackit_beta_edge-cloud_instance.md) - Provides functionality for edge instances.

34 changes: 34 additions & 0 deletions docs/stackit_beta_edge-cloud_kubeconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit beta edge-cloud kubeconfig

Provides functionality for edge kubeconfig.

### Synopsis

Provides functionality for STACKIT Edge Cloud (STEC) kubeconfig management.

```
stackit beta edge-cloud kubeconfig [flags]
```

### Options

```
-h, --help Help for "stackit beta edge-cloud kubeconfig"
```

### 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 edge-cloud](./stackit_beta_edge-cloud.md) - Provides functionality for edge services.
* [stackit beta edge-cloud kubeconfig create](./stackit_beta_edge-cloud_kubeconfig_create.md) - Creates or updates a local kubeconfig file of an edge instance

Loading
Loading