Documentation
¶
Overview ¶
Package cmd provides the Constellation CLI.
It is responsible for the interaction with the user.
Logic should be kept to input/output parsing whenever possible. Any more complex code should usually be implemented in one of the other CLI packages.
The code here should be kept as cloud provider agnostic as possible. Any CSP specific tasks should be handled by the "cloudcmd" package.
All filepaths handled by the CLI code should originate from here. Common filepaths are defined as constants in the global "/internal/constants" package. To generate workspace correct filepaths for printing, use the functions from the "workspace" package.
Index ¶
- Variables
- func NewApplyCmd() *cobra.Command
- func NewConfigCmd() *cobra.Command
- func NewCreateCmd() *cobra.Command
- func NewIAMCmd() *cobra.Command
- func NewInitCmd() *cobra.Command
- func NewMaaPatchCmd() *cobra.Command
- func NewMiniCmd() *cobra.Command
- func NewRecoverCmd() *cobra.Command
- func NewStatusCmd() *cobra.Command
- func NewTerminateCmd() *cobra.Command
- func NewUpgradeCmd() *cobra.Command
- func NewVerifyCmd() *cobra.Command
- func NewVersionCmd() *cobra.Command
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidInput = errors.New("user made invalid input")
ErrInvalidInput is an error where user entered invalid input.
Functions ¶
func NewApplyCmd ¶ added in v2.13.0
NewApplyCmd creates the apply command.
func NewConfigCmd ¶
NewConfigCmd creates a new config parent command. Config needs another verb, and does nothing on its own.
func NewCreateCmd ¶
NewCreateCmd returns a new cobra.Command for the create command.
func NewIAMCmd ¶ added in v2.3.0
NewIAMCmd returns a new cobra.Command for the iam parent command. It needs another verb and does nothing on its own.
func NewInitCmd ¶
NewInitCmd returns a new cobra.Command for the init command.
func NewMaaPatchCmd ¶ added in v2.13.0
NewMaaPatchCmd returns a new cobra.Command for the maa-patch command.
func NewMiniCmd ¶
NewMiniCmd creates a new cobra.Command for managing MiniConstellation clusters.
func NewRecoverCmd ¶
NewRecoverCmd returns a new cobra.Command for the recover command.
func NewStatusCmd ¶ added in v2.7.0
NewStatusCmd returns a new cobra.Command for the statuus command.
func NewTerminateCmd ¶
NewTerminateCmd returns a new cobra.Command for the terminate command.
func NewUpgradeCmd ¶
NewUpgradeCmd returns a new cobra.Command for the upgrade command.
func NewVerifyCmd ¶
NewVerifyCmd returns a new cobra.Command for the verify command.
func NewVersionCmd ¶
NewVersionCmd returns a new cobra.Command for the verify command.
Types ¶
This section is empty.
Source Files
¶
- apply.go
- applyhelm.go
- applyinit.go
- applyterraform.go
- cloud.go
- cmd.go
- config.go
- configfetchmeasurements.go
- configgenerate.go
- configinstancetypes.go
- configkubernetesversions.go
- configmigrate.go
- create.go
- iam.go
- iamcreate.go
- iamcreateaws.go
- iamcreateazure.go
- iamcreategcp.go
- iamdestroy.go
- iamupgradeapply.go
- init.go
- license_oss.go
- log.go
- maapatch.go
- mini.go
- minidown.go
- miniup.go
- miniup_linux_amd64.go
- recover.go
- spinner.go
- status.go
- terminate.go
- upgrade.go
- upgradeapply.go
- upgradecheck.go
- userinteraction.go
- validargs.go
- verify.go
- version.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Package pathprefix is used to print correct filepaths for a configured workspace.
|
Package pathprefix is used to print correct filepaths for a configured workspace. |