Skip to content

Commit 40fca8e

Browse files
committed
feat(credentials): updated documentation
1 parent af33b73 commit 40fca8e

7 files changed

+257
-0
lines changed

docs/stackit_beta_alb.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ stackit beta alb [flags]
3131

3232
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
3333
* [stackit beta alb create](./stackit_beta_alb_create.md) - Creates an application loadbalancer
34+
* [stackit beta alb credentials](./stackit_beta_alb_credentials.md) - Provides functionality for application loadbalancer credentials
3435
* [stackit beta alb delete](./stackit_beta_alb_delete.md) - Deletes an application loadbalancer
3536
* [stackit beta alb describe](./stackit_beta_alb_describe.md) - Describes an application loadbalancer
3637
* [stackit beta alb list](./stackit_beta_alb_list.md) - Lists albs
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## stackit beta alb credentials
2+
3+
Provides functionality for application loadbalancer credentials
4+
5+
### Synopsis
6+
7+
Provides functionality for application loadbalancer credentials
8+
9+
```
10+
stackit beta alb credentials [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit beta alb 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" "yaml"]
25+
-p, --project-id string Project ID
26+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit beta alb](./stackit_beta_alb.md) - Manages application loadbalancers
33+
* [stackit beta alb credentials create](./stackit_beta_alb_credentials_create.md) - Creates a credential
34+
* [stackit beta alb credentials delete](./stackit_beta_alb_credentials_delete.md) - Deletes credentials
35+
* [stackit beta alb credentials describe](./stackit_beta_alb_credentials_describe.md) - Describes credentials
36+
* [stackit beta alb credentials list](./stackit_beta_alb_credentials_list.md) - Lists all credentials
37+
* [stackit beta alb credentials update](./stackit_beta_alb_credentials_update.md) - Update credentials
38+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## stackit beta alb credentials create
2+
3+
Creates a credential
4+
5+
### Synopsis
6+
7+
Creates a credential.
8+
9+
```
10+
stackit beta alb credentials create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create a new credential, the password is requested interactively or read from ENV variable ALB_CREDENTIALS_PASSWORD
17+
$ stackit beta alb credential create --username some.user --displayname master-creds
18+
```
19+
20+
### Options
21+
22+
```
23+
-d, --displayname string the displayname for the credentials
24+
-h, --help Help for "stackit beta alb credentials create"
25+
-u, --username string the username for the credentials
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" "yaml"]
34+
-p, --project-id string Project ID
35+
--region string Target region for region-specific requests
36+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
37+
```
38+
39+
### SEE ALSO
40+
41+
* [stackit beta alb credentials](./stackit_beta_alb_credentials.md) - Provides functionality for application loadbalancer credentials
42+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit beta alb credentials delete
2+
3+
Deletes credentials
4+
5+
### Synopsis
6+
7+
Deletes credentials.
8+
9+
```
10+
stackit beta alb credentials delete CREDENTIAL_REF [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete credential with name "credential-12345"
17+
$ stackit beta alb credentials delete credential-12345
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta alb credentials delete"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit beta alb credentials](./stackit_beta_alb_credentials.md) - Provides functionality for application loadbalancer credentials
40+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit beta alb credentials describe
2+
3+
Describes credentials
4+
5+
### Synopsis
6+
7+
Describes credentials.
8+
9+
```
10+
stackit beta alb credentials describe CREDENTIAL_REF [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details about credentials with name "credential-12345"
17+
$ stackit beta alb credential describe credential-12345
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta alb credentials describe"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit beta alb credentials](./stackit_beta_alb_credentials.md) - Provides functionality for application loadbalancer credentials
40+
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## stackit beta alb credentials list
2+
3+
Lists all credentials
4+
5+
### Synopsis
6+
7+
Lists all credentials.
8+
9+
```
10+
stackit beta alb credentials list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Lists all credentials
17+
$ stackit beta alb credential list
18+
19+
Lists all credentials in JSON format
20+
$ stackit beta alb credential list --output-format json
21+
22+
Lists up to 10 credentials
23+
$ stackit beta alb credential list --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit beta alb credentials list"
30+
--limit int Number of credentials to list
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
-y, --assume-yes If set, skips all confirmation prompts
37+
--async If set, runs the command asynchronously
38+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
39+
-p, --project-id string Project ID
40+
--region string Target region for region-specific requests
41+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
42+
```
43+
44+
### SEE ALSO
45+
46+
* [stackit beta alb credentials](./stackit_beta_alb_credentials.md) - Provides functionality for application loadbalancer credentials
47+
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## stackit beta alb credentials update
2+
3+
Update credentials
4+
5+
### Synopsis
6+
7+
Update credentials.
8+
9+
```
10+
stackit beta alb credentials update CREDENTIAL_REF_ARG [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update the username
17+
$ stackit beta alb credentials update --username test-cred2 credentials-12345
18+
19+
Update the displayname
20+
$ stackit beta alb credentials update --displayname new-name credentials-12345
21+
22+
Update the password (is retrieved interactively or from ENV variable )
23+
$ stackit beta alb credentials update --password credentials-12345
24+
```
25+
26+
### Options
27+
28+
```
29+
-d, --displayname string the displayname for the credentials
30+
-h, --help Help for "stackit beta alb credentials update"
31+
-w, --password change the password for the credentials
32+
-u, --username string the username for the credentials
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
-y, --assume-yes If set, skips all confirmation prompts
39+
--async If set, runs the command asynchronously
40+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
41+
-p, --project-id string Project ID
42+
--region string Target region for region-specific requests
43+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
44+
```
45+
46+
### SEE ALSO
47+
48+
* [stackit beta alb credentials](./stackit_beta_alb_credentials.md) - Provides functionality for application loadbalancer credentials
49+

0 commit comments

Comments
 (0)