charm

package module
v2.0.0-...-39b1fc1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 7, 2014 License: AGPL-3.0 Imports: 25 Imported by: 2

README

Juju charms

This package parses juju charms.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var CacheDir string

CacheDir stores the charm cache directory path.

View Source 
var ErrUnresolvedUrl error = fmt.Errorf("charm url series is not resolved")
View Source 
var Store = &CharmStore{BaseURL: "https://store.juju.ubuntu.com"}

Functions

func IsValidName 

func IsValidName(name string) bool

IsValidName returns whether name is a valid charm name.

func IsValidSeries 

func IsValidSeries(series string) bool

IsValidSeries returns whether series is a valid series in charm URLs.

func IsValidUser 

func IsValidUser(user string) bool

IsValidUser returns whether user is a valid username in charm URLs.

func Latest 

func Latest(repo Repository, curl *URL) (int, error)

Latest returns the latest revision of the charm referenced by curl, regardless of the revision set on each curl. This is a helper which calls the bulk method and unpacks a single result.

func Quote 

func Quote(unsafe string) string

Quote translates a charm url string into one which can be safely used in a file path. ASCII letters, ASCII digits, dot and dash stay the same; other characters are translated to their hex representation surrounded by underscores.

Types

type ActionSpec 

type ActionSpec struct {
	Description string
	Params      map[string]interface{}
}

ActionSpec is a definition of the parameters and traits of an Action. The Params map is expected to conform to JSON-Schema Draft 4 as defined at http://json-schema.org/draft-04/schema# (see http://json-schema.org/latest/json-schema-core.html)

func (*ActionSpec) ValidateParams 

func (spec *ActionSpec) ValidateParams(params interface{}) (bool, error)

ValidateParams tells us whether an unmarshaled JSON object conforms to the Params for the specific ActionSpec. Usage: ok, err := ch.Actions()["snapshot"].Validate(jsonParams)

type Actions 

type Actions struct {
	ActionSpecs map[string]ActionSpec `yaml:"actions,omitempty" bson:",omitempty"`
}

Actions defines the available actions for the charm. Additional params may be added as metadata at a future time (e.g. version.)

func NewActions 

func NewActions() *Actions

func ReadActionsYaml 

func ReadActionsYaml(r io.Reader) (*Actions, error)

ReadActions builds an Actions spec from a charm's actions.yaml.

type BundleData 

type BundleData struct {
	// Services holds one entry for each service
	// that the bundle will create, indexed by
	// the service name.
	Services map[string]*ServiceSpec

	// Machines holds one entry for each machine referred to
	// by unit placements. These will be mapped onto actual
	// machines at bundle deployment time.
	// It is an error if a machine is specified but
	// not referred to by a unit placement directive.
	Machines map[string]*MachineSpec `yaml:",omitempty"`

	// Series holds the default series to use when
	// the bundle chooses charms.
	Series string `yaml:",omitempty"`

	// Relations holds a slice of 2-element slices,
	// each specifying a relation between two services.
	// Each two-element slice holds two colon-separated
	// (service, relation) pairs - the relation is made between
	// each.
	Relations [][]string `yaml:",omitempty"`
}

BundleData holds the contents of the bundle.

func ReadBundleData 

func ReadBundleData(r io.Reader) (*BundleData, error)

ReadBundleData reads bundle data from the given reader. The returned data is not verified - call Verify to ensure that it is OK.

func (*BundleData) Verify 

func (bd *BundleData) Verify(verifyConstraints func(c string) error) error

Verify verifies that the bundle is internally consistent. The verifyConstraints function is called to verify any constraints that are found.

It verifies the following:

- All defined machines are referred to by placement directives. - All services referred to by placement directives are specified in the bundle. - All services referred to by relations are specified in the bundle. - All constraints are valid.

If the verification fails, Verify returns a *VerificationError describing all the problems found.

type Charm 

type Charm interface {
	Meta() *Meta
	Config() *Config
	Actions() *Actions
	Revision() int
}

The Charm interface is implemented by any type that may be handled as a charm.

func ReadCharm 

func ReadCharm(path string) (Charm, error)

ReadCharm reads a Charm from path, which can point to either a charm archive or a charm directory.

type CharmArchive 

type CharmArchive struct {
	Path string // May be empty if CharmArchive wasn't read from a file
	// contains filtered or unexported fields
}

The CharmArchive type encapsulates access to data and operations on a charm archive.

func ReadCharmArchive 

func ReadCharmArchive(path string) (archive *CharmArchive, err error)

ReadCharmArchive returns a CharmArchive for the charm in path.

func ReadCharmArchiveBytes 

func ReadCharmArchiveBytes(data []byte) (archive *CharmArchive, err error)

ReadCharmArchiveBytes returns a CharmArchive read from the given data. Make sure the archive fits in memory before using this.

func (*CharmArchive) Actions 

func (a *CharmArchive) Actions() *Actions

Actions returns the Actions map for the actions.yaml file for the charm archive.

func (*CharmArchive) Config 

func (a *CharmArchive) Config() *Config

Config returns the Config representing the config.yaml file for the charm archive.

func (*CharmArchive) ExpandTo 

func (a *CharmArchive) ExpandTo(dir string) (err error)

ExpandTo expands the charm archive into dir, creating it if necessary. If any errors occur during the expansion procedure, the process will abort.

func (*CharmArchive) Manifest 

func (a *CharmArchive) Manifest() (set.Strings, error)

Manifest returns a set of the charm's contents.

func (*CharmArchive) Meta 

func (a *CharmArchive) Meta() *Meta

Meta returns the Meta representing the metadata.yaml file from archive.

func (*CharmArchive) Revision 

func (a *CharmArchive) Revision() int

Revision returns the revision number for the charm expanded in dir.

func (*CharmArchive) SetRevision 

func (a *CharmArchive) SetRevision(revision int)

SetRevision changes the charm revision number. This affects the revision reported by Revision and the revision of the charm directory created by ExpandTo.

type CharmDir 

type CharmDir struct {
	Path string
	// contains filtered or unexported fields
}

The CharmDir type encapsulates access to data and operations on a charm directory.

func ReadCharmDir 

func ReadCharmDir(path string) (dir *CharmDir, err error)

ReadCharmDir returns a CharmDir representing an expanded charm directory.

func (*CharmDir) Actions 

func (dir *CharmDir) Actions() *Actions

Actions returns the Actions representing the actions.yaml file for the charm expanded in dir.

func (*CharmDir) ArchiveTo 

func (dir *CharmDir) ArchiveTo(w io.Writer) (err error)

ArchiveTo creates a charm file from the charm expanded in dir. By convention a charm archive should have a ".charm" suffix.

func (*CharmDir) Config 

func (dir *CharmDir) Config() *Config

Config returns the Config representing the config.yaml file for the charm expanded in dir.

func (*CharmDir) Meta 

func (dir *CharmDir) Meta() *Meta

Meta returns the Meta representing the metadata.yaml file for the charm expanded in dir.

func (*CharmDir) Revision 

func (dir *CharmDir) Revision() int

Revision returns the revision number for the charm expanded in dir.

func (*CharmDir) SetDiskRevision 

func (dir *CharmDir) SetDiskRevision(revision int) error

SetDiskRevision does the same as SetRevision but also changes the revision file in the charm directory.

func (*CharmDir) SetRevision 

func (dir *CharmDir) SetRevision(revision int)

SetRevision changes the charm revision number. This affects the revision reported by Revision and the revision of the charm archived by ArchiveTo. The revision file in the charm directory is not modified.

type CharmRevision 

type CharmRevision struct {
	Revision int
	Sha256   string
	Err      error
}

CharmRevision holds the revision number of a charm and any error encountered in retrieving it.

type CharmStore 

type CharmStore struct {
	BaseURL string
	// contains filtered or unexported fields
}

CharmStore is a Repository that provides access to the public juju charm store.

func (*CharmStore) BranchLocation 

func (s *CharmStore) BranchLocation(curl *URL) string

BranchLocation returns the location for the branch holding the charm at curl.

func (*CharmStore) CharmURL 

func (s *CharmStore) CharmURL(location string) (*URL, error)

CharmURL returns the charm URL for the branch at location.

func (*CharmStore) Event 

func (s *CharmStore) Event(curl *URL, digest string) (*EventResponse, error)

Event returns details for a charm event in the charm store.

If digest is empty, the latest event is returned.

func (*CharmStore) Get 

func (s *CharmStore) Get(curl *URL) (Charm, error)

Get returns the charm referenced by curl. CacheDir must have been set, otherwise Get will panic.

func (*CharmStore) Info 

func (s *CharmStore) Info(curls ...Location) ([]*InfoResponse, error)

Info returns details for all the specified charms in the charm store.

func (*CharmStore) Latest 

func (s *CharmStore) Latest(curls ...*URL) ([]CharmRevision, error)

Latest returns the latest revision of the charms referenced by curls, regardless of the revision set on each curl.

func (*CharmStore) Resolve 

func (s *CharmStore) Resolve(ref Reference) (*URL, error)

Resolve canonicalizes charm URLs, resolving references and implied series.

func (*CharmStore) WithAuthAttrs 

func (s *CharmStore) WithAuthAttrs(authAttrs string) Repository

WithAuthAttrs return a Repository with the authentication token list set. authAttrs is a list of attr=value pairs.

func (*CharmStore) WithJujuAttrs 

func (s *CharmStore) WithJujuAttrs(jujuAttrs string) Repository

WithJujuAttrs returns a Repository with the Juju metadata attributes set. jujuAttrs is a list of attr=value pairs.

func (*CharmStore) WithTestMode 

func (s *CharmStore) WithTestMode(testMode bool) Repository

WithTestMode returns a Repository where testMode is set to value passed to this method.

type Config 

type Config struct {
	Options map[string]Option
}

Config represents the supported configuration options for a charm, as declared in its config.yaml file.

func NewConfig 

func NewConfig() *Config

NewConfig returns a new Config without any options.

func ReadConfig 

func ReadConfig(r io.Reader) (*Config, error)

ReadConfig reads a Config in YAML format.

func (*Config) DefaultSettings 

func (c *Config) DefaultSettings() Settings

DefaultSettings returns settings containing the default value of every option in the config. Default values may be nil.

func (*Config) FilterSettings 

func (c *Config) FilterSettings(settings Settings) Settings

FilterSettings returns the subset of the supplied settings that are valid.

func (*Config) ParseSettingsStrings 

func (c *Config) ParseSettingsStrings(values map[string]string) (Settings, error)

ParseSettingsStrings returns settings derived from the supplied map. Every value in the map must be parseable to the correct type for the option identified by its key. Empty values are interpreted as nil.

func (*Config) ParseSettingsYAML 

func (c *Config) ParseSettingsYAML(yamlData []byte, key string) (Settings, error)

ParseSettingsYAML returns settings derived from the supplied YAML data. The YAML must unmarshal to a map of strings to settings data; the supplied key must be present in the map, and must point to a map in which every value must have, or be a string parseable to, the correct type for the associated config option. Empty strings and nil values are both interpreted as nil.

func (*Config) ValidateSettings 

func (c *Config) ValidateSettings(settings Settings) (Settings, error)

ValidateSettings returns a copy of the supplied settings with a consistent type for each value. It returns an error if the settings contain unknown keys or invalid values.

type EventResponse 

type EventResponse struct {
	Kind     string   `json:"kind"`
	Revision int      `json:"revision"` // Zero is valid. Can't omitempty.
	Digest   string   `json:"digest,omitempty"`
	Errors   []string `json:"errors,omitempty"`
	Warnings []string `json:"warnings,omitempty"`
	Time     string   `json:"time,omitempty"`
}

EventResponse is sent by the charm store in response to charm-event requests.

type InfoResponse 

type InfoResponse struct {
	CanonicalURL string   `json:"canonical-url,omitempty"`
	Revision     int      `json:"revision"` // Zero is valid. Can't omitempty.
	Sha256       string   `json:"sha256,omitempty"`
	Digest       string   `json:"digest,omitempty"`
	Errors       []string `json:"errors,omitempty"`
	Warnings     []string `json:"warnings,omitempty"`
}

InfoResponse is sent by the charm store in response to charm-info requests.

type LocalRepository 

type LocalRepository struct {
	Path string
	// contains filtered or unexported fields
}

LocalRepository represents a local directory containing subdirectories named after an Ubuntu series, each of which contains charms targeted for that series. For example: 

/path/to/repository/oneiric/mongodb/
/path/to/repository/precise/mongodb.charm
/path/to/repository/precise/wordpress/

func (*LocalRepository) Get 

func (r *LocalRepository) Get(curl *URL) (Charm, error)

Get returns a charm matching curl, if one exists. If curl has a revision of -1, it returns the latest charm that matches curl. If multiple candidates satisfy the foregoing, the first one encountered will be returned.

func (*LocalRepository) Latest 

func (r *LocalRepository) Latest(curls ...*URL) ([]CharmRevision, error)

Latest returns the latest revision of the charm referenced by curl, regardless of the revision set on curl itself.

func (*LocalRepository) Resolve 

func (r *LocalRepository) Resolve(ref Reference) (*URL, error)

Resolve canonicalizes charm URLs, resolving references and implied series.

func (*LocalRepository) WithDefaultSeries 

func (r *LocalRepository) WithDefaultSeries(defaultSeries string) Repository

WithDefaultSeries returns a Repository with the default series set.

type Location 

type Location interface {
	Path() string
	String() string
}

Location represents a charm location, which must declare a path component and a string representaion.

type MachineSpec 

type MachineSpec struct {
	Constraints string            `yaml:",omitempty"`
	Annotations map[string]string `yaml:",omitempty"`
}

MachineSpec represents a notional machine that will be mapped onto an actual machine at bundle deployment time.

type Meta 

type Meta struct {
	Name        string
	Summary     string
	Description string
	Subordinate bool
	Provides    map[string]Relation `bson:",omitempty"`
	Requires    map[string]Relation `bson:",omitempty"`
	Peers       map[string]Relation `bson:",omitempty"`
	Format      int                 `bson:",omitempty"`
	OldRevision int                 `bson:",omitempty"` // Obsolete
	Categories  []string            `bson:",omitempty"`
	Series      string              `bson:",omitempty"`
}

Meta represents all the known content that may be defined within a charm's metadata.yaml file.

func ReadMeta 

func ReadMeta(r io.Reader) (meta *Meta, err error)

ReadMeta reads the content of a metadata.yaml file and returns its representation.

func (Meta) Check 

func (meta Meta) Check() error

Check checks that the metadata is well-formed.

func (Meta) Hooks 

func (m Meta) Hooks() map[string]bool

Hooks returns a map of all possible valid hooks, taking relations into account. It's a map to enable fast lookups, and the value is always true.

type NotFoundError 

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

NotFoundError represents an error indicating that the requested data wasn't found.

func (*NotFoundError) Error 

func (e *NotFoundError) Error() string

type Option 

type Option struct {
	Type        string
	Description string
	Default     interface{}
}

Option represents a single charm config option.

type Reference 

type Reference struct {
	Schema   string // "cs" or "local"
	User     string // "joe"
	Name     string // "wordpress"
	Revision int    // -1 if unset, N otherwise
}

Reference represents a charm location with an unresolved, untargeted series, such as: 

cs:~joe/wordpress
cs:wordpress-42

func ParseReference 

func ParseReference(url string) (Reference, string, error)

ParseReference parses the provided charm Reference string into its respective structure and the targeted series, if present.

func (*Reference) MarshalJSON 

func (r *Reference) MarshalJSON() ([]byte, error)

func (Reference) Path 

func (r Reference) Path() string

func (Reference) String 

func (r Reference) String() string

func (*Reference) UnmarshalJSON 

func (r *Reference) UnmarshalJSON(b []byte) error

type Relation 

type Relation struct {
	Name      string
	Role      RelationRole
	Interface string
	Optional  bool
	Limit     int
	Scope     RelationScope
}

Relation represents a single relation defined in the charm metadata.yaml file.

func (Relation) ImplementedBy 

func (r Relation) ImplementedBy(ch Charm) bool

ImplementedBy returns whether the relation is implemented by the supplied charm.

func (Relation) IsImplicit 

func (r Relation) IsImplicit() bool

IsImplicit returns whether the relation is supplied by juju itself, rather than by a charm.

type RelationRole 

type RelationRole string

RelationRole defines the role of a relation. 

const (
	RoleProvider RelationRole = "provider"
	RoleRequirer RelationRole = "requirer"
	RolePeer     RelationRole = "peer"
)

type RelationScope 

type RelationScope string

RelationScope describes the scope of a relation. 

const (
	ScopeGlobal    RelationScope = "global"
	ScopeContainer RelationScope = "container"
)

type Repository 

type Repository interface {
	Get(curl *URL) (Charm, error)
	Latest(curls ...*URL) ([]CharmRevision, error)
	Resolve(ref Reference) (*URL, error)
}

Repository represents a collection of charms.

func InferRepository 

func InferRepository(ref Reference, localRepoPath string) (repo Repository, err error)

InferRepository returns a charm repository inferred from the provided charm reference. Local references will use the provided path.

type ServiceSpec 

type ServiceSpec struct {
	// Charm holds the charm URL of the charm to
	// use for the given service.
	Charm string

	// NumUnits holds the number of units of the
	// service that will be deployed.
	NumUnits int `yaml:"num_units"`

	// To may hold up to NumUnits members with
	// each member specifying a desired placement
	// for the respective unit of the service.
	//
	// In regular-expression-like notation, each
	// element matches the following pattern:
	//
	//      (<containertype>:)?(<unit>|<machine>|new)
	//
	// If containertype is specified, the unit is deployed
	// into a new container of that type, otherwise
	// it will be "hulk-smashed" into the specified location,
	// by co-locating it with any other units that happen to
	// be there, which may result in unintended behavior.
	//
	// The second part (after the colon) specifies where
	// the new unit should be placed - it may refer to
	// a unit of another service specified in the bundle,
	// a machine id specified in the machines section,
	// or the special name "new" which specifies a newly
	// created machine.
	//
	// A unit placement may be specified with a service name only,
	// in which case its unit number is assumed to
	// be one more than the unit number of the previous
	// unit in the list with the same service, or zero
	// if there were none.
	//
	// If there are less elements in To than NumUnits,
	// the last element is replicated to fill it. If there
	// are no elements (or To is omitted), "new" is replicated.
	//
	// For example:
	//
	//     wordpress/0 wordpress/1 lxc:0 kvm:new
	//
	//  specifies that the first two units get hulk-smashed
	//  onto the first two units of the wordpress service,
	//  the third unit gets allocated onto an lxc container
	//  on machine 0, and subsequent units get allocated
	//  on kvm containers on new machines.
	//
	// The above example is the same as this:
	//
	//     wordpress wordpress lxc:0 kvm:new
	To []string `yaml:",omitempty"`

	// Options holds the configuration values
	// to apply to the new service. They should
	// be compatible with the charm configuration.
	Options map[string]interface{} `yaml:",omitempty"`

	// Annotations holds any annotations to apply to the
	// service when deployed.
	Annotations map[string]string `yaml:",omitempty"`

	// Constraints holds the default constraints to apply
	// when creating new machines for units of the service.
	// This is ignored for units with explicit placement directives.
	Constraints string `yaml:",omitempty"`
}

ServiceSpec represents a single service that will be deployed as part of the bundle.

type Settings 

type Settings map[string]interface{}

Settings is a group of charm config option names and values. A Settings S is considered valid by the Config C if every key in S is an option in C, and every value either has the correct type or is nil.

type URL 

type URL struct {
	Reference
	Series string // "oneiric"
}

URL represents a fully resolved charm location with a specific series, such as: 

cs:~joe/oneiric/wordpress
cs:oneiric/wordpress-42
local:oneiric/wordpress

func InferURL 

func InferURL(src, defaultSeries string) (*URL, error)

InferURL returns a charm URL inferred from src. The provided src may be a valid URL, in which case it is returned as-is, or it may be an alias in one of the following formats: 

name
name-revision
series/name
series/name-revision
schema:name
schema:name-revision
cs:~user/name
cs:~user/name-revision

The defaultSeries paramater is used to define the resulting URL when src does not include that information; similarly, a missing schema is assumed to be 'cs'.

func MustParseURL 

func MustParseURL(url string) *URL

MustParseURL works like ParseURL, but panics in case of errors.

func ParseURL 

func ParseURL(url string) (*URL, error)

ParseURL parses the provided charm URL string into its respective structure.

func (*URL) GetBSON 

func (u *URL) GetBSON() (interface{}, error)

GetBSON turns u into a bson.Getter so it can be saved directly on a MongoDB database with mgo.

func (*URL) MarshalJSON 

func (u *URL) MarshalJSON() ([]byte, error)

func (*URL) Path 

func (u *URL) Path() string

func (*URL) SetBSON 

func (u *URL) SetBSON(raw bson.Raw) error

SetBSON turns u into a bson.Setter so it can be loaded directly from a MongoDB database with mgo.

func (*URL) String 

func (u *URL) String() string

func (*URL) UnmarshalJSON 

func (u *URL) UnmarshalJSON(b []byte) error

func (*URL) WithRevision 

func (url *URL) WithRevision(revision int) *URL

WithRevision returns a URL equivalent to url but with Revision set to revision.

type UnitPlacement 

type UnitPlacement struct {
	// ContainerType holds the container type of the new
	// new unit, or empty if unspecified.
	ContainerType string

	// Machine holds the numeric machine id, or "new",
	// or empty if the placement specifies a service.
	Machine string

	// Service holds the service name, or empty if
	// the placement specifies a machine.
	Service string

	// Unit holds the unit number of the service, or -1
	// if unspecified.
	Unit int
}

func ParsePlacement 

func ParsePlacement(p string) (*UnitPlacement, error)

ParsePlacement parses a unit placement directive, as specified in the To clause of a service entry in the services section of a bundle.

type VerificationError 

type VerificationError struct {
	Errors []error
}

VerificationError holds an error generated by BundleData.Verify, holding all the verification errors found when verifying.

func (*VerificationError) Error 

func (err *VerificationError) Error() string

Source Files

View all Source files

Directories

Path Synopsis
hooks provides types and constants that define the hooks known to Juju.
 hooks provides types and constants that define the hooks known to Juju.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.