Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 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
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,28 +65,28 @@ Help is available for any command by specifying the special flag `--help` (or si

Below you can find a list of the STACKIT services already available in the CLI (along with their respective command names) and the ones that are currently planned to be integrated.

| Service | CLI Commands | Status |
| ---------------------------------- | ------------------------- | ------------------------- |
| Observability | `observability` | :white_check_mark: |
| Infrastructure as a Service (IaaS) | `beta network-area` | :white_check_mark: (beta) |
| Authorization | `project`, `organization` | :white_check_mark: |
| DNS | `dns` | :white_check_mark: |
| Kubernetes Engine (SKE) | `ske` | :white_check_mark: |
| Load Balancer | `load-balancer` | :white_check_mark: |
| LogMe | `logme` | :white_check_mark: |
| MariaDB | `mariadb` | :white_check_mark: |
| MongoDB Flex | `mongodbflex` | :white_check_mark: |
| Object Storage | `object-storage` | :white_check_mark: |
| OpenSearch | `opensearch` | :white_check_mark: |
| PostgreSQL Flex | `postgresflex` | :white_check_mark: |
| RabbitMQ | `rabbitmq` | :white_check_mark: |
| Redis | `redis` | :white_check_mark: |
| Resource Manager | `project` | :white_check_mark: |
| Secrets Manager | `secrets-manager` | :white_check_mark: |
| Server Backup Management | `beta server backup` | :white_check_mark: (beta) |
| Server Command (Run Command) | `beta server command` | :white_check_mark: (beta) |
| Service Account | `service-account` | :white_check_mark: |
| SQLServer Flex | `beta sqlserverflex` | :white_check_mark: (beta) |
| Service | CLI Commands | Status |
| ---------------------------------- |----------------------------------------------------------------| ------------------------- |
| Observability | `observability` | :white_check_mark: |
| Infrastructure as a Service (IaaS) | `beta network-area` <br/> `beta network` <br/> `beta volume` | :white_check_mark: (beta) |
| Authorization | `project`, `organization` | :white_check_mark: |
| DNS | `dns` | :white_check_mark: |
| Kubernetes Engine (SKE) | `ske` | :white_check_mark: |
| Load Balancer | `load-balancer` | :white_check_mark: |
| LogMe | `logme` | :white_check_mark: |
| MariaDB | `mariadb` | :white_check_mark: |
| MongoDB Flex | `mongodbflex` | :white_check_mark: |
| Object Storage | `object-storage` | :white_check_mark: |
| OpenSearch | `opensearch` | :white_check_mark: |
| PostgreSQL Flex | `postgresflex` | :white_check_mark: |
| RabbitMQ | `rabbitmq` | :white_check_mark: |
| Redis | `redis` | :white_check_mark: |
| Resource Manager | `project` | :white_check_mark: |
| Secrets Manager | `secrets-manager` | :white_check_mark: |
| Server Backup Management | `beta server backup` | :white_check_mark: (beta) |
| Server Command (Run Command) | `beta server command` | :white_check_mark: (beta) |
| Service Account | `service-account` | :white_check_mark: |
| SQLServer Flex | `beta sqlserverflex` | :white_check_mark: (beta) |

## Authentication

Expand Down
1 change: 1 addition & 0 deletions docs/stackit_beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,5 @@ stackit beta [flags]
* [stackit beta network-area](./stackit_beta_network-area.md) - Provides functionality for STACKIT Network Area (SNA)
* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server
* [stackit beta sqlserverflex](./stackit_beta_sqlserverflex.md) - Provides functionality for SQLServer Flex
* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for Volume

39 changes: 39 additions & 0 deletions docs/stackit_beta_volume.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## stackit beta volume

Provides functionality for Volume

### Synopsis

Provides functionality for Volume.

```
stackit beta volume [flags]
```

### Options

```
-h, --help Help for "stackit beta volume"
```

### 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
--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 volume create](./stackit_beta_volume_create.md) - Creates a volume
* [stackit beta volume delete](./stackit_beta_volume_delete.md) - Deletes a volume
* [stackit beta volume describe](./stackit_beta_volume_describe.md) - Shows details of a volume
* [stackit beta volume list](./stackit_beta_volume_list.md) - Lists all volumes of a project
* [stackit beta volume performance-class](./stackit_beta_volume_performance-class.md) - Provides functionality for volume performance classes available inside a project
* [stackit beta volume resize](./stackit_beta_volume_resize.md) - Resizes a volume
* [stackit beta volume update](./stackit_beta_volume_update.md) - Updates a volume

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

Creates a volume

### Synopsis

Creates a volume.

```
stackit beta volume create [flags]
```

### Examples

```
Create a volume with availability zone "eu01-1"
$ stackit beta volume create --availability-zone eu01-1

Create a volume with name "volume-1"
$ stackit beta volume create --availability-zone eu01-1 --name volume-1

Create a volume with availability zone "eu01-1", performance class "storage_premium_perf1"
$ stackit beta volume create --availability-zone eu01-1 --performance-class storage_premium_perf1
```

### Options

```
--availability-zone string Availability zone
--description string Volume description
-h, --help Help for "stackit beta volume create"
--label stringToString Labels are key-value string pairs which can be attached to a volume. A label can be provided with the format key=value and the flag can be used multiple times to provide a list of labels (default [])
-n, --name string Volume name
--performance-class string Performance class
--size int Volume size (GB). Either size or source ID and type flags must be given.
--source-id string ID of the source object of volume. Either size or source id and type flags must be given. Source ID and type must be provided together.
--source-type string Type of the source object of volume. Either size or source id and type flags must be given. Source ID and type must be provided together.
```

### 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
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for Volume

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

Deletes a volume

### Synopsis

Deletes a volume.
If the volume is still in use, the deletion will fail


```
stackit beta volume delete [flags]
```

### Examples

```
Delete volume with ID "xxx"
$ stackit beta volume delete xxx
```

### Options

```
-h, --help Help for "stackit beta volume 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
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for Volume

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

Shows details of a volume

### Synopsis

Shows details of a volume.

```
stackit beta volume describe [flags]
```

### Examples

```
Show details of a volume with ID "xxx"
$ stackit beta volume describe xxx

Show details of a volume with ID "xxx" in JSON format
$ stackit beta volume describe xxx --output-format json
```

### Options

```
-h, --help Help for "stackit beta volume 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
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for Volume

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

Lists all volumes of a project

### Synopsis

Lists all volumes of a project.

```
stackit beta volume list [flags]
```

### Examples

```
Lists all volumes
$ stackit beta volume list

Lists all volumes which contains the label xxx
$ stackit beta volume list --label-selector xxx

Lists all volumes in JSON format
$ stackit beta volume list --output-format json

Lists up to 10 volumes
$ stackit beta volume list --limit 10
```

### Options

```
-h, --help Help for "stackit beta volume list"
--label-selector string Filter by label
--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
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for Volume

34 changes: 34 additions & 0 deletions docs/stackit_beta_volume_performance-class.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit beta volume performance-class

Provides functionality for volume performance classes available inside a project

### Synopsis

Provides functionality for volume performance classes available inside a project.

```
stackit beta volume performance-class [flags]
```

### Options

```
-h, --help Help for "stackit beta volume performance-class"
```

### 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
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for Volume
* [stackit beta volume performance-class describe](./stackit_beta_volume_performance-class_describe.md) - Shows details of a volume performance class
* [stackit beta volume performance-class list](./stackit_beta_volume_performance-class_list.md) - Lists all volume performance classes for a project

42 changes: 42 additions & 0 deletions docs/stackit_beta_volume_performance-class_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## stackit beta volume performance-class describe

Shows details of a volume performance class

### Synopsis

Shows details of a volume performance class.

```
stackit beta volume performance-class describe [flags]
```

### Examples

```
Show details of a volume performance class with name "xxx"
$ stackit beta volume performance-class describe xxx

Show details of a volume performance class with name "xxx" in JSON format
$ stackit beta volume performance-class describe xxx --output-format json
```

### Options

```
-h, --help Help for "stackit beta volume performance-class 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
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta volume performance-class](./stackit_beta_volume_performance-class.md) - Provides functionality for volume performance classes available inside a project

Loading