k8sclient

Documentation

Index

• type Apps
• type Client
  • func NewClient(logger chassis.Logger) Client
• type System

Types

type Apps

type Apps interface {
	// Install will install the given app
	Install(ctx context.Context, spec opv1.AppSpec) error
	// Delete will delete the given app
	Delete(ctx context.Context, spec opv1.AppSpec) error
	// Update will update the given app
	//
	// NOTE: An empty value on the spec will be applied as empty and will NOT
	// default to the existing value.
	Update(ctx context.Context, spec opv1.AppSpec) error
	// Installed returns whether or not the app with the given name is currently installed
	Installed(ctx context.Context, name string) (installed bool, err error)
	// Healthcheck will retrieve the health of all installed apps
	Healthcheck(ctx context.Context) ([]*webv1.AppHealth, error)
	// InstalledApps will retrive all installed apps
	InstalledApps(ctx context.Context) ([]opv1.App, error)
	// AppStorage will retrive storage volumes for the given app list
	AppStorage(ctx context.Context, apps []opv1.App) ([]*webv1.AppStorage, error)
}

type Client

type Client interface {
	Apps
	System
}

func NewClient

func NewClient(logger chassis.Logger) Client

type System

type System interface {
	// CurrentImages will retrieve the current images of all system containers. System
	// containers are considered to be those in the `home-cloud-system` and `draft-system`
	// namespaces.
	CurrentImages(ctx context.Context) ([]*webv1.ImageVersion, error)
}