airshipctl/cmd/baremetal/baremetal.go
Kostiantyn Kalynovskyi 7dfb0eb98c Don't allow to run baremetal actions without flags
With this change we will be sure that no commands against bmh
hosts will be applied without selector flags specified, now if you
want to target all hosts in inventory you must specify --all flag

Relates-To: #364
Related-To: #364

Closes: #364
Change-Id: I0d615ea226528162e07acc96fa61b26e031145aa
2021-02-24 20:01:15 +00:00

98 lines
3.5 KiB
Go

/*
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 baremetal
import (
"fmt"
"time"
"github.com/spf13/cobra"
"opendev.org/airship/airshipctl/pkg/config"
"opendev.org/airship/airshipctl/pkg/inventory"
)
// Action type is used to perform specific baremetal action
type Action int
const (
flagLabel = "labels"
flagLabelShort = "l"
flagLabelDescription = "Label(s) to filter desired baremetal host documents"
flagName = "name"
flagNameDescription = "Name to filter desired baremetal host document"
flagNamespace = "namespace"
flagNamespaceSort = "n"
flagNamespaceDescription = "airshipctl phase that contains the desired baremetal host document(s)"
flagTimeout = "timeout"
flagTimeoutDescription = "timeout on baremetal action"
flagAll = "all"
flagAllDescription = "specify this to target all hosts in the inventory"
)
var (
selectorsDescription = fmt.Sprintf(`The command will target baremetal hosts from airship inventory kustomize root
based on the --%s, --%s and --%s flags provided. If no flags are
provided airshipctl will try to select all baremetal hosts in the inventory`, flagName, flagNamespace, flagLabel)
bmhActionExampleTempalte = `
Perform action against hosts with name rdm9r3s3 in all namespaces where the host is found
# airshipctl baremetal %[1]s --name rdm9r3s3
Perform action against hosts with name rdm9r3s3 in namespace metal3
# airshipctl baremetal %[1]s --name rdm9r3s3 --namespace metal3
Perform action against all hosts defined in inventory
# airshipctl baremetal %[1]s --all
Perform action against hosts with a label 'foo=bar'
# airshipctl baremetal %[1]s --labels "foo=bar"
`
)
// NewBaremetalCommand creates a new command for interacting with baremetal using airshipctl.
func NewBaremetalCommand(cfgFactory config.Factory) *cobra.Command {
options := inventory.NewOptions(inventory.NewInventory(cfgFactory))
baremetalRootCmd := &cobra.Command{
Use: "baremetal",
Short: "Perform actions on baremetal hosts",
}
baremetalRootCmd.AddCommand(NewEjectMediaCommand(cfgFactory, options))
baremetalRootCmd.AddCommand(NewPowerOffCommand(cfgFactory, options))
baremetalRootCmd.AddCommand(NewPowerOnCommand(cfgFactory, options))
baremetalRootCmd.AddCommand(NewPowerStatusCommand(cfgFactory, options))
baremetalRootCmd.AddCommand(NewRebootCommand(cfgFactory, options))
baremetalRootCmd.AddCommand(NewRemoteDirectCommand(cfgFactory, options))
return baremetalRootCmd
}
func initFlags(options *inventory.CommandOptions, cmd *cobra.Command) {
flags := cmd.Flags()
flags.StringVarP(&options.Labels, flagLabel, flagLabelShort, "", flagLabelDescription)
flags.StringVar(&options.Name, flagName, "", flagNameDescription)
flags.StringVarP(&options.Namespace, flagNamespace, flagNamespaceSort, "", flagNamespaceDescription)
flags.DurationVar(&options.Timeout, flagTimeout, 10*time.Minute, flagTimeoutDescription)
}
func initAllFlag(options *inventory.CommandOptions, cmd *cobra.Command) {
cmd.Flags().BoolVar(&options.All, flagAll, false, flagAllDescription)
}