v1

package
v0.0.0-...-83b2fe5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

+groupName=operator.openshift.io

Index

Constants

This section is empty.

Variables

View Source 
var (
	GroupName    = "operator.openshift.io"
	GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

	// Install is a function which adds this version to a scheme
	Install = schemeBuilder.AddToScheme

	// SchemeGroupVersion generated code relies on this name
	// Deprecated
	SchemeGroupVersion = GroupVersion
	// AddToScheme exists solely to keep the old generators creating valid code
	// DEPRECATED
	AddToScheme = schemeBuilder.AddToScheme
)
View Source 
var (
	// Available indicates that the operand is present and accessible in the cluster
	OperatorStatusTypeAvailable = "Available"
	// Progressing indicates that the operator is trying to transition the operand to a different state
	OperatorStatusTypeProgressing = "Progressing"
	// Failing indicates that the operator (not the operand) is unable to fulfill the user intent
	OperatorStatusTypeFailing = "Failing"
	// PrereqsSatisfied indicates that the things this operator depends on are present and at levels compatible with the
	// current and desired states.
	OperatorStatusTypePrereqsSatisfied = "PrereqsSatisfied"
	// Upgradeable indicates that the operator configuration itself (not prereqs) can be auto-upgraded by the CVO
	OperatorStatusTypeUpgradeable = "Upgradeable"
)

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED

Types

type CapnsLogConfig 

type CapnsLogConfig struct {
	// level is passed to capnslog: critical, error, warning, notice, info, debug, trace
	Level string `json:"level"`
}

func (*CapnsLogConfig) DeepCopy 

func (in *CapnsLogConfig) DeepCopy() *CapnsLogConfig

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

func (*CapnsLogConfig) DeepCopyInto 

func (in *CapnsLogConfig) DeepCopyInto(out *CapnsLogConfig)

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

func (CapnsLogConfig) SwaggerDoc 

func (CapnsLogConfig) SwaggerDoc() map[string]string

type ConditionStatus 

type ConditionStatus string
const (
	ConditionTrue    ConditionStatus = "True"
	ConditionFalse   ConditionStatus = "False"
	ConditionUnknown ConditionStatus = "Unknown"
)

type GenerationStatus 

type GenerationStatus struct {
	// group is the group of the thing you're tracking
	Group string `json:"group"`
	// resource is the resource type of the thing you're tracking
	Resource string `json:"resource"`
	// namespace is where the thing you're tracking is
	Namespace string `json:"namespace"`
	// name is the name of the thing you're tracking
	Name string `json:"name"`
	// lastGeneration is the last generation of the workload controller involved
	LastGeneration int64 `json:"lastGeneration"`
	// hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps
	Hash string `json:"hash"`
}

GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.

func (*GenerationStatus) DeepCopy 

func (in *GenerationStatus) DeepCopy() *GenerationStatus

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

func (*GenerationStatus) DeepCopyInto 

func (in *GenerationStatus) DeepCopyInto(out *GenerationStatus)

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

func (GenerationStatus) SwaggerDoc 

func (GenerationStatus) SwaggerDoc() map[string]string

type GlogConfig 

type GlogConfig struct {
	// level is passed to glog.
	Level int64 `json:"level"`

	// vmodule is passed to glog.
	Vmodule string `json:"vmodule"`
}

GlogConfig holds information about configuring logging

func (*GlogConfig) DeepCopy 

func (in *GlogConfig) DeepCopy() *GlogConfig

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

func (*GlogConfig) DeepCopyInto 

func (in *GlogConfig) DeepCopyInto(out *GlogConfig)

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

func (GlogConfig) SwaggerDoc 

func (GlogConfig) SwaggerDoc() map[string]string

type JavaLog 

type JavaLog struct {
	// level is passed to jsr47: fatal, error, warning, info, fine, finer, finest
	Level string `json:"level"`
}

func (*JavaLog) DeepCopy 

func (in *JavaLog) DeepCopy() *JavaLog

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

func (*JavaLog) DeepCopyInto 

func (in *JavaLog) DeepCopyInto(out *JavaLog)

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

func (JavaLog) SwaggerDoc 

func (JavaLog) SwaggerDoc() map[string]string

type LoggingConfig 

type LoggingConfig struct {
	Type string `json:"type"`

	Glog     *GlogConfig     `json:"glog,omitempty"`
	CapnsLog *CapnsLogConfig `json:"capnsLog,omitempty"`
	Java     *JavaLog        `json:"java,omitempty"`
}

LoggingConfig holds information about configuring logging

func (*LoggingConfig) DeepCopy 

func (in *LoggingConfig) DeepCopy() *LoggingConfig

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

func (*LoggingConfig) DeepCopyInto 

func (in *LoggingConfig) DeepCopyInto(out *LoggingConfig)

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

func (LoggingConfig) SwaggerDoc 

func (LoggingConfig) SwaggerDoc() map[string]string

type ManagementState 

type ManagementState string
var (
	// Force means that the operator is actively managing its resources but will not block an upgrade
	// if unmet prereqs exist. This state puts the operator at risk for unsuccessful upgrades
	Force ManagementState = "Force"
	// Managed means that the operator is actively managing its resources and trying to keep the component active.
	// It will only upgrade the component if it is safe to do so
	Managed ManagementState = "Managed"
	// Unmanaged means that the operator will not take any action related to the component
	Unmanaged ManagementState = "Unmanaged"
	// Removed means that the operator is actively managing its resources and trying to remove all traces of the component
	Removed ManagementState = "Removed"
)

type MyOperatorResource 

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

	Spec   MyOperatorResourceSpec   `json:"spec"`
	Status MyOperatorResourceStatus `json:"status"`
}

MyOperatorResource is an example operator configuration type

func (*MyOperatorResource) DeepCopy 

func (in *MyOperatorResource) DeepCopy() *MyOperatorResource

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

func (*MyOperatorResource) DeepCopyInto 

func (in *MyOperatorResource) DeepCopyInto(out *MyOperatorResource)

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

func (MyOperatorResource) SwaggerDoc 

func (MyOperatorResource) SwaggerDoc() map[string]string

type MyOperatorResourceSpec 

type MyOperatorResourceSpec struct {
	OperatorSpec `json:",inline"`
}

func (*MyOperatorResourceSpec) DeepCopy 

func (in *MyOperatorResourceSpec) DeepCopy() *MyOperatorResourceSpec

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

func (*MyOperatorResourceSpec) DeepCopyInto 

func (in *MyOperatorResourceSpec) DeepCopyInto(out *MyOperatorResourceSpec)

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

type MyOperatorResourceStatus 

type MyOperatorResourceStatus struct {
	OperatorStatus `json:",inline"`
}

func (*MyOperatorResourceStatus) DeepCopy 

func (in *MyOperatorResourceStatus) DeepCopy() *MyOperatorResourceStatus

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

func (*MyOperatorResourceStatus) DeepCopyInto 

func (in *MyOperatorResourceStatus) DeepCopyInto(out *MyOperatorResourceStatus)

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

type NodeStatus 

type NodeStatus struct {
	// nodeName is the name of the node
	NodeName string `json:"nodeName"`

	// currentRevision is the generation of the most recently successful deployment
	CurrentRevision int32 `json:"currentRevision"`
	// targetRevision is the generation of the deployment we're trying to apply
	TargetRevision int32 `json:"targetRevision"`
	// lastFailedRevision is the generation of the deployment we tried and failed to deploy.
	LastFailedRevision int32 `json:"lastFailedRevision"`

	// lastFailedRevisionErrors is a list of the errors during the failed deployment referenced in lastFailedRevision
	LastFailedRevisionErrors []string `json:"lastFailedRevisionErrors"`
}

NodeStatus provides information about the current state of a particular node managed by this operator.

func (*NodeStatus) DeepCopy 

func (in *NodeStatus) DeepCopy() *NodeStatus

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

func (*NodeStatus) DeepCopyInto 

func (in *NodeStatus) DeepCopyInto(out *NodeStatus)

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

func (NodeStatus) SwaggerDoc 

func (NodeStatus) SwaggerDoc() map[string]string

type OperandContainerSpec 

type OperandContainerSpec struct {
	// name is the name of the container to modify
	Name string `json:"name"`

	// resources are the requests and limits to place in the container.  Nil means to accept the defaults.
	Resources *corev1.ResourceRequirements `json:"resources,omitempty"`

	// logging contains parameters for setting log values on the operand. Nil means to accept the defaults.
	Logging LoggingConfig `json:"logging,omitempty"`
}

func (*OperandContainerSpec) DeepCopy 

func (in *OperandContainerSpec) DeepCopy() *OperandContainerSpec

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

func (*OperandContainerSpec) DeepCopyInto 

func (in *OperandContainerSpec) DeepCopyInto(out *OperandContainerSpec)

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

func (OperandContainerSpec) SwaggerDoc 

func (OperandContainerSpec) SwaggerDoc() map[string]string

type OperandSpec 

type OperandSpec struct {
	// name is the name of this unit.  The operator must be aware of it.
	Name string `json:"name"`

	// operandContainerSpecs are per-container options
	OperandContainerSpecs []OperandContainerSpec `json:"operandContainerSpecs"`

	// unsupportedResourcePatches are applied to the workload resource for this unit. This is an unsupported
	// workaround if anything needs to be modified on the workload that is not otherwise configurable.
	// TODO Decide: alternatively, we could simply include a RawExtension which is used in place of the "normal" default manifest
	UnsupportedResourcePatches []ResourcePatch `json:"unsupportedResourcePatches"`
}

OperandSpec holds information for customization of a particular functional unit - logically maps to a workload

func (*OperandSpec) DeepCopy 

func (in *OperandSpec) DeepCopy() *OperandSpec

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

func (*OperandSpec) DeepCopyInto 

func (in *OperandSpec) DeepCopyInto(out *OperandSpec)

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

func (OperandSpec) SwaggerDoc 

func (OperandSpec) SwaggerDoc() map[string]string

type OperatorCondition 

type OperatorCondition struct {
	Type               string          `json:"type"`
	Status             ConditionStatus `json:"status"`
	LastTransitionTime metav1.Time     `json:"lastTransitionTime,omitempty"`
	Reason             string          `json:"reason,omitempty"`
	Message            string          `json:"message,omitempty"`
}

OperatorCondition is just the standard condition fields.

func (*OperatorCondition) DeepCopy 

func (in *OperatorCondition) DeepCopy() *OperatorCondition

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

func (*OperatorCondition) DeepCopyInto 

func (in *OperatorCondition) DeepCopyInto(out *OperatorCondition)

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

func (OperatorCondition) SwaggerDoc 

func (OperatorCondition) SwaggerDoc() map[string]string

type OperatorSpec 

type OperatorSpec struct {
	// managementState indicates whether and how the operator should manage the component
	ManagementState ManagementState `json:"managementState"`

	// operandSpecs provide customization for functional units within the component
	OperandSpecs []OperandSpec `json:"operandSpecs"`

	// unsupportedConfigOverrides holds a sparse config that will override any previously set options.  It only needs to be the fields to override
	// it will end up overlaying in the following order:
	// 1. hardcoded defaults
	// 2. observedConfig
	// 3. unsupportedConfigOverrides
	UnsupportedConfigOverrides runtime.RawExtension `json:"unsupportedConfigOverrides"`

	// observedConfig holds a sparse config that controller has observed from the cluster state.  It exists in spec because
	// it is an input to the level for the operator
	ObservedConfig runtime.RawExtension `json:"observedConfig"`
}

OperatorSpec contains common fields operators need. It is intended to be anonymous included inside of the Spec struct for your particular operator.

func (*OperatorSpec) DeepCopy 

func (in *OperatorSpec) DeepCopy() *OperatorSpec

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

func (*OperatorSpec) DeepCopyInto 

func (in *OperatorSpec) DeepCopyInto(out *OperatorSpec)

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

func (OperatorSpec) SwaggerDoc 

func (OperatorSpec) SwaggerDoc() map[string]string

type OperatorStatus 

type OperatorStatus struct {
	// observedGeneration is the last generation change you've dealt with
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// conditions is a list of conditions and their status
	Conditions []OperatorCondition `json:"conditions,omitempty"`

	// version is the level this availability applies to
	Version string `json:"version"`

	// readyReplicas indicates how many replicas are ready and at the desired state
	ReadyReplicas int32 `json:"readyReplicas"`

	// generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.
	Generations []GenerationStatus `json:"generations"`
}

func (*OperatorStatus) DeepCopy 

func (in *OperatorStatus) DeepCopy() *OperatorStatus

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

func (*OperatorStatus) DeepCopyInto 

func (in *OperatorStatus) DeepCopyInto(out *OperatorStatus)

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

func (OperatorStatus) SwaggerDoc 

func (OperatorStatus) SwaggerDoc() map[string]string

type ResourcePatch 

type ResourcePatch struct {
	// type is the type of patch to apply: jsonmerge, strategicmerge
	Type string `json:"type"`
	// patch the patch itself
	Patch string `json:"patch"`
}

ResourcePatch is a way to represent the patch you would issue to `kubectl patch` in the API

func (*ResourcePatch) DeepCopy 

func (in *ResourcePatch) DeepCopy() *ResourcePatch

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

func (*ResourcePatch) DeepCopyInto 

func (in *ResourcePatch) DeepCopyInto(out *ResourcePatch)

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

func (ResourcePatch) SwaggerDoc 

func (ResourcePatch) SwaggerDoc() map[string]string

type StaticPodOperatorStatus 

type StaticPodOperatorStatus struct {
	OperatorStatus `json:",inline"`

	// latestAvailableRevision is the deploymentID of the most recent deployment
	LatestAvailableRevision int32 `json:"latestAvailableRevision"`

	// nodeStatuses track the deployment values and errors across individual nodes
	NodeStatuses []NodeStatus `json:"nodeStatuses"`
}

StaticPodOperatorStatus is status for controllers that manage static pods. There are different needs because individual node status must be tracked.

func (*StaticPodOperatorStatus) DeepCopy 

func (in *StaticPodOperatorStatus) DeepCopy() *StaticPodOperatorStatus

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

func (*StaticPodOperatorStatus) DeepCopyInto 

func (in *StaticPodOperatorStatus) DeepCopyInto(out *StaticPodOperatorStatus)

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

func (StaticPodOperatorStatus) SwaggerDoc 

func (StaticPodOperatorStatus) SwaggerDoc() map[string]string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.