d13d15f453
The description and examples are updated for the airshipctl commands, which will be inturn used for generating documentation. Please ignore the .md file changes in this PS. They are added for zuul gates to pass. Here is the PS with generated documention files https://review.opendev.org/c/airship/airshipctl/+/789250 Relates-To: #280 Change-Id: I7c088528842ff859f502d4484ff9a3847ebb1177
61 lines
1.7 KiB
Go
Executable File
61 lines
1.7 KiB
Go
Executable File
/*
|
|
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 cluster
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"opendev.org/airship/airshipctl/pkg/config"
|
|
"opendev.org/airship/airshipctl/pkg/phase"
|
|
)
|
|
|
|
const (
|
|
listLong = `
|
|
Retrieve and list the defined clusters in the table form or display just the name as specified.
|
|
`
|
|
|
|
listExample = `
|
|
Retrieve list of clusters
|
|
# airshipctl cluster list --airshipconf /tmp/airconfig
|
|
# airshipctl cluster list -o table
|
|
# airshipctl cluster list -o name
|
|
`
|
|
)
|
|
|
|
// NewListCommand creates a command which retrieves list of clusters
|
|
func NewListCommand(cfgFactory config.Factory) *cobra.Command {
|
|
o := &phase.ClusterListCommand{Factory: cfgFactory}
|
|
cmd := &cobra.Command{
|
|
Use: "list",
|
|
Short: "Airshipctl command to get and list defined clusters",
|
|
Long: listLong,
|
|
Example: listExample,
|
|
RunE: listRunE(o),
|
|
}
|
|
flags := cmd.Flags()
|
|
flags.StringVarP(&o.Format, "output", "o", "name", "output formats. Supported options are 'table' and 'name'")
|
|
|
|
return cmd
|
|
}
|
|
|
|
// listRunE returns a function to cobra command to be executed in runtime
|
|
func listRunE(o *phase.ClusterListCommand) func(
|
|
cmd *cobra.Command, args []string) error {
|
|
return func(cmd *cobra.Command, args []string) error {
|
|
o.Writer = cmd.OutOrStdout()
|
|
return o.RunE()
|
|
}
|
|
}
|