v1beta1

Documentation

Overview

Package v1beta1 is the v1beta1 version of the API +groupName=openebs.io

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type Action
• type Condition
• type ConditionOperator
• type Kind
• type Option
  • func (in *Option) DeepCopy() *Option
  • func (in *Option) DeepCopyInto(out *Option)
• type RunItem
  • func (in *RunItem) DeepCopy() *RunItem
  • func (in *RunItem) DeepCopyInto(out *RunItem)
• type RunTask
  • func (in *RunTask) DeepCopy() *RunTask
  • func (in *RunTask) DeepCopyInto(out *RunTask)
  • func (in *RunTask) DeepCopyObject() runtime.Object
• type RunTaskList
  • func (in *RunTaskList) DeepCopy() *RunTaskList
  • func (in *RunTaskList) DeepCopyInto(out *RunTaskList)
  • func (in *RunTaskList) DeepCopyObject() runtime.Object
• type RunTaskSpec
  • func (in *RunTaskSpec) DeepCopy() *RunTaskSpec
  • func (in *RunTaskSpec) DeepCopyInto(out *RunTaskSpec)
• type RunTaskStatus
  • func (in *RunTaskStatus) DeepCopy() *RunTaskStatus
  • func (in *RunTaskStatus) DeepCopyInto(out *RunTaskStatus)

Variables

var (
	// SchemeBuilder is the scheme builder with scheme init functions to run for this API package
	SchemeBuilder runtime.SchemeBuilder

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: openebsio.GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Action

type Action string

Action defines the supported commands to be executed against a supported resource

const (
	Get      Action = "get"
	Template Action = "template"
	List     Action = "list"
	Create   Action = "create"
	Update   Action = "update"
	Patch    Action = "patch"
)

type Condition

type Condition string

Condition defines a condition in string format

type ConditionOperator

type ConditionOperator string

ConditionOperator defines the logical operator to be used against one or more conditions

type Kind

type Kind string

Kind defines the supported resource types

const (
	// DaemonSet is a supported resource
	DaemonSet Kind = "daemonset"
)

type Option

type Option struct {
	Func        string            `json:"func"`
	Conditions  []Condition       `json:"conditions,omitempty"`
	ConditionOp ConditionOperator `json:"conditionOp,omitempty"`
}

Option represents a logic and corresponding condition(s) to execute the action

func (*Option) DeepCopy

func (in *Option) DeepCopy() *Option

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

func (*Option) DeepCopyInto

func (in *Option) DeepCopyInto(out *Option)

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

type RunItem

type RunItem struct {
	ID          string            `json:"id"`                    // identity of this run
	Name        string            `json:"name,omitempty"`        // description of this run
	Action      Action            `json:"action"`                // command that this run will invoke
	APIVersion  string            `json:"apiVersion,omitempty"`  // resource version
	Kind        Kind              `json:"kind"`                  // refers to resource against which action gets executed
	Options     []Option          `json:"options"`               // options while executing the action
	Conditions  []Condition       `json:"conditions,omitempty"`  // conditions to satisfy before executing
	ConditionOp ConditionOperator `json:"conditionOp,omitempty"` // operator applied against the list of conditions
}

RunItem composes of properties that form a single run execution

func (*RunItem) DeepCopy

func (in *RunItem) DeepCopy() *RunItem

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

func (*RunItem) DeepCopyInto

func (in *RunItem) DeepCopyInto(out *RunItem)

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

type RunTask

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

	Spec   RunTaskSpec   `json:"spec"`
	Status RunTaskStatus `json:"status"`
}

RunTask forms the desired run specification as well as the result of trying the same

func (*RunTask) DeepCopy

func (in *RunTask) DeepCopy() *RunTask

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

func (*RunTask) DeepCopyInto

func (in *RunTask) DeepCopyInto(out *RunTask)

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

func (*RunTask) DeepCopyObject

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

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

type RunTaskList

type RunTaskList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

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

RunTaskList is a list of RunTask resources

func (*RunTaskList) DeepCopy

func (in *RunTaskList) DeepCopy() *RunTaskList

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

func (*RunTaskList) DeepCopyInto

func (in *RunTaskList) DeepCopyInto(out *RunTaskList)

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

func (*RunTaskList) DeepCopyObject

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

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

type RunTaskSpec

type RunTaskSpec struct {
	Config map[string]string `json:"config"`
	Runs   []RunItem         `json:"runs"`
}

RunTaskSpec is the specifications of a RunTask resource. It composes of a config as well as a list of run items. It specifies the desired actions against one or more kubernetes resources.

func (*RunTaskSpec) DeepCopy

func (in *RunTaskSpec) DeepCopy() *RunTaskSpec

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

func (*RunTaskSpec) DeepCopyInto

func (in *RunTaskSpec) DeepCopyInto(out *RunTaskSpec)

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

type RunTaskStatus

type RunTaskStatus struct {
	Phase string `json:"phase"`
}

RunTaskStatus presents the state of runtask after execution of desired actions

func (*RunTaskStatus) DeepCopy

func (in *RunTaskStatus) DeepCopy() *RunTaskStatus

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

func (*RunTaskStatus) DeepCopyInto

func (in *RunTaskStatus) DeepCopyInto(out *RunTaskStatus)

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