Skip to content

Commit e7fc0fe

Browse files
Merge branch 'main' of https://github.com/stackitcloud/stackit-cli into feature/onboard-load-balancer
2 parents 671e146 + 3eebc87 commit e7fc0fe

37 files changed

Lines changed: 2582 additions & 18 deletions

INSTALLATION.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Package managers
44

5-
[![Packaging status](https://repology.org/badge/vertical-allrepos/stackit-cli.svg?columns=3)](https://repology.org/project/stackit-cli/versions)
5+
[![Packaging status](https://repology.org/badge/vertical-allrepos/stackit-cli.svg?columns=1)](https://repology.org/project/stackit-cli/versions)
66

77
### macOS
88

@@ -22,6 +22,16 @@ brew install stackit
2222

2323
### Linux
2424

25+
#### Snapcraft
26+
27+
The STACKIT CLI is available as a [Snap](https://snapcraft.io/stackit), and can be installed via:
28+
29+
```shell
30+
sudo snap install stackit --beta --classic
31+
```
32+
33+
or via the [Snap Store](https://snapcraft.io/snap-store) for desktop.
34+
2535
#### Debian/Ubuntu (`APT`)
2636

2737
The STACKIT CLI can be installed through the [`APT`](https://ubuntu.com/server/docs/package-management) package manager.

docs/stackit_argus.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ stackit argus [flags]
2929
### SEE ALSO
3030

3131
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
32+
* [stackit argus credentials](./stackit_argus_credentials.md) - Provides functionality for Argus credentials
3233
* [stackit argus grafana](./stackit_argus_grafana.md) - Provides functionality for the Grafana configuration of Argus instances
3334
* [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances
3435
* [stackit argus plans](./stackit_argus_plans.md) - Lists all Argus service plans

docs/stackit_argus_credentials.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit argus credentials
2+
3+
Provides functionality for Argus credentials
4+
5+
### Synopsis
6+
7+
Provides functionality for Argus credentials.
8+
9+
```
10+
stackit argus credentials [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit argus credentials"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty" "none"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit argus](./stackit_argus.md) - Provides functionality for Argus
32+
* [stackit argus credentials create](./stackit_argus_credentials_create.md) - Creates credentials for an Argus instance.
33+
* [stackit argus credentials delete](./stackit_argus_credentials_delete.md) - Deletes credentials of an Argus instance
34+
* [stackit argus credentials list](./stackit_argus_credentials_list.md) - Lists the usernames of all credentials for an Argus instance
35+
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## stackit argus credentials create
2+
3+
Creates credentials for an Argus instance.
4+
5+
### Synopsis
6+
7+
Creates credentials (username and password) for an Argus instance.
8+
The credentials will be generated and included in the response. You won't be able to retrieve the password later.
9+
10+
```
11+
stackit argus credentials create [flags]
12+
```
13+
14+
### Examples
15+
16+
```
17+
Create credentials for Argus instance with ID "xxx"
18+
$ stackit argus credentials create --instance-id xxx
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help Help for "stackit argus credentials create"
25+
--instance-id string Instance ID
26+
```
27+
28+
### Options inherited from parent commands
29+
30+
```
31+
-y, --assume-yes If set, skips all confirmation prompts
32+
--async If set, runs the command asynchronously
33+
-o, --output-format string Output format, one of ["json" "pretty" "none"]
34+
-p, --project-id string Project ID
35+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
36+
```
37+
38+
### SEE ALSO
39+
40+
* [stackit argus credentials](./stackit_argus_credentials.md) - Provides functionality for Argus credentials
41+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit argus credentials delete
2+
3+
Deletes credentials of an Argus instance
4+
5+
### Synopsis
6+
7+
Deletes credentials of an Argus instance.
8+
9+
```
10+
stackit argus credentials delete USERNAME [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete credentials of username "xxx" for Argus instance with ID "yyy"
17+
$ stackit argus credentials delete xxx --instance-id yyy
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit argus credentials delete"
24+
--instance-id string Instance ID
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-y, --assume-yes If set, skips all confirmation prompts
31+
--async If set, runs the command asynchronously
32+
-o, --output-format string Output format, one of ["json" "pretty" "none"]
33+
-p, --project-id string Project ID
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit argus credentials](./stackit_argus_credentials.md) - Provides functionality for Argus credentials
40+
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## stackit argus credentials list
2+
3+
Lists the usernames of all credentials for an Argus instance
4+
5+
### Synopsis
6+
7+
Lists the usernames of all credentials for an Argus instance.
8+
9+
```
10+
stackit argus credentials list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List the usernames of all credentials for an Argus instance with ID "xxx"
17+
$ stackit argus credentials list --instance-id xxx
18+
19+
List the usernames of all credentials for an Argus instance in JSON format
20+
$ stackit argus credentials list --instance-id xxx --output-format json
21+
22+
List the usernames of up to 10 credentials for an Argus instance
23+
$ stackit argus credentials list --instance-id xxx --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit argus credentials list"
30+
--instance-id string Instance ID
31+
--limit int Maximum number of entries to list
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
-y, --assume-yes If set, skips all confirmation prompts
38+
--async If set, runs the command asynchronously
39+
-o, --output-format string Output format, one of ["json" "pretty" "none"]
40+
-p, --project-id string Project ID
41+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
42+
```
43+
44+
### SEE ALSO
45+
46+
* [stackit argus credentials](./stackit_argus_credentials.md) - Provides functionality for Argus credentials
47+

docs/stackit_postgresflex.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ stackit postgresflex [flags]
2929
### SEE ALSO
3030

3131
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
32+
* [stackit postgresflex backup](./stackit_postgresflex_backup.md) - Provides functionality for PostgreSQL Flex instance backups
3233
* [stackit postgresflex instance](./stackit_postgresflex_instance.md) - Provides functionality for PostgreSQL Flex instances
3334
* [stackit postgresflex options](./stackit_postgresflex_options.md) - Lists PostgreSQL Flex options
3435
* [stackit postgresflex user](./stackit_postgresflex_user.md) - Provides functionality for PostgreSQL Flex users
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## stackit postgresflex backup
2+
3+
Provides functionality for PostgreSQL Flex instance backups
4+
5+
### Synopsis
6+
7+
Provides functionality for PostgreSQL Flex instance backups.
8+
9+
```
10+
stackit postgresflex backup [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit postgresflex backup"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty" "none"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex
32+
* [stackit postgresflex backup describe](./stackit_postgresflex_backup_describe.md) - Shows details of a backup for a PostgreSQL Flex instance
33+
* [stackit postgresflex backup list](./stackit_postgresflex_backup_list.md) - Lists all backups which are available for a PostgreSQL Flex instance
34+
* [stackit postgresflex backup update-schedule](./stackit_postgresflex_backup_update-schedule.md) - Updates backup schedule for a PostgreSQL Flex instance
35+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit postgresflex backup describe
2+
3+
Shows details of a backup for a PostgreSQL Flex instance
4+
5+
### Synopsis
6+
7+
Shows details of a backup for a PostgreSQL Flex instance.
8+
9+
```
10+
stackit postgresflex backup describe BACKUP_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of a backup with ID "xxx" for a PostgreSQL Flex instance with ID "yyy"
17+
$ stackit postgresflex backup describe xxx --instance-id yyy
18+
19+
Get details of a backup with ID "xxx" for a PostgreSQL Flex instance with ID "yyy" in a table format
20+
$ stackit postgresflex backup describe xxx --instance-id yyy --output-format pretty
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit postgresflex backup describe"
27+
--instance-id string Instance ID
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-y, --assume-yes If set, skips all confirmation prompts
34+
--async If set, runs the command asynchronously
35+
-o, --output-format string Output format, one of ["json" "pretty" "none"]
36+
-p, --project-id string Project ID
37+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit postgresflex backup](./stackit_postgresflex_backup.md) - Provides functionality for PostgreSQL Flex instance backups
43+
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## stackit postgresflex backup list
2+
3+
Lists all backups which are available for a PostgreSQL Flex instance
4+
5+
### Synopsis
6+
7+
Lists all backups which are available for a PostgreSQL Flex instance.
8+
9+
```
10+
stackit postgresflex backup list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all backups of instance with ID "xxx"
17+
$ stackit postgresflex backup list --instance-id xxx
18+
19+
List all backups of instance with ID "xxx" in JSON format
20+
$ stackit postgresflex backup list --instance-id xxx --output-format json
21+
22+
List up to 10 backups of instance with ID "xxx"
23+
$ stackit postgresflex backup list --instance-id xxx --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit postgresflex backup list"
30+
--instance-id string Instance ID
31+
--limit int Maximum number of entries to list
32+
```
33+
34+
### Options inherited from parent commands
35+
36+
```
37+
-y, --assume-yes If set, skips all confirmation prompts
38+
--async If set, runs the command asynchronously
39+
-o, --output-format string Output format, one of ["json" "pretty" "none"]
40+
-p, --project-id string Project ID
41+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
42+
```
43+
44+
### SEE ALSO
45+
46+
* [stackit postgresflex backup](./stackit_postgresflex_backup.md) - Provides functionality for PostgreSQL Flex instance backups
47+

0 commit comments

Comments
 (0)