v1beta1

Documentation

Overview

Package v1beta1 is the first version of the Stack spec, containing only a compose file +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=compose.docker.com

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type Owner
  • func (o *Owner) DeepCopyObject() runtime.Object
• type Stack
  • func (s *Stack) Clone() *Stack
  • func (s *Stack) DeepCopyObject() runtime.Object
• type StackList
  • func (s *StackList) DeepCopyObject() runtime.Object
• type StackPhase
• type StackSpec
• type StackStatus

Constants

const GroupName = "compose.docker.com"

GroupName is the group name used to register these objects

const MaxComposeVersion = "3.5"

MaxComposeVersion is the most recent version of compose file Schema supported in v1beta1

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}
	SchemeBuilder      runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)

Alias variables for the registration

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Owner

type Owner struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Owner             impersonation.Config `json:"owner,omitempty"`
}

Owner defines the owner of a stack. It is used to impersonate the controller calls to kubernetes api.

func (*Owner) DeepCopyObject

func (o *Owner) DeepCopyObject() runtime.Object

DeepCopyObject clones the owner

type Stack

type Stack struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StackSpec   `json:"spec,omitempty"`
	Status StackStatus `json:"status,omitempty"`
}

Stack defines a stack object to be register in the kubernetes API

func (*Stack) Clone

func (s *Stack) Clone() *Stack

Clone implements the Cloner interface for kubernetes

func (*Stack) DeepCopyObject

func (s *Stack) DeepCopyObject() runtime.Object

DeepCopyObject clones the stack

type StackList

type StackList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Items []Stack `json:"items" protobuf:"bytes,2,rep,name=items"`
}

StackList defines a list of stacks

func (*StackList) DeepCopyObject

func (s *StackList) DeepCopyObject() runtime.Object

DeepCopyObject clones the stack list

type StackPhase

type StackPhase string

StackPhase defines the status phase in which the stack is.

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"
)

These are valid conditions of a stack.

type StackSpec

type StackSpec struct {
	ComposeFile string `json:"composeFile,omitempty"`
}

StackSpec defines the desired state of Stack

type StackStatus

type StackStatus struct {
	// Current condition of the stack.
	Phase StackPhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=StackPhase"`
	// A human readable message indicating details about the stack.
	Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"`
}

StackStatus defines the observed state of Stack