9ffc305392
This commit cleans up the command constructors in an attempt to make the codebase more uniform and approachable. This includes several refactors: * Removed the FlagConstants - this makes the help messages and examples significantly more readable without needed to compile and run airshipctl * Long help messages and examples are now constant * Short, Long, and Examples all begin with a capitol letter * Flag descriptions begin with a lowercase letter. This matches the flag description for the builtin "help" flag, making formatting uniform for all flags * Removed redundant unit tests on non-leaf commands This change also updates the documentation for the affected commands. Change-Id: I8b9dcbfd9846b3deaab06dec17f80643dae78de9
53 lines
1.6 KiB
Go
53 lines
1.6 KiB
Go
/*
|
|
Copyright 2014 The Kubernetes Authors.
|
|
|
|
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 (
|
|
"github.com/spf13/cobra"
|
|
|
|
"opendev.org/airship/airshipctl/pkg/environment"
|
|
)
|
|
|
|
const (
|
|
initLong = `
|
|
Generate an airshipctl config file and its associated kubeConfig file.
|
|
These files will be written to the $HOME/.airship directory, and will contain
|
|
default configurations.
|
|
|
|
NOTE: This will overwrite any existing config files in $HOME/.airship
|
|
`
|
|
)
|
|
|
|
// NewInitCommand creates a command for generating default airshipctl config files.
|
|
func NewInitCommand(rootSettings *environment.AirshipCTLSettings) *cobra.Command {
|
|
// TODO(howell): It'd be nice to have a flag to tell
|
|
// airshipctl where to store the new files.
|
|
// TODO(howell): Currently, this command overwrites whatever the user
|
|
// has in their airship directory. We should remove that functionality
|
|
// as default and provide and optional --overwrite flag.
|
|
cmd := &cobra.Command{
|
|
Use: "init",
|
|
Short: "Generate initial configuration files for airshipctl",
|
|
Long: initLong[1:],
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
return rootSettings.Config.PersistConfig()
|
|
},
|
|
}
|
|
|
|
return cmd
|
|
}
|