latest

Documentation

Index

• Constants
• Variables
• func GroupResource(resource string) schema.GroupResource
• type ComposeFile
• type ConfigObjConfig
• type Constraint
• type Constraints
• type DeployConfig
• type External
• type FileObjectConfig
• type FileReferenceConfig
• type HealthCheckConfig
• type InternalPort
• type InternalServiceType
• type Owner
• type Placement
• type Resource
• type Resources
• type RestartPolicy
• type Scale
• type SecretConfig
• type ServiceConfig
• type ServiceConfigObjConfig
• type ServicePortConfig
• type ServiceSecretConfig
• type ServiceVolumeConfig
• type Stack
• type StackList
• type StackPhase
• type StackSpec
• type StackStatus
• type UpdateConfig

Constants

const (
	// StackAvailable means the stack is available.
	StackAvailable StackPhase = "Available"
	// StackProgressing means the deployment is progressing.
	StackProgressing StackPhase = "Progressing"
	// StackFailure is added in a stack when one of its members fails to be created
	// or deleted.
	StackFailure StackPhase = "Failure"
	// StackReconciliationPending means the stack has not yet been reconciled
	StackReconciliationPending StackPhase = "ReconciliationPending"

	// InternalServiceTypeAuto behavior is the same as InternalServiceTypeHeadless if InternalPorts is empty, InternalServiceTypeClusterIP otherwise
	InternalServiceTypeAuto = InternalServiceType("")
	// InternalServiceTypeHeadless always create a Headless service
	InternalServiceTypeHeadless = InternalServiceType("Headless")
	// InternalServiceTypeClusterIP always create a ClusterIP service
	InternalServiceTypeClusterIP = InternalServiceType("ClusterIP")
)

These are valid conditions of a stack.

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = ref.SchemeGroupVersion
	// SchemeBuilder is the scheme builder
	SchemeBuilder = ref.SchemeBuilder
	// AddToScheme adds to scheme
	AddToScheme = ref.AddToScheme
)

Functions

func GroupResource

func GroupResource(resource string) schema.GroupResource

GroupResource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ComposeFile

type ComposeFile = ref.ComposeFile

ComposeFile is the content of a stack's compose file if any

type ConfigObjConfig

type ConfigObjConfig = ref.ConfigObjConfig

ConfigObjConfig is the config for the swarm "Config" object

type Constraint

type Constraint = ref.Constraint

Constraint defines a constraint and it's operator (== or !=)

type Constraints

type Constraints = ref.Constraints

Constraints lists constraints that can be set on the service

type DeployConfig

type DeployConfig = ref.DeployConfig

DeployConfig is the deployment configuration for a service

type External

type External = ref.External

External identifies a Volume or Network as a reference to a resource that is not managed, and should already exist. External.name is deprecated and replaced by Volume.name

type FileObjectConfig

type FileObjectConfig = ref.FileObjectConfig

FileObjectConfig is a config type for a file used by a service

type FileReferenceConfig

type FileReferenceConfig = ref.FileReferenceConfig

FileReferenceConfig for a reference to a swarm file object

type HealthCheckConfig

type HealthCheckConfig = ref.HealthCheckConfig

HealthCheckConfig the healthcheck configuration for a service

type InternalPort

type InternalPort = ref.InternalPort

InternalPort describes a Port exposed internally to other services in the stack

type InternalServiceType

type InternalServiceType = ref.InternalServiceType

InternalServiceType defines the strategy for defining the Service Type to use for inter-service networking

type Owner

type Owner = ref.Owner

Owner describes the user who created the stack

type Placement

type Placement = ref.Placement

Placement constraints for the service

type Resource

type Resource = ref.Resource

Resource is a resource to be limited or reserved

type Resources

type Resources = ref.Resources

Resources the resource limits and reservations

type RestartPolicy

type RestartPolicy = ref.RestartPolicy

RestartPolicy is the service restart policy

type Scale

type Scale = ref.Scale

Scale contains the current/desired replica count for services in a stack.

type SecretConfig

type SecretConfig = ref.SecretConfig

SecretConfig for a secret

type ServiceConfig

type ServiceConfig = ref.ServiceConfig

ServiceConfig is the configuration of one service

type ServiceConfigObjConfig

type ServiceConfigObjConfig = ref.ServiceConfigObjConfig

ServiceConfigObjConfig is the config obj configuration for a service

type ServicePortConfig

type ServicePortConfig = ref.ServicePortConfig

ServicePortConfig is the port configuration for a service

type ServiceSecretConfig

type ServiceSecretConfig = ref.ServiceSecretConfig

ServiceSecretConfig is the secret configuration for a service

type ServiceVolumeConfig

type ServiceVolumeConfig = ref.ServiceVolumeConfig

ServiceVolumeConfig are references to a volume used by a service

type Stack

type Stack = ref.Stack

Stack is v1alpha3's representation of a Stack

type StackList

type StackList = ref.StackList

StackList is a list of stacks

type StackPhase

type StackPhase = ref.StackPhase

StackPhase is the deployment phase of a stack

type StackSpec

type StackSpec = ref.StackSpec

StackSpec defines the desired state of Stack

type StackStatus

type StackStatus = ref.StackStatus

StackStatus defines the observed state of Stack

type UpdateConfig

type UpdateConfig = ref.UpdateConfig

UpdateConfig is the service update configuration