14ef1f8680
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: I5d46bd361088cc1e4aff79a3009cd43a73ca1252
61 lines
1.7 KiB
Go
61 lines
1.7 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 plan
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"opendev.org/airship/airshipctl/pkg/config"
|
|
"opendev.org/airship/airshipctl/pkg/phase"
|
|
)
|
|
|
|
const (
|
|
runLong = `
|
|
Run a plan defined in the site manifest. Specify the plan using the mandatory parameter PLAN_NAME.
|
|
To get list of plans associated for a site, run 'airshipctl plan list'.
|
|
`
|
|
runExample = `
|
|
Run plan named iso
|
|
# airshipctl plan run iso
|
|
|
|
Perform a dry run of a plan
|
|
# airshipctl plan run iso --dry-run
|
|
`
|
|
)
|
|
|
|
// NewRunCommand creates a command which execute a particular phase plan
|
|
func NewRunCommand(cfgFactory config.Factory) *cobra.Command {
|
|
r := &phase.PlanRunCommand{
|
|
Factory: cfgFactory,
|
|
Options: phase.PlanRunFlags{},
|
|
}
|
|
runCmd := &cobra.Command{
|
|
Use: "run PLAN_NAME",
|
|
Short: "Airshipctl command to run plan",
|
|
Long: runLong[1:],
|
|
Example: runExample,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
r.Options.PlanID.Name = args[0]
|
|
return r.RunE()
|
|
},
|
|
}
|
|
|
|
flags := runCmd.Flags()
|
|
flags.BoolVar(&r.Options.DryRun, "dry-run", false, "simulate phase execution")
|
|
flags.DurationVar(&r.Options.Timeout, "wait-timeout", 0, "wait timeout")
|
|
return runCmd
|
|
}
|