v1alpha1

package
v0.0.0-...-5e84c48 Latest Latest
Warning

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

Go to latest
Published: Nov 25, 2022 License: Apache-2.0 Imports: 11 Imported by: 6

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

View Source
const ManifestKind = "Manifest"

Variables

View Source
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
)

Functions

This section is empty.

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

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

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

Manifest is the Schema for the manifests API.

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

func (m *Manifest) IsSpecUpdated() bool

func (*Manifest) SetObservedGeneration

func (m *Manifest) SetObservedGeneration() *Manifest

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 ManifestCondition

type ManifestCondition struct {
	// Type of ManifestCondition
	Type ManifestConditionType `json:"type"`

	// Status of the ManifestCondition
	// +kubebuilder:validation:Enum=True;False;Unknown
	Status ManifestConditionStatus `json:"status"`

	// Human-readable message indicating details about the last status transition.
	// +kubebuilder:validation:Optional
	Message string `json:"message"`

	// Machine-readable text indicating the reason for the condition's last transition.
	// +kubebuilder:validation:Optional
	Reason string `json:"reason"`

	// Timestamp for when Manifest last transitioned from one status to another.
	// +kubebuilder:validation:Optional
	LastTransitionTime *metav1.Time `json:"lastTransitionTime"`

	// InstallInfo contains a list of installations for Manifest
	// +kubebuilder:validation:Optional
	InstallInfo InstallItem `json:"installInfo"`
}

ManifestCondition describes condition information for Manifest.

func (*ManifestCondition) DeepCopy

func (in *ManifestCondition) DeepCopy() *ManifestCondition

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

func (*ManifestCondition) DeepCopyInto

func (in *ManifestCondition) DeepCopyInto(out *ManifestCondition)

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

type ManifestConditionStatus

type ManifestConditionStatus string
const (
	// ConditionStatusTrue signifies ManifestConditionStatus true.
	ConditionStatusTrue ManifestConditionStatus = "True"

	// ConditionStatusFalse signifies ManifestConditionStatus false.
	ConditionStatusFalse ManifestConditionStatus = "False"

	// ConditionStatusUnknown signifies ManifestConditionStatus unknown.
	ConditionStatusUnknown ManifestConditionStatus = "Unknown"
)

Valid ManifestCondition Status.

type ManifestConditionType

type ManifestConditionType string
const (
	// ConditionTypeReady represents ManifestConditionType Ready.
	ConditionTypeReady ManifestConditionType = "Ready"
)

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
	// +kubebuilder:validation:Optional
	// +kubebuilder:default:=true
	Remote bool `json:"remote"`

	// Config specifies OCI image configuration for Manifest
	// +kubebuilder:validation:Optional
	Config types.ImageSpec `json:"config"`

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

	//+kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:Optional
	// Resource specifies a resource to be watched for state updates
	Resource unstructured.Unstructured `json:"resource"`

	// CRDs specifies the custom resource definitions' ImageSpec
	// +kubebuilder:validation:Optional
	CRDs types.ImageSpec `json:"crds"`
}

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 ManifestState

type ManifestState string

+kubebuilder:validation:Enum=Processing;Deleting;Ready;Error

const (
	// ManifestStateReady signifies Manifest is ready.
	ManifestStateReady ManifestState = "Ready"

	// ManifestStateProcessing signifies Manifest is reconciling.
	ManifestStateProcessing ManifestState = "Processing"

	// ManifestStateError signifies an error for Manifest.
	ManifestStateError ManifestState = "Error"

	// ManifestStateDeleting signifies Manifest is being deleted.
	ManifestStateDeleting ManifestState = "Deleting"
)

Valid Helm States.

type ManifestStatus

type ManifestStatus struct {
	// State signifies current state of Manifest
	// +kubebuilder:validation:Enum=Ready;Processing;Error;Deleting;
	State ManifestState `json:"state"`

	// Conditions is a list of status conditions to indicate the status of Manifest
	// +kubebuilder:validation:Optional
	Conditions []ManifestCondition `json:"conditions"`

	// ObservedGeneration
	// +kubebuilder:validation:Optional
	ObservedGeneration int64 `json:"observedGeneration"`
}

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL