v1alpha2

Documentation

Overview

Package v1alpha2 contains resources types for version v1alpha2 of the operators.coreos.com API group.

Package v1alpha2 contains API Schema definitions for the discovery v1alpha2 API group.

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type OperatorGroup
  • func (o *OperatorGroup) BuildTargetNamespaces() string
  • func (in *OperatorGroup) DeepCopy() *OperatorGroup
  • func (in *OperatorGroup) DeepCopyInto(out *OperatorGroup)
  • func (in *OperatorGroup) DeepCopyObject() runtime.Object
  • func (o *OperatorGroup) HasServiceAccountSynced() bool
  • func (o *OperatorGroup) IsServiceAccountSpecified() bool
• type OperatorGroupList
  • func (in *OperatorGroupList) DeepCopy() *OperatorGroupList
  • func (in *OperatorGroupList) DeepCopyInto(out *OperatorGroupList)
  • func (in *OperatorGroupList) DeepCopyObject() runtime.Object
• type OperatorGroupSpec
  • func (in *OperatorGroupSpec) DeepCopy() *OperatorGroupSpec
  • func (in *OperatorGroupSpec) DeepCopyInto(out *OperatorGroupSpec)
• type OperatorGroupStatus
  • func (in *OperatorGroupStatus) DeepCopy() *OperatorGroupStatus
  • func (in *OperatorGroupStatus) DeepCopyInto(out *OperatorGroupStatus)

Constants

const (
	OperatorGroupAnnotationKey             = "olm.operatorGroup"
	OperatorGroupNamespaceAnnotationKey    = "olm.operatorNamespace"
	OperatorGroupTargetsAnnotationKey      = "olm.targetNamespaces"
	OperatorGroupProvidedAPIsAnnotationKey = "olm.providedAPIs"

	OperatorGroupKind = "OperatorGroup"
)

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "operators.coreos.com", Version: "v1alpha2"}

	// SchemeGroupVersion is required for compatibility with client generation.
	SchemeGroupVersion = GroupVersion

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type OperatorGroup

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

	// +optional
	Spec   OperatorGroupSpec   `json:"spec"`
	Status OperatorGroupStatus `json:"status,omitempty"`
}

OperatorGroup is the unit of multitenancy for OLM managed operators. It constrains the installation of operators in its namespace to a specified set of target namespaces.

func (*OperatorGroup) BuildTargetNamespaces

func (o *OperatorGroup) BuildTargetNamespaces() string

func (*OperatorGroup) DeepCopy

func (in *OperatorGroup) DeepCopy() *OperatorGroup

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

func (*OperatorGroup) DeepCopyInto

func (in *OperatorGroup) DeepCopyInto(out *OperatorGroup)

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

func (*OperatorGroup) DeepCopyObject

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

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

func (*OperatorGroup) HasServiceAccountSynced

func (o *OperatorGroup) HasServiceAccountSynced() bool

HasServiceAccountSynced returns true if the service account specified has been synced.

func (*OperatorGroup) IsServiceAccountSpecified

func (o *OperatorGroup) IsServiceAccountSpecified() bool

IsServiceAccountSpecified returns true if the spec has a service account name specified.

type OperatorGroupList

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

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

OperatorGroupList is a list of OperatorGroup resources.

func (*OperatorGroupList) DeepCopy

func (in *OperatorGroupList) DeepCopy() *OperatorGroupList

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

func (*OperatorGroupList) DeepCopyInto

func (in *OperatorGroupList) DeepCopyInto(out *OperatorGroupList)

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

func (*OperatorGroupList) DeepCopyObject

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

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

type OperatorGroupSpec

type OperatorGroupSpec struct {
	// Selector selects the OperatorGroup's target namespaces.
	// +optional
	Selector *metav1.LabelSelector `json:"selector,omitempty"`

	// TargetNamespaces is an explicit set of namespaces to target.
	// If it is set, Selector is ignored.
	// +optional
	TargetNamespaces []string `json:"targetNamespaces,omitempty"`

	// ServiceAccountName is the admin specified service account which will be
	// used to deploy operator(s) in this operator group.
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// Static tells OLM not to update the OperatorGroup's providedAPIs annotation
	// +optional
	StaticProvidedAPIs bool `json:"staticProvidedAPIs,omitempty"`
}

OperatorGroupSpec is the spec for an OperatorGroup resource.

func (*OperatorGroupSpec) DeepCopy

func (in *OperatorGroupSpec) DeepCopy() *OperatorGroupSpec

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

func (*OperatorGroupSpec) DeepCopyInto

func (in *OperatorGroupSpec) DeepCopyInto(out *OperatorGroupSpec)

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

type OperatorGroupStatus

type OperatorGroupStatus struct {
	// Namespaces is the set of target namespaces for the OperatorGroup.
	Namespaces []string `json:"namespaces,omitempty"`

	// ServiceAccountRef references the service account object specified.
	ServiceAccountRef *corev1.ObjectReference `json:"serviceAccountRef,omitempty"`

	// LastUpdated is a timestamp of the last time the OperatorGroup's status was Updated.
	LastUpdated *metav1.Time `json:"lastUpdated"`
}

OperatorGroupStatus is the status for an OperatorGroupResource.

func (*OperatorGroupStatus) DeepCopy

func (in *OperatorGroupStatus) DeepCopy() *OperatorGroupStatus

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

func (*OperatorGroupStatus) DeepCopyInto

func (in *OperatorGroupStatus) DeepCopyInto(out *OperatorGroupStatus)

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