Skip to content

Commit 5d5ae24

Browse files
Improve README! (#558)
1 parent 135cb02 commit 5d5ae24

File tree

1 file changed

+31
-23
lines changed

1 file changed

+31
-23
lines changed

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,15 @@
99

1010
[![Go Report Card](https://goreportcard.com/badge/github.com/stackitcloud/stackit-cli)](https://goreportcard.com/report/github.com/stackitcloud/stackit-cli) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/stackitcloud/stackit-cli) [![GitHub License](https://img.shields.io/github/license/stackitcloud/stackit-cli)](https://www.apache.org/licenses/LICENSE-2.0)
1111

12-
Welcome to the [STACKIT](https://www.stackit.de/en) CLI, a command-line interface for the STACKIT services.
12+
Welcome to the STACKIT CLI, a command-line interface for [STACKIT - The German business cloud](https://www.stackit.de/en).
13+
14+
The STACKIT CLI allows you to manage your STACKIT services and resources as well as perform operations using the command-line or in scripts or automation, such as:
15+
16+
- Projects, including permissions
17+
- STACKIT Kubernetes Engine clusters
18+
- Servers
19+
- DNS zones and record-sets
20+
- Databases such as PostgreSQL Flex, MongoDB Flex and SQLServer Flex
1321

1422
This CLI is in a BETA state. More services and functionality will be supported soon.
1523
Your feedback is appreciated!
@@ -65,28 +73,28 @@ Help is available for any command by specifying the special flag `--help` (or si
6573

6674
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.
6775

68-
| Service | CLI Commands | Status |
69-
| ---------------------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------- |
70-
| Observability | `observability` | :white_check_mark: |
71-
| Infrastructure as a Service (IaaS) | `beta network-area` <br/> `beta network` <br/> `beta volume` <br/> `beta network-interface` <br/> `beta public-ip` <br/> `beta security-group` <br/> `beta key-pair` | :white_check_mark: (beta) |
72-
| Authorization | `project`, `organization` | :white_check_mark: |
73-
| DNS | `dns` | :white_check_mark: |
74-
| Kubernetes Engine (SKE) | `ske` | :white_check_mark: |
75-
| Load Balancer | `load-balancer` | :white_check_mark: |
76-
| LogMe | `logme` | :white_check_mark: |
77-
| MariaDB | `mariadb` | :white_check_mark: |
78-
| MongoDB Flex | `mongodbflex` | :white_check_mark: |
79-
| Object Storage | `object-storage` | :white_check_mark: |
80-
| OpenSearch | `opensearch` | :white_check_mark: |
81-
| PostgreSQL Flex | `postgresflex` | :white_check_mark: |
82-
| RabbitMQ | `rabbitmq` | :white_check_mark: |
83-
| Redis | `redis` | :white_check_mark: |
84-
| Resource Manager | `project` | :white_check_mark: |
85-
| Secrets Manager | `secrets-manager` | :white_check_mark: |
86-
| Server Backup Management | `beta server backup` | :white_check_mark: (beta) |
87-
| Server Command (Run Command) | `beta server command` | :white_check_mark: (beta) |
88-
| Service Account | `service-account` | :white_check_mark: |
89-
| SQLServer Flex | `beta sqlserverflex` | :white_check_mark: (beta) |
76+
| Service | CLI Commands | Status |
77+
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
78+
| Observability | `observability` | :white_check_mark: |
79+
| Infrastructure as a Service (IaaS) | `beta network-area` <br/> `beta network` <br/> `beta volume` <br/> `beta network-interface` <br/> `beta public-ip` <br/> `beta security-group` <br/> `beta key-pair` | :white_check_mark: (beta) |
80+
| Authorization | `project`, `organization` | :white_check_mark: |
81+
| DNS | `dns` | :white_check_mark: |
82+
| Kubernetes Engine (SKE) | `ske` | :white_check_mark: |
83+
| Load Balancer | `load-balancer` | :white_check_mark: |
84+
| LogMe | `logme` | :white_check_mark: |
85+
| MariaDB | `mariadb` | :white_check_mark: |
86+
| MongoDB Flex | `mongodbflex` | :white_check_mark: |
87+
| Object Storage | `object-storage` | :white_check_mark: |
88+
| OpenSearch | `opensearch` | :white_check_mark: |
89+
| PostgreSQL Flex | `postgresflex` | :white_check_mark: |
90+
| RabbitMQ | `rabbitmq` | :white_check_mark: |
91+
| Redis | `redis` | :white_check_mark: |
92+
| Resource Manager | `project` | :white_check_mark: |
93+
| Secrets Manager | `secrets-manager` | :white_check_mark: |
94+
| Server Backup Management | `beta server backup` | :white_check_mark: (beta) |
95+
| Server Command (Run Command) | `beta server command` | :white_check_mark: (beta) |
96+
| Service Account | `service-account` | :white_check_mark: |
97+
| SQLServer Flex | `beta sqlserverflex` | :white_check_mark: (beta) |
9098

9199
## Authentication
92100

0 commit comments

Comments
 (0)