v1beta1

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

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

 Go to latest Published: Aug 18, 2022 License: Apache-2.0 Imports: 7 Imported by: 2

Documentation

Overview

Package v1beta1 contains API Schema definitions for the sro v1beta1 API group +kubebuilder:object:generate=true +groupName=sro.openshift.io

Index

Constants

View Source 
const (
	// Ready means the SpecialResource is operational, ie. the recipe was reconciled.
	SpecialResourceReady string = "Ready"

	// Progressing means handling of the SpecialResource is in progress.
	SpecialResourceProgressing string = "Progressing"

	// Errored means SpecialResourceOperator detected an error that might be short-lived or unrecoverable without user's intervention.
	SpecialResourceErrored string = "Errored"
)

These are valid conditions of a SpecialResource.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "sro.openshift.io", Version: "v1beta1"}

	// 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

This section is empty.

Types

type SpecialResource 

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

	Spec   SpecialResourceSpec   `json:"spec,omitempty"`
	Status SpecialResourceStatus `json:"status,omitempty"`
}

SpecialResource describes a software stack for hardware accelerators on an existing Kubernetes cluster. +kubebuilder:resource:path=specialresources,scope=Cluster +kubebuilder:resource:path=specialresources,scope=Cluster,shortName=sr +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.conditions[?(@.type=="Ready")].status` +kubebuilder:printcolumn:name="Progressing",type=string,JSONPath=`.status.conditions[?(@.type=="Progressing")].status` +kubebuilder:printcolumn:name="Errored",type=string,JSONPath=`.status.conditions[?(@.type=="Errored")].status`

func (*SpecialResource) DeepCopy 

func (in *SpecialResource) DeepCopy() *SpecialResource

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

func (*SpecialResource) DeepCopyInto 

func (in *SpecialResource) DeepCopyInto(out *SpecialResource)

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

func (*SpecialResource) DeepCopyObject 

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

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

type SpecialResourceArtifacts 

type SpecialResourceArtifacts struct {
	// +kubebuilder:validation:Optional
	HostPaths []SpecialResourcePaths `json:"hostPaths,omitempty"`
	// +kubebuilder:validation:Optional
	Images []SpecialResourceImages `json:"images,omitempty"`
	// +kubebuilder:validation:Optional
	Claims []SpecialResourceClaims `json:"claims,omitempty"`
}

SpecialResourceArtifacts is not used.

func (*SpecialResourceArtifacts) DeepCopy 

func (in *SpecialResourceArtifacts) DeepCopy() *SpecialResourceArtifacts

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

func (*SpecialResourceArtifacts) DeepCopyInto 

func (in *SpecialResourceArtifacts) DeepCopyInto(out *SpecialResourceArtifacts)

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

type SpecialResourceBuildArgs 

type SpecialResourceBuildArgs struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

SpecialResourceBuildArgs is not used.

func (*SpecialResourceBuildArgs) DeepCopy 

func (in *SpecialResourceBuildArgs) DeepCopy() *SpecialResourceBuildArgs

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

func (*SpecialResourceBuildArgs) DeepCopyInto 

func (in *SpecialResourceBuildArgs) DeepCopyInto(out *SpecialResourceBuildArgs)

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

type SpecialResourceClaims 

type SpecialResourceClaims struct {
	Name      string `json:"name"`
	MountPath string `json:"mountPath"`
}

SpecialResourceClaims is not used.

func (*SpecialResourceClaims) DeepCopy 

func (in *SpecialResourceClaims) DeepCopy() *SpecialResourceClaims

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

func (*SpecialResourceClaims) DeepCopyInto 

func (in *SpecialResourceClaims) DeepCopyInto(out *SpecialResourceClaims)

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

type SpecialResourceConfiguration 

type SpecialResourceConfiguration struct {
	Name  string   `json:"name"`
	Value []string `json:"value"`
}

SpecialResourceConfiguration is not used.

func (*SpecialResourceConfiguration) DeepCopy 

func (in *SpecialResourceConfiguration) DeepCopy() *SpecialResourceConfiguration

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

func (*SpecialResourceConfiguration) DeepCopyInto 

func (in *SpecialResourceConfiguration) DeepCopyInto(out *SpecialResourceConfiguration)

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

type SpecialResourceDependency 

type SpecialResourceDependency struct {
	helmerv1beta1.HelmChart `json:"chart,omitempty"`

	// Set are Helm hierarchical values for this chart installation.
	// +kubebuilder:validation:Optional
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:EmbeddedResource
	Set unstructured.Unstructured `json:"set,omitempty"`
}

SpecialResourceDependency is a Helm chart the SpecialResource depends on.

func (*SpecialResourceDependency) DeepCopy 

func (in *SpecialResourceDependency) DeepCopy() *SpecialResourceDependency

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

func (*SpecialResourceDependency) DeepCopyInto 

func (in *SpecialResourceDependency) DeepCopyInto(out *SpecialResourceDependency)

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

type SpecialResourceDriverContainer 

type SpecialResourceDriverContainer struct {
	// +kubebuilder:validation:Optional
	Source SpecialResourceSource `json:"source,omitempty"`

	// +kubebuilder:validation:Optional
	Artifacts SpecialResourceArtifacts `json:"artifacts,omitempty"`
}

SpecialResourceDriverContainer is not used.

func (*SpecialResourceDriverContainer) DeepCopy 

func (in *SpecialResourceDriverContainer) DeepCopy() *SpecialResourceDriverContainer

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

func (*SpecialResourceDriverContainer) DeepCopyInto 

func (in *SpecialResourceDriverContainer) DeepCopyInto(out *SpecialResourceDriverContainer)

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

type SpecialResourceGit 

type SpecialResourceGit struct {
	Ref string `json:"ref"`
	Uri string `json:"uri"`
}

SpecialResourceGit is not used.

func (*SpecialResourceGit) DeepCopy 

func (in *SpecialResourceGit) DeepCopy() *SpecialResourceGit

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

func (*SpecialResourceGit) DeepCopyInto 

func (in *SpecialResourceGit) DeepCopyInto(out *SpecialResourceGit)

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

type SpecialResourceImages 

type SpecialResourceImages struct {
	Name       string                 `json:"name"`
	Kind       string                 `json:"kind"`
	Namespace  string                 `json:"namespace"`
	PullSecret string                 `json:"pullsecret,omitempty"`
	Paths      []SpecialResourcePaths `json:"path"`
}

SpecialResourceImages is not used.

func (*SpecialResourceImages) DeepCopy 

func (in *SpecialResourceImages) DeepCopy() *SpecialResourceImages

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

func (*SpecialResourceImages) DeepCopyInto 

func (in *SpecialResourceImages) DeepCopyInto(out *SpecialResourceImages)

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

type SpecialResourceList 

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

	// List of SpecialResources. More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
	Items []SpecialResource `json:"items"`
}

SpecialResourceList is a list of SpecialResource objects.

func (*SpecialResourceList) DeepCopy 

func (in *SpecialResourceList) DeepCopy() *SpecialResourceList

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

func (*SpecialResourceList) DeepCopyInto 

func (in *SpecialResourceList) DeepCopyInto(out *SpecialResourceList)

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

func (*SpecialResourceList) DeepCopyObject 

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

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

type SpecialResourcePaths 

type SpecialResourcePaths struct {
	SourcePath     string `json:"sourcePath"`
	DestinationDir string `json:"destinationDir"`
}

SpecialResourcePaths is not used.

func (*SpecialResourcePaths) DeepCopy 

func (in *SpecialResourcePaths) DeepCopy() *SpecialResourcePaths

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

func (*SpecialResourcePaths) DeepCopyInto 

func (in *SpecialResourcePaths) DeepCopyInto(out *SpecialResourcePaths)

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

type SpecialResourceSource 

type SpecialResourceSource struct {
	Git SpecialResourceGit `json:"git,omitempty"`
}

SpecialResourceSource is not used.

func (*SpecialResourceSource) DeepCopy 

func (in *SpecialResourceSource) DeepCopy() *SpecialResourceSource

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

func (*SpecialResourceSource) DeepCopyInto 

func (in *SpecialResourceSource) DeepCopyInto(out *SpecialResourceSource)

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

type SpecialResourceSpec 

type SpecialResourceSpec struct {
	// Chart describes the Helm chart that needs to be installed.
	// +kubebuilder:validation:Required
	Chart helmerv1beta1.HelmChart `json:"chart"`

	// Namespace describes in which namespace the chart will be installed.
	// +kubebuilder:validation:Required
	Namespace string `json:"namespace"`

	// ForceUpgrade is not used.
	// +kubebuilder:validation:Optional
	ForceUpgrade bool `json:"forceUpgrade"`

	// Debug enables additional logging.
	// +kubebuilder:validation:Optional
	Debug bool `json:"debug"`

	// Set is a user-defined hierarchical value tree from where the chart takes its parameters.
	// +kubebuilder:validation:Optional
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:EmbeddedResource
	Set unstructured.Unstructured `json:"set,omitempty"`

	// DriverContainer is not used.
	// +kubebuilder:validation:Optional
	DriverContainer SpecialResourceDriverContainer `json:"driverContainer,omitempty"`

	// NodeSelector is used to determine on which nodes the software stack should be installed.
	// +kubebuilder:validation:Optional
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

	// Dependencies is a list of dependencies required by this SpecialReosurce.
	// +kubebuilder:validation:Optional
	Dependencies []SpecialResourceDependency `json:"dependencies,omitempty"`
	// +kubebuilder:validation:Optional
	ManagementState operatorv1.ManagementState `json:"managementState,omitempty"`
}

SpecialResourceSpec describes the desired state of the resource, such as the chart to be used and a selector on which nodes it should be installed. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +kubebuilder:validation:Required

func (*SpecialResourceSpec) DeepCopy 

func (in *SpecialResourceSpec) DeepCopy() *SpecialResourceSpec

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

func (*SpecialResourceSpec) DeepCopyInto 

func (in *SpecialResourceSpec) DeepCopyInto(out *SpecialResourceSpec)

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

type SpecialResourceStatus 

type SpecialResourceStatus struct {
	// State describes at which step the chart installation is.
	// TODO: Remove on API version bump.
	State string `json:"state"`

	// Conditions contain observations about SpecialResource's current state
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

SpecialResourceStatus is the most recently observed status of the SpecialResource. It is populated by the system and is read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

func (*SpecialResourceStatus) DeepCopy 

func (in *SpecialResourceStatus) DeepCopy() *SpecialResourceStatus

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

func (*SpecialResourceStatus) DeepCopyInto 

func (in *SpecialResourceStatus) DeepCopyInto(out *SpecialResourceStatus)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.