From 35a1e4a5127b8e6c060fdc3c6432b093348b363c Mon Sep 17 00:00:00 2001 From: Faris Huskovic Date: Tue, 3 Nov 2020 12:03:54 -0600 Subject: [PATCH] Hide secrets command --- ci/integration/secrets_test.go | 1 + docs/coder.md | 1 - docs/coder_secrets.md | 29 ------------------------ docs/coder_secrets_create.md | 41 ---------------------------------- docs/coder_secrets_ls.md | 25 --------------------- docs/coder_secrets_rm.md | 31 ------------------------- docs/coder_secrets_view.md | 31 ------------------------- internal/cmd/secrets.go | 16 ++++++++++--- 8 files changed, 14 insertions(+), 161 deletions(-) delete mode 100644 docs/coder_secrets.md delete mode 100644 docs/coder_secrets_create.md delete mode 100644 docs/coder_secrets_ls.md delete mode 100644 docs/coder_secrets_rm.md delete mode 100644 docs/coder_secrets_view.md diff --git a/ci/integration/secrets_test.go b/ci/integration/secrets_test.go index 7d3b6663..ffba0b25 100644 --- a/ci/integration/secrets_test.go +++ b/ci/integration/secrets_test.go @@ -12,6 +12,7 @@ import ( func TestSecrets(t *testing.T) { t.Parallel() run(t, "secrets-cli-tests", func(t *testing.T, ctx context.Context, c *tcli.ContainerRunner) { + t.Skip() headlessLogin(ctx, t, c) c.Run(ctx, "coder secrets ls").Assert(t, diff --git a/docs/coder.md b/docs/coder.md index 5a20d80c..e268d312 100644 --- a/docs/coder.md +++ b/docs/coder.md @@ -16,7 +16,6 @@ coder provides a CLI for working with an existing Coder Enterprise installation * [coder envs](coder_envs.md) - Interact with Coder environments * [coder login](coder_login.md) - Authenticate this client for future operations * [coder logout](coder_logout.md) - Remove local authentication credentials if any exist -* [coder secrets](coder_secrets.md) - Interact with Coder Secrets * [coder sh](coder_sh.md) - Open a shell and execute commands in a Coder environment * [coder sync](coder_sync.md) - Establish a one way directory sync to a Coder environment * [coder urls](coder_urls.md) - Interact with environment DevURLs diff --git a/docs/coder_secrets.md b/docs/coder_secrets.md deleted file mode 100644 index dec20226..00000000 --- a/docs/coder_secrets.md +++ /dev/null @@ -1,29 +0,0 @@ -## coder secrets - -Interact with Coder Secrets - -### Synopsis - -Interact with secrets objects owned by the active user. - -### Options - -``` - -h, --help help for secrets - --user string Specify the user whose resources to target (default "me") -``` - -### Options inherited from parent commands - -``` - -v, --verbose show verbose output -``` - -### SEE ALSO - -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation -* [coder secrets create](coder_secrets_create.md) - Create a new secret -* [coder secrets ls](coder_secrets_ls.md) - List all secrets owned by the active user -* [coder secrets rm](coder_secrets_rm.md) - Remove one or more secrets by name -* [coder secrets view](coder_secrets_view.md) - View a secret by name - diff --git a/docs/coder_secrets_create.md b/docs/coder_secrets_create.md deleted file mode 100644 index 17255174..00000000 --- a/docs/coder_secrets_create.md +++ /dev/null @@ -1,41 +0,0 @@ -## coder secrets create - -Create a new secret - -### Synopsis - -Create a new secret object to store application secrets and access them securely from within your environments. - -``` -coder secrets create [secret_name] [flags] -``` - -### Examples - -``` -coder secrets create mysql-password --from-literal 123password -coder secrets create mysql-password --from-prompt -coder secrets create aws-credentials --from-file ./credentials.json -``` - -### Options - -``` - --description string a description of the secret - --from-file string a file from which to read the value of the secret - --from-literal string the value of the secret - --from-prompt enter the secret value through a terminal prompt - -h, --help help for create -``` - -### Options inherited from parent commands - -``` - --user string Specify the user whose resources to target (default "me") - -v, --verbose show verbose output -``` - -### SEE ALSO - -* [coder secrets](coder_secrets.md) - Interact with Coder Secrets - diff --git a/docs/coder_secrets_ls.md b/docs/coder_secrets_ls.md deleted file mode 100644 index 5c4ec55e..00000000 --- a/docs/coder_secrets_ls.md +++ /dev/null @@ -1,25 +0,0 @@ -## coder secrets ls - -List all secrets owned by the active user - -``` -coder secrets ls [flags] -``` - -### Options - -``` - -h, --help help for ls -``` - -### Options inherited from parent commands - -``` - --user string Specify the user whose resources to target (default "me") - -v, --verbose show verbose output -``` - -### SEE ALSO - -* [coder secrets](coder_secrets.md) - Interact with Coder Secrets - diff --git a/docs/coder_secrets_rm.md b/docs/coder_secrets_rm.md deleted file mode 100644 index a7bc4889..00000000 --- a/docs/coder_secrets_rm.md +++ /dev/null @@ -1,31 +0,0 @@ -## coder secrets rm - -Remove one or more secrets by name - -``` -coder secrets rm [...secret_name] [flags] -``` - -### Examples - -``` -coder secrets rm mysql-password mysql-user -``` - -### Options - -``` - -h, --help help for rm -``` - -### Options inherited from parent commands - -``` - --user string Specify the user whose resources to target (default "me") - -v, --verbose show verbose output -``` - -### SEE ALSO - -* [coder secrets](coder_secrets.md) - Interact with Coder Secrets - diff --git a/docs/coder_secrets_view.md b/docs/coder_secrets_view.md deleted file mode 100644 index aba88202..00000000 --- a/docs/coder_secrets_view.md +++ /dev/null @@ -1,31 +0,0 @@ -## coder secrets view - -View a secret by name - -``` -coder secrets view [secret_name] [flags] -``` - -### Examples - -``` -coder secrets view mysql-password -``` - -### Options - -``` - -h, --help help for view -``` - -### Options inherited from parent commands - -``` - --user string Specify the user whose resources to target (default "me") - -v, --verbose show verbose output -``` - -### SEE ALSO - -* [coder secrets](coder_secrets.md) - Interact with Coder Secrets - diff --git a/internal/cmd/secrets.go b/internal/cmd/secrets.go index d15e9778..9fedb6a1 100644 --- a/internal/cmd/secrets.go +++ b/internal/cmd/secrets.go @@ -17,9 +17,19 @@ import ( func secretsCmd() *cobra.Command { var user string cmd := &cobra.Command{ - Use: "secrets", - Short: "Interact with Coder Secrets", - Long: "Interact with secrets objects owned by the active user.", + Use: "secrets", + Short: "Interact with Coder Secrets", + Long: "Interact with secrets objects owned by the active user.", + Hidden: true, + PersistentPreRun: func(cmd *cobra.Command, args []string) { + clog.LogWarn( + "The 'secrets' command is now deprecated", + "It will be removed in the next minor release", + ) + }, + Run: func(cmd *cobra.Command, args []string) { + _ = cmd.Help() + }, } cmd.PersistentFlags().StringVar(&user, "user", coder.Me, "Specify the user whose resources to target") cmd.AddCommand(