cli

Documentation

Index

• Variables
• func AdminConsoleCmd() *cobra.Command
• func AdminConsoleUpgradeCmd() *cobra.Command
• func AdminCopyPublicImagesCmd() *cobra.Command
• func AdminGenerateManifestsCmd() *cobra.Command
• func AdminPushImagesCmd() *cobra.Command
• func AppStatusCmd() *cobra.Command
• func BackupCmd() *cobra.Command
• func BackupListCmd() *cobra.Command
• func CheckRBAC() error
• func CompareVersions(cliVersion string, apiVersion string, log *logger.CLILogger) error
• func CompletionCmd() *cobra.Command
• func DockerCmd() *cobra.Command
• func DockerEnsureSecretCmd() *cobra.Command
• func DockerRegistryCmd() *cobra.Command
• func DockerRegistryServeCmd() *cobra.Command
• func DownloadCmd() *cobra.Command
• func EnableHACmd() *cobra.Command
• func ExpandDir(input string) string
• func GarbageCollectImagesCmd() *cobra.Command
• func GetAppsCmd() *cobra.Command
• func GetBackupsCmd() *cobra.Command
• func GetCmd() *cobra.Command
• func GetConfigCmd() *cobra.Command
• func GetRestoresCmd() *cobra.Command
• func GetVersionsCmd() *cobra.Command
• func IdentityServiceCmd() *cobra.Command
• func IdentityServiceConfigureCmd() *cobra.Command
• func IdentityServiceEnableSharedPasswordCmd() *cobra.Command
• func IdentityServiceInstallCmd() *cobra.Command
• func IdentityServiceOIDCCallbackURLCmd() *cobra.Command
• func IdentityServiceUninstallCmd() *cobra.Command
• func IngressCmd() *cobra.Command
• func IngressInstallCmd() *cobra.Command
• func IngressUninstallCmd() *cobra.Command
• func InitAndExecute()
• func InstallCmd() *cobra.Command
• func PullCmd() *cobra.Command
• func RemoveCmd() *cobra.Command
• func ResetPasswordCmd() *cobra.Command
• func ResetTLSCmd() *cobra.Command
• func RestoreCmd() *cobra.Command
• func RestoreListCmd() *cobra.Command
• func RootCmd() *cobra.Command
• func SetCmd() *cobra.Command
• func SetConfigCmd() *cobra.Command
• func UploadCmd() *cobra.Command
• func UpstreamCmd() *cobra.Command
• func UpstreamDownloadCmd() *cobra.Command
• func UpstreamUpgradeCmd() *cobra.Command
• func ValidateAutomatedInstall(deployOptions kotsadmtypes.DeployOptions, authSlug string, apiEndpoint string) (storetypes.DownstreamVersionStatus, error)
• func ValidatePreflightStatus(deployOptions kotsadmtypes.DeployOptions, authSlug string, apiEndpoint string) error
• func VeleroCmd() *cobra.Command
• func VeleroConfigureAmazonS3AccessKeyCmd() *cobra.Command
• func VeleroConfigureAmazonS3Cmd() *cobra.Command
• func VeleroConfigureAmazonS3InstanceRoleCmd() *cobra.Command
• func VeleroConfigureAzureCmd() *cobra.Command
• func VeleroConfigureAzureServicePrincipleCmd() *cobra.Command
• func VeleroConfigureGCPCmd() *cobra.Command
• func VeleroConfigureGCPServiceAccount() *cobra.Command
• func VeleroConfigureGCPWorkloadIdentity() *cobra.Command
• func VeleroConfigureHostPathCmd() *cobra.Command
• func VeleroConfigureInternalCmd() *cobra.Command
• func VeleroConfigureNFSCmd() *cobra.Command
• func VeleroConfigureOtherS3Cmd() *cobra.Command
• func VeleroEnsurePermissionsCmd() *cobra.Command
• func VeleroMigrateMinioFileSystemCmd() *cobra.Command
• func VeleroPrintFileSystemInstructionsCmd() *cobra.Command
• func VersionCmd() *cobra.Command
• type DownloadOutput
• type RestoreOutput
• type UploadOutput
• type VeleroConfigureFileSystemOptions
• type VersionOutput

Variables

var (
	RBACError = errors.New("attempting to grant RBAC permissions not currently held")
)

Functions

func AdminConsoleCmd

func AdminConsoleCmd() *cobra.Command

func AdminConsoleUpgradeCmd

func AdminConsoleUpgradeCmd() *cobra.Command

func AdminCopyPublicImagesCmd

func AdminCopyPublicImagesCmd() *cobra.Command

func AdminGenerateManifestsCmd

func AdminGenerateManifestsCmd() *cobra.Command

func AdminPushImagesCmd

func AdminPushImagesCmd() *cobra.Command

func AppStatusCmd

func AppStatusCmd() *cobra.Command

func BackupCmd

func BackupCmd() *cobra.Command

func BackupListCmd

func BackupListCmd() *cobra.Command

func CheckRBAC

func CheckRBAC() error

func CompareVersions

func CompareVersions(cliVersion string, apiVersion string, log *logger.CLILogger) error

func CompletionCmd

func CompletionCmd() *cobra.Command

func DockerCmd

func DockerCmd() *cobra.Command

func DockerEnsureSecretCmd

func DockerEnsureSecretCmd() *cobra.Command

func DockerRegistryCmd

func DockerRegistryCmd() *cobra.Command

func DockerRegistryServeCmd

func DockerRegistryServeCmd() *cobra.Command

func DownloadCmd

func DownloadCmd() *cobra.Command

func EnableHACmd

func EnableHACmd() *cobra.Command

func ExpandDir

func ExpandDir(input string) string

func GarbageCollectImagesCmd

func GarbageCollectImagesCmd() *cobra.Command

func GetAppsCmd

func GetAppsCmd() *cobra.Command

func GetBackupsCmd

func GetBackupsCmd() *cobra.Command

func GetCmd

func GetCmd() *cobra.Command

func GetConfigCmd

func GetConfigCmd() *cobra.Command

func GetRestoresCmd

func GetRestoresCmd() *cobra.Command

func GetVersionsCmd

func GetVersionsCmd() *cobra.Command

func IdentityServiceCmd

func IdentityServiceCmd() *cobra.Command

func IdentityServiceConfigureCmd

func IdentityServiceConfigureCmd() *cobra.Command

func IdentityServiceEnableSharedPasswordCmd

func IdentityServiceEnableSharedPasswordCmd() *cobra.Command

func IdentityServiceInstallCmd

func IdentityServiceInstallCmd() *cobra.Command

func IdentityServiceOIDCCallbackURLCmd

func IdentityServiceOIDCCallbackURLCmd() *cobra.Command

func IdentityServiceUninstallCmd

func IdentityServiceUninstallCmd() *cobra.Command

func IngressCmd

func IngressCmd() *cobra.Command

func IngressInstallCmd

func IngressInstallCmd() *cobra.Command

func IngressUninstallCmd

func IngressUninstallCmd() *cobra.Command

func InitAndExecute

func InitAndExecute()

func InstallCmd

func InstallCmd() *cobra.Command

func PullCmd

func PullCmd() *cobra.Command

func RemoveCmd

func RemoveCmd() *cobra.Command

func ResetPasswordCmd

func ResetPasswordCmd() *cobra.Command

func ResetTLSCmd

func ResetTLSCmd() *cobra.Command

func RestoreCmd

func RestoreCmd() *cobra.Command

func RestoreListCmd

func RestoreListCmd() *cobra.Command

func RootCmd

func RootCmd() *cobra.Command

func SetCmd

func SetCmd() *cobra.Command

func SetConfigCmd

func SetConfigCmd() *cobra.Command

func UploadCmd

func UploadCmd() *cobra.Command

func UpstreamCmd

func UpstreamCmd() *cobra.Command

func UpstreamDownloadCmd

func UpstreamDownloadCmd() *cobra.Command

func UpstreamUpgradeCmd

func UpstreamUpgradeCmd() *cobra.Command

func ValidateAutomatedInstall

func ValidateAutomatedInstall(deployOptions kotsadmtypes.DeployOptions, authSlug string, apiEndpoint string) (storetypes.DownstreamVersionStatus, error)

func ValidatePreflightStatus

func ValidatePreflightStatus(deployOptions kotsadmtypes.DeployOptions, authSlug string, apiEndpoint string) error

func VeleroCmd

func VeleroCmd() *cobra.Command

func VeleroConfigureAmazonS3AccessKeyCmd

func VeleroConfigureAmazonS3AccessKeyCmd() *cobra.Command

func VeleroConfigureAmazonS3Cmd

func VeleroConfigureAmazonS3Cmd() *cobra.Command

func VeleroConfigureAmazonS3InstanceRoleCmd

func VeleroConfigureAmazonS3InstanceRoleCmd() *cobra.Command

func VeleroConfigureAzureCmd

func VeleroConfigureAzureCmd() *cobra.Command

func VeleroConfigureAzureServicePrincipleCmd

func VeleroConfigureAzureServicePrincipleCmd() *cobra.Command

func VeleroConfigureGCPCmd

func VeleroConfigureGCPCmd() *cobra.Command

func VeleroConfigureGCPServiceAccount

func VeleroConfigureGCPServiceAccount() *cobra.Command

func VeleroConfigureGCPWorkloadIdentity

func VeleroConfigureGCPWorkloadIdentity() *cobra.Command

func VeleroConfigureHostPathCmd

func VeleroConfigureHostPathCmd() *cobra.Command

func VeleroConfigureInternalCmd

func VeleroConfigureInternalCmd() *cobra.Command

func VeleroConfigureNFSCmd

func VeleroConfigureNFSCmd() *cobra.Command

func VeleroConfigureOtherS3Cmd

func VeleroConfigureOtherS3Cmd() *cobra.Command

func VeleroEnsurePermissionsCmd

func VeleroEnsurePermissionsCmd() *cobra.Command

func VeleroMigrateMinioFileSystemCmd

func VeleroMigrateMinioFileSystemCmd() *cobra.Command

VeleroMigrateMinioFileSystemCmd is an internal command used by kURL to migrate minio filesystem snapshots to using the LVP plugin. kURL does not run the upgrade command directly

func VeleroPrintFileSystemInstructionsCmd

func VeleroPrintFileSystemInstructionsCmd() *cobra.Command

(DEPRECATED) VeleroPrintFileSystemInstrunctions prints instructions for setting up a file system (e.g. NFS, Host Path) as the snapshots storage destination

func VersionCmd

func VersionCmd() *cobra.Command

Types

type DownloadOutput

type DownloadOutput struct {
	Success          bool   `json:"success"`
	DownloadLocation string `json:"downloadLocation,omitempty"`
	UploadCommand    string `json:"uploadCommand,omitempty"`
	Error            string `json:"error,omitempty"`
}

type RestoreOutput

type RestoreOutput struct {
	Success bool   `json:"success"`
	Error   string `json:"error,omitempty"`
}

type UploadOutput

type UploadOutput struct {
	Success bool   `json:"success"`
	AppSlug string `json:"appSlug,omitempty"`
	Error   string `json:"error,omitempty"`
}

type VeleroConfigureFileSystemOptions

type VeleroConfigureFileSystemOptions struct {
	Namespace          string
	RegistryConfig     *kotsadmtypes.RegistryConfig
	FileSystemConfig   snapshottypes.FileSystemConfig
	ForceReset         bool
	SkipValidation     bool
	IsMinioDisabled    bool
	IsLegacyDeployment bool
}

type VersionOutput

type VersionOutput struct {
	Version       string `json:"version"`
	LatestVersion string `json:"latestVersion,omitempty"`
	InstallLatest string `json:"installLatest,omitempty"`
}