4c3140be93
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: I3587ad211f7d614b5cc6a162ca352ac54c3b90f0
46 lines
1.4 KiB
Go
46 lines
1.4 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 phase
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"opendev.org/airship/airshipctl/pkg/config"
|
|
)
|
|
|
|
const (
|
|
phaseLong = `
|
|
Provides capabilities for interacting with phases, such as getting list of phases or applying a specific one.
|
|
`
|
|
)
|
|
|
|
// NewPhaseCommand creates a command for interacting with phases
|
|
func NewPhaseCommand(cfgFactory config.Factory) *cobra.Command {
|
|
phaseRootCmd := &cobra.Command{
|
|
Use: "phase",
|
|
Short: "Airshipctl command to manage phases",
|
|
Long: phaseLong[1:],
|
|
}
|
|
|
|
phaseRootCmd.AddCommand(NewRenderCommand(cfgFactory))
|
|
phaseRootCmd.AddCommand(NewListCommand(cfgFactory))
|
|
phaseRootCmd.AddCommand(NewRunCommand(cfgFactory))
|
|
phaseRootCmd.AddCommand(NewTreeCommand(cfgFactory))
|
|
phaseRootCmd.AddCommand(NewValidateCommand(cfgFactory))
|
|
phaseRootCmd.AddCommand(NewStatusCommand(cfgFactory))
|
|
|
|
return phaseRootCmd
|
|
}
|