From 9d8b6b7f0a4c19a4edc9da6bb4a22e244d2b21d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Palet?= Date: Wed, 8 May 2024 17:03:56 +0100 Subject: [PATCH 1/2] Improve examples of LB observability credentials commands --- .../stackit_load-balancer_observability-credentials_add.md | 4 ++-- ...ackit_load-balancer_observability-credentials_update.md | 7 ++----- .../cmd/load-balancer/observability-credentials/add/add.go | 4 ++-- .../observability-credentials/update/update.go | 7 ++----- 4 files changed, 8 insertions(+), 14 deletions(-) diff --git a/docs/stackit_load-balancer_observability-credentials_add.md b/docs/stackit_load-balancer_observability-credentials_add.md index 50f5c92b4..f66ccf0e6 100644 --- a/docs/stackit_load-balancer_observability-credentials_add.md +++ b/docs/stackit_load-balancer_observability-credentials_add.md @@ -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 diff --git a/docs/stackit_load-balancer_observability-credentials_update.md b/docs/stackit_load-balancer_observability-credentials_update.md index ec82debce..47f0cd15c 100644 --- a/docs/stackit_load-balancer_observability-credentials_update.md +++ b/docs/stackit_load-balancer_observability-credentials_update.md @@ -16,11 +16,8 @@ stackit load-balancer observability-credentials update [flags] 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 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 diff --git a/internal/cmd/load-balancer/observability-credentials/add/add.go b/internal/cmd/load-balancer/observability-credentials/add/add.go index c7ec91a2d..e97963d9f 100644 --- a/internal/cmd/load-balancer/observability-credentials/add/add.go +++ b/internal/cmd/load-balancer/observability-credentials/add/add.go @@ -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() diff --git a/internal/cmd/load-balancer/observability-credentials/update/update.go b/internal/cmd/load-balancer/observability-credentials/update/update.go index 126f42cf1..cf47b70fc 100644 --- a/internal/cmd/load-balancer/observability-credentials/update/update.go +++ b/internal/cmd/load-balancer/observability-credentials/update/update.go @@ -46,11 +46,8 @@ func NewCmd(p *print.Printer) *cobra.Command { `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"), 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"), + `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() From faddd3c78ecfeda7e886409377c2ad7d00042cb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Palet?= Date: Wed, 8 May 2024 17:07:14 +0100 Subject: [PATCH 2/2] Extend example --- .../stackit_load-balancer_observability-credentials_update.md | 4 ++-- .../load-balancer/observability-credentials/update/update.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/stackit_load-balancer_observability-credentials_update.md b/docs/stackit_load-balancer_observability-credentials_update.md index 47f0cd15c..86646227e 100644 --- a/docs/stackit_load-balancer_observability-credentials_update.md +++ b/docs/stackit_load-balancer_observability-credentials_update.md @@ -13,8 +13,8 @@ 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 the path to a file with the new password as flag $ stackit load-balancer observability-credentials update credentials-xxx --password @./new-password.txt diff --git a/internal/cmd/load-balancer/observability-credentials/update/update.go b/internal/cmd/load-balancer/observability-credentials/update/update.go index cf47b70fc..0f395139f 100644 --- a/internal/cmd/load-balancer/observability-credentials/update/update.go +++ b/internal/cmd/load-balancer/observability-credentials/update/update.go @@ -43,8 +43,8 @@ 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 the path to a file with the new password as flag`, "$ stackit load-balancer observability-credentials update credentials-xxx --password @./new-password.txt"),