...

Package v1alpha1

import "github.com/openshift/api/platform/v1alpha1"
Overview
Index

Overview ▾

+groupName=platform.openshift.io Package v1alpha1 is the v1alpha1 version of the API.

Index ▾

Variables
type ActiveBundleDeployment
    func (in *ActiveBundleDeployment) DeepCopy() *ActiveBundleDeployment
    func (in *ActiveBundleDeployment) DeepCopyInto(out *ActiveBundleDeployment)
    func (ActiveBundleDeployment) SwaggerDoc() map[string]string
type Package
    func (in *Package) DeepCopy() *Package
    func (in *Package) DeepCopyInto(out *Package)
    func (Package) SwaggerDoc() map[string]string
type PlatformOperator
    func (in *PlatformOperator) DeepCopy() *PlatformOperator
    func (in *PlatformOperator) DeepCopyInto(out *PlatformOperator)
    func (in *PlatformOperator) DeepCopyObject() runtime.Object
    func (PlatformOperator) SwaggerDoc() map[string]string
type PlatformOperatorList
    func (in *PlatformOperatorList) DeepCopy() *PlatformOperatorList
    func (in *PlatformOperatorList) DeepCopyInto(out *PlatformOperatorList)
    func (in *PlatformOperatorList) DeepCopyObject() runtime.Object
    func (PlatformOperatorList) SwaggerDoc() map[string]string
type PlatformOperatorSpec
    func (in *PlatformOperatorSpec) DeepCopy() *PlatformOperatorSpec
    func (in *PlatformOperatorSpec) DeepCopyInto(out *PlatformOperatorSpec)
    func (PlatformOperatorSpec) SwaggerDoc() map[string]string
type PlatformOperatorStatus
    func (in *PlatformOperatorStatus) DeepCopy() *PlatformOperatorStatus
    func (in *PlatformOperatorStatus) DeepCopyInto(out *PlatformOperatorStatus)
    func (PlatformOperatorStatus) SwaggerDoc() map[string]string

Package files

doc.go register.go types.go zz_generated.deepcopy.go zz_generated.swagger_doc_generated.go

Variables

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

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

type ActiveBundleDeployment

ActiveBundleDeployment references a BundleDeployment resource.

type ActiveBundleDeployment struct {
    // name is the metadata.name of the referenced BundleDeployment object.
    // +kubebuilder:validation:Required
    Name string `json:"name"`
}

func (*ActiveBundleDeployment) DeepCopy

func (in *ActiveBundleDeployment) DeepCopy() *ActiveBundleDeployment

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

func (*ActiveBundleDeployment) DeepCopyInto

func (in *ActiveBundleDeployment) DeepCopyInto(out *ActiveBundleDeployment)

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

func (ActiveBundleDeployment) SwaggerDoc

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

type Package

Package contains fields to configure which OLM package this PlatformOperator will install

type Package struct {
    // name contains the desired OLM-based Operator package name
    // that is defined in an existing CatalogSource resource in the cluster.
    //
    // This configured package will be managed with the cluster's lifecycle. In
    // the current implementation, it will be retrieving this name from a list of
    // supported operators out of the catalogs included with OpenShift.
    // +kubebuilder:validation:Required
    //
    // +kubebuilder:validation:Pattern:=[a-z0-9]([-a-z0-9]*[a-z0-9])?
    // +kubebuilder:validation:MaxLength:=56
    // ---
    // + More restrictions to package names supported is an intentional design
    // + decision that, while limiting to user options, allows code built on these
    // + API's to make more confident assumptions on data structure.
    Name string `json:"name"`
}

func (*Package) DeepCopy

func (in *Package) DeepCopy() *Package

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

func (*Package) DeepCopyInto

func (in *Package) DeepCopyInto(out *Package)

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

func (Package) SwaggerDoc

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

type PlatformOperator

PlatformOperator is the Schema for the PlatformOperators API.

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 PlatformOperator 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   PlatformOperatorSpec   `json:"spec"`
    Status PlatformOperatorStatus `json:"status,omitempty"`
}

func (*PlatformOperator) DeepCopy

func (in *PlatformOperator) DeepCopy() *PlatformOperator

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

func (*PlatformOperator) DeepCopyInto

func (in *PlatformOperator) DeepCopyInto(out *PlatformOperator)

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

func (*PlatformOperator) DeepCopyObject

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

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

func (PlatformOperator) SwaggerDoc

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

type PlatformOperatorList

PlatformOperatorList contains a list of PlatformOperators

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 PlatformOperatorList 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,omitempty"`

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

func (*PlatformOperatorList) DeepCopy

func (in *PlatformOperatorList) DeepCopy() *PlatformOperatorList

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

func (*PlatformOperatorList) DeepCopyInto

func (in *PlatformOperatorList) DeepCopyInto(out *PlatformOperatorList)

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

func (*PlatformOperatorList) DeepCopyObject

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

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

func (PlatformOperatorList) SwaggerDoc

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

type PlatformOperatorSpec

PlatformOperatorSpec defines the desired state of PlatformOperator.

type PlatformOperatorSpec struct {
    // package contains the desired package and its configuration for this
    // PlatformOperator.
    // +kubebuilder:validation:Required
    Package Package `json:"package"`
}

func (*PlatformOperatorSpec) DeepCopy

func (in *PlatformOperatorSpec) DeepCopy() *PlatformOperatorSpec

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

func (*PlatformOperatorSpec) DeepCopyInto

func (in *PlatformOperatorSpec) DeepCopyInto(out *PlatformOperatorSpec)

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

func (PlatformOperatorSpec) SwaggerDoc

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

type PlatformOperatorStatus

PlatformOperatorStatus defines the observed state of PlatformOperator

type PlatformOperatorStatus struct {
    // conditions represent the latest available observations of a platform operator's current state.
    // +optional
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`

    // activeBundleDeployment is the reference to the BundleDeployment resource that's
    // being managed by this PO resource. If this field is not populated in the status
    // then it means the PlatformOperator has either not been installed yet or is
    // failing to install.
    // +optional
    ActiveBundleDeployment ActiveBundleDeployment `json:"activeBundleDeployment,omitempty"`
}

func (*PlatformOperatorStatus) DeepCopy

func (in *PlatformOperatorStatus) DeepCopy() *PlatformOperatorStatus

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

func (*PlatformOperatorStatus) DeepCopyInto

func (in *PlatformOperatorStatus) DeepCopyInto(out *PlatformOperatorStatus)

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

func (PlatformOperatorStatus) SwaggerDoc

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