crossmodel

Documentation

Overview

Package crossmodel provides an API server facade for managing cross model relations.

Index

• type API
  • func NewAPI(ctx facade.Context) (*API, error)
  • func (api *API) ApplicationOffers(urls params.ApplicationURLs) (params.ApplicationOffersResults, error)
  • func (api *API) FindApplicationOffers(filters params.OfferFilters) (params.FindApplicationOffersResults, error)
  • func (api *API) ListApplicationOffers(filters params.OfferFilters) (params.ListApplicationOffersResults, error)
  • func (api *API) Offer(all params.AddApplicationOffers) (params.ErrorResults, error)
• type Application
• type Backend
• type Charm
• type Model
• type RemoteConnectionStatus
• type StatePool
• type UserModel

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API implements the cross model interface and is the concrete implementation of the api end point.

func NewAPI

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

NewAPI returns a new cross model API facade.

func (*API) ApplicationOffers

func (api *API) ApplicationOffers(urls params.ApplicationURLs) (params.ApplicationOffersResults, error)

ApplicationOffers gets details about remote applications that match given URLs.

func (*API) FindApplicationOffers

func (api *API) FindApplicationOffers(filters params.OfferFilters) (params.FindApplicationOffersResults, error)

FindApplicationOffers gets details about remote applications that match given filter.

func (*API) ListApplicationOffers

func (api *API) ListApplicationOffers(filters params.OfferFilters) (params.ListApplicationOffersResults, error)

ListApplicationOffers gets deployed details about application offers that match given filter. The results contain details about the deployed applications such as connection count.

func (*API) Offer

func (api *API) Offer(all params.AddApplicationOffers) (params.ErrorResults, error)

Offer makes application endpoints available for consumption at a specified URL.

type Application

type Application interface {
	Charm() (ch Charm, force bool, err error)
	CharmURL() (curl *charm.URL, force bool)
	Name() string
}

type Backend

type Backend interface {
	Application(name string) (Application, error)
	Model() (Model, error)
	ModelUUID() string
	ModelsForUser(user names.UserTag) ([]UserModel, error)
	RemoteConnectionStatus(offerName string) (RemoteConnectionStatus, error)
}

Backend provides selected methods off the state.State struct.

type Charm

type Charm interface {
	Meta() *charm.Meta
}

type Model

type Model interface {
	UUID() string
	Name() string
	Owner() names.UserTag
}

type RemoteConnectionStatus

type RemoteConnectionStatus interface {
	ConnectionCount() int
}

type StatePool

type StatePool interface {
	// Get returns a State for a given model from the pool.
	Get(modelUUID string) (Backend, func(), error)
}

StatePool provides the subset of a state pool required by the crossmodel facade.

type UserModel

type UserModel interface {
	Model() Model
}