juju: github.com/juju/juju/apiserver/common/crossmodel Index | Files

package crossmodel

import "github.com/juju/juju/apiserver/common/crossmodel"

Index

Package Files

auth.go crossmodel.go interface.go state.go

func GetBackend Uses

func GetBackend(st *state.State) stateShim

GetBackend wraps a State to provide a Backend interface implementation.

func GetOfferStatusChange Uses

func GetOfferStatusChange(st offerGetter, offerUUID string) (*params.OfferStatusChange, error)

GetOfferStatusChange returns a status change struct for a specified offer name.

func GetRelationLifeSuspendedStatusChange Uses

func GetRelationLifeSuspendedStatusChange(st relationGetter, key string) (*params.RelationLifeSuspendedStatusChange, error)

GetRelationLifeSuspendedStatusChange returns a life/suspended status change struct for a specified relation key.

func PublishIngressNetworkChange Uses

func PublishIngressNetworkChange(backend Backend, relationTag names.Tag, change params.IngressNetworksChangeEvent) error

PublishIngressNetworkChange saves the specified ingress networks for a relation.

func PublishRelationChange Uses

func PublishRelationChange(backend Backend, relationTag names.Tag, change params.RemoteRelationChangeEvent) error

PublishRelationChange applies the relation change event to the specified backend.

func RelationUnitSettings Uses

func RelationUnitSettings(backend Backend, ru params.RelationUnit) (params.Settings, error)

RelationUnitSettings returns the unit settings for the specified relation unit.

func WatchRelationUnits Uses

func WatchRelationUnits(backend Backend, tag names.RelationTag) (state.RelationUnitsWatcher, error)

WatchRelationUnits returns a watcher for changes to the units on the specified relation.

type Application Uses

type Application interface {
    // Name is the name of the application.
    Name() string

    // Life returns the lifecycle state of the application.
    Life() state.Life

    // Endpoints returns the application's currently available relation endpoints.
    Endpoints() ([]state.Endpoint, error)

    // Charm returns the application's charm and whether units should upgrade to that
    // charm even if they are in an error state.
    Charm() (ch Charm, force bool, err error)

    // CharmURL returns the application's charm URL, and whether units should upgrade
    // to the charm with that URL even if they are in an error state.
    CharmURL() (curl *charm.URL, force bool)

    // EndpointBindings returns the mapping for each endpoint name and the space
    // name it is bound to (or empty if unspecified). When no bindings are stored
    // for the application, defaults are returned.
    EndpointBindings() (map[string]string, error)

    // Status returns the status of the application.
    Status() (status.StatusInfo, error)
}

Application represents the state of a application hosted in the local model.

type AuthContext Uses

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

AuthContext is used to validate macaroons used to access application offers.

func NewAuthContext Uses

func NewAuthContext(
    pool StatePool,
    localOfferThirdPartyBakeryService authentication.BakeryService,
    localOfferBakeryService authentication.ExpirableStorageBakeryService,
) (*AuthContext, error)

NewAuthContext creates a new authentication context for checking macaroons used with application offer requests.

func (*AuthContext) Authenticator Uses

func (a *AuthContext) Authenticator(sourceModelUUID, offerUUID string) *authenticator

Authenticator returns an instance used to authenticate macaroons used to access the specified offer.

func (*AuthContext) CheckLocalAccessRequest Uses

func (a *AuthContext) CheckLocalAccessRequest(details *offerPermissionCheck) ([]checkers.Caveat, error)

CheckLocalAccessRequest checks that the user in the specified permission check details has consume access to the offer in the details. It returns an error with a *bakery.VerificationError cause if the macaroon verification failed. If the macaroon is valid, CheckLocalAccessRequest returns a list of caveats to add to the discharge macaroon.

func (*AuthContext) CheckOfferAccessCaveat Uses

func (a *AuthContext) CheckOfferAccessCaveat(caveat string) (*offerPermissionCheck, error)

CheckOfferAccessCaveat checks that the specified caveat required to be satisfied to gain access to an offer is valid, and returns the attributes return to check that the caveat is satisfied.

func (*AuthContext) CreateConsumeOfferMacaroon Uses

func (a *AuthContext) CreateConsumeOfferMacaroon(offer *params.ApplicationOfferDetails, username string) (*macaroon.Macaroon, error)

CreateConsumeOfferMacaroon creates a macaroon that authorises access to the specified offer.

func (*AuthContext) CreateRemoteRelationMacaroon Uses

func (a *AuthContext) CreateRemoteRelationMacaroon(sourceModelUUID, offerUUID string, username string, rel names.Tag) (*macaroon.Macaroon, error)

CreateRemoteRelationMacaroon creates a macaroon that authorises access to the specified relation.

func (*AuthContext) ThirdPartyBakeryService Uses

func (a *AuthContext) ThirdPartyBakeryService() authentication.BakeryService

ThirdPartyBakeryService returns the third party bakery service.

func (*AuthContext) WithClock Uses

func (a *AuthContext) WithClock(clock clock.Clock) *AuthContext

WithClock creates a new authentication context using the specified clock.

func (*AuthContext) WithDischargeURL Uses

func (a *AuthContext) WithDischargeURL(offerAccessEndpoint string) *AuthContext

WithDischargeURL create an auth context based on this context and used to perform third party discharges at the specified URL.

type Backend Uses

type Backend interface {
    // ModelUUID returns the model UUID for the model
    // controlled by this state instance.
    ModelUUID() string

    // ModelTag the tag of the model on which we are operating.
    ModelTag() names.ModelTag

    // AllModelUUIDs returns the UUIDs of all models in the controller.
    AllModelUUIDs() ([]string, error)

    // ControllerTag the tag of the controller in which we are operating.
    ControllerTag() names.ControllerTag

    // KeyRelation returns the existing relation with the given key (which can
    // be derived unambiguously from the relation's endpoints).
    KeyRelation(string) (Relation, error)

    // Application returns a local application by name.
    Application(string) (Application, error)

    // GetOfferAccess gets the access permission for the specified user on an offer.
    GetOfferAccess(offerUUID string, user names.UserTag) (permission.Access, error)

    // UserPermission returns the access permission for the passed subject and target.
    UserPermission(subject names.UserTag, target names.Tag) (permission.Access, error)

    // RemoteApplication returns a remote application by name.
    RemoteApplication(string) (RemoteApplication, error)

    // AddRelation adds a relation between the specified endpoints and returns the relation info.
    AddRelation(...state.Endpoint) (Relation, error)

    // EndpointsRelation returns the existing relation with the given endpoints.
    EndpointsRelation(...state.Endpoint) (Relation, error)

    // AddRemoteApplication creates a new remote application record, having the supplied relation endpoints,
    // with the supplied name (which must be unique across all applications, local and remote).
    AddRemoteApplication(state.AddRemoteApplicationParams) (RemoteApplication, error)

    // GetRemoteEntity returns the tag of the entity associated with the given token.
    GetRemoteEntity(string) (names.Tag, error)

    // GetToken returns the token associated with the entity with the given tag.
    GetToken(entity names.Tag) (string, error)

    // ExportLocalEntity adds an entity to the remote entities collection,
    // returning an opaque token that uniquely identifies the entity within
    // the model.
    ExportLocalEntity(names.Tag) (string, error)

    // ImportRemoteEntity adds an entity to the remote entities collection
    // with the specified opaque token.
    ImportRemoteEntity(entity names.Tag, token string) error

    // SaveIngressNetworks stores in state the ingress networks for the relation.
    SaveIngressNetworks(relationKey string, cidrs []string) (state.RelationNetworks, error)

    // Networks returns the networks for the specified relation.
    IngressNetworks(relationKey string) (state.RelationNetworks, error)

    // ApplicationOfferForUUID returns the application offer for the UUID.
    ApplicationOfferForUUID(offerUUID string) (*crossmodel.ApplicationOffer, error)

    // WatchStatus returns a watcher that notifies of changes to the status
    // of the offer.
    WatchOfferStatus(offerUUID string) (state.NotifyWatcher, error)

    // FirewallRule returns the firewall rule for the specified service.
    FirewallRule(service state.WellKnownServiceType) (*state.FirewallRule, error)

    // ApplyOperation applies a model operation to the state.
    ApplyOperation(op state.ModelOperation) error
}

type Charm Uses

type Charm interface {
    // Meta returns the metadata of the charm.
    Meta() *charm.Meta

    // StoragePath returns the storage path of the charm bundle.
    StoragePath() string
}

type Relation Uses

type Relation interface {
    status.StatusGetter
    status.StatusSetter
    // Destroy ensures that the relation will be removed at some point; if
    // no units are currently in scope, it will be removed immediately.
    Destroy() error

    // Id returns the integer internal relation key.
    Id() int

    // Life returns the relation's current life state.
    Life() state.Life

    // Tag returns the relation's tag.
    Tag() names.Tag

    // RemoteUnit returns a RelationUnit for the remote application unit
    // with the supplied ID.
    RemoteUnit(unitId string) (RelationUnit, error)

    // AllRemoteUnits returns all the RelationUnits for the remote
    // application units for a given application.
    AllRemoteUnits(appName string) ([]RelationUnit, error)

    // Endpoints returns the endpoints that constitute the relation.
    Endpoints() []state.Endpoint

    // Endpoint returns the endpoint of the relation for the named application.
    Endpoint(appName string) (state.Endpoint, error)

    // Unit returns a RelationUnit for the unit with the supplied ID.
    Unit(unitId string) (RelationUnit, error)

    // WatchUnits returns a watcher that notifies of changes to the units of the
    // specified application in the relation.
    WatchUnits(applicationName string) (state.RelationUnitsWatcher, error)

    // WatchLifeSuspendedStatus returns a watcher that notifies of changes to the life
    // or suspended status of the relation.
    WatchLifeSuspendedStatus() state.StringsWatcher

    // Suspended returns the suspended status of the relation.
    Suspended() bool

    // SuspendedReason returns the reason why the relation is suspended.
    SuspendedReason() string

    // SetSuspended sets the suspended status of the relation.
    SetSuspended(bool, string) error
}

Relation provides access a relation in global state.

type RelationUnit Uses

type RelationUnit interface {
    // EnterScope ensures that the unit has entered its scope in the
    // relation. When the unit has already entered its scope, EnterScope
    // will report success but make no changes to state.
    EnterScope(settings map[string]interface{}) error

    // InScope returns whether the relation unit has entered scope and
    // not left it.
    InScope() (bool, error)

    // LeaveScope signals that the unit has left its scope in the relation.
    // After the unit has left its relation scope, it is no longer a member
    // of the relation; if the relation is dying when its last member unit
    // leaves, it is removed immediately. It is not an error to leave a
    // scope that the unit is not, or never was, a member of.
    LeaveScope() error

    // Settings returns the relation unit's settings within the relation.
    Settings() (map[string]interface{}, error)

    // ReplaceSettings replaces the relation unit's settings within the
    // relation.
    ReplaceSettings(map[string]interface{}) error
}

RelationUnit provides access to the settings of a single unit in a relation, and methods for modifying the unit's involvement in the relation.

type RemoteApplication Uses

type RemoteApplication interface {
    // Destroy ensures that this remote application reference and all its relations
    // will be removed at some point; if no relation involving the
    // application has any units in scope, they are all removed immediately.
    Destroy() error

    // Name returns the name of the remote application.
    Name() string

    // Tag returns the remote applications's tag.
    Tag() names.Tag

    // URL returns the offer URL, at which the application is offered.
    URL() (string, bool)

    // OfferUUID returns the UUID of the offer.
    OfferUUID() string

    // SourceModel returns the tag of the model hosting the remote application.
    SourceModel() names.ModelTag

    // Macaroon returns the macaroon used for authentication.
    Macaroon() (*macaroon.Macaroon, error)

    // Status returns the status of the remote application.
    Status() (status.StatusInfo, error)

    // IsConsumerProxy returns whether application is created
    // from a registration operation by a consuming model.
    IsConsumerProxy() bool

    // Life returns the lifecycle state of the application.
    Life() state.Life

    // SetStatus sets the status of the remote application.
    SetStatus(info status.StatusInfo) error

    // TerminateOperation returns an operation that will set this
    // remote application to terminated and leave it in a state
    // enabling it to be removed cleanly.
    TerminateOperation(string) state.ModelOperation
}

RemoteApplication represents the state of an application hosted in an external (remote) model.

type StatePool Uses

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.

func GetStatePool Uses

func GetStatePool(pool *state.StatePool) StatePool

Package crossmodel imports 21 packages (graph) and is imported by 6 packages. Updated 2019-09-05. Refresh now. Tools for package owners.