api

Documentation

Index

• Constants
• func JoinDockerPullSpec(registry, namespace, name, tag string) string
• func SplitDockerPullSpec(spec string) (registry, namespace, name, tag string, err error)
• func SplitOpenShiftPullSpec(spec string) (registry, namespace, name, tag string, err error)
• type DockerConfig
• type DockerImage
  • func (*DockerImage) IsAnAPIObject()
• type Image
  • func (*Image) IsAnAPIObject()
• type ImageList
  • func (*ImageList) IsAnAPIObject()
• type ImageRepository
  • func (*ImageRepository) IsAnAPIObject()
• type ImageRepositoryList
  • func (*ImageRepositoryList) IsAnAPIObject()
• type ImageRepositoryMapping
  • func (*ImageRepositoryMapping) IsAnAPIObject()
• type ImageRepositoryStatus

Constants

const DockerDefaultNamespace = "library"

DockerDefaultNamespace is the value for namespace when a single segment name is provided.

Functions

func JoinDockerPullSpec

func JoinDockerPullSpec(registry, namespace, name, tag string) string

JoinDockerPullSpec turns a set of components of a Docker pull specification into a single string. Attempts to match as closely as possible the Docker spec up to 1.3. Future API revisions may change the pull syntax.

func SplitDockerPullSpec

func SplitDockerPullSpec(spec string) (registry, namespace, name, tag string, err error)

SplitDockerPullSpec breaks a Docker pull specification into its components, or returns an error if those components are not valid. Attempts to match as closely as possible the Docker spec up to 1.3. Future API revisions may change the pull syntax.

func SplitOpenShiftPullSpec

func SplitOpenShiftPullSpec(spec string) (registry, namespace, name, tag string, err error)

SplitOpenShiftPullSpec breaks an OpenShift pull specification into its components, or returns an error if those components are not valid. Attempts to match as closely as possible the Docker spec up to 1.3. Future API revisions may change the pull syntax.

Types

type DockerConfig

type DockerConfig struct {
	Hostname        string              `json:"Hostname,omitempty"`
	Domainname      string              `json:"Domainname,omitempty"`
	User            string              `json:"User,omitempty"`
	Memory          int64               `json:"Memory,omitempty"`
	MemorySwap      int64               `json:"MemorySwap,omitempty"`
	CPUShares       int64               `json:"CpuShares,omitempty"`
	CPUSet          string              `json:"Cpuset,omitempty"`
	AttachStdin     bool                `json:"AttachStdin,omitempty"`
	AttachStdout    bool                `json:"AttachStdout,omitempty"`
	AttachStderr    bool                `json:"AttachStderr,omitempty"`
	PortSpecs       []string            `json:"PortSpecs,omitempty"`
	ExposedPorts    map[string]struct{} `json:"ExposedPorts,omitempty"`
	Tty             bool                `json:"Tty,omitempty"`
	OpenStdin       bool                `json:"OpenStdin,omitempty"`
	StdinOnce       bool                `json:"StdinOnce,omitempty"`
	Env             []string            `json:"Env,omitempty"`
	Cmd             []string            `json:"Cmd,omitempty"`
	DNS             []string            `json:"Dns,omitempty"` // For Docker API v1.9 and below only
	Image           string              `json:"Image,omitempty"`
	Volumes         map[string]struct{} `json:"Volumes,omitempty"`
	VolumesFrom     string              `json:"VolumesFrom,omitempty"`
	WorkingDir      string              `json:"WorkingDir,omitempty"`
	Entrypoint      []string            `json:"Entrypoint,omitempty"`
	NetworkDisabled bool                `json:"NetworkDisabled,omitempty"`
}

DockerConfig is the list of configuration options used when creating a container.

type DockerImage

type DockerImage struct {
	kapi.TypeMeta `json:",inline"`

	ID              string       `json:"Id"`
	Parent          string       `json:"Parent,omitempty"`
	Comment         string       `json:"Comment,omitempty"`
	Created         util.Time    `json:"Created,omitempty"`
	Container       string       `json:"Container,omitempty"`
	ContainerConfig DockerConfig `json:"ContainerConfig,omitempty"`
	DockerVersion   string       `json:"DockerVersion,omitempty"`
	Author          string       `json:"Author,omitempty"`
	Config          DockerConfig `json:"Config,omitempty"`
	Architecture    string       `json:"Architecture,omitempty"`
	Size            int64        `json:"Size,omitempty"`
}

Image is the type representing a docker image and its various properties when retrieved from the Docker client API.

func (*DockerImage) IsAnAPIObject

func (*DockerImage) IsAnAPIObject()

type Image

type Image struct {
	kapi.TypeMeta   `json:",inline"`
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// The string that can be used to pull this image.
	DockerImageReference string `json:"dockerImageReference,omitempty"`
	// Metadata about this image
	DockerImageMetadata DockerImage `json:"dockerImageMetadata,omitempty"`
	// This attribute conveys the version of docker metadata the JSON should be stored in, which if empty defaults to "1.0"
	DockerImageMetadataVersion string `json:"dockerImageMetadataVersion,omitempty"`
}

Image is an immutable representation of a Docker image and metadata at a point in time.

func (*Image) IsAnAPIObject

func (*Image) IsAnAPIObject()

type ImageList

type ImageList struct {
	kapi.TypeMeta `json:",inline"`
	kapi.ListMeta `json:"metadata,omitempty"`

	Items []Image `json:"items"`
}

ImageList is a list of Image objects.

func (*ImageList) IsAnAPIObject

func (*ImageList) IsAnAPIObject()

type ImageRepository

type ImageRepository struct {
	kapi.TypeMeta   `json:",inline"`
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// Optional, if specified this repository is backed by a Docker repository on this server
	DockerImageRepository string `json:"dockerImageRepository,omitempty"`
	// Tags map arbitrary string values to specific image locators
	Tags map[string]string `json:"tags,omitempty"`

	// Status describes the current state of this repository
	Status ImageRepositoryStatus `json:"status,omitempty"`
}

ImageRepository stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a repository, and an optional reference to a Docker image repository on a registry.

func (*ImageRepository) IsAnAPIObject

func (*ImageRepository) IsAnAPIObject()

type ImageRepositoryList

type ImageRepositoryList struct {
	kapi.TypeMeta `json:",inline"`
	kapi.ListMeta `json:"metadata,omitempty"`

	Items []ImageRepository `json:"items"`
}

ImageRepositoryList is a list of ImageRepository objects.

func (*ImageRepositoryList) IsAnAPIObject

func (*ImageRepositoryList) IsAnAPIObject()

type ImageRepositoryMapping

type ImageRepositoryMapping struct {
	kapi.TypeMeta   `json:",inline"`
	kapi.ObjectMeta `json:"metadata,omitempty"`

	// The Docker image repository the specified image is located in
	DockerImageRepository string `json:"dockerImageRepository"`
	// A Docker image.
	Image Image `json:"image"`
	// A string value this image can be located with inside the repository.
	Tag string `json:"tag"`
}

ImageRepositoryMapping represents a mapping from a single tag to a Docker image as well as the reference to the Docker image repository the image came from.

func (*ImageRepositoryMapping) IsAnAPIObject

func (*ImageRepositoryMapping) IsAnAPIObject()

type ImageRepositoryStatus

type ImageRepositoryStatus struct {
	// Represents the effective location this repository may be accessed at. May be empty until the server
	// determines where the repository is located
	DockerImageRepository string `json:"dockerImageRepository,omitempty"`
}

ImageRepositoryStatus contains information about the state of this image repository.