From c4c3c8a12181239fbde09828185f7362a0da0bf3 Mon Sep 17 00:00:00 2001 From: Matous Jobanek Date: Thu, 14 Mar 2024 14:22:41 +0100 Subject: [PATCH] rename sandbox-cli to ksctl --- pkg/client/sandbox_config_file.go | 2 +- pkg/cmd/adm/generate_cli_configs.go | 2 +- pkg/cmd/adm/register_member.go | 2 +- pkg/cmd/adm/setup.go | 4 ++-- pkg/cmd/base_kubectl.go | 2 +- pkg/cmd/describe.go | 2 +- pkg/cmd/get.go | 2 +- pkg/cmd/root.go | 6 +++--- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/pkg/client/sandbox_config_file.go b/pkg/client/sandbox_config_file.go index 8d2e324..ad82762 100644 --- a/pkg/client/sandbox_config_file.go +++ b/pkg/client/sandbox_config_file.go @@ -16,7 +16,7 @@ func EnsureSandboxCliConfigFile() (string, error) { return "", err } } - filePath := path.Join(dirPath, "sandbox-cli-config") + filePath := path.Join(dirPath, "ksctl-config") _, err = os.Stat(filePath) if os.IsNotExist(err) { emptyFile, err := os.Create(filePath) diff --git a/pkg/cmd/adm/generate_cli_configs.go b/pkg/cmd/adm/generate_cli_configs.go index 8827538..612153d 100644 --- a/pkg/cmd/adm/generate_cli_configs.go +++ b/pkg/cmd/adm/generate_cli_configs.go @@ -37,7 +37,7 @@ func NewGenerateCliConfigsCmd() *cobra.Command { command := &cobra.Command{ Use: "generate-cli-configs --sandbox-config=", Short: "Generate sandbox.yaml files", - Long: `Generate sandbox.yaml files, that is used by sandbox-cli, for every ServiceAccount defined in the given sandbox-config.yaml file`, + Long: `Generate sandbox.yaml files, that is used by ksctl, for every ServiceAccount defined in the given sandbox-config.yaml file`, Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, _ []string) error { term := ioutils.NewTerminal(cmd.InOrStdin, cmd.OutOrStdout) diff --git a/pkg/cmd/adm/register_member.go b/pkg/cmd/adm/register_member.go index b4b592d..2ec04b6 100644 --- a/pkg/cmd/adm/register_member.go +++ b/pkg/cmd/adm/register_member.go @@ -56,7 +56,7 @@ func NewRegisterMemberCmd() *cobra.Command { } func registerMemberCluster(ctx *clicontext.CommandContext, newCommand client.CommandCreator, hostKubeconfig, memberKubeconfig string) error { - ctx.AskForConfirmation(ioutils.WithMessagef("register member cluster from kubeconfig %s. Be aware that the sandbox-cli disables automatic approval to prevent new users being provisioned to the new member cluster. "+ + ctx.AskForConfirmation(ioutils.WithMessagef("register member cluster from kubeconfig %s. Be aware that the ksctl disables automatic approval to prevent new users being provisioned to the new member cluster. "+ "You will need to enable it again manually.", memberKubeconfig)) hostClusterConfig, err := configuration.LoadClusterConfig(ctx, configuration.HostName) diff --git a/pkg/cmd/adm/setup.go b/pkg/cmd/adm/setup.go index d36f931..adcac2b 100644 --- a/pkg/cmd/adm/setup.go +++ b/pkg/cmd/adm/setup.go @@ -23,8 +23,8 @@ func NewSetupCmd() *cobra.Command { f := setupFlags{} command := &cobra.Command{ Use: "setup --sandbox-config= --out-dir ", - Example: `sandbox-cli adm setup ./path/to/sandbox.openshiftapps.com/sandbox-config.yaml --out-dir ./components/auth/devsandbox-production -sandbox-cli adm setup ./path/to/sandbox-stage.openshiftapps.com/sandbox-config.yaml --out-dir ./components/auth/devsandbox-staging -s`, + Example: `ksctl adm setup ./path/to/sandbox.openshiftapps.com/sandbox-config.yaml --out-dir ./components/auth/devsandbox-production +ksctl adm setup ./path/to/sandbox-stage.openshiftapps.com/sandbox-config.yaml --out-dir ./components/auth/devsandbox-staging -s`, Short: "Generates user-management manifests", Long: `Reads the sandbox-config.yaml file and based on the content it generates user-management RBAC and manifests.`, Args: cobra.ExactArgs(0), diff --git a/pkg/cmd/base_kubectl.go b/pkg/cmd/base_kubectl.go index c8cde85..78189be 100644 --- a/pkg/cmd/base_kubectl.go +++ b/pkg/cmd/base_kubectl.go @@ -27,7 +27,7 @@ func setupKubectlCmd(newCmd newCmd) *cobra.Command { ErrOut: os.Stderr, } cmd := newCmd(factory, ioStreams) - cmd.Example = strings.ReplaceAll(cmd.Example, "kubectl ", "sandbox-cli ") + cmd.Example = strings.ReplaceAll(cmd.Example, "kubectl ", "ksctl ") // hide unused/redefined flags kubeConfigFlags.ClusterName = nil // `cluster` flag is redefined for our own purpose diff --git a/pkg/cmd/describe.go b/pkg/cmd/describe.go index 0c99f3e..41eed3f 100644 --- a/pkg/cmd/describe.go +++ b/pkg/cmd/describe.go @@ -9,6 +9,6 @@ import ( func NewDescribeCmd() *cobra.Command { return setupKubectlCmd(func(factory cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command { - return kubectldesc.NewCmdDescribe("sandbox-cli", factory, ioStreams) + return kubectldesc.NewCmdDescribe("ksctl", factory, ioStreams) }) } diff --git a/pkg/cmd/get.go b/pkg/cmd/get.go index f3c8069..00bccee 100644 --- a/pkg/cmd/get.go +++ b/pkg/cmd/get.go @@ -9,6 +9,6 @@ import ( func NewGetCmd() *cobra.Command { return setupKubectlCmd(func(factory cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command { - return kubectlget.NewCmdGet("sandbox-cli", factory, ioStreams) + return kubectlget.NewCmdGet("ksctl", factory, ioStreams) }) } diff --git a/pkg/cmd/root.go b/pkg/cmd/root.go index 22d37d4..63d2ab0 100644 --- a/pkg/cmd/root.go +++ b/pkg/cmd/root.go @@ -17,9 +17,9 @@ var rootCmd = NewRootCmd() func NewRootCmd() *cobra.Command { return &cobra.Command{ - Use: "sandbox-cli", - Short: "Dev Sandbox CLI", - Long: `Dev Sandbox CLI helps you to manage Toolchain resources in Dev Sandbox instances`, + Use: "ksctl", + Short: "KubeSaw command-line", + Long: `KubeSaw command-line tool that helps you to manage your KubeSaw service`, Version: version.NewMessage(), } }