types

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2015 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package types contains structs representing the various types in the app container specification. It is used by the [schema manifest types](../) to enforce validation.

Index

Constants

View Source 
const (
	LinuxCapabilitiesRetainSetName string = "os/linux/capabilities-retain-set"
	LinuxCapabilitiesRevokeSetName string = "os/linux/capabilities-revoke-set"
)
View Source 
const (
	ResourceBlockBandwidthName   = "resource/block-bandwidth"
	ResourceBlockIOPSName        = "resource/block-iops"
	ResourceCPUName              = "resource/cpu"
	ResourceMemoryName           = "resource/memory"
	ResourceNetworkBandwidthName = "resource/network-bandwidth"
)

Variables

View Source 
var (
	// ValidACName is a regular expression that defines a valid ACName
	ValidACName = regexp.MustCompile("^[a-z0-9]+([-./][a-z0-9]+)*$")

	ErrEmptyACName = ACNameError("ACName cannot be empty")
	ErrInvalidEdge = ACNameError("ACName must start and end with only lower case " +
		"alphanumeric characters")
	ErrInvalidChar = ACNameError("ACName must contain only lower case " +
		`alphanumeric characters plus ".", "-", "/"`)
)
View Source 
var (
	ErrDefaultTrue     = errors.New("default must be false")
	ErrDefaultRequired = errors.New("default must be true")
	ErrRequestNonEmpty = errors.New("request not supported by this resource, must be empty")
)
View Source 
var (
	ErrNoZeroSemVer = ACVersionError("SemVer cannot be zero")
	ErrBadSemVer    = ACVersionError("SemVer is bad")
)
View Source 
var (
	ErrNoACKind = ACKindError("ACKind must be set")
)
View Source 
var (
	ErrNoEmptyUUID = errors.New("UUID cannot be empty")
)
View Source 
var ValidOSArch = map[string][]string{
	"linux":   {"amd64", "i386"},
	"freebsd": {"amd64", "i386", "arm"},
	"darwin":  {"x86_64", "i386"},
}

Functions

func AddIsolatorValueConstructor added in v0.4.0 

func AddIsolatorValueConstructor(i IsolatorValueConstructor)

func SanitizeACName added in v0.4.0 

func SanitizeACName(s string) (string, error)

SanitizeACName replaces every invalid ACName character in s with a dash making it a legal ACName string. If the character is an upper case letter it replaces it with its lower case. It also removes illegal edge characters (hyphens, periods and slashes).

This is a helper function and its algorithm is not part of the spec. It should not be called without the user explicitly asking for a suggestion.

func ShortHash added in v0.2.0 

func ShortHash(hash string) string

Types

type ACKind 

type ACKind string

ACKind wraps a string to define a field which must be set with one of several ACKind values. If it is unset, or has an invalid value, the field will refuse to marshal/unmarshal.

func (ACKind) MarshalJSON 

func (a ACKind) MarshalJSON() ([]byte, error)

func (ACKind) String 

func (a ACKind) String() string

func (*ACKind) UnmarshalJSON 

func (a *ACKind) UnmarshalJSON(data []byte) error

type ACKindError 

type ACKindError string

An ACKindError is returned when the wrong ACKind is set in a manifest

func InvalidACKindError added in v0.4.0 

func InvalidACKindError(kind ACKind) ACKindError

func (ACKindError) Error 

func (e ACKindError) Error() string

type ACName 

type ACName string

ACName (an App-Container Name) is a format used by keys in different formats of the App Container Standard. An ACName is restricted to characters accepted by the DNS RFC[1] and "/"; all alphabetical characters must be lowercase only. Furthermore, the first and last character ("edges") must be alphanumeric, and an ACName cannot be empty. Programmatically, an ACName must conform to the regular expression ValidACName.

[1] http://tools.ietf.org/html/rfc1123#page-13

func NewACName 

func NewACName(s string) (*ACName, error)

NewACName generates a new ACName from a string. If the given string is not a valid ACName, nil and an error are returned.

func (ACName) Empty 

func (n ACName) Empty() bool

Empty returns a boolean indicating whether this ACName is empty.

func (ACName) Equals 

func (n ACName) Equals(o ACName) bool

Equals checks whether a given ACName is equal to this one.

func (ACName) MarshalJSON 

func (n ACName) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface

func (*ACName) Set added in v0.2.0 

func (n *ACName) Set(s string) error

Set sets the ACName to the given value, if it is valid; if not, an error is returned.

func (ACName) String 

func (n ACName) String() string

func (*ACName) UnmarshalJSON 

func (n *ACName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface

type ACNameError 

type ACNameError string

An ACNameError is returned when a bad value is used for an ACName

func (ACNameError) Error 

func (e ACNameError) Error() string

type ACVersionError 

type ACVersionError string

An ACVersionError is returned when a bad ACVersion is set in a manifest

func (ACVersionError) Error 

func (e ACVersionError) Error() string

type Annotation added in v0.2.0 

type Annotation struct {
	Name  ACName `json:"name"`
	Value string `json:"value"`
}

type Annotations 

type Annotations []Annotation

func (Annotations) Get added in v0.2.0 

func (a Annotations) Get(name string) (val string, ok bool)

Retrieve the value of an annotation by the given name from Annotations, if it exists.

func (Annotations) MarshalJSON 

func (a Annotations) MarshalJSON() ([]byte, error)

func (*Annotations) Set added in v0.2.0 

func (a *Annotations) Set(name ACName, value string)

Set sets the value of an annotation by the given name, overwriting if one already exists.

func (*Annotations) UnmarshalJSON 

func (a *Annotations) UnmarshalJSON(data []byte) error

type App 

type App struct {
	Exec             Exec           `json:"exec"`
	EventHandlers    []EventHandler `json:"eventHandlers,omitempty"`
	User             string         `json:"user"`
	Group            string         `json:"group"`
	WorkingDirectory string         `json:"workingDirectory,omitempty"`
	Environment      Environment    `json:"environment,omitempty"`
	MountPoints      []MountPoint   `json:"mountPoints,omitempty"`
	Ports            []Port         `json:"ports,omitempty"`
	Isolators        []Isolator     `json:"isolators,omitempty"`
}

func (App) MarshalJSON 

func (a App) MarshalJSON() ([]byte, error)

func (*App) UnmarshalJSON 

func (a *App) UnmarshalJSON(data []byte) error

type Date 

type Date time.Time

Date wraps time.Time to marshal/unmarshal to/from JSON strings in strict accordance with RFC3339 TODO(jonboulle): golang's implementation seems slightly buggy here; according to http://tools.ietf.org/html/rfc3339#section-5.6 , applications may choose to separate the date and time with a space instead of a T character (for example, `date --rfc-3339` on GNU coreutils) - but this is considered an error by go's parser. File a bug?

func NewDate 

func NewDate(s string) (*Date, error)

func (Date) MarshalJSON 

func (d Date) MarshalJSON() ([]byte, error)

func (Date) String 

func (d Date) String() string

func (*Date) UnmarshalJSON 

func (d *Date) UnmarshalJSON(data []byte) error

type Dependencies 

type Dependencies []Dependency

type Dependency 

type Dependency struct {
	App     ACName `json:"app"`
	ImageID *Hash  `json:"imageID,omitempty"`
	Labels  Labels `json:"labels,omitempty"`
}

func (Dependency) MarshalJSON 

func (d Dependency) MarshalJSON() ([]byte, error)

func (*Dependency) UnmarshalJSON 

func (d *Dependency) UnmarshalJSON(data []byte) error

type Environment added in v0.3.0 

type Environment []EnvironmentVariable

func (Environment) Get added in v0.3.0 

func (e Environment) Get(name string) (value string, ok bool)

Retrieve the value of an environment variable by the given name from Environment, if it exists.

func (Environment) MarshalJSON added in v0.3.0 

func (e Environment) MarshalJSON() ([]byte, error)

func (*Environment) Set added in v0.3.0 

func (e *Environment) Set(name string, value string)

Set sets the value of an environment variable by the given name, overwriting if one already exists.

func (*Environment) UnmarshalJSON added in v0.3.0 

func (e *Environment) UnmarshalJSON(data []byte) error

type EnvironmentVariable added in v0.3.0 

type EnvironmentVariable struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type EventHandler 

type EventHandler struct {
	Name string `json:"name"`
	Exec Exec   `json:"exec"`
}

func (EventHandler) MarshalJSON 

func (e EventHandler) MarshalJSON() ([]byte, error)

func (*EventHandler) UnmarshalJSON 

func (e *EventHandler) UnmarshalJSON(data []byte) error

type Exec added in v0.2.0 

type Exec []string

func (Exec) MarshalJSON added in v0.2.0 

func (e Exec) MarshalJSON() ([]byte, error)

func (*Exec) UnmarshalJSON added in v0.2.0 

func (e *Exec) UnmarshalJSON(data []byte) error

type Hash 

type Hash struct {
	Val string
	// contains filtered or unexported fields
}

Hash encodes a hash specified in a string of the form: 

"<type>-<value>"

for example 

"sha512-06c733b1838136838e6d2d3e8fa5aea4c7905e92[...]"

Valid types are currently:

  • sha512

func NewHash 

func NewHash(s string) (*Hash, error)

func NewHashSHA512 added in v0.2.0 

func NewHashSHA512(b []byte) *Hash

func (Hash) Empty added in v0.2.0 

func (h Hash) Empty() bool

func (Hash) MarshalJSON 

func (h Hash) MarshalJSON() ([]byte, error)

func (*Hash) Set added in v0.2.0 

func (h *Hash) Set(s string) error

func (Hash) String 

func (h Hash) String() string

func (*Hash) UnmarshalJSON 

func (h *Hash) UnmarshalJSON(data []byte) error

type Isolator 

type Isolator struct {
	Name     string          `json:"name"`
	ValueRaw json.RawMessage `json:"value"`
	// contains filtered or unexported fields
}

func (*Isolator) UnmarshalJSON added in v0.4.0 

func (i *Isolator) UnmarshalJSON(b []byte) error

func (*Isolator) Value added in v0.4.0 

func (i *Isolator) Value() IsolatorValue

type IsolatorValue added in v0.4.0 

type IsolatorValue interface {
	Name() string
	UnmarshalJSON(b []byte) error
	AssertValid() error
}

func NewLinuxCapabilitiesRetainSet added in v0.4.0 

func NewLinuxCapabilitiesRetainSet() IsolatorValue

func NewLinuxCapabilitiesRevokeSet added in v0.4.0 

func NewLinuxCapabilitiesRevokeSet() IsolatorValue

func NewResourceBlockBandwidth added in v0.4.0 

func NewResourceBlockBandwidth() IsolatorValue

func NewResourceBlockIOPS added in v0.4.0 

func NewResourceBlockIOPS() IsolatorValue

func NewResourceCPU added in v0.4.0 

func NewResourceCPU() IsolatorValue

func NewResourceMemory added in v0.4.0 

func NewResourceMemory() IsolatorValue

func NewResourceNetworkBandwidth added in v0.4.0 

func NewResourceNetworkBandwidth() IsolatorValue

type IsolatorValueConstructor added in v0.4.0 

type IsolatorValueConstructor func() IsolatorValue

type Isolators added in v0.4.0 

type Isolators []Isolator

func (*Isolators) GetByName added in v0.4.0 

func (is *Isolators) GetByName(name string) *Isolator

GetByName returns the last isolator in the list by the given name.

type Label 

type Label struct {
	Name  ACName `json:"name"`
	Value string `json:"value"`
}

type Labels 

type Labels []Label

func (Labels) Get added in v0.2.0 

func (l Labels) Get(name string) (val string, ok bool)

Get retrieves the value of the label by the given name from Labels, if it exists

func (Labels) MarshalJSON 

func (l Labels) MarshalJSON() ([]byte, error)

func (*Labels) UnmarshalJSON 

func (l *Labels) UnmarshalJSON(data []byte) error

type LinuxCapabilitiesRetainSet added in v0.4.0 

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

func (LinuxCapabilitiesRetainSet) AssertValid added in v0.4.0 

func (l LinuxCapabilitiesRetainSet) AssertValid() error

func (LinuxCapabilitiesRetainSet) Name added in v0.4.0 

func (l LinuxCapabilitiesRetainSet) Name() string

func (LinuxCapabilitiesRetainSet) Set added in v0.4.0 

func (l LinuxCapabilitiesRetainSet) Set() []LinuxCapability

func (*LinuxCapabilitiesRetainSet) UnmarshalJSON added in v0.4.0 

func (l *LinuxCapabilitiesRetainSet) UnmarshalJSON(b []byte) error

type LinuxCapabilitiesRevokeSet added in v0.4.0 

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

func (LinuxCapabilitiesRevokeSet) AssertValid added in v0.4.0 

func (l LinuxCapabilitiesRevokeSet) AssertValid() error

func (LinuxCapabilitiesRevokeSet) Name added in v0.4.0 

func (l LinuxCapabilitiesRevokeSet) Name() string

func (LinuxCapabilitiesRevokeSet) Set added in v0.4.0 

func (l LinuxCapabilitiesRevokeSet) Set() []LinuxCapability

func (*LinuxCapabilitiesRevokeSet) UnmarshalJSON added in v0.4.0 

func (l *LinuxCapabilitiesRevokeSet) UnmarshalJSON(b []byte) error

type LinuxCapabilitiesSet added in v0.4.0 

type LinuxCapabilitiesSet interface {
	Name() string
	Set() []LinuxCapability
	AssertValid() error
}

type LinuxCapability added in v0.4.0 

type LinuxCapability string

type MountPoint 

type MountPoint struct {
	Name     ACName `json:"name"`
	Path     string `json:"path"`
	ReadOnly bool   `json:"readOnly,omitempty"`
}

type Port 

type Port struct {
	Name            ACName `json:"name"`
	Protocol        string `json:"protocol"`
	Port            uint   `json:"port"`
	SocketActivated bool   `json:"socketActivated"`
}

type Resource added in v0.4.0 

type Resource interface {
	Limit() *resource.Quantity
	Request() *resource.Quantity
	Default() bool
}

type ResourceBase added in v0.4.0 

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

func (ResourceBase) AssertValid added in v0.4.0 

func (r ResourceBase) AssertValid() error

func (ResourceBase) Default added in v0.4.0 

func (r ResourceBase) Default() bool

func (ResourceBase) Limit added in v0.4.0 

func (r ResourceBase) Limit() *resource.Quantity

func (ResourceBase) Request added in v0.4.0 

func (r ResourceBase) Request() *resource.Quantity

func (*ResourceBase) UnmarshalJSON added in v0.4.0 

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

type ResourceBlockBandwidth added in v0.4.0 

type ResourceBlockBandwidth struct {
	ResourceBase
}

func (ResourceBlockBandwidth) AssertValid added in v0.4.0 

func (r ResourceBlockBandwidth) AssertValid() error

func (ResourceBlockBandwidth) Name added in v0.4.0 

func (r ResourceBlockBandwidth) Name() string

type ResourceBlockIOPS added in v0.4.0 

type ResourceBlockIOPS struct {
	ResourceBase
}

func (ResourceBlockIOPS) AssertValid added in v0.4.0 

func (r ResourceBlockIOPS) AssertValid() error

func (ResourceBlockIOPS) Name added in v0.4.0 

func (r ResourceBlockIOPS) Name() string

type ResourceCPU added in v0.4.0 

type ResourceCPU struct {
	ResourceBase
}

func (ResourceCPU) AssertValid added in v0.4.0 

func (r ResourceCPU) AssertValid() error

func (ResourceCPU) Name added in v0.4.0 

func (r ResourceCPU) Name() string

type ResourceMemory added in v0.4.0 

type ResourceMemory struct {
	ResourceBase
}

func (ResourceMemory) AssertValid added in v0.4.0 

func (r ResourceMemory) AssertValid() error

func (ResourceMemory) Name added in v0.4.0 

func (r ResourceMemory) Name() string

type ResourceNetworkBandwidth added in v0.4.0 

type ResourceNetworkBandwidth struct {
	ResourceBase
}

func (ResourceNetworkBandwidth) AssertValid added in v0.4.0 

func (r ResourceNetworkBandwidth) AssertValid() error

func (ResourceNetworkBandwidth) Name added in v0.4.0 

func (r ResourceNetworkBandwidth) Name() string

type SemVer 

type SemVer semver.Version

SemVer implements the Unmarshaler interface to define a field that must be a semantic version string TODO(jonboulle): extend upstream instead of wrapping?

func NewSemVer 

func NewSemVer(s string) (*SemVer, error)

NewSemVer generates a new SemVer from a string. If the given string does not represent a valid SemVer, nil and an error are returned.

func (SemVer) Empty 

func (sv SemVer) Empty() bool

func (SemVer) MarshalJSON 

func (sv SemVer) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface

func (SemVer) String 

func (sv SemVer) String() string

func (*SemVer) UnmarshalJSON 

func (sv *SemVer) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface

type URL 

type URL url.URL

URL wraps url.URL to marshal/unmarshal to/from JSON strings and enforce that the scheme is HTTP/HTTPS only

func NewURL 

func NewURL(s string) (*URL, error)

func (URL) MarshalJSON 

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

func (URL) String 

func (u URL) String() string

func (*URL) UnmarshalJSON 

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

type UUID 

type UUID [16]byte

UUID encodes an RFC4122-compliant UUID, marshaled to/from a string TODO(jonboulle): vendor a package for this? TODO(jonboulle): consider more flexibility in input string formats. Right now, we only accept: 

"6733C088-A507-4694-AABF-EDBE4FC5266F"
"6733C088A5074694AABFEDBE4FC5266F"

func NewUUID 

func NewUUID(s string) (*UUID, error)

NewUUID generates a new UUID from the given string. If the string does not represent a valid UUID, nil and an error are returned.

func (UUID) Empty 

func (u UUID) Empty() bool

func (UUID) MarshalJSON 

func (u UUID) MarshalJSON() ([]byte, error)

func (*UUID) Set added in v0.2.0 

func (u *UUID) Set(s string) error

func (UUID) String 

func (u UUID) String() string

func (*UUID) UnmarshalJSON 

func (u *UUID) UnmarshalJSON(data []byte) error

type Volume 

type Volume struct {
	Name ACName `json:"name"`
	Kind string `json:"kind"`

	// currently used only by "host"
	// TODO(jonboulle): factor out?
	Source   string `json:"source,omitempty"`
	ReadOnly bool   `json:"readOnly,omitempty"`
}

Volume encapsulates a volume which should be mounted into the filesystem of all apps in a ContainerRuntimeManifest

func VolumeFromString added in v0.3.0 

func VolumeFromString(vp string) (*Volume, error)

VolumeFromString takes a command line volume parameter and returns a volume

Example volume parameters: 

database,kind=host,source=/tmp,readOnly=true

func (Volume) MarshalJSON 

func (v Volume) MarshalJSON() ([]byte, error)

func (Volume) String added in v0.3.0 

func (v Volume) String() string

func (*Volume) UnmarshalJSON 

func (v *Volume) UnmarshalJSON(data []byte) error

Source Files

View all Source files

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.