airshipctl/cmd/cluster/initinfra.go
Alexander Hughes 26fdd05b0f [#38] Add end-user documentation to project
1. Add end-user documentation of CLI commands
2. Minor refactor of several help messages
3. Update of golden test data to reflect help message changes

Change-Id: I58b8ac3a7871efdb569887ab65191bfb1842c24e
Signed-off-by: Alexander Hughes <Alexander.Hughes@pm.me>
2020-03-10 16:45:19 +00:00

72 lines
2.1 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 cluster
import (
"github.com/spf13/cobra"
"opendev.org/airship/airshipctl/pkg/cluster/initinfra"
"opendev.org/airship/airshipctl/pkg/environment"
)
const (
// TODO add labels in description, when we have them designed
getInitInfraLong = `Deploy initial infrastructure to kubernetes cluster such as ` +
`metal3.io, argo, tiller and other manifest documents with appropriate labels`
getInitInfraExample = `#deploy infra to cluster
airshipctl cluster initinfra`
)
// NewCmdInitInfra creates a command to deploy initial airship infrastructure
func NewCmdInitInfra(rootSettings *environment.AirshipCTLSettings) *cobra.Command {
i := initinfra.NewInfra(rootSettings)
initinfraCmd := &cobra.Command{
Use: "initinfra",
Short: "deploy initinfra components to cluster",
Long: getInitInfraLong,
Example: getInitInfraExample,
RunE: func(cmd *cobra.Command, args []string) error {
return i.Run()
},
}
addInitinfraFlags(i, initinfraCmd)
return initinfraCmd
}
func addInitinfraFlags(i *initinfra.Infra, cmd *cobra.Command) {
flags := cmd.Flags()
flags.BoolVar(
&i.DryRun,
"dry-run",
false,
"Don't deliver documents to the cluster, simulate the changes instead")
flags.BoolVar(
&i.Prune,
"prune",
false,
`If set to true, command will delete all kubernetes resources that are not`+
` defined in airship documents and have airshipit.org/deployed=initinfra label`)
flags.StringVar(
&i.ClusterType,
"cluster-type",
"ephemeral",
`Select cluster type to deploy initial infastructure to;`+
` currently only ephemeral is supported`)
}