Skip to content

Improve examples of LB observability credentials commands #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joaopalet merged 2 commits into from
May 8, 2024
Merged

Improve examples of LB observability credentials commands #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d8b6b7
Improve examples of LB observability credentials commands
May 8, 2024
faddd3c
Extend example
May 8, 2024
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
4 changes: 2 additions & 2 deletions docs/stackit_load-balancer_observability-credentials_add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ stackit load-balancer observability-credentials add [flags]
Add observability credentials to a load balancer with username "xxx" and display name "yyy". The password is entered using the terminal
$ stackit load-balancer observability-credentials add --username xxx --display-name yyy

Add observability credentials to a load balancer with username "xxx" and display name "yyy", providing the password as flag
$ stackit load-balancer observability-credentials add --username xxx --password pwd --display-name yyy
Add observability credentials to a load balancer with username "xxx" and display name "yyy", providing the path to a file with the password as flag
$ stackit load-balancer observability-credentials add --username xxx --password @./password.txt --display-name yyy
```

### Options
Expand Down
11 changes: 4 additions & 7 deletions docs/stackit_load-balancer_observability-credentials_update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,11 @@ stackit load-balancer observability-credentials update [flags]
### Examples

```
Update the password of observability credentials of Load Balancer with credentials reference "credentials-xxx". The password is entered using the terminal
$ stackit load-balancer observability-credentials update credentials-xxx
Update the password and username of observability credentials of Load Balancer with credentials reference "credentials-xxx". The password is entered using the terminal
$ stackit load-balancer observability-credentials update credentials-xxx --username new-username

Update the password of observability credentials of Load Balancer with credentials reference "credentials-xxx", by providing it in the flag
$ stackit load-balancer observability-credentials update credentials-xxx --password new-pwd

Update the display name of observability credentials of Load Balancer with credentials reference "credentials-xxx".
$ stackit load-balancer observability-credentials update credentials-xxx --display-name yyy
Update the password of observability credentials of Load Balancer with credentials reference "credentials-xxx", by providing the path to a file with the new password as flag
$ stackit load-balancer observability-credentials update credentials-xxx --password @./new-password.txt
```

### Options
Expand Down
4 changes: 2 additions & 2 deletions internal/cmd/load-balancer/observability-credentials/add/add.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
`Add observability credentials to a load balancer with username "xxx" and display name "yyy". The password is entered using the terminal`,
"$ stackit load-balancer observability-credentials add --username xxx --display-name yyy"),
examples.NewExample(
`Add observability credentials to a load balancer with username "xxx" and display name "yyy", providing the password as flag`,
"$ stackit load-balancer observability-credentials add --username xxx --password pwd --display-name yyy"),
`Add observability credentials to a load balancer with username "xxx" and display name "yyy", providing the path to a file with the password as flag`,
"$ stackit load-balancer observability-credentials add --username xxx --password @./password.txt --display-name yyy"),
),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := context.Background()
Expand Down
11 changes: 4 additions & 7 deletions internal/cmd/load-balancer/observability-credentials/update/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,11 @@ func NewCmd(p *print.Printer) *cobra.Command {
Args: args.SingleArg(credentialsRefArg, nil),
Example: examples.Build(
examples.NewExample(
`Update the password of observability credentials of Load Balancer with credentials reference "credentials-xxx". The password is entered using the terminal`,
"$ stackit load-balancer observability-credentials update credentials-xxx"),
`Update the password and username of observability credentials of Load Balancer with credentials reference "credentials-xxx". The password is entered using the terminal`,
"$ stackit load-balancer observability-credentials update credentials-xxx --username new-username"),
examples.NewExample(
`Update the password of observability credentials of Load Balancer with credentials reference "credentials-xxx", by providing it in the flag`,
"$ stackit load-balancer observability-credentials update credentials-xxx --password new-pwd"),
examples.NewExample(
`Update the display name of observability credentials of Load Balancer with credentials reference "credentials-xxx".`,
"$ stackit load-balancer observability-credentials update credentials-xxx --display-name yyy"),
Comment thread
joaopalet marked this conversation as resolved.
`Update the password of observability credentials of Load Balancer with credentials reference "credentials-xxx", by providing the path to a file with the new password as flag`,
"$ stackit load-balancer observability-credentials update credentials-xxx --password @./new-password.txt"),
),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := context.Background()
Expand Down