kotsadm

Documentation

Index

• func CreateRestoreJob(options *types.RestoreJobOptions) error
• func Delete(options *types.DeleteOptions) error
• func Deploy(deployOptions types.DeployOptions) error
• func GetKotsadmOptionsFromCluster(namespace string, clientset *kubernetes.Clientset) (types.KotsadmOptions, error)
• func PushImages(airgapArchive string, options types.PushImagesOptions) error
• func TagAndPushAppImages(imagesDir string, options types.PushImagesOptions) ([]kustomizetypes.Image, error)
• func Upgrade(upgradeOptions types.UpgradeOptions) error
• func YAML(deployOptions types.DeployOptions) (map[string][]byte, error)
• type ProgressImage
• type ProgressReport

Functions

func CreateRestoreJob

func CreateRestoreJob(options *types.RestoreJobOptions) error

func Delete

func Delete(options *types.DeleteOptions) error

func Deploy

func Deploy(deployOptions types.DeployOptions) error

func GetKotsadmOptionsFromCluster

func GetKotsadmOptionsFromCluster(namespace string, clientset *kubernetes.Clientset) (types.KotsadmOptions, error)

func PushImages

func PushImages(airgapArchive string, options types.PushImagesOptions) error

func TagAndPushAppImages

func TagAndPushAppImages(imagesDir string, options types.PushImagesOptions) ([]kustomizetypes.Image, error)

func Upgrade

func Upgrade(upgradeOptions types.UpgradeOptions) error

func YAML

func YAML(deployOptions types.DeployOptions) (map[string][]byte, error)

YAML will return a map containing the YAML needed to run the admin console

Types

type ProgressImage

type ProgressImage struct {
	// image name and tag, "nginx:latest"
	DisplayName string `json:"displayName"`
	// image upload status: queued, uploading, uploaded, failed
	Status string `json:"status"`
	// error string set when status is failed
	Error string `json:"error"`
	// amount currently uploaded (currently number of layers)
	Current int64 `json:"current"`
	// total amount that needs to be uploaded (currently number of layers)
	Total int64 `json:"total"`
	// time when image started uploading
	StartTime time.Time `json:"startTime"`
	// time when image finished uploading
	EndTime time.Time `json:"endTime"`
}

type ProgressReport

type ProgressReport struct {
	// set to "progressReport"
	Type string `json:"type"`
	// the same progress text that used to be sent in unstructured message
	CompatibilityMessage string `json:"compatibilityMessage"`
	// all images found in archive
	Images []ProgressImage `json:"images"`
}