types

package

v0.0.0-...-814ced4 Latest Latest Go to latest Published: Oct 9, 2018 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/AliyunContainerService/cli

Documentation ¶

Constants ¶

View Source

const (
	// CommunityEngineImage is the repo name for the community engine
	CommunityEngineImage = "engine-community"

	// EnterpriseEngineImage is the repo name for the enterprise engine
	EnterpriseEngineImage = "engine-enterprise"

	// RegistryPrefix is the default prefix used to pull engine images
	RegistryPrefix = "docker.io/store/docker"

	// ReleaseNotePrefix is where to point users to for release notes
	ReleaseNotePrefix = "https://docs.docker.com/releasenotes"

	// RuntimeMetadataName is the name of the runtime metadata file
	// When stored as a label on the container it is prefixed by "com.docker."
	RuntimeMetadataName = "distribution_based_engine"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AvailableVersions ¶

type AvailableVersions struct {
	Downgrades []DockerVersion
	Patches    []DockerVersion
	Upgrades   []DockerVersion
}

AvailableVersions groups the available versions which were discovered

type ContainerizedClient ¶

type ContainerizedClient interface {
	Close() error
	ActivateEngine(ctx context.Context,
		opts EngineInitOptions,
		out OutStream,
		authConfig *types.AuthConfig) error
	DoUpdate(ctx context.Context,
		opts EngineInitOptions,
		out OutStream,
		authConfig *types.AuthConfig) error
}

ContainerizedClient can be used to manage the lifecycle of dockerd running as a container on containerd.

type DockerVersion ¶

type DockerVersion struct {
	ver.Version
	Tag string
}

DockerVersion wraps a semantic version to retain the original tag since the docker date based versions don't strictly follow semantic versioning (leading zeros, etc.)

type EngineInitOptions ¶

type EngineInitOptions struct {
	RegistryPrefix     string
	EngineImage        string
	EngineVersion      string
	ConfigFile         string
	RuntimeMetadataDir string
}

EngineInitOptions contains the configuration settings use during initialization of a containerized docker engine

type OutStream ¶

type OutStream interface {
	io.Writer
	FD() uintptr
	IsTerminal() bool
}

OutStream is an output stream used to write normal program output.

type RuntimeMetadata ¶

type RuntimeMetadata struct {
	Platform             string `json:"platform"`
	ContainerdMinVersion string `json:"containerd_min_version"`
	Runtime              string `json:"runtime"`
	EngineImage          string `json:"engine_image"`
}

RuntimeMetadata holds platform information about the daemon

type Update ¶

type Update struct {
	Type    string
	Version string
	Notes   string
}

Update stores available updates for rendering in a table

Source Files ¶

View all Source files

types.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL