v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the yoyo.dzon.pl v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=yoyo.dzon.pl

Package v1alpha1 contains API Schema definitions for the yoyo.dzon.pl v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=yoyo.dzon.pl

Index

• Variables
• type Container
  • func (in *Container) DeepCopy() *Container
  • func (in *Container) DeepCopyInto(out *Container)
• type ContainerPort
  • func (in *ContainerPort) DeepCopy() *ContainerPort
  • func (in *ContainerPort) DeepCopyInto(out *ContainerPort)
• type RollbackPolicy
• type YoyoDeployment
  • func (in *YoyoDeployment) DeepCopy() *YoyoDeployment
  • func (in *YoyoDeployment) DeepCopyInto(out *YoyoDeployment)
  • func (in *YoyoDeployment) DeepCopyObject() runtime.Object
• type YoyoDeploymentCondition
  • func (in *YoyoDeploymentCondition) DeepCopy() *YoyoDeploymentCondition
  • func (in *YoyoDeploymentCondition) DeepCopyInto(out *YoyoDeploymentCondition)
• type YoyoDeploymentConditionType
• type YoyoDeploymentList
  • func (in *YoyoDeploymentList) DeepCopy() *YoyoDeploymentList
  • func (in *YoyoDeploymentList) DeepCopyInto(out *YoyoDeploymentList)
  • func (in *YoyoDeploymentList) DeepCopyObject() runtime.Object
• type YoyoDeploymentSpec
  • func (in *YoyoDeploymentSpec) DeepCopy() *YoyoDeploymentSpec
  • func (in *YoyoDeploymentSpec) DeepCopyInto(out *YoyoDeploymentSpec)
• type YoyoDeploymentStatus
  • func (in *YoyoDeploymentStatus) DeepCopy() *YoyoDeploymentStatus
  • func (in *YoyoDeploymentStatus) DeepCopyInto(out *YoyoDeploymentStatus)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "yoyo.dzon.pl", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Types

type Container

type Container struct {
	// Name specifies the name of the container
	Name string `json:"name"`

	// Image defines the container image that will be started
	Image string `json:"image"`

	// Ports specifies list of ports to expose from the container
	// +optional
	Ports []ContainerPort `json:"ports,omitempty"`

	// HealtCheck defines how health of the container is verified
	// +optional
	HealthCheck corev1.Probe `json:"healthCheck,omitempty"`
}

Container defines application container that will be run as part of the deployment +k8s:openapi-gen=true

func (*Container) DeepCopy

func (in *Container) DeepCopy() *Container

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Container.

func (*Container) DeepCopyInto

func (in *Container) DeepCopyInto(out *Container)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ContainerPort

type ContainerPort struct {
	// PortNumber is the number of the network port
	PortNumber int32 `json:"portNumber"`
	// Protocol specifies protocol for which the port is defined
	Protocol corev1.Protocol `json:"protocol"`
	// ServicePort specifies port number that should be used to map to this container port
	ServicePort int32 `json:"servicePort"`
}

ContainerPort defines network port +k8s:openapi-gen=true

func (*ContainerPort) DeepCopy

func (in *ContainerPort) DeepCopy() *ContainerPort

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContainerPort.

func (*ContainerPort) DeepCopyInto

func (in *ContainerPort) DeepCopyInto(out *ContainerPort)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RollbackPolicy

type RollbackPolicy string

RollbackPolicy defines rollback policy for the deployment +k8s:openapi-gen=true

const (
	// Automatic defines automatic rollback policy; the rollback will be executed automatically after startup failure is detected
	Automatic RollbackPolicy = "Automatic"
	// Disabled defines no rollback policy; even if startup fails, no action will be undertaken
	Disabled RollbackPolicy = "Disabled"
)

type YoyoDeployment

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

	Spec   YoyoDeploymentSpec   `json:"spec,omitempty"`
	Status YoyoDeploymentStatus `json:"status,omitempty"`
}

YoyoDeployment is the Schema for the yoyodeployments API +kubebuilder:subresource:status +kubebuilder:resource:path=yoyodeployments,scope=Namespaced

func (*YoyoDeployment) DeepCopy

func (in *YoyoDeployment) DeepCopy() *YoyoDeployment

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new YoyoDeployment.

func (*YoyoDeployment) DeepCopyInto

func (in *YoyoDeployment) DeepCopyInto(out *YoyoDeployment)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*YoyoDeployment) DeepCopyObject

func (in *YoyoDeployment) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type YoyoDeploymentCondition

type YoyoDeploymentCondition struct {
	// Type of virtual machine import condition
	Type YoyoDeploymentConditionType `json:"type"`

	// Status of the condition, one of True, False, Unknown
	Status corev1.ConditionStatus `json:"status"`

	// A brief CamelCase string that describes why the Yoyo Deployment is in current condition status
	// +optional
	Reason string `json:"reason,omitempty"`

	// A human-readable message indicating details about last transition
	// +optional
	Message string `json:"message,omitempty"`

	// The last time we got an update on a given condition
	// +optional
	LastHeartbeatTime metav1.Time `json:"lastHeartbeatTime,omitempty"`

	// The last time the condition transit from one status to another
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
}

YoyoDeploymentCondition defines the observed state of YoyoDeploymentCondition conditions +k8s:openapi-gen=true

func (*YoyoDeploymentCondition) DeepCopy

func (in *YoyoDeploymentCondition) DeepCopy() *YoyoDeploymentCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new YoyoDeploymentCondition.

func (*YoyoDeploymentCondition) DeepCopyInto

func (in *YoyoDeploymentCondition) DeepCopyInto(out *YoyoDeploymentCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type YoyoDeploymentConditionType

type YoyoDeploymentConditionType string

YoyoDeploymentConditionType represents a yoyo deployment condition type +k8s:openapi-gen=true

const (
	// Deploying represents the status of the deployment being deployed
	Deploying YoyoDeploymentConditionType = "Deploying"

	// Deployed represents the status of a deployed deployment
	Deployed YoyoDeploymentConditionType = "Deployed"

	// Degraded represents the status of deployment that is not fully operational; some components are unhealthy
	Degraded YoyoDeploymentConditionType = "Degraded"

	// RollingBack represents the status of a deployment being rolled-back
	RollingBack YoyoDeploymentConditionType = "RollingBack"
)

type YoyoDeploymentList

type YoyoDeploymentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []YoyoDeployment `json:"items"`
}

YoyoDeploymentList contains a list of YoyoDeployment

func (*YoyoDeploymentList) DeepCopy

func (in *YoyoDeploymentList) DeepCopy() *YoyoDeploymentList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new YoyoDeploymentList.

func (*YoyoDeploymentList) DeepCopyInto

func (in *YoyoDeploymentList) DeepCopyInto(out *YoyoDeploymentList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*YoyoDeploymentList) DeepCopyObject

func (in *YoyoDeploymentList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type YoyoDeploymentSpec

type YoyoDeploymentSpec struct {

	// Containers is a list of application containers being part of the deployment
	Containers []Container `json:"containers"`

	// RollbackPolicy defines how a rollback of the deployment should be executed
	// +optional
	RollbackPolicy RollbackPolicy `json:"rollbackPolicy,omitempty"`
}

YoyoDeploymentSpec defines the desired state of YoyoDeployment +k8s:openapi-gen=true

func (*YoyoDeploymentSpec) DeepCopy

func (in *YoyoDeploymentSpec) DeepCopy() *YoyoDeploymentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new YoyoDeploymentSpec.

func (*YoyoDeploymentSpec) DeepCopyInto

func (in *YoyoDeploymentSpec) DeepCopyInto(out *YoyoDeploymentSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type YoyoDeploymentStatus

type YoyoDeploymentStatus struct {

	// +optional
	// DeploymentName reports the name of dependant k8s Deployment
	DeploymentName string `json:"deploymentName"`

	// +optional
	// Current service state of the deployment.
	Conditions []YoyoDeploymentCondition `json:"conditions"`
}

YoyoDeploymentStatus defines the observed state of a Yoyo Deployment

func (*YoyoDeploymentStatus) DeepCopy

func (in *YoyoDeploymentStatus) DeepCopy() *YoyoDeploymentStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new YoyoDeploymentStatus.

func (*YoyoDeploymentStatus) DeepCopyInto

func (in *YoyoDeploymentStatus) DeepCopyInto(out *YoyoDeploymentStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.