v1alpha1

package
v0.0.0-...-51726fa Latest Latest
Warning

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

 Go to latest Published: Nov 12, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

+groupName=operator.openshift.io

Index

Constants

View Source 
const (
	ConditionTrue    ConditionStatus = "True"
	ConditionFalse   ConditionStatus = "False"
	ConditionUnknown ConditionStatus = "Unknown"

	// these conditions match the conditions for the ClusterOperator type.
	OperatorStatusTypeAvailable   = "Available"
	OperatorStatusTypeProgressing = "Progressing"
	OperatorStatusTypeFailing     = "Failing"

	OperatorStatusTypeMigrating = "Migrating"
	// TODO this is going to be removed
	OperatorStatusTypeSyncSuccessful = "SyncSuccessful"
)

Variables

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

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

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 ConditionStatus 

type ConditionStatus string

type DelegatedAuthentication 

type DelegatedAuthentication struct {
	// disabled indicates that authentication should be disabled.  By default it will use delegated authentication.
	Disabled bool `json:"disabled,omitempty"`
}

DelegatedAuthentication allows authentication to be disabled.

func (*DelegatedAuthentication) DeepCopy 

func (in *DelegatedAuthentication) DeepCopy() *DelegatedAuthentication

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

func (*DelegatedAuthentication) DeepCopyInto 

func (in *DelegatedAuthentication) DeepCopyInto(out *DelegatedAuthentication)

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

func (DelegatedAuthentication) SwaggerDoc 

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

type DelegatedAuthorization 

type DelegatedAuthorization struct {
	// disabled indicates that authorization should be disabled.  By default it will use delegated authorization.
	Disabled bool `json:"disabled,omitempty"`
}

DelegatedAuthorization allows authorization to be disabled.

func (*DelegatedAuthorization) DeepCopy 

func (in *DelegatedAuthorization) DeepCopy() *DelegatedAuthorization

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

func (*DelegatedAuthorization) DeepCopyInto 

func (in *DelegatedAuthorization) DeepCopyInto(out *DelegatedAuthorization)

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

func (DelegatedAuthorization) SwaggerDoc 

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

type GenerationHistory 

type GenerationHistory 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"`
}

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

func (*GenerationHistory) DeepCopy 

func (in *GenerationHistory) DeepCopy() *GenerationHistory

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

func (*GenerationHistory) DeepCopyInto 

func (in *GenerationHistory) DeepCopyInto(out *GenerationHistory)

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

func (GenerationHistory) SwaggerDoc 

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

type GenericOperatorConfig 

type GenericOperatorConfig struct {
	metav1.TypeMeta `json:",inline"`

	// ServingInfo is the HTTP serving information for the controller's endpoints
	ServingInfo configv1.HTTPServingInfo `json:"servingInfo,omitempty"`

	// leaderElection provides information to elect a leader. Only override this if you have a specific need
	LeaderElection configv1.LeaderElection `json:"leaderElection,omitempty"`

	// authentication allows configuration of authentication for the endpoints
	Authentication DelegatedAuthentication `json:"authentication,omitempty"`
	// authorization allows configuration of authentication for the endpoints
	Authorization DelegatedAuthorization `json:"authorization,omitempty"`
}

GenericOperatorConfig provides information to configure an operator

func (*GenericOperatorConfig) DeepCopy 

func (in *GenericOperatorConfig) DeepCopy() *GenericOperatorConfig

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

func (*GenericOperatorConfig) DeepCopyInto 

func (in *GenericOperatorConfig) DeepCopyInto(out *GenericOperatorConfig)

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

func (*GenericOperatorConfig) DeepCopyObject 

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

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

func (GenericOperatorConfig) SwaggerDoc 

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

type LoggingConfig 

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

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

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
const (
	// Managed means that the operator is actively managing its resources and trying to keep the component active
	Managed ManagementState = "Managed"
	// Unmanaged means that the operator is not taking 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 NodeStatus 

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

	// currentDeploymentGeneration is the generation of the most recently successful deployment
	CurrentDeploymentGeneration int32 `json:"currentDeploymentGeneration"`
	// targetDeploymentGeneration is the generation of the deployment we're trying to apply
	TargetDeploymentGeneration int32 `json:"targetDeploymentGeneration"`
	// lastFailedDeploymentGeneration is the generation of the deployment we tried and failed to deploy.
	LastFailedDeploymentGeneration int32 `json:"lastFailedDeploymentGeneration"`

	// lastFailedDeploymentGenerationErrors is a list of the errors during the failed deployment referenced in lastFailedDeploymentGeneration
	LastFailedDeploymentErrors []string `json:"lastFailedDeploymentErrors"`
}

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

	// imagePullSpec is the image to use for the component.
	ImagePullSpec string `json:"imagePullSpec"`

	// imagePullPolicy specifies the image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified,
	// or IfNotPresent otherwise.
	ImagePullPolicy string `json:"imagePullPolicy"`

	// version is the desired state in major.minor.micro-patch.  Usually patch is ignored.
	Version string `json:"version"`

	// logging contains glog parameters for the component pods.  It's always a command line arg for the moment
	Logging LoggingConfig `json:"logging,omitempty"`
}

OperatorSpec contains common fields for an operator to need. It is intended to be anonymous included inside of the Spec struct for you 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
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

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

	// state indicates what the operator has observed to be its current operational status.
	State ManagementState `json:"state,omitempty"`
	// taskSummary is a high level summary of what the controller is currently attempting to do.  It is high-level, human-readable
	// and not guaranteed in any way. (I needed this for debugging and realized it made a great summary).
	TaskSummary string `json:"taskSummary,omitempty"`

	// currentVersionAvailability is availability information for the current version.  If it is unmanged or removed, this doesn't exist.
	CurrentAvailability *VersionAvailability `json:"currentVersionAvailability,omitempty"`
	// targetVersionAvailability is availability information for the target version if we are migrating
	TargetAvailability *VersionAvailability `json:"targetVersionAvailability,omitempty"`
}

OperatorStatus contains common fields for an operator to need. It is intended to be anonymous included inside of the Status struct for you particular operator.

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 StaticPodOperatorStatus 

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

	// latestAvailableDeploymentGeneration is the deploymentID of the most recent deployment
	LatestAvailableDeploymentGeneration int32 `json:"latestAvailableDeploymentGeneration"`

	// 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

type VersionAvailability 

type VersionAvailability struct {
	// version is the level this availability applies to
	Version string `json:"version"`
	// updatedReplicas indicates how many replicas are at the desired state
	UpdatedReplicas int32 `json:"updatedReplicas"`
	// readyReplicas indicates how many replicas are ready and at the desired state
	ReadyReplicas int32 `json:"readyReplicas"`
	// errors indicates what failures are associated with the operator trying to manage this version
	Errors []string `json:"errors"`
	// generations allows an operator to track what the generation of "important" resources was the last time we updated them
	Generations []GenerationHistory `json:"generations"`
}

VersionAvailability gives information about the synchronization and operational status of a particular version of the component

func (*VersionAvailability) DeepCopy 

func (in *VersionAvailability) DeepCopy() *VersionAvailability

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

func (*VersionAvailability) DeepCopyInto 

func (in *VersionAvailability) DeepCopyInto(out *VersionAvailability)

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

func (VersionAvailability) SwaggerDoc 

func (VersionAvailability) 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.