charm

package
v0.0.0-...-a81527e Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2025 License: AGPL-3.0 Imports: 9 Imported by: 18

Documentation

Overview

Package charm provides the domain types for a charm. The application domain is the primary domain for creation and handling of a charm. The types here are to ensure that the charm is handled correctly and that the charm is correctly represented in the domain.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action 

type Action struct {
	Description    string
	Parallel       bool
	ExecutionGroup string
	Params         []byte
}

Action is a definition of the parameters and traits of an Action.

type Actions 

type Actions struct {
	Actions map[string]Action
}

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

type Base 

type Base struct {
	Name          string
	Channel       Channel
	Architectures []string
}

Base represents an OS/Channel and architecture combination that a charm supports.

type Channel 

type Channel struct {
	Track  string
	Risk   ChannelRisk
	Branch string
}

Channel represents the channel of a charm.

type ChannelRisk 

type ChannelRisk string

ChannelRisk describes the type of risk in a current channel. 

const (
	RiskStable    ChannelRisk = "stable"
	RiskCandidate ChannelRisk = "candidate"
	RiskBeta      ChannelRisk = "beta"
	RiskEdge      ChannelRisk = "edge"
)

type Charm 

type Charm struct {
	// Metadata holds the metadata of the charm.
	Metadata Metadata
	// Manifest holds the manifest of the charm. It defines the bases that
	// the charm supports.
	Manifest Manifest
	// Actions holds the actions of the charm.
	Actions Actions
	// Config holds the configuration options of the charm.
	Config Config
	// LXDProfile holds the LXD profile of the charm. It allows the charm to
	// specify the LXD profile that should be used when deploying the charm.
	LXDProfile []byte
	// Source is the source of the charm.
	Source CharmSource
	// ReferenceName is the given name of the charm that is stored in the
	// persistent storage. The proxy name should either be the application name
	// or the charm metadata name.
	//
	// The name of a charm can differ from the charm name stored in the metadata
	// in the cases where the application name is selected by the user. In order
	// to select that charm again via the name, we need to use the proxy name to
	// locate it. You can't go via the application and select it via the
	// application name, as no application might be referencing it at that
	// specific revision. The only way to then locate the charm directly via the
	// name is use the proxy name.
	ReferenceName string
	// Revision is the revision of the charm.
	Revision Revision
	// Hash is the hash of the charm.
	Hash string
	// ArchivePath is the path to the charm archive path.
	ArchivePath string
	// ObjectStoreUUID is the UUID of the object store where the charm is
	// stored.
	ObjectStoreUUID objectstore.UUID
	// Version is the optional charm version.
	Version string
	// Architecture is the architecture of the charm. The only reason this
	// is here is to allow us to reconstruct the charm URL purely from the
	// charm.
	Architecture architecture.Architecture
	// Available indicates whether the charm is available and ready to use.
	Available bool
}

Charm represents a charm from the perspective of the service. This is the golden source of charm information. If the charm changes at the wire format level, we should be able to map it to this struct.

type CharmLocator 

type CharmLocator struct {
	// Name is the name of the charm.
	Name string

	// Revision is the revision of the charm.
	Revision int

	// Source is the source of the charm.
	Source CharmSource

	// Architecture is the architecture of the charm.
	Architecture architecture.Architecture
}

CharmLocator represents the parts of a charm that are needed to locate it in the same way as a charm URL.

func (CharmLocator) IsZero 

func (c CharmLocator) IsZero() bool

IsZero returns true if the charm locator is zero.

type CharmSource 

type CharmSource string

CharmSource represents the source of a charm. 

const (
	// LocalSource represents a local charm source.
	LocalSource CharmSource = "local"
	// CharmHubSource represents a charmhub charm source.
	CharmHubSource CharmSource = "charmhub"
)

func ParseCharmSchema 

func ParseCharmSchema(source internalcharm.Schema) (CharmSource, error)

ParseCharmSchema creates a CharmSource from a string. It will map the string "ch" (representing the CharmHub URL scheme) to CharmHubSource and "local" to LocalSource.

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.

type Container 

type Container struct {
	Resource string
	Mounts   []Mount
	Uid      *int
	Gid      *int
}

Container specifies the possible systems it supports and mounts it wants.

type Device 

type Device struct {
	// Name is the name of the device.
	Name string

	// Description is a description of the device.
	Description string

	// Type is the device type.
	// currently supported types are
	// - gpu
	// - nvidia.com/gpu
	// - amd.com/gpu
	Type DeviceType

	// CountMin is the min number of devices that the charm requires.
	CountMin int64

	// CountMax is the max number of devices that the charm requires.
	CountMax int64
}

Device represents a charm's device requirement (GPU for example).

type DeviceType 

type DeviceType string

DeviceType defines a device type.

type DownloadInfo 

type DownloadInfo struct {
	// Provenance is the provenance of the download.
	Provenance Provenance

	// CharmhubIdentifier is the instance ID of the charm in relation to
	// charmhub.
	CharmhubIdentifier string

	// DownloadURL is the URL to download the charm from.
	DownloadURL string

	// DownloadSize is the size of the charm in bytes that the download URL
	// points to.
	DownloadSize int64
}

DownloadInfo holds the information needed to download a charmhub charm.

func (DownloadInfo) Validate 

func (d DownloadInfo) Validate() error

Validate validates the download information.

type ExtraBinding 

type ExtraBinding struct {
	Name string
}

ExtraBinding represents an extra bindable endpoint that is not a relation.

type GetCharmArgs 

type GetCharmArgs struct {
	// Name is the name of the charm to get the ID for.
	Name string

	// Revision allows the selection of a specific revision of the charm.
	// Otherwise, the latest revision is returned.
	Revision *int

	// Source is the source of the charm.
	Source CharmSource
}

GetCharmArgs holds the arguments for the GetCharmID method. Name is the name of the charm to get the ID for. This is required. Revision allows the selection of a specific revision of the charm. If revision is not provided, the latest revision is returned.

type Manifest 

type Manifest struct {
	Bases []Base
}

Manifest represents the manifest of a charm from the perspective of the service. This is the golden source of charm manifest. If the charm changes at the wire format level, we should be able to map it to this struct.

type Metadata 

type Metadata struct {
	Name           string
	Summary        string
	Description    string
	Subordinate    bool
	Provides       map[string]Relation
	Requires       map[string]Relation
	Peers          map[string]Relation
	ExtraBindings  map[string]ExtraBinding
	Categories     []string
	Tags           []string
	Storage        map[string]Storage
	Devices        map[string]Device
	Resources      map[string]Resource
	Terms          []string
	MinJujuVersion version.Number
	Containers     map[string]Container
	Assumes        []byte
	RunAs          RunAs
}

Metadata represents the metadata of a charm from the perspective of the service. This is the golden source of charm metadata. If the charm changes at the wire format level, we should be able to map it to this struct.

Of note:

  • Assumes is represented as a single binary blob and not of hierarchical set of structs.
  • RunAs default value is marshalled as "default" and not as an empty string.

type Mount 

type Mount struct {
	Storage  string
	Location string
}

Mount allows a container to mount a storage filesystem from the storage top-level directive.

type Option 

type Option struct {
	Type        OptionType
	Description string
	Default     any
}

Option represents a single charm config option.

type OptionType 

type OptionType string

OptionType defines the type of a charm config option. 

const (
	OptionString OptionType = "string"
	OptionInt    OptionType = "int"
	OptionFloat  OptionType = "float"
	OptionBool   OptionType = "boolean"
	OptionSecret OptionType = "secret"
)

type Provenance 

type Provenance string

Provenance represents the provenance of a charm download. Ideally this would be called origin, but that's already used for an origin of a charm. 

const (
	// ProvenanceDownload represents a charm download from the charmhub.
	ProvenanceDownload Provenance = "download"
	// ProvenanceUpload represents a charm download from an upload.
	ProvenanceUpload Provenance = "upload"
	// ProvenanceMigration represents a charm download from a migration.
	ProvenanceMigration Provenance = "migration"
	// ProvenanceBootstrap represents a charm placement during bootstrap.
	ProvenanceBootstrap Provenance = "bootstrap"
)

type Relation 

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

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

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 ReserveCharmRevisionArgs 

type ReserveCharmRevisionArgs struct {
	// Charm is the charm to set.
	Charm internalcharm.Charm
	// Source is the source of the charm.
	Source charm.Source
	// ReferenceName is the given name of the charm that is stored in the
	// persistent storage. The proxy name should either be the application name
	// or the charm metadata name.
	//
	// The name of a charm can differ from the charm name stored in the metadata
	// in the cases where the application name is selected by the user. In order
	// to select that charm again via the name, we need to use the proxy name to
	// locate it. You can't go via the application and select it via the
	// application name, as no application might be referencing it at that
	// specific revision. The only way to then locate the charm directly via the
	// name is use the proxy name.
	ReferenceName string
	// Revision is the revision of the charm.
	Revision int
	// Hash is the sha256 of the charm.
	Hash string
	// Architecture is the architecture of the charm.
	Architecture arch.Arch
	// DownloadInfo holds the information needed to download a charmhub charm.
	DownloadInfo *DownloadInfo
}

ReserveCharmRevisionArgs holds the arguments for the ReserveCharmRevision method.

type ResolveUploadCharm 

type ResolveUploadCharm struct {
	// Name is the name of the charm.
	Name string
	// Revision is the revision of the charm.
	Revision int
	// Source is the source of the charm.
	Source charm.Source
	// Architecture is the architecture of the charm.
	Architecture arch.Arch
	// SHA256Prefix is the SHA256 prefix of the charm.
	SHA256Prefix string
	// Reader is the reader to read the charm from.
	Reader io.Reader
	// Importing indicates that the charm is being uploaded during model
	// migration import. This is useful to set the provenance of the charm
	// correctly.
	Importing bool
}

ResolveUploadCharm holds the arguments for the ResolveUploadCharm method.

type ResolvedMigratingUploadedCharm 

type ResolvedMigratingUploadedCharm struct {
	// ObjectStoreUUID is the UUID of the object store where the charm is
	// stored.
	ObjectStoreUUID objectstore.UUID
	// ArchivePath is the path to the charm archive path.
	ArchivePath string
	// Hash is the sha256 of the charm.
	Hash string
	// DownloadInfo holds the information needed to download a charmhub charm.
	DownloadInfo *DownloadInfo
}

ResolvedMigratingUploadedCharm holds the arguments for the ResolveMigratingUploadedCharm method.

type Resource 

type Resource struct {
	// Name identifies the resource.
	Name string

	// Type identifies the type of resource (e.g. "file").
	Type ResourceType

	// Path is the relative path of the file or directory where the
	// resource will be stored under the unit's data directory. The path
	// is resolved against a subdirectory assigned to the resource. For
	// example, given an application named "spam", a resource "eggs", and a
	// path "eggs.tgz", the fully resolved storage path for the resource
	// would be:
	//   /var/lib/juju/agent/spam-0/resources/eggs/eggs.tgz
	Path string

	// Description holds optional user-facing info for the resource.
	Description string
}

Resource holds the information about a resource, as stored in a charm's metadata.

type ResourceType 

type ResourceType string

Type enumerates the recognized resource types. 

const (
	ResourceTypeFile           ResourceType = "file"
	ResourceTypeContainerImage ResourceType = "oci-image"
)

type Revision 

type Revision = int

Revision is the charm revision. This type alias just exists to help understand what an int represents in the context of return arguments.

type RunAs 

type RunAs string

RunAs defines which user to run a certain process as. 

const (
	RunAsDefault RunAs = "default"
	RunAsRoot    RunAs = "root"
	RunAsSudoer  RunAs = "sudoer"
	RunAsNonRoot RunAs = "non-root"
)

type SetCharmArgs 

type SetCharmArgs struct {
	// Charm is the charm to set.
	Charm internalcharm.Charm
	// Source is the source of the charm.
	Source charm.Source
	// ReferenceName is the given name of the charm that is stored in the
	// persistent storage. The proxy name should either be the application name
	// or the charm metadata name.
	//
	// The name of a charm can differ from the charm name stored in the metadata
	// in the cases where the application name is selected by the user. In order
	// to select that charm again via the name, we need to use the proxy name to
	// locate it. You can't go via the application and select it via the
	// application name, as no application might be referencing it at that
	// specific revision. The only way to then locate the charm directly via the
	// name is use the proxy name.
	ReferenceName string
	// Revision is the revision of the charm.
	Revision int
	// Hash is the sha256 of the charm.
	Hash string
	// ArchivePath is the path to the charm archive path.
	ArchivePath string
	// ObjectStoreUUID is the UUID of the object store where the charm is
	// stored.
	ObjectStoreUUID objectstore.UUID
	// Version is the optional charm version.
	Version string
	// Architecture is the architecture of the charm.
	Architecture arch.Arch
	// DownloadInfo holds the information needed to download a charmhub charm.
	DownloadInfo *DownloadInfo
	// RequiresSequencing indicates that the charm requires sequencing. This
	// will update the charms revision based on the current revision of the
	// current charm sequence in state. This will reflect on the charms
	// revision in state.
	RequiresSequencing bool
}

SetCharmArgs holds the arguments for the SetCharm method.

type Storage 

type Storage struct {
	// Name is the name of the store.
	//
	// Name has no default, and must be specified.
	Name string

	// Description is a description of the store.
	//
	// Description has no default, and is optional.
	Description string

	// Type is the storage type: filesystem or block-device.
	//
	// Type has no default, and must be specified.
	Type StorageType

	// Shared indicates that the storage is shared between all units of
	// an application deployed from the charm. It is an error to attempt to
	// assign non-shareable storage to a "shared" storage requirement.
	//
	// Shared defaults to false.
	Shared bool

	// ReadOnly indicates that the storage should be made read-only if
	// possible. If the storage cannot be made read-only, Juju will warn
	// the user.
	//
	// ReadOnly defaults to false.
	ReadOnly bool

	// CountMin is the number of storage instances that must be attached
	// to the charm for it to be useful; the charm will not install until
	// this number has been satisfied. This must be a non-negative number.
	//
	// CountMin defaults to 1 for singleton stores.
	CountMin int

	// CountMax is the largest number of storage instances that can be
	// attached to the charm. If CountMax is -1, then there is no upper
	// bound.
	//
	// CountMax defaults to 1 for singleton stores.
	CountMax int

	// MinimumSize is the minimum size of store that the charm needs to
	// work at all. This is not a recommended size or a comfortable size
	// or a will-work-well size, just a bare minimum below which the charm
	// is going to break.
	// MinimumSize requires a unit, one of MGTPEZY, and is stored as MiB.
	//
	// There is no default MinimumSize; if left unspecified, a provider
	// specific default will be used, typically 1GB for block storage.
	MinimumSize uint64

	// Location is the mount location for filesystem stores. For multi-
	// stores, the location acts as the parent directory for each mounted
	// store.
	//
	// Location has no default, and is optional.
	Location string

	// Properties allow the charm author to characterise the relative storage
	// performance requirements and sensitivities for each store.
	// eg “transient” is used to indicate that non persistent storage is
	// acceptable, such as tmpfs or ephemeral instance disks.
	//
	// Properties has no default, and is optional.
	Properties []string
}

Storage represents a charm's storage requirement.

type StorageType 

type StorageType string

StorageType defines a storage type. 

const (
	StorageBlock      StorageType = "block"
	StorageFilesystem StorageType = "filesystem"
)

Source Files

View all Source files

Directories

Path Synopsis

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.