From a632a9b22c361ba005196367ca5e668819e4d259 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Wei=C3=9Fe?= <66256922+daniel-weisse@users.noreply.github.com> Date: Tue, 10 Dec 2024 10:29:31 +0100 Subject: [PATCH] cli: align descriptions of `--cert` and `--key` flags (#775) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Daniel Weiße --- cli/internal/cmd/cmd.go | 4 ++-- docs/docs/reference/cli.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/cli/internal/cmd/cmd.go b/cli/internal/cmd/cmd.go index c2397839..09f9e5f6 100644 --- a/cli/internal/cmd/cmd.go +++ b/cli/internal/cmd/cmd.go @@ -34,8 +34,8 @@ func webhookDNSName(namespace string) string { } func addClientAuthFlags(cmd *cobra.Command, flags *pflag.FlagSet) { - flags.StringP("cert", "c", "", "PEM encoded admin certificate file") - flags.StringP("key", "k", "", "PEM encoded admin key file") + flags.StringP("cert", "c", "", "PEM encoded MarbleRun user certificate file") + flags.StringP("key", "k", "", "PEM encoded MarbleRun user key file") cmd.MarkFlagsRequiredTogether("key", "cert") flags.String("pkcs11-config", "", "Path to a PKCS#11 configuration file to load the client certificate with") diff --git a/docs/docs/reference/cli.md b/docs/docs/reference/cli.md index c4926bb7..a6577269 100644 --- a/docs/docs/reference/cli.md +++ b/docs/docs/reference/cli.md @@ -424,9 +424,9 @@ marblerun manifest update apply update-manifest.json $MARBLERUN --cert=admin-cer ### Options ``` - -c, --cert string PEM encoded admin certificate file + -c, --cert string PEM encoded MarbleRun user certificate file -h, --help help for apply - -k, --key string PEM encoded admin key file + -k, --key string PEM encoded MarbleRun user key file --pkcs11-cert-id string ID of the certificate in the PKCS#11 token --pkcs11-cert-label string Label of the certificate in the PKCS#11 token --pkcs11-config string Path to a PKCS#11 configuration file to load the client certificate with @@ -472,9 +472,9 @@ marblerun manifest update acknowledge update-manifest.json $MARBLERUN --cert=adm ### Options ``` - -c, --cert string PEM encoded admin certificate file + -c, --cert string PEM encoded MarbleRun user certificate file -h, --help help for acknowledge - -k, --key string PEM encoded admin key file + -k, --key string PEM encoded MarbleRun user key file --pkcs11-cert-id string ID of the certificate in the PKCS#11 token --pkcs11-cert-label string Label of the certificate in the PKCS#11 token --pkcs11-config string Path to a PKCS#11 configuration file to load the client certificate with @@ -516,9 +516,9 @@ marblerun manifest update cancel $MARBLERUN --cert=admin-cert.pem --key=admin-ke ### Options ``` - -c, --cert string PEM encoded admin certificate file + -c, --cert string PEM encoded MarbleRun user certificate file -h, --help help for cancel - -k, --key string PEM encoded admin key file + -k, --key string PEM encoded MarbleRun user key file --pkcs11-cert-id string ID of the certificate in the PKCS#11 token --pkcs11-cert-label string Label of the certificate in the PKCS#11 token --pkcs11-config string Path to a PKCS#11 configuration file to load the client certificate with