v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +groupName=stork.com

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type StorkRule
  • func (in *StorkRule) DeepCopy() *StorkRule
  • func (in *StorkRule) DeepCopyInto(out *StorkRule)
  • func (in *StorkRule) DeepCopyObject() runtime.Object
• type StorkRuleAction
  • func (in *StorkRuleAction) DeepCopy() *StorkRuleAction
  • func (in *StorkRuleAction) DeepCopyInto(out *StorkRuleAction)
• type StorkRuleActionType
• type StorkRuleItem
  • func (in *StorkRuleItem) DeepCopy() *StorkRuleItem
  • func (in *StorkRuleItem) DeepCopyInto(out *StorkRuleItem)
• type StorkRuleList
  • func (in *StorkRuleList) DeepCopy() *StorkRuleList
  • func (in *StorkRuleList) DeepCopyInto(out *StorkRuleList)
  • func (in *StorkRuleList) DeepCopyObject() runtime.Object

Variables

var (
	// SchemeBuilder is the scheme builder for the types
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme applies all the stored functions to the scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: stork.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type StorkRule

type StorkRule struct {
	meta.TypeMeta   `json:",inline"`
	meta.ObjectMeta `json:"metadata,omitempty"`
	Spec            []StorkRuleItem `json:"spec"`
}

StorkRule denotes an object to declare a rule that performs actions on pods

func (*StorkRule) DeepCopy

func (in *StorkRule) DeepCopy() *StorkRule

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

func (*StorkRule) DeepCopyInto

func (in *StorkRule) DeepCopyInto(out *StorkRule)

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

func (*StorkRule) DeepCopyObject

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

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

type StorkRuleAction

type StorkRuleAction struct {
	// Type is a type of the stork rule action
	Type StorkRuleActionType `json:"type"`
	// Background indicates that the action needs to be performed in the background
	// +optional
	Background bool `json:"background,omitempty"`
	// RunInSinglePod indicates that the action needs to be performed in a single pod
	//                from the list of pods that match the selector
	// +optional
	RunInSinglePod bool `json:"runInSinglePod,omitempty"`
	// Value is the actual action value for e.g the command to run
	Value string `json:"value"`
}

StorkRuleAction represents an action in a stork rule item

func (*StorkRuleAction) DeepCopy

func (in *StorkRuleAction) DeepCopy() *StorkRuleAction

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

func (*StorkRuleAction) DeepCopyInto

func (in *StorkRuleAction) DeepCopyInto(out *StorkRuleAction)

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

type StorkRuleActionType

type StorkRuleActionType string

StorkRuleActionType is a type for actions that are supported in a stork rule

const (
	// StorkRuleActionCommand is a command action
	StorkRuleActionCommand StorkRuleActionType = "command"
)

type StorkRuleItem

type StorkRuleItem struct {
	// PodSelector is a map of key value pairs that are used to select the pods using their labels
	PodSelector map[string]string `json:"podSelector"`
	// Actions are actions to be performed on the pods selected using the selector
	Actions []StorkRuleAction `json:"actions"`
}

StorkRuleItem represents one items in a stork rule spec

func (*StorkRuleItem) DeepCopy

func (in *StorkRuleItem) DeepCopy() *StorkRuleItem

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

func (*StorkRuleItem) DeepCopyInto

func (in *StorkRuleItem) DeepCopyInto(out *StorkRuleItem)

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

type StorkRuleList

type StorkRuleList struct {
	meta.TypeMeta `json:",inline"`
	meta.ListMeta `json:"metadata,omitempty"`

	Items []StorkRule `json:"items"`
}

StorkRuleList is a list of stork rules

func (*StorkRuleList) DeepCopy

func (in *StorkRuleList) DeepCopy() *StorkRuleList

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

func (*StorkRuleList) DeepCopyInto

func (in *StorkRuleList) DeepCopyInto(out *StorkRuleList)

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

func (*StorkRuleList) DeepCopyObject

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

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