From 2ba5d51120d215f47441bb27aed8738f7a361410 Mon Sep 17 00:00:00 2001 From: Monis Khan Date: Tue, 26 Oct 2021 14:56:49 -0400 Subject: [PATCH] Change default install hint to use get.pinniped.dev/cli This avoids a hard link against a docs page that may change over time. Signed-off-by: Monis Khan --- cmd/pinniped/cmd/kubeconfig.go | 2 +- cmd/pinniped/cmd/kubeconfig_test.go | 42 ++++++++++---------- site/redirects/get.pinniped.dev/netlify.toml | 6 +++ 3 files changed, 28 insertions(+), 22 deletions(-) diff --git a/cmd/pinniped/cmd/kubeconfig.go b/cmd/pinniped/cmd/kubeconfig.go index f6638cda..7f04e6e5 100644 --- a/cmd/pinniped/cmd/kubeconfig.go +++ b/cmd/pinniped/cmd/kubeconfig.go @@ -148,7 +148,7 @@ func kubeconfigCommand(deps kubeconfigDeps) *cobra.Command { f.StringVarP(&flags.outputPath, "output", "o", "", "Output file path (default: stdout)") f.StringVar(&flags.generatedNameSuffix, "generated-name-suffix", "-pinniped", "Suffix to append to generated cluster, context, user kubeconfig entries") f.StringVar(&flags.credentialCachePath, "credential-cache", "", "Path to cluster-specific credentials cache") - f.StringVar(&flags.installHint, "install-hint", "The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli for more details", "This text is shown to the user when the pinniped CLI is not installed.") + f.StringVar(&flags.installHint, "install-hint", "The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details", "This text is shown to the user when the pinniped CLI is not installed.") mustMarkHidden(cmd, "oidc-debug-session-cache") // --oidc-skip-listen is mainly needed for testing. We'll leave it hidden until we have a non-testing use case. diff --git a/cmd/pinniped/cmd/kubeconfig_test.go b/cmd/pinniped/cmd/kubeconfig_test.go index 838b7e65..9c83a963 100644 --- a/cmd/pinniped/cmd/kubeconfig_test.go +++ b/cmd/pinniped/cmd/kubeconfig_test.go @@ -133,7 +133,7 @@ func TestGetKubeconfig(t *testing.T) { --credential-cache string Path to cluster-specific credentials cache --generated-name-suffix string Suffix to append to generated cluster, context, user kubeconfig entries (default "-pinniped") -h, --help help for kubeconfig - --install-hint string This text is shown to the user when the pinniped CLI is not installed. (default "The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli for more details") + --install-hint string This text is shown to the user when the pinniped CLI is not installed. (default "The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details") --kubeconfig string Path to kubeconfig file --kubeconfig-context string Kubeconfig context name (default: current active context) --no-concierge Generate a configuration which does not use the Concierge, but sends the credential to the cluster directly @@ -1327,7 +1327,7 @@ func TestGetKubeconfig(t *testing.T) { - --token=test-token command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `) @@ -1392,7 +1392,7 @@ func TestGetKubeconfig(t *testing.T) { - --token-env=TEST_TOKEN command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `) @@ -1462,7 +1462,7 @@ func TestGetKubeconfig(t *testing.T) { - --request-audience=test-audience command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -1548,7 +1548,7 @@ func TestGetKubeconfig(t *testing.T) { - --request-audience=test-audience command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -1661,7 +1661,7 @@ func TestGetKubeconfig(t *testing.T) { - --request-audience=test-audience command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -1770,7 +1770,7 @@ func TestGetKubeconfig(t *testing.T) { - --request-audience=test-audience command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -1849,7 +1849,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-type=ldap command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -1928,7 +1928,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-type=oidc command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2003,7 +2003,7 @@ func TestGetKubeconfig(t *testing.T) { - --request-audience=test-audience command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2076,7 +2076,7 @@ func TestGetKubeconfig(t *testing.T) { - --request-audience=test-audience command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2156,7 +2156,7 @@ func TestGetKubeconfig(t *testing.T) { - --request-audience=test-audience command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2234,7 +2234,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-flow=foobar command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2317,7 +2317,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-flow=foobar command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2375,7 +2375,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-type=ldap command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2436,7 +2436,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-type=ldap command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2497,7 +2497,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-type=ldap command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2559,7 +2559,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-type=ldap command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2622,7 +2622,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-flow=foobar command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2683,7 +2683,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-flow=cli_password command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, @@ -2743,7 +2743,7 @@ func TestGetKubeconfig(t *testing.T) { - --upstream-identity-provider-flow=cli_password command: '.../path/to/pinniped' env: [] - installHint: The pinniped CLI does not appear to be installed. See https://pinniped.dev/docs/howto/install-cli + installHint: The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details provideClusterInfo: true `, diff --git a/site/redirects/get.pinniped.dev/netlify.toml b/site/redirects/get.pinniped.dev/netlify.toml index 2e7d89ac..3379f215 100644 --- a/site/redirects/get.pinniped.dev/netlify.toml +++ b/site/redirects/get.pinniped.dev/netlify.toml @@ -4,6 +4,12 @@ status = 302 force = true +[[redirects]] + from = "/cli" + to = "https://pinniped.dev/docs/howto/install-cli" + status = 302 + force = true + [[redirects]] from = "/latest/*" to = "https://github.com/vmware-tanzu/pinniped/releases/latest/download/:splat"