types

Documentation

Index

• Constants
• type OrchestratorChoice
• type Stack
• type StackCreateOptions
• type StackCreateResponse
• type StackList
• type StackListOptions
• type StackSpec
• type StackTask
• type StackUpdateOptions
• type Version

Constants

const (
	// StackEventType is the value of Type in an events.Message for stacks
	StackEventType = "stack"
	// StackLabel is a label on objects indicating the stack that it belongs to
	StackLabel = "com.docker.stacks.stack_id"
)

const (
	// OrchestratorSwarm defines the OrchestratorChoice valud for Swarm
	OrchestratorSwarm = "swarm"

	// OrchestratorKubernetes defines the OrchestratorChoice valud for Kubernetes
	OrchestratorKubernetes = "kubernetes"

	// OrchestratorNone defines the OrchestratorChoice valud for no orchestrator (basic containers)
	OrchestratorNone = "none"
)

Types

type OrchestratorChoice

type OrchestratorChoice string

OrchestratorChoice This field specifies which orchestrator the stack is deployed on.

type Stack

type Stack struct {
	ID string
	swarm.Meta
	Spec StackSpec
}

Stack represents a Stack with Engine API types.

type StackCreateOptions

type StackCreateOptions struct {
	EncodedRegistryAuth string
}

StackCreateOptions is input to the Create operation for a Stack

type StackCreateResponse

type StackCreateResponse struct {
	ID string
}

StackCreateResponse is the response type of the Create Stack operation.

type StackList

type StackList struct {
	Items []Stack `json:"items"`
}

StackList is the output for Stack listing

type StackListOptions

type StackListOptions struct {
	Filters filters.Args
}

StackListOptions is input to the List operation for a Stack

type StackSpec

type StackSpec struct {
	Annotations swarm.Annotations
	Services    []swarm.ServiceSpec
	// Networks is a map of name -> types.NetworkCreate. It's like this because
	// Networks don't have a Spec, they're defined in terms of the
	// NetworkCreate type only.
	Networks map[string]types.NetworkCreate
	Secrets  []swarm.SecretSpec
	Configs  []swarm.ConfigSpec
}

StackSpec represents a StackSpec with Engine API types.

type StackTask

type StackTask struct {
	ID           string `json:"id"`
	Name         string `json:"name"`
	Image        string `json:"image"`
	NodeID       string `json:"node_id"`
	DesiredState string `json:"desired_state"`
	CurrentState string `json:"current_state"`
	Err          string `json:"err"`
}

StackTask This contains a summary of the Stacks task

type StackUpdateOptions

type StackUpdateOptions struct {
	EncodedRegistryAuth string
}

StackUpdateOptions is input to the Update operation for a Stack

type Version

type Version struct {
	Index uint64 `json:",omitempty"`
}

Version represents the internal object version.