charms

Documentation

Index

• type API
  • func NewCharmsAPI(authorizer facade.Authorizer, st charmsinterfaces.BackendState, ...) (*API, error)
  • func NewFacadeV4(ctx facade.Context) (*API, error)
  • func (a *API) AddCharm(args params.AddCharmWithOrigin) (params.CharmOriginResult, error)
  • func (a *API) AddCharmWithAuthorization(args params.AddCharmWithAuth) (params.CharmOriginResult, error)
  • func (a *API) CharmInfo(args params.CharmURL) (params.Charm, error)
  • func (a *API) CheckCharmPlacement(args params.ApplicationCharmPlacements) (params.ErrorResults, error)
  • func (a *API) GetDownloadInfos(args params.CharmURLAndOrigins) (params.DownloadInfoResults, error)
  • func (a *API) IsMetered(args params.CharmURL) (params.IsMeteredResult, error)
  • func (a *API) List(args params.CharmsList) (params.CharmsListResult, error)
  • func (a *API) ListCharmResources(args params.CharmURLAndOrigins) (params.CharmResourcesResults, error)
  • func (a *API) ResolveCharms(args params.ResolveCharmsWithChannel) (params.ResolveCharmWithChannelResults, error)
• type APIv2
  • func NewFacadeV2(ctx facade.Context) (*APIv2, error)
  • func (a *APIv2) AddCharm(_ struct{})
  • func (a *APIv2) AddCharmWithAuthorization(_ struct{})
  • func (a *APIv2) GetDownloadInfos(_ struct{})
  • func (a *APIv2) ListCharmResources(_ struct{})
  • func (a *APIv2) ResolveCharms(_ struct{})
• type APIv3
  • func NewFacadeV3(ctx facade.Context) (*APIv3, error)
  • func (a *APIv3) CheckCharmPlacement(_, _ struct{})
• type CSRepository
• type CSResolverGetterFunc
• type CharmArchive
• type CharmHubClient
• type Metadata
• type Method
• type Release
• type ResolverGetterParams
• type StoreCharm
• type Strategy
• type StrategyFunc

Types

type API

type API struct {
	*charmscommon.CharmsAPI
	// contains filtered or unexported fields
}

API implements the charms interface and is the concrete implementation of the API end point.

func NewCharmsAPI

func NewCharmsAPI(
	authorizer facade.Authorizer,
	st charmsinterfaces.BackendState,
	m charmsinterfaces.BackendModel,
	csResolverFunc CSResolverGetterFunc,
	getStrategyFunc func(source string) StrategyFunc,
	newStorage func(modelUUID string, session *mgo.Session) storage.Storage,
) (*API, error)

func NewFacadeV4

func NewFacadeV4(ctx facade.Context) (*API, error)

NewFacadeV4 provides the signature required for facade V4 registration.

func (*API) AddCharm

func (a *API) AddCharm(args params.AddCharmWithOrigin) (params.CharmOriginResult, error)

AddCharm adds the given charm URL (which must include revision) to the environment, if it does not exist yet. Local charms are not supported, only charm store and charm hub URLs. See also AddLocalCharm().

func (*API) AddCharmWithAuthorization

func (a *API) AddCharmWithAuthorization(args params.AddCharmWithAuth) (params.CharmOriginResult, error)

AddCharmWithAuthorization adds the given charm URL (which must include revision) to the environment, if it does not exist yet. Local charms are not supported, only charm store and charm hub URLs. See also AddLocalCharm().

The authorization macaroon, args.CharmStoreMacaroon, may be omitted, in which case this call is equivalent to AddCharm.

func (*API) CharmInfo

func (a *API) CharmInfo(args params.CharmURL) (params.Charm, error)

CharmInfo returns information about the requested charm. NOTE: thumper 2016-06-29, this is not a bulk call and probably should be.

func (*API) CheckCharmPlacement

func (a *API) CheckCharmPlacement(args params.ApplicationCharmPlacements) (params.ErrorResults, error)

CheckCharmPlacement checks if a charm is allowed to be placed with in a given application.

func (*API) GetDownloadInfos

func (a *API) GetDownloadInfos(args params.CharmURLAndOrigins) (params.DownloadInfoResults, error)

GetDownloadInfos attempts to get the bundle corresponding to the charm url and origin.

func (*API) IsMetered

func (a *API) IsMetered(args params.CharmURL) (params.IsMeteredResult, error)

IsMetered returns whether or not the charm is metered.

func (*API) List

func (a *API) List(args params.CharmsList) (params.CharmsListResult, error)

List returns a list of charm URLs currently in the state. If supplied parameter contains any names, the result will be filtered to return only the charms with supplied names.

func (*API) ListCharmResources

func (a *API) ListCharmResources(args params.CharmURLAndOrigins) (params.CharmResourcesResults, error)

ListCharmResources returns a series of resources for a given charm.

func (*API) ResolveCharms

func (a *API) ResolveCharms(args params.ResolveCharmsWithChannel) (params.ResolveCharmWithChannelResults, error)

ResolveCharms resolves the given charm URLs with an optionally specified preferred channel. Channel provided via CharmOrigin.

type APIv2

type APIv2 struct {
	*APIv3
}

func NewFacadeV2

func NewFacadeV2(ctx facade.Context) (*APIv2, error)

NewFacadeV2 provides the signature required for facade V2 registration. It is unknown where V1 is.

func (*APIv2) AddCharm

func (a *APIv2) AddCharm(_ struct{})

AddCharm is not available via the V2 API.

func (*APIv2) AddCharmWithAuthorization

func (a *APIv2) AddCharmWithAuthorization(_ struct{})

AddCharmWithAuthorization is not available via the V2 API.

func (*APIv2) GetDownloadInfos

func (a *APIv2) GetDownloadInfos(_ struct{})

GetDownloadInfos is not available via the V2 API.

func (*APIv2) ListCharmResources

func (a *APIv2) ListCharmResources(_ struct{})

ListCharmResources is not available via the V2 API.

func (*APIv2) ResolveCharms

func (a *APIv2) ResolveCharms(_ struct{})

ResolveCharms is not available via the V2 API.

type APIv3

type APIv3 struct {
	*API
}

func NewFacadeV3

func NewFacadeV3(ctx facade.Context) (*APIv3, error)

NewFacadeV3 provides the signature required for facade V3 registration.

func (*APIv3) CheckCharmPlacement

func (a *APIv3) CheckCharmPlacement(_, _ struct{})

CheckCharmPlacement isn't on the v13 API.

type CSRepository

type CSRepository interface {
	Get(curl *charm.URL, archivePath string) (*charm.CharmArchive, error)
	ResolveWithPreferredChannel(*charm.URL, csparams.Channel) (*charm.URL, csparams.Channel, []string, error)
}

CSRepository is the part of charmrepo.Charmstore that we need to resolve a charm url, install or upgrade a charm store charm.

type CSResolverGetterFunc

type CSResolverGetterFunc func(args ResolverGetterParams) (CSRepository, error)

type CharmArchive

type CharmArchive struct {
	// ID is the charm URL for which we're storing the archive.
	ID *charm.URL

	// Charm is the metadata about the charm for the archive.
	Charm charm.Charm

	// Data contains the bytes of the archive.
	Data io.Reader

	// Size is the number of bytes in Data.
	Size int64

	// SHA256 is the hash of the bytes in Data.
	SHA256 string

	// Macaroon is the authorization macaroon for accessing the charmstore.
	Macaroon macaroon.Slice

	// Charm Version contains semantic version of charm, typically the output of git describe.
	CharmVersion string
}

CharmArchive is the data that needs to be stored for a charm archive in state.

type CharmHubClient

type CharmHubClient interface {
	DownloadAndRead(ctx context.Context, resourceURL *url.URL, archivePath string, options ...charmhub.DownloadOption) (*charm.CharmArchive, error)
	Refresh(ctx context.Context, config charmhub.RefreshConfig) ([]transport.RefreshResponse, error)
}

CharmHubClient represents the methods required of a client to install or upgrade a CharmHub charm.

type Metadata

type Metadata interface {
	ComputedSeries() []string
}

Metadata represents the return type for both charm types (charm and bundles)

type Method

type Method string

Method describes the method for requesting the charm using the RefreshAPI.

const (
	// MethodRevision utilizes requesting by the revision only.
	MethodRevision Method = "revision"
	// MethodChannel utilizes requesting by the channel only.
	MethodChannel Method = "channel"
	// MethodID utilizes requesting by the id and channel (falls back to
	// latest/stable if channel is found).
	MethodID Method = "id"
)

type Release

type Release struct {
	OS, Series string
}

Release represents a release that a charm can be selected from.

type ResolverGetterParams

type ResolverGetterParams struct {
	CSURL              string
	Channel            string
	CharmStoreMacaroon *macaroon.Macaroon
}

type StoreCharm

type StoreCharm interface {
	charm.Charm
	charm.LXDProfiler
	Version() string
}

StoreCharm represents a store charm.

type Strategy

type Strategy interface {
	CharmURL() *charm.URL
	Finish() error
	Run(corecharm.State, corecharm.JujuVersionValidator, corecharm.Origin) (corecharm.DownloadResult, bool, corecharm.Origin, error)
	Validate() error
}

Strategy represents a core charm Strategy

type StrategyFunc

type StrategyFunc func(charmRepo corecharm.Repository, url string, force bool) (Strategy, error)

StrategyFunc defines a function for executing a strategy for downloading a charm.