v1beta2

Documentation

Overview

Package v1beta2 is the second version of the stack, containing a structured spec

Index

• Constants
• Variables
• type ComposeFile
• type ConfigObjConfig
• type Constraint
• type Constraints
• type DeployConfig
• type External
• type FileObjectConfig
• type FileReferenceConfig
• type HealthCheckConfig
• 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 GroupName = api.GroupName

GroupName is the name of the compose group Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Owner instead

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	// Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.SchemeGroupVersion instead
	SchemeGroupVersion = api.SchemeGroupVersion
	// SchemeBuilder is the scheme builder
	// Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.SchemeBuilder instead
	SchemeBuilder = api.SchemeBuilder
	// AddToScheme adds to scheme
	// Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.AddToScheme instead
	AddToScheme = api.AddToScheme
)

var GroupResource = api.GroupResource

GroupResource takes an unqualified resource and returns a Group qualified GroupResource Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.GroupResource instead

Types

type ComposeFile

type ComposeFile = api.ComposeFile

ComposeFile is the content of a stack's compose file if any Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.ComposeFile instead

type ConfigObjConfig

type ConfigObjConfig = api.ConfigObjConfig

ConfigObjConfig is the config for the swarm "Config" object Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.ConfigObjConfig instead

type Constraint

type Constraint = api.Constraint

Constraint defines a constraint and it's operator (== or !=) Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Constraint instead

type Constraints

type Constraints = api.Constraints

Constraints lists constraints that can be set on the service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Constraints instead

type DeployConfig

type DeployConfig = api.DeployConfig

DeployConfig is the deployment configuration for a service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.DeployConfig instead

type External

type External = api.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 Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.External instead

type FileObjectConfig

type FileObjectConfig = api.FileObjectConfig

FileObjectConfig is a config type for a file used by a service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.FileObjectConfig instead

type FileReferenceConfig

type FileReferenceConfig = api.FileReferenceConfig

FileReferenceConfig for a reference to a swarm file object Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.FileReferenceConfig instead

type HealthCheckConfig

type HealthCheckConfig = api.HealthCheckConfig

HealthCheckConfig the healthcheck configuration for a service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.HealthCheckConfig instead

type Owner

type Owner = api.Owner

Owner describes the user who created the stack Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Owner instead

type Placement

type Placement = api.Placement

Placement constraints for the service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Placement instead

type Resource

type Resource = api.Resource

Resource is a resource to be limited or reserved Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Resource instead

type Resources

type Resources = api.Resources

Resources the resource limits and reservations Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Resources instead

type RestartPolicy

type RestartPolicy = api.RestartPolicy

RestartPolicy is the service restart policy Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.RestartPolicy instead

type Scale

type Scale = api.Scale

Scale contains the current/desired replica count for services in a stack. Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Scale instead

type SecretConfig

type SecretConfig = api.SecretConfig

SecretConfig for a secret Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.SecretConfig instead

type ServiceConfig

type ServiceConfig = api.ServiceConfig

ServiceConfig is the configuration of one service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.ServiceConfig instead

type ServiceConfigObjConfig

type ServiceConfigObjConfig = api.ServiceConfigObjConfig

ServiceConfigObjConfig is the config obj configuration for a service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.ServiceConfigObjConfig instead

type ServicePortConfig

type ServicePortConfig = api.ServicePortConfig

ServicePortConfig is the port configuration for a service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.ServicePortConfig instead

type ServiceSecretConfig

type ServiceSecretConfig = api.ServiceSecretConfig

ServiceSecretConfig is the secret configuration for a service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.ServiceSecretConfig instead

type ServiceVolumeConfig

type ServiceVolumeConfig = api.ServiceVolumeConfig

ServiceVolumeConfig are references to a volume used by a service Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.ServiceVolumeConfig instead

type Stack

type Stack = api.Stack

Stack is v1beta2's representation of a Stack Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.Stack instead

type StackList

type StackList = api.StackList

StackList is a list of stacks Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.StackList instead

type StackPhase

type StackPhase = api.StackPhase

StackPhase is the deployment phase of a stack Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.StackPhase instead

const (
	// StackAvailable means the stack is available.
	// Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.StackAvailable instead
	StackAvailable StackPhase = api.StackAvailable
	// StackProgressing means the deployment is progressing.
	// Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.StackProgressing instead
	StackProgressing StackPhase = api.StackProgressing
	// StackFailure is added in a stack when one of its members fails to be created
	// or deleted.
	// Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.StackFailure instead
	StackFailure StackPhase = api.StackFailure
)

These are valid conditions of a stack.

type StackSpec

type StackSpec = api.StackSpec

StackSpec defines the desired state of Stack Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.StackSpec instead

type StackStatus

type StackStatus = api.StackStatus

StackStatus defines the observed state of Stack Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.StackStatus instead

type UpdateConfig

type UpdateConfig = api.UpdateConfig

UpdateConfig is the service update configuration Deprecated: Use github.com/docker/compose-on-kubernetes/api/compose/v1beta2.UpdateConfig instead