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"
)
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
)
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
type ConditionStatus string
DelegatedAuthentication allows authentication to be disabled.
type DelegatedAuthentication struct {
// disabled indicates that authentication should be disabled. By default it will use delegated authentication.
Disabled bool `json:"disabled,omitempty"`
}
func (in *DelegatedAuthentication) DeepCopy() *DelegatedAuthentication
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DelegatedAuthentication.
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() map[string]string
DelegatedAuthorization allows authorization to be disabled.
type DelegatedAuthorization struct {
// disabled indicates that authorization should be disabled. By default it will use delegated authorization.
Disabled bool `json:"disabled,omitempty"`
}
func (in *DelegatedAuthorization) DeepCopy() *DelegatedAuthorization
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DelegatedAuthorization.
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() map[string]string
GenerationHistory keeps track of the generation for a given resource so that decisions about forced updated can be made.
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"`
}
func (in *GenerationHistory) DeepCopy() *GenerationHistory
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenerationHistory.
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() map[string]string
GenericOperatorConfig provides information to configure an operator
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:internal
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"`
}
func (in *GenericOperatorConfig) DeepCopy() *GenericOperatorConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericOperatorConfig.
func (in *GenericOperatorConfig) DeepCopyInto(out *GenericOperatorConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *GenericOperatorConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (GenericOperatorConfig) SwaggerDoc() map[string]string
ImageContentSourcePolicy holds cluster-wide information about how to handle registry mirror rules. When multiple policies are defined, the outcome of the behavior is defined on each field.
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:level=4
type ImageContentSourcePolicy struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
// spec holds user settable values for configuration
// +kubebuilder:validation:Required
// +required
Spec ImageContentSourcePolicySpec `json:"spec"`
}
func (in *ImageContentSourcePolicy) DeepCopy() *ImageContentSourcePolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageContentSourcePolicy.
func (in *ImageContentSourcePolicy) DeepCopyInto(out *ImageContentSourcePolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ImageContentSourcePolicy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageContentSourcePolicy) SwaggerDoc() map[string]string
ImageContentSourcePolicyList lists the items in the ImageContentSourcePolicy CRD.
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:level=4
type ImageContentSourcePolicyList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []ImageContentSourcePolicy `json:"items"`
}
func (in *ImageContentSourcePolicyList) DeepCopy() *ImageContentSourcePolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageContentSourcePolicyList.
func (in *ImageContentSourcePolicyList) DeepCopyInto(out *ImageContentSourcePolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *ImageContentSourcePolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ImageContentSourcePolicyList) SwaggerDoc() map[string]string
ImageContentSourcePolicySpec is the specification of the ImageContentSourcePolicy CRD.
type ImageContentSourcePolicySpec struct {
// repositoryDigestMirrors allows images referenced by image digests in pods to be
// pulled from alternative mirrored repository locations. The image pull specification
// provided to the pod will be compared to the source locations described in RepositoryDigestMirrors
// and the image may be pulled down from any of the mirrors in the list instead of the
// specified repository allowing administrators to choose a potentially faster mirror.
// Only image pull specifications that have an image digest will have this behavior applied
// to them - tags will continue to be pulled from the specified repository in the pull spec.
//
// Each “source” repository is treated independently; configurations for different “source”
// repositories don’t interact.
//
// When multiple policies are defined for the same “source” repository, the sets of defined
// mirrors will be merged together, preserving the relative order of the mirrors, if possible.
// For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the
// mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict
// (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified.
// +optional
RepositoryDigestMirrors []RepositoryDigestMirrors `json:"repositoryDigestMirrors"`
}
func (in *ImageContentSourcePolicySpec) DeepCopy() *ImageContentSourcePolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageContentSourcePolicySpec.
func (in *ImageContentSourcePolicySpec) DeepCopyInto(out *ImageContentSourcePolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ImageContentSourcePolicySpec) SwaggerDoc() map[string]string
LoggingConfig holds information about configuring logging
type LoggingConfig struct {
// level is passed to glog.
Level int64 `json:"level"`
// vmodule is passed to glog.
Vmodule string `json:"vmodule"`
}
func (in *LoggingConfig) DeepCopy() *LoggingConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LoggingConfig.
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() map[string]string
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"
)
NodeStatus provides information about the current state of a particular node managed by this operator.
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"`
}
func (in *NodeStatus) DeepCopy() *NodeStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeStatus.
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() map[string]string
OperatorCondition is just the standard condition fields.
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"`
}
func (in *OperatorCondition) DeepCopy() *OperatorCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperatorCondition.
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() map[string]string
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.
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"`
}
func (in *OperatorSpec) DeepCopy() *OperatorSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperatorSpec.
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() map[string]string
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.
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"`
}
func (in *OperatorStatus) DeepCopy() *OperatorStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OperatorStatus.
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() map[string]string
RepositoryDigestMirrors holds cluster-wide information about how to handle mirros in the registries config. Note: the mirrors only work when pulling the images that are referenced by their digests.
type RepositoryDigestMirrors struct {
// source is the repository that users refer to, e.g. in image pull specifications.
// +required
Source string `json:"source"`
// mirrors is one or more repositories that may also contain the same images.
// The order of mirrors in this list is treated as the user's desired priority, while source
// is by default considered lower priority than all mirrors. Other cluster configuration,
// including (but not limited to) other repositoryDigestMirrors objects,
// may impact the exact order mirrors are contacted in, or some mirrors may be contacted
// in parallel, so this should be considered a preference rather than a guarantee of ordering.
// +optional
Mirrors []string `json:"mirrors"`
}
func (in *RepositoryDigestMirrors) DeepCopy() *RepositoryDigestMirrors
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryDigestMirrors.
func (in *RepositoryDigestMirrors) DeepCopyInto(out *RepositoryDigestMirrors)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (RepositoryDigestMirrors) SwaggerDoc() map[string]string
StaticPodOperatorStatus is status for controllers that manage static pods. There are different needs because individual node status must be tracked.
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"`
}
func (in *StaticPodOperatorStatus) DeepCopy() *StaticPodOperatorStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StaticPodOperatorStatus.
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() map[string]string
VersionAvailability gives information about the synchronization and operational status of a particular version of the component
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"`
}
func (in *VersionAvailability) DeepCopy() *VersionAvailability
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VersionAvailability.
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() map[string]string