From e4436ca36d9b93efb61cfc60a527501ff5e453a9 Mon Sep 17 00:00:00 2001 From: Ruslan Aliev Date: Mon, 8 Mar 2021 22:32:59 +0000 Subject: [PATCH] Revert "Adding commands to get and set encryption configs" This reverts commit 694067492cfedd5e7b369b396bfce9923c0ca3a1. Reason for revert: Encryption configs inside airship config are no longer required. Encrypt feature was implemented different way. Change-Id: I1c8feec75000402e314e815e4832ce740f0e1254 --- cmd/config/config.go | 3 - cmd/config/get_encryption_config.go | 76 -------- cmd/config/get_encryption_config_test.go | 65 ------- cmd/config/set_context.go | 7 - cmd/config/set_context_test.go | 31 +-- cmd/config/set_encryption_config.go | 104 ---------- .../set_encryption_configuration_test.go | 179 ------------------ .../config-cmd-with-help.golden | 2 - ...onfig-cmd-set-context-too-many-args.golden | 8 +- .../config-cmd-set-context-with-help.golden | 8 +- ...d-set-encryption-config-excess-args.golden | 24 --- ...g-cmd-set-encryption-config-no-args.golden | 24 --- ...cmd-set-encryption-config-with-help.golden | 26 --- .../get-empty-encryption-config.golden | 3 - .../get-encryption-config-all.golden | 3 - .../get-encryption-config-not-found.golden | 19 -- .../get-encryption-config-with-help.golden | 19 -- ...cryption-config-error-no-encryption.golden | 24 --- docs/source/cli/airshipctl_config.md | 2 - ...airshipctl_config_get-encryption-config.md | 42 ---- .../cli/airshipctl_config_set-context.md | 8 +- ...airshipctl_config_set-encryption-config.md | 52 ----- docs/source/cli/airshipctl_phase.md | 2 +- docs/source/cli/airshipctl_phase_validate.md | 5 +- 24 files changed, 22 insertions(+), 714 deletions(-) delete mode 100644 cmd/config/get_encryption_config.go delete mode 100644 cmd/config/get_encryption_config_test.go delete mode 100644 cmd/config/set_encryption_config.go delete mode 100644 cmd/config/set_encryption_configuration_test.go delete mode 100644 cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-excess-args.golden delete mode 100644 cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-no-args.golden delete mode 100644 cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-with-help.golden delete mode 100644 cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-empty-encryption-config.golden delete mode 100644 cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-all.golden delete mode 100644 cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-not-found.golden delete mode 100644 cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-with-help.golden delete mode 100644 cmd/config/testdata/TestSetEncryptionConfigGoldenOutput/set-encryption-config-error-no-encryption.golden delete mode 100644 docs/source/cli/airshipctl_config_get-encryption-config.md delete mode 100644 docs/source/cli/airshipctl_config_set-encryption-config.md diff --git a/cmd/config/config.go b/cmd/config/config.go index 8fed8f3af..594745b92 100644 --- a/cmd/config/config.go +++ b/cmd/config/config.go @@ -39,9 +39,6 @@ func NewConfigCommand(cfgFactory config.Factory) *cobra.Command { configRootCmd.AddCommand(NewGetManifestCommand(cfgFactory)) configRootCmd.AddCommand(NewSetManifestCommand(cfgFactory)) - configRootCmd.AddCommand(NewGetEncryptionConfigCommand(cfgFactory)) - configRootCmd.AddCommand(NewSetEncryptionConfigCommand(cfgFactory)) - // Init will have different factory configRootCmd.AddCommand(NewInitCommand()) return configRootCmd diff --git a/cmd/config/get_encryption_config.go b/cmd/config/get_encryption_config.go deleted file mode 100644 index e5ca5f4e3..000000000 --- a/cmd/config/get_encryption_config.go +++ /dev/null @@ -1,76 +0,0 @@ -/* - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - https://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -*/ - -package config - -import ( - "fmt" - - "github.com/spf13/cobra" - - "opendev.org/airship/airshipctl/pkg/config" -) - -const ( - getEncryptionConfigsLong = ` -Display a specific encryption config information, or all defined encryption configs if no name is provided. -` - - getEncryptionConfigsExample = ` -# List all the encryption configs airshipctl knows about -airshipctl config get-encryption-configs - -# Display a specific encryption config -airshipctl config get-encryption-config exampleConfig -` -) - -// NewGetEncryptionConfigCommand creates a command that enables printing an encryption configuration to stdout. -func NewGetEncryptionConfigCommand(cfgFactory config.Factory) *cobra.Command { - cmd := &cobra.Command{ - Use: "get-encryption-config NAME", - Short: "Get an encryption config information from the airshipctl config", - Long: getEncryptionConfigsLong[1:], - Example: getEncryptionConfigsExample, - Args: cobra.MaximumNArgs(1), - Aliases: []string{"get-encryption-configs"}, - RunE: func(cmd *cobra.Command, args []string) error { - airconfig, err := cfgFactory() - if err != nil { - return err - } - if len(args) == 1 { - name := args[0] - encryptionConfig, exists := airconfig.EncryptionConfigs[name] - if !exists { - return config.ErrEncryptionConfigurationNotFound{ - Name: fmt.Sprintf("Encryption Config with name '%s'", name), - } - } - fmt.Fprintln(cmd.OutOrStdout(), encryptionConfig) - } else { - encryptionConfigs := airconfig.GetEncryptionConfigs() - if len(encryptionConfigs) == 0 { - fmt.Fprintln(cmd.OutOrStdout(), "No Encryption Config found in the configuration.") - } - for _, encryptionConfig := range encryptionConfigs { - fmt.Fprintln(cmd.OutOrStdout(), encryptionConfig) - } - } - return nil - }, - } - - return cmd -} diff --git a/cmd/config/get_encryption_config_test.go b/cmd/config/get_encryption_config_test.go deleted file mode 100644 index a10ba745c..000000000 --- a/cmd/config/get_encryption_config_test.go +++ /dev/null @@ -1,65 +0,0 @@ -/* -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package config_test - -import ( - "testing" - - cmd "opendev.org/airship/airshipctl/cmd/config" - "opendev.org/airship/airshipctl/pkg/config" - "opendev.org/airship/airshipctl/testutil" -) - -func TestGetEncryptionConfigCmd(t *testing.T) { - settings := func() (*config.Config, error) { - return &config.Config{ - EncryptionConfigs: map[string]*config.EncryptionConfig{ - config.AirshipDefaultContext: testutil.DummyEncryptionConfig(), - }, - }, nil - } - - emptySettings := func() (*config.Config, error) { - return &config.Config{}, nil - } - - cmdTests := []*testutil.CmdTest{ - { - Name: "get-encryption-config-with-help", - CmdLine: "--help", - Cmd: cmd.NewGetEncryptionConfigCommand(nil), - }, - { - Name: "get-encryption-config-not-found", - CmdLine: "foo", - Cmd: cmd.NewGetEncryptionConfigCommand(emptySettings), - Error: config.ErrEncryptionConfigurationNotFound{Name: "Encryption Config with name 'foo'"}, - }, - { - Name: "get-encryption-config-all", - CmdLine: "", - Cmd: cmd.NewGetEncryptionConfigCommand(settings), - }, - { - Name: "get-empty-encryption-config", - CmdLine: config.AirshipDefaultContext, - Cmd: cmd.NewGetEncryptionConfigCommand(settings), - }, - } - - for _, tt := range cmdTests { - testutil.RunTest(t, tt) - } -} diff --git a/cmd/config/set_context.go b/cmd/config/set_context.go index e4ec0fa82..a31cfdc5c 100644 --- a/cmd/config/set_context.go +++ b/cmd/config/set_context.go @@ -31,7 +31,6 @@ Create or modify a context in the airshipctl config files. # Create a new context named "exampleContext" airshipctl config set-context exampleContext \ --manifest=exampleManifest \ - --encryption-config=exampleEncryptionConfig # Update the manifest of the current-context airshipctl config set-context \ @@ -92,12 +91,6 @@ func addSetContextFlags(o *config.ContextOptions, cmd *cobra.Command) { "", "set the manifest for the specified context") - flags.StringVar( - &o.EncryptionConfig, - "encryption-config", - "", - "set the encryption config for the specified context") - flags.BoolVar( &o.Current, "current", diff --git a/cmd/config/set_context_test.go b/cmd/config/set_context_test.go index fb6776358..6045f5297 100644 --- a/cmd/config/set_context_test.go +++ b/cmd/config/set_context_test.go @@ -28,9 +28,8 @@ import ( ) const ( - testEncryptionConfig = "test_encryption_config" - defaultManifest = "edge_cloud" - testManifest = "test_manifest" + defaultManifest = "edge_cloud" + testManifest = "test_manifest" ) type setContextTest struct { @@ -70,23 +69,20 @@ func TestSetContext(t *testing.T) { defer cleanupGiven(t) tests := []struct { - testName string - contextName string - flags []string - givenConfig *config.Config - manifest string - encryptionConfig string + testName string + contextName string + flags []string + givenConfig *config.Config + manifest string }{ { testName: "set-context", contextName: "dummycontext", flags: []string{ "--manifest=" + defaultManifest, - "--encryption-config=" + testEncryptionConfig, }, - givenConfig: given, - manifest: defaultManifest, - encryptionConfig: testEncryptionConfig, + givenConfig: given, + manifest: defaultManifest, }, { testName: "set-current-context", @@ -103,15 +99,6 @@ func TestSetContext(t *testing.T) { givenConfig: given, manifest: testManifest, }, - { - testName: "modify-context", - contextName: "def_target", - flags: []string{ - "--encryption-config=" + testEncryptionConfig, - }, - givenConfig: given, - encryptionConfig: testEncryptionConfig, - }, } for _, tt := range tests { diff --git a/cmd/config/set_encryption_config.go b/cmd/config/set_encryption_config.go deleted file mode 100644 index 38464f520..000000000 --- a/cmd/config/set_encryption_config.go +++ /dev/null @@ -1,104 +0,0 @@ -/* -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package config - -import ( - "fmt" - - "github.com/spf13/cobra" - - "opendev.org/airship/airshipctl/pkg/config" -) - -const ( - setEncryptionConfigLong = ` -Create or modify an encryption config in the airshipctl config file. - -Encryption configs are local files or kubernetes secrets that are used to encrypt and decrypt kubernetes objects -` - - setEncryptionConfigExample = ` -# Create an encryption config with local gpg key source -airshipctl config set-encryption-config exampleConfig \ - --encryption-key path-to-encryption-key \ - --decryption-key path-to-encryption-key - -# Create an encryption config with kube api server secret as the store to store encryption keys -airshipctl config set-encryption-config exampleConfig \ - --secret-name secretName \ - --secret-namespace secretNamespace -` -) - -// NewSetEncryptionConfigCommand creates a command for creating and modifying encryption -// configs in the airshipctl config file. -func NewSetEncryptionConfigCommand(cfgFactory config.Factory) *cobra.Command { - o := &config.EncryptionConfigOptions{} - cmd := &cobra.Command{ - Use: "set-encryption-config NAME", - Short: "Manage encryption configs in airship config", - Long: setEncryptionConfigLong[1:], - Example: setEncryptionConfigExample, - Args: cobra.ExactArgs(1), - RunE: func(cmd *cobra.Command, args []string) error { - cfg, err := cfgFactory() - if err != nil { - return err - } - o.Name = args[0] - modified, err := config.RunSetEncryptionConfig(o, cfg, true) - if err != nil { - return err - } - if modified { - fmt.Fprintf(cmd.OutOrStdout(), "Encryption Config %q modified.\n", o.Name) - } else { - fmt.Fprintf(cmd.OutOrStdout(), "Encryption Config %q created.\n", o.Name) - } - return nil - }, - } - - addSetEncryptionConfigFlags(o, cmd) - return cmd -} - -func addSetEncryptionConfigFlags(o *config.EncryptionConfigOptions, cmd *cobra.Command) { - flags := cmd.Flags() - - flags.StringVar( - &o.EncryptionKeyPath, - "encryption-key-path", - "", - "the path to the encryption key file") - - flags.StringVar( - &o.DecryptionKeyPath, - "decryption-key-path", - "", - "the path to the decryption key file") - - flags.StringVar( - &o.KeySecretName, - "secret-name", - "", - "name of the secret consisting of the encryption and decryption keys") - - flags.StringVar( - &o.KeySecretNamespace, - "secret-namespace", - "", - "namespace of the secret consisting of the encryption and decryption keys") -} diff --git a/cmd/config/set_encryption_configuration_test.go b/cmd/config/set_encryption_configuration_test.go deleted file mode 100644 index fa48eb649..000000000 --- a/cmd/config/set_encryption_configuration_test.go +++ /dev/null @@ -1,179 +0,0 @@ -/* - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -*/ - -package config - -import ( - "fmt" - "strings" - "testing" - - "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" - - "opendev.org/airship/airshipctl/pkg/config" - "opendev.org/airship/airshipctl/testutil" -) - -const ( - encryptionConfigName = "encryptionConfig" - secretName = "secretName" - secretNamespace = "secretNamespace" - encryptionKeyFilePath = "/tmp/encryption.key" - decryptionKeyFilePath = "/tmp/decryption.pub" -) - -func TestConfigSetEncryptionConfigurationCmd(t *testing.T) { - cmdTests := []*testutil.CmdTest{ - { - Name: "config-cmd-set-encryption-config-with-help", - CmdLine: "--help", - Cmd: NewSetEncryptionConfigCommand(nil), - }, - { - Name: "config-cmd-set-encryption-config-no-args", - CmdLine: "", - Cmd: NewSetEncryptionConfigCommand(nil), - Error: fmt.Errorf("accepts %d arg(s), received %d", 1, 0), - }, - { - Name: "config-cmd-set-encryption-config-excess-args", - CmdLine: "arg1 arg2", - Cmd: NewSetEncryptionConfigCommand(nil), - Error: fmt.Errorf("accepts %d arg(s), received %d", 1, 2), - }, - } - - for _, tt := range cmdTests { - testutil.RunTest(t, tt) - } -} - -func TestSetEncryptionConfig(t *testing.T) { - given, cleanupGiven := testutil.InitConfig(t) - defer cleanupGiven(t) - - tests := []struct { - testName string - encryptionConfigName string - flags []string - inputConfig *config.Config - secretName string - secretNamespace string - encryptionKeyFilePath string - decryptionKeyFilePath string - error error - }{ - { - testName: "set-encryption-config-error-no-encryption", - encryptionKeyFilePath: encryptionKeyFilePath, - decryptionKeyFilePath: decryptionKeyFilePath, - encryptionConfigName: encryptionConfigName, - flags: []string{ - "--decryption-key-path " + decryptionKeyFilePath, - }, - error: fmt.Errorf("specify both encryption " + - "and decryption keys when setting encryption config"), - inputConfig: given, - }, - { - testName: "set-encryption-config-error-no-decryption", - flags: []string{ - "--encryption-key-path " + encryptionKeyFilePath, - }, - error: fmt.Errorf("you must specify both encryption " + - "and decryption keys when setting encryption config"), - encryptionConfigName: encryptionConfigName, - encryptionKeyFilePath: encryptionKeyFilePath, - decryptionKeyFilePath: decryptionKeyFilePath, - }, - { - testName: "set-encryption-config-error-no-options", - encryptionConfigName: encryptionConfigName, - error: fmt.Errorf("you must specify both encryption " + - "and decryption keys when setting encryption config"), - inputConfig: given, - }, - { - testName: "set-encryption-config", - encryptionConfigName: encryptionConfigName, - encryptionKeyFilePath: encryptionKeyFilePath, - decryptionKeyFilePath: decryptionKeyFilePath, - flags: []string{ - "--decryption-key-path " + decryptionKeyFilePath, - "--encryption-key-path " + encryptionKeyFilePath, - }, - inputConfig: given, - }, - { - testName: "set-encryption-config-error-no-namespace", - encryptionConfigName: encryptionConfigName, - flags: []string{ - "--secret-name " + secretName, - }, - error: fmt.Errorf("you must specify both secret name and namespace" + - " when setting encryption config"), - }, - { - testName: "set-encryption-config-error-no-secret-name", - encryptionConfigName: encryptionConfigName, - flags: []string{ - "--secret-namespace " + secretNamespace, - }, - error: fmt.Errorf("you must specify both secret name and namespace" + - " when setting encryption config"), - }, - { - testName: "set-encryption-config", - encryptionConfigName: encryptionConfigName, - secretName: secretName, - secretNamespace: secretNamespace, - encryptionKeyFilePath: encryptionKeyFilePath, - decryptionKeyFilePath: decryptionKeyFilePath, - flags: []string{ - "--secret-name " + secretName, - "--secret-namespace " + secretNamespace, - }, - inputConfig: given, - }, - } - - for _, tt := range tests { - settings := func() (*config.Config, error) { - return tt.inputConfig, nil - } - - cmd := &testutil.CmdTest{ - Name: tt.testName, - CmdLine: fmt.Sprintf("%s %s", tt.encryptionConfigName, strings.Join(tt.flags, " ")), - Error: tt.error, - Cmd: NewSetEncryptionConfigCommand(settings), - } - - testutil.RunTest(t, cmd) - - if cmd.Error != nil { - return - } - - afterRunConf := tt.inputConfig - // Find the Encryption Config Created or Modified - afterRunEncryptionConfig, _ := afterRunConf.EncryptionConfigs[tt.encryptionConfigName] - require.NotNil(t, afterRunEncryptionConfig) - assert.EqualValues(t, afterRunEncryptionConfig.KeySecretName, tt.secretName) - assert.EqualValues(t, afterRunEncryptionConfig.KeySecretNamespace, tt.secretNamespace) - assert.EqualValues(t, afterRunEncryptionConfig.EncryptionKeyPath, tt.encryptionKeyFilePath) - assert.EqualValues(t, afterRunEncryptionConfig.DecryptionKeyPath, tt.decryptionKeyFilePath) - } -} diff --git a/cmd/config/testdata/TestConfigGoldenOutput/config-cmd-with-help.golden b/cmd/config/testdata/TestConfigGoldenOutput/config-cmd-with-help.golden index 53de3049f..240214f65 100644 --- a/cmd/config/testdata/TestConfigGoldenOutput/config-cmd-with-help.golden +++ b/cmd/config/testdata/TestConfigGoldenOutput/config-cmd-with-help.golden @@ -5,13 +5,11 @@ Usage: Available Commands: get-context Get context information from the airshipctl config - get-encryption-config Get an encryption config information from the airshipctl config get-management-config View a management config or all management configs defined in the airshipctl config get-manifest Get a manifest information from the airshipctl config help Help about any command init Generate initial configuration file for airshipctl set-context Manage contexts - set-encryption-config Manage encryption configs in airship config set-management-config Modify an out-of-band management configuration set-manifest Manage manifests in airship config use-context Switch to a different context diff --git a/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-too-many-args.golden b/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-too-many-args.golden index 28edef10e..a409d896d 100644 --- a/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-too-many-args.golden +++ b/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-too-many-args.golden @@ -7,7 +7,6 @@ Examples: # Create a new context named "exampleContext" airshipctl config set-context exampleContext \ --manifest=exampleManifest \ - --encryption-config=exampleEncryptionConfig # Update the manifest of the current-context airshipctl config set-context \ @@ -16,8 +15,7 @@ airshipctl config set-context \ Flags: - --current update the current context - --encryption-config string set the encryption config for the specified context - -h, --help help for set-context - --manifest string set the manifest for the specified context + --current update the current context + -h, --help help for set-context + --manifest string set the manifest for the specified context diff --git a/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-with-help.golden b/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-with-help.golden index 4927ca1f0..2780e1efd 100644 --- a/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-with-help.golden +++ b/cmd/config/testdata/TestConfigSetContextGoldenOutput/config-cmd-set-context-with-help.golden @@ -8,7 +8,6 @@ Examples: # Create a new context named "exampleContext" airshipctl config set-context exampleContext \ --manifest=exampleManifest \ - --encryption-config=exampleEncryptionConfig # Update the manifest of the current-context airshipctl config set-context \ @@ -17,7 +16,6 @@ airshipctl config set-context \ Flags: - --current update the current context - --encryption-config string set the encryption config for the specified context - -h, --help help for set-context - --manifest string set the manifest for the specified context + --current update the current context + -h, --help help for set-context + --manifest string set the manifest for the specified context diff --git a/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-excess-args.golden b/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-excess-args.golden deleted file mode 100644 index 071b0076e..000000000 --- a/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-excess-args.golden +++ /dev/null @@ -1,24 +0,0 @@ -Error: accepts 1 arg(s), received 2 -Usage: - set-encryption-config NAME [flags] - -Examples: - -# Create an encryption config with local gpg key source -airshipctl config set-encryption-config exampleConfig \ - --encryption-key path-to-encryption-key \ - --decryption-key path-to-encryption-key - -# Create an encryption config with kube api server secret as the store to store encryption keys -airshipctl config set-encryption-config exampleConfig \ - --secret-name secretName \ - --secret-namespace secretNamespace - - -Flags: - --decryption-key-path string the path to the decryption key file - --encryption-key-path string the path to the encryption key file - -h, --help help for set-encryption-config - --secret-name string name of the secret consisting of the encryption and decryption keys - --secret-namespace string namespace of the secret consisting of the encryption and decryption keys - diff --git a/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-no-args.golden b/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-no-args.golden deleted file mode 100644 index 625793b38..000000000 --- a/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-no-args.golden +++ /dev/null @@ -1,24 +0,0 @@ -Error: accepts 1 arg(s), received 0 -Usage: - set-encryption-config NAME [flags] - -Examples: - -# Create an encryption config with local gpg key source -airshipctl config set-encryption-config exampleConfig \ - --encryption-key path-to-encryption-key \ - --decryption-key path-to-encryption-key - -# Create an encryption config with kube api server secret as the store to store encryption keys -airshipctl config set-encryption-config exampleConfig \ - --secret-name secretName \ - --secret-namespace secretNamespace - - -Flags: - --decryption-key-path string the path to the decryption key file - --encryption-key-path string the path to the encryption key file - -h, --help help for set-encryption-config - --secret-name string name of the secret consisting of the encryption and decryption keys - --secret-namespace string namespace of the secret consisting of the encryption and decryption keys - diff --git a/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-with-help.golden b/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-with-help.golden deleted file mode 100644 index 290d120a0..000000000 --- a/cmd/config/testdata/TestConfigSetEncryptionConfigurationCmdGoldenOutput/config-cmd-set-encryption-config-with-help.golden +++ /dev/null @@ -1,26 +0,0 @@ -Create or modify an encryption config in the airshipctl config file. - -Encryption configs are local files or kubernetes secrets that are used to encrypt and decrypt kubernetes objects - -Usage: - set-encryption-config NAME [flags] - -Examples: - -# Create an encryption config with local gpg key source -airshipctl config set-encryption-config exampleConfig \ - --encryption-key path-to-encryption-key \ - --decryption-key path-to-encryption-key - -# Create an encryption config with kube api server secret as the store to store encryption keys -airshipctl config set-encryption-config exampleConfig \ - --secret-name secretName \ - --secret-namespace secretNamespace - - -Flags: - --decryption-key-path string the path to the decryption key file - --encryption-key-path string the path to the encryption key file - -h, --help help for set-encryption-config - --secret-name string name of the secret consisting of the encryption and decryption keys - --secret-namespace string namespace of the secret consisting of the encryption and decryption keys diff --git a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-empty-encryption-config.golden b/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-empty-encryption-config.golden deleted file mode 100644 index 54c9e0ba9..000000000 --- a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-empty-encryption-config.golden +++ /dev/null @@ -1,3 +0,0 @@ -decryptionKeyPath: /tmp/decryption.pub -encryptionKeyPath: /tmp/encryption.key - diff --git a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-all.golden b/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-all.golden deleted file mode 100644 index 54c9e0ba9..000000000 --- a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-all.golden +++ /dev/null @@ -1,3 +0,0 @@ -decryptionKeyPath: /tmp/decryption.pub -encryptionKeyPath: /tmp/encryption.key - diff --git a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-not-found.golden b/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-not-found.golden deleted file mode 100644 index e02aa3dad..000000000 --- a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-not-found.golden +++ /dev/null @@ -1,19 +0,0 @@ -Error: Unknown encryption configuration 'Encryption Config with name 'foo''. -Usage: - get-encryption-config NAME [flags] - -Aliases: - get-encryption-config, get-encryption-configs - -Examples: - -# List all the encryption configs airshipctl knows about -airshipctl config get-encryption-configs - -# Display a specific encryption config -airshipctl config get-encryption-config exampleConfig - - -Flags: - -h, --help help for get-encryption-config - diff --git a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-with-help.golden b/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-with-help.golden deleted file mode 100644 index 518a742d3..000000000 --- a/cmd/config/testdata/TestGetEncryptionConfigCmdGoldenOutput/get-encryption-config-with-help.golden +++ /dev/null @@ -1,19 +0,0 @@ -Display a specific encryption config information, or all defined encryption configs if no name is provided. - -Usage: - get-encryption-config NAME [flags] - -Aliases: - get-encryption-config, get-encryption-configs - -Examples: - -# List all the encryption configs airshipctl knows about -airshipctl config get-encryption-configs - -# Display a specific encryption config -airshipctl config get-encryption-config exampleConfig - - -Flags: - -h, --help help for get-encryption-config diff --git a/cmd/config/testdata/TestSetEncryptionConfigGoldenOutput/set-encryption-config-error-no-encryption.golden b/cmd/config/testdata/TestSetEncryptionConfigGoldenOutput/set-encryption-config-error-no-encryption.golden deleted file mode 100644 index 22e45018f..000000000 --- a/cmd/config/testdata/TestSetEncryptionConfigGoldenOutput/set-encryption-config-error-no-encryption.golden +++ /dev/null @@ -1,24 +0,0 @@ -Error: specify both encryption and decryption keys when setting encryption config -Usage: - set-encryption-config NAME [flags] - -Examples: - -# Create an encryption config with local gpg key source -airshipctl config set-encryption-config exampleConfig \ - --encryption-key path-to-encryption-key \ - --decryption-key path-to-encryption-key - -# Create an encryption config with kube api server secret as the store to store encryption keys -airshipctl config set-encryption-config exampleConfig \ - --secret-name secretName \ - --secret-namespace secretNamespace - - -Flags: - --decryption-key-path string the path to the decryption key file - --encryption-key-path string the path to the encryption key file - -h, --help help for set-encryption-config - --secret-name string name of the secret consisting of the encryption and decryption keys - --secret-namespace string namespace of the secret consisting of the encryption and decryption keys - diff --git a/docs/source/cli/airshipctl_config.md b/docs/source/cli/airshipctl_config.md index f40149c59..276be0e3c 100644 --- a/docs/source/cli/airshipctl_config.md +++ b/docs/source/cli/airshipctl_config.md @@ -23,12 +23,10 @@ Manage the airshipctl config file * [airshipctl](airshipctl.md) - A unified entrypoint to various airship components * [airshipctl config get-context](airshipctl_config_get-context.md) - Get context information from the airshipctl config -* [airshipctl config get-encryption-config](airshipctl_config_get-encryption-config.md) - Get an encryption config information from the airshipctl config * [airshipctl config get-management-config](airshipctl_config_get-management-config.md) - View a management config or all management configs defined in the airshipctl config * [airshipctl config get-manifest](airshipctl_config_get-manifest.md) - Get a manifest information from the airshipctl config * [airshipctl config init](airshipctl_config_init.md) - Generate initial configuration file for airshipctl * [airshipctl config set-context](airshipctl_config_set-context.md) - Manage contexts -* [airshipctl config set-encryption-config](airshipctl_config_set-encryption-config.md) - Manage encryption configs in airship config * [airshipctl config set-management-config](airshipctl_config_set-management-config.md) - Modify an out-of-band management configuration * [airshipctl config set-manifest](airshipctl_config_set-manifest.md) - Manage manifests in airship config * [airshipctl config use-context](airshipctl_config_use-context.md) - Switch to a different context diff --git a/docs/source/cli/airshipctl_config_get-encryption-config.md b/docs/source/cli/airshipctl_config_get-encryption-config.md deleted file mode 100644 index fdd02dcc7..000000000 --- a/docs/source/cli/airshipctl_config_get-encryption-config.md +++ /dev/null @@ -1,42 +0,0 @@ -## airshipctl config get-encryption-config - -Get an encryption config information from the airshipctl config - -### Synopsis - -Display a specific encryption config information, or all defined encryption configs if no name is provided. - - -``` -airshipctl config get-encryption-config NAME [flags] -``` - -### Examples - -``` - -# List all the encryption configs airshipctl knows about -airshipctl config get-encryption-configs - -# Display a specific encryption config -airshipctl config get-encryption-config exampleConfig - -``` - -### Options - -``` - -h, --help help for get-encryption-config -``` - -### Options inherited from parent commands - -``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") - --debug enable verbose output -``` - -### SEE ALSO - -* [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file - diff --git a/docs/source/cli/airshipctl_config_set-context.md b/docs/source/cli/airshipctl_config_set-context.md index 06ecf6416..098dd0f14 100644 --- a/docs/source/cli/airshipctl_config_set-context.md +++ b/docs/source/cli/airshipctl_config_set-context.md @@ -18,7 +18,6 @@ airshipctl config set-context NAME [flags] # Create a new context named "exampleContext" airshipctl config set-context exampleContext \ --manifest=exampleManifest \ - --encryption-config=exampleEncryptionConfig # Update the manifest of the current-context airshipctl config set-context \ @@ -30,10 +29,9 @@ airshipctl config set-context \ ### Options ``` - --current update the current context - --encryption-config string set the encryption config for the specified context - -h, --help help for set-context - --manifest string set the manifest for the specified context + --current update the current context + -h, --help help for set-context + --manifest string set the manifest for the specified context ``` ### Options inherited from parent commands diff --git a/docs/source/cli/airshipctl_config_set-encryption-config.md b/docs/source/cli/airshipctl_config_set-encryption-config.md deleted file mode 100644 index efff19c2c..000000000 --- a/docs/source/cli/airshipctl_config_set-encryption-config.md +++ /dev/null @@ -1,52 +0,0 @@ -## airshipctl config set-encryption-config - -Manage encryption configs in airship config - -### Synopsis - -Create or modify an encryption config in the airshipctl config file. - -Encryption configs are local files or kubernetes secrets that are used to encrypt and decrypt kubernetes objects - - -``` -airshipctl config set-encryption-config NAME [flags] -``` - -### Examples - -``` - -# Create an encryption config with local gpg key source -airshipctl config set-encryption-config exampleConfig \ - --encryption-key path-to-encryption-key \ - --decryption-key path-to-encryption-key - -# Create an encryption config with kube api server secret as the store to store encryption keys -airshipctl config set-encryption-config exampleConfig \ - --secret-name secretName \ - --secret-namespace secretNamespace - -``` - -### Options - -``` - --decryption-key-path string the path to the decryption key file - --encryption-key-path string the path to the encryption key file - -h, --help help for set-encryption-config - --secret-name string name of the secret consisting of the encryption and decryption keys - --secret-namespace string namespace of the secret consisting of the encryption and decryption keys -``` - -### Options inherited from parent commands - -``` - --airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config") - --debug enable verbose output -``` - -### SEE ALSO - -* [airshipctl config](airshipctl_config.md) - Manage the airshipctl config file - diff --git a/docs/source/cli/airshipctl_phase.md b/docs/source/cli/airshipctl_phase.md index 635aa3948..71342604e 100644 --- a/docs/source/cli/airshipctl_phase.md +++ b/docs/source/cli/airshipctl_phase.md @@ -28,5 +28,5 @@ such as getting list and applying specific one. * [airshipctl phase render](airshipctl_phase_render.md) - Render phase documents from model * [airshipctl phase run](airshipctl_phase_run.md) - Run phase * [airshipctl phase tree](airshipctl_phase_tree.md) - Tree view of kustomize entrypoints of phase -* [airshipctl phase validate](airshipctl_phase_validate.md) - Validate phase +* [airshipctl phase validate](airshipctl_phase_validate.md) - Assert that a phase is valid diff --git a/docs/source/cli/airshipctl_phase_validate.md b/docs/source/cli/airshipctl_phase_validate.md index 687af7e9e..4afe0ec48 100644 --- a/docs/source/cli/airshipctl_phase_validate.md +++ b/docs/source/cli/airshipctl_phase_validate.md @@ -4,7 +4,8 @@ Assert that a phase is valid ### Synopsis -Command which would validate that the phase contains the required documents to run the phase +Command which would validate that the phase contains the required documents to run the phase. + ``` airshipctl phase validate PHASE_NAME [flags] @@ -22,7 +23,7 @@ airshipctl phase validate initinfra ### Options ``` - -h, --help help for run + -h, --help help for validate ``` ### Options inherited from parent commands