caasapplicationprovisioner

Documentation

Index

• Variables
• type Client
  • func NewClient(caller base.APICaller, options ...Option) *Client
  • func (c *Client) ApplicationOCIResources(ctx context.Context, appName string) (map[string]resource.DockerImageDetails, error)
  • func (c *Client) ClearApplicationResources(ctx context.Context, appName string) error
  • func (c *Client) DestroyUnits(ctx context.Context, unitNames []string) error
  • func (c *Client) Life(ctx context.Context, entityName string) (life.Value, error)
  • func (c *Client) ProvisionerConfig(ctx context.Context) (params.CAASApplicationProvisionerConfig, error)
  • func (c *Client) ProvisioningInfo(ctx context.Context, applicationName string) (ProvisioningInfo, error)
  • func (c *Client) ProvisioningState(ctx context.Context, appName string) (*params.CAASApplicationProvisioningState, error)
  • func (c *Client) RemoveUnit(ctx context.Context, unitName string) error
  • func (c *Client) SetOperatorStatus(ctx context.Context, appName string, status status.Status, message string, ...) error
  • func (c *Client) SetPassword(ctx context.Context, appName string, password string) error
  • func (c *Client) SetProvisioningState(ctx context.Context, appName string, ...) error
  • func (c *Client) Units(ctx context.Context, appName string) ([]params.CAASUnit, error)
  • func (c *Client) UpdateUnits(ctx context.Context, arg params.UpdateApplicationUnits) (*params.UpdateApplicationUnitsInfo, error)
  • func (c *Client) WatchApplication(ctx context.Context, appName string) (watcher.NotifyWatcher, error)
  • func (c *Client) WatchApplications(ctx context.Context) (watcher.StringsWatcher, error)
  • func (c *Client) WatchProvisioningInfo(ctx context.Context, applicationName string) (watcher.NotifyWatcher, error)
  • func (c *Client) WatchUnits(ctx context.Context, application string) (watcher.StringsWatcher, error)
• type Option
• type ProvisioningInfo

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

Types

type Client

type Client struct {
	*charmscommon.CharmInfoClient
	*charmscommon.ApplicationCharmInfoClient
	// contains filtered or unexported fields
}

Client allows access to the CAAS application provisioner API endpoint.

func NewClient

func NewClient(caller base.APICaller, options ...Option) *Client

NewClient returns a client used to access the CAAS Application Provisioner API.

func (*Client) ApplicationOCIResources

func (c *Client) ApplicationOCIResources(ctx context.Context, appName string) (map[string]resource.DockerImageDetails, error)

ApplicationOCIResources returns all the OCI image resources for an application.

func (*Client) ClearApplicationResources

func (c *Client) ClearApplicationResources(ctx context.Context, appName string) error

ClearApplicationResources clears the flag which indicates an application still has resources in the cluster.

func (*Client) DestroyUnits

func (c *Client) DestroyUnits(ctx context.Context, unitNames []string) error

DestroyUnits is responsible for starting the process of destroying units associated with this application.

func (*Client) Life

func (c *Client) Life(ctx context.Context, entityName string) (life.Value, error)

Life returns the lifecycle state for the specified application or unit in the current model.

func (*Client) ProvisionerConfig

func (c *Client) ProvisionerConfig(ctx context.Context) (params.CAASApplicationProvisionerConfig, error)

ProvisionerConfig returns the provisioner's configuration.

func (*Client) ProvisioningInfo

func (c *Client) ProvisioningInfo(ctx context.Context, applicationName string) (ProvisioningInfo, error)

ProvisioningInfo returns the info needed to provision an operator for an application.

func (*Client) ProvisioningState

func (c *Client) ProvisioningState(ctx context.Context, appName string) (*params.CAASApplicationProvisioningState, error)

ProvisioningState returns the current provisioning state for the CAAS application. The result can be nil.

func (*Client) RemoveUnit

func (c *Client) RemoveUnit(ctx context.Context, unitName string) error

RemoveUnit removes the specified unit from the current model.

func (*Client) SetOperatorStatus

func (c *Client) SetOperatorStatus(ctx context.Context, appName string, status status.Status, message string, data map[string]interface{}) error

SetOperatorStatus updates the provisioning status of an operator.

func (*Client) SetPassword

func (c *Client) SetPassword(ctx context.Context, appName string, password string) error

SetPassword sets API password for the specified application.

func (*Client) SetProvisioningState

func (c *Client) SetProvisioningState(ctx context.Context, appName string, state params.CAASApplicationProvisioningState) error

SetProvisioningState sets the provisioning state for the CAAS application.

func (*Client) Units

func (c *Client) Units(ctx context.Context, appName string) ([]params.CAASUnit, error)

Units returns all the units for an Application.

func (*Client) UpdateUnits

func (c *Client) UpdateUnits(ctx context.Context, arg params.UpdateApplicationUnits) (*params.UpdateApplicationUnitsInfo, error)

UpdateUnits updates the state model to reflect the state of the units as reported by the cloud.

func (*Client) WatchApplication

func (c *Client) WatchApplication(ctx context.Context, appName string) (watcher.NotifyWatcher, error)

WatchApplication returns a NotifyWatcher that notifies of changes to the application in the current model.

func (*Client) WatchApplications

func (c *Client) WatchApplications(ctx context.Context) (watcher.StringsWatcher, error)

WatchApplications returns a StringsWatcher that notifies of changes to the lifecycles of CAAS applications in the current model.

func (*Client) WatchProvisioningInfo

func (c *Client) WatchProvisioningInfo(ctx context.Context, applicationName string) (watcher.NotifyWatcher, error)

func (*Client) WatchUnits

func (c *Client) WatchUnits(ctx context.Context, application string) (watcher.StringsWatcher, error)

WatchUnits returns a StringsWatcher that notifies of changes to the lifecycles of units of the specified application in the current model.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.

type ProvisioningInfo

type ProvisioningInfo struct {
	Version              version.Number
	APIAddresses         []string
	CACert               string
	Tags                 map[string]string
	Constraints          constraints.Value
	Filesystems          []storage.KubernetesFilesystemParams
	Devices              []devices.KubernetesDeviceParams
	Base                 corebase.Base
	ImageDetails         resource.DockerImageDetails
	CharmModifiedVersion int
	CharmURL             *charm.URL
	Trust                bool
	Scale                int
}

ProvisioningInfo holds the info needed to provision an operator.