v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the component v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.kyma-project.io

Index

• Constants
• Variables
• type InstallInfo
  • func (in *InstallInfo) DeepCopy() *InstallInfo
  • func (in *InstallInfo) DeepCopyInto(out *InstallInfo)
• type InstallItem
  • func (in *InstallItem) DeepCopy() *InstallItem
  • func (in *InstallItem) DeepCopyInto(out *InstallItem)
• type Manifest
  • func (m *Manifest) ComponentName() string
  • func (in *Manifest) DeepCopy() *Manifest
  • func (in *Manifest) DeepCopyInto(out *Manifest)
  • func (in *Manifest) DeepCopyObject() runtime.Object
  • func (m *Manifest) Default()
  • func (m *Manifest) GetStatus() declarative.Status
  • func (m *Manifest) SetStatus(status declarative.Status)
  • func (m *Manifest) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (m *Manifest) ValidateCreate() error
  • func (m *Manifest) ValidateDelete() error
  • func (m *Manifest) ValidateUpdate(old runtime.Object) error
• type ManifestList
  • func (in *ManifestList) DeepCopy() *ManifestList
  • func (in *ManifestList) DeepCopyInto(out *ManifestList)
  • func (in *ManifestList) DeepCopyObject() runtime.Object
• type ManifestSpec
  • func (in *ManifestSpec) DeepCopy() *ManifestSpec
  • func (in *ManifestSpec) DeepCopyInto(out *ManifestSpec)
• type ManifestStatus
  • func (in *ManifestStatus) DeepCopy() *ManifestStatus
  • func (in *ManifestStatus) DeepCopyInto(out *ManifestStatus)

Constants

const ManifestKind = "Manifest"

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "operator.kyma-project.io", Version: "v1alpha1"} //nolint:gochecknoglobals

	// GroupVersionResource is group version resource.
	GroupVersionResource = GroupVersion.WithResource("manifests") //nolint:gochecknoglobals

	// GroupVersionKind is group version kind.
	GroupVersionKind = GroupVersion.WithKind("Manifest") //nolint:gochecknoglobals

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

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

Types

type InstallInfo

type InstallInfo struct {
	// Source can either be described as ImageSpec, HelmChartSpec or KustomizeSpec
	//+kubebuilder:pruning:PreserveUnknownFields
	Source runtime.RawExtension `json:"source"`

	// Name specifies a unique install name for Manifest
	Name string `json:"name"`
}

InstallInfo defines installation information.

func (*InstallInfo) DeepCopy

func (in *InstallInfo) DeepCopy() *InstallInfo

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

func (*InstallInfo) DeepCopyInto

func (in *InstallInfo) DeepCopyInto(out *InstallInfo)

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

type InstallItem

type InstallItem struct {
	// ChartName defines the name for InstallItem
	// +kubebuilder:validation:Optional
	ChartName string `json:"chartName"`

	// ClientConfig defines the client config for InstallItem
	// +kubebuilder:validation:Optional
	ClientConfig string `json:"clientConfig"`

	// Overrides defines the overrides for InstallItem
	// +kubebuilder:validation:Optional
	Overrides string `json:"overrides"`
}

InstallItem describes install information for ManifestCondition.

func (*InstallItem) DeepCopy

func (in *InstallItem) DeepCopy() *InstallItem

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

func (*InstallItem) DeepCopyInto

func (in *InstallItem) DeepCopyInto(out *InstallItem)

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

type Manifest

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

	// Spec specifies the content and configuration for Manifest
	Spec ManifestSpec `json:"spec,omitempty"`

	// Status signifies the current status of the Manifest
	// +kubebuilder:validation:Optional
	Status ManifestStatus `json:"status,omitempty"`
}

Manifest is the Schema for the manifests API.

func (*Manifest) ComponentName

func (m *Manifest) ComponentName() string

func (*Manifest) DeepCopy

func (in *Manifest) DeepCopy() *Manifest

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

func (*Manifest) DeepCopyInto

func (in *Manifest) DeepCopyInto(out *Manifest)

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

func (*Manifest) DeepCopyObject

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

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

func (*Manifest) Default

func (m *Manifest) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type.

func (*Manifest) GetStatus

func (m *Manifest) GetStatus() declarative.Status

func (*Manifest) SetStatus

func (m *Manifest) SetStatus(status declarative.Status)

func (*Manifest) SetupWebhookWithManager

func (m *Manifest) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Manifest) ValidateCreate

func (m *Manifest) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type.

func (*Manifest) ValidateDelete

func (m *Manifest) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type.

func (*Manifest) ValidateUpdate

func (m *Manifest) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.

type ManifestList

type ManifestList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []Manifest `json:"items"`
}

ManifestList contains a list of Manifest.

func (*ManifestList) DeepCopy

func (in *ManifestList) DeepCopy() *ManifestList

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

func (*ManifestList) DeepCopyInto

func (in *ManifestList) DeepCopyInto(out *ManifestList)

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

func (*ManifestList) DeepCopyObject

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

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

type ManifestSpec

type ManifestSpec struct {
	// Remote indicates if Manifest should be installed on a remote cluster
	Remote bool `json:"remote"`

	// Config specifies OCI image configuration for Manifest
	Config types.ImageSpec `json:"config,omitempty"`

	// Installs specifies a list of installations for Manifest
	Installs []InstallInfo `json:"installs"`

	//+kubebuilder:pruning:PreserveUnknownFields
	//+kubebuilder:validation:XEmbeddedResource
	//+nullable
	// Resource specifies a resource to be watched for state updates
	Resource *unstructured.Unstructured `json:"resource,omitempty"`

	// CRDs specifies the custom resource definitions' ImageSpec
	CRDs types.ImageSpec `json:"crds,omitempty"`
}

ManifestSpec defines the specification of Manifest.

func (*ManifestSpec) DeepCopy

func (in *ManifestSpec) DeepCopy() *ManifestSpec

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

func (*ManifestSpec) DeepCopyInto

func (in *ManifestSpec) DeepCopyInto(out *ManifestSpec)

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

type ManifestStatus

type ManifestStatus declarative.Status

ManifestStatus defines the observed state of Manifest.

func (*ManifestStatus) DeepCopy

func (in *ManifestStatus) DeepCopy() *ManifestStatus

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

func (*ManifestStatus) DeepCopyInto

func (in *ManifestStatus) DeepCopyInto(out *ManifestStatus)

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