v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the hwmgr-plugin.oran.openshift.io v1alpha1 API group +kubebuilder:object:generate=true +groupName=hwmgr-plugin.oran.openshift.io

Index

• Variables
• type ConditionReason
• type ConditionType
• type DellData
  • func (in *DellData) DeepCopy() *DellData
  • func (in *DellData) DeepCopyInto(out *DellData)
• type HardwareManager
  • func (in *HardwareManager) DeepCopy() *HardwareManager
  • func (in *HardwareManager) DeepCopyInto(out *HardwareManager)
  • func (in *HardwareManager) DeepCopyObject() runtime.Object
• type HardwareManagerAdaptorID
• type HardwareManagerList
  • func (in *HardwareManagerList) DeepCopy() *HardwareManagerList
  • func (in *HardwareManagerList) DeepCopyInto(out *HardwareManagerList)
  • func (in *HardwareManagerList) DeepCopyObject() runtime.Object
• type HardwareManagerSpec
  • func (in *HardwareManagerSpec) DeepCopy() *HardwareManagerSpec
  • func (in *HardwareManagerSpec) DeepCopyInto(out *HardwareManagerSpec)
• type HardwareManagerStatus
  • func (in *HardwareManagerStatus) DeepCopy() *HardwareManagerStatus
  • func (in *HardwareManagerStatus) DeepCopyInto(out *HardwareManagerStatus)
• type LoopbackData
  • func (in *LoopbackData) DeepCopy() *LoopbackData
  • func (in *LoopbackData) DeepCopyInto(out *LoopbackData)
• type OAuthGrantType
• type PerSiteResourcePoolList
  • func (in PerSiteResourcePoolList) DeepCopy() PerSiteResourcePoolList
  • func (in PerSiteResourcePoolList) DeepCopyInto(out *PerSiteResourcePoolList)
• type ResourcePoolList
  • func (in ResourcePoolList) DeepCopy() ResourcePoolList
  • func (in ResourcePoolList) DeepCopyInto(out *ResourcePoolList)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "hwmgr-plugin.oran.openshift.io", Version: "v1alpha1"}

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

var ConditionReasons = struct {
	Completed  ConditionReason
	Failed     ConditionReason
	InProgress ConditionReason
}{
	Completed:  "Completed",
	Failed:     "Failed",
	InProgress: "InProgress",
}

ConditionReasons define the different reasons that conditions will be set for

var ConditionTypes = struct {
	Validation ConditionType
}{
	Validation: "Validation",
}

ConditionTypes define the different types of conditions that will be set

var OAuthGrantTypes = struct {
	ClientCredentials OAuthGrantType
	Password          OAuthGrantType
}{
	ClientCredentials: "client_credentials",
	Password:          "password",
}

OAuthGrantTypes define the different reasons that conditions will be set for

var SupportedAdaptors = struct {
	Loopback HardwareManagerAdaptorID
	Dell     HardwareManagerAdaptorID
}{
	Loopback: "loopback",
	Dell:     "dell-hwmgr",
}

SupportedAdaptors defines the string values for valid stages

Types

type ConditionReason

type ConditionReason string

ConditionReason is a string representing the condition's reason

type ConditionType

type ConditionType string

ConditionType is a string representing the condition's type

type DellData

type DellData struct {
	// +kubebuilder:validation:Required
	// +required
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	AuthSecret string `json:"authSecret"`

	// +kubebuilder:validation:Required
	// +required
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	ApiUrl string `json:"apiUrl"`

	// CaBundleName references a config map that contains a set of custom CA certificates to be used when communicating
	// with a hardware manager that has its TLS certificate signed by a non-public CA certificate.
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Custom CA Certificates",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:text"}
	CaBundleName *string `json:"caBundleName,omitempty"`

	// Tenant allows the specification of the hardware manager tenant to use for this instance.
	// +optional
	Tenant *string `json:"tenant,omitempty"`

	// insecureSkipTLSVerify indicates that the plugin should not confirm the validity of the TLS certificate of the hardware manager.
	// This is insecure and is not recommended.
	// +optional
	InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
}

DellData defines configuration data for dell-hwmgr adaptor instance

func (*DellData) DeepCopy

func (in *DellData) DeepCopy() *DellData

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

func (*DellData) DeepCopyInto

func (in *DellData) DeepCopyInto(out *DellData)

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

type HardwareManager

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

	Spec   HardwareManagerSpec   `json:"spec,omitempty"`
	Status HardwareManagerStatus `json:"status,omitempty"`
}

HardwareManager is the Schema for the hardwaremanagers API

func (*HardwareManager) DeepCopy

func (in *HardwareManager) DeepCopy() *HardwareManager

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

func (*HardwareManager) DeepCopyInto

func (in *HardwareManager) DeepCopyInto(out *HardwareManager)

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

func (*HardwareManager) DeepCopyObject

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

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

type HardwareManagerAdaptorID

type HardwareManagerAdaptorID string

HardwareManagerAdaptorID defines the type for the Hardware Manager Adaptor

type HardwareManagerList

type HardwareManagerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []HardwareManager `json:"items"`
}

HardwareManagerList contains a list of HardwareManager

func (*HardwareManagerList) DeepCopy

func (in *HardwareManagerList) DeepCopy() *HardwareManagerList

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

func (*HardwareManagerList) DeepCopyInto

func (in *HardwareManagerList) DeepCopyInto(out *HardwareManagerList)

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

func (*HardwareManagerList) DeepCopyObject

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

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

type HardwareManagerSpec

type HardwareManagerSpec struct {

	// The adaptor ID
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=loopback;dell-hwmgr
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	AdaptorID HardwareManagerAdaptorID `json:"adaptorId"`

	// Config data for an instance of the loopback adaptor
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	LoopbackData *LoopbackData `json:"loopbackData,omitempty"`

	// Config data for an instance of the dell-hwmgr adaptor
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	DellData *DellData `json:"dellData,omitempty"`
}

HardwareManagerSpec defines the desired state of HardwareManager

func (*HardwareManagerSpec) DeepCopy

func (in *HardwareManagerSpec) DeepCopy() *HardwareManagerSpec

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

func (*HardwareManagerSpec) DeepCopyInto

func (in *HardwareManagerSpec) DeepCopyInto(out *HardwareManagerSpec)

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

type HardwareManagerStatus

type HardwareManagerStatus struct {
	// +operator-sdk:csv:customresourcedefinitions:type=status
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Conditions describe the state of the UpdateService resource.
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +kubebuilder:validation:Optional
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`

	// ResourcePools provides a per-site list of resource pools
	// +operator-sdk:csv:customresourcedefinitions:type=status
	ResourcePools PerSiteResourcePoolList `json:"resourcePools,omitempty"`
}

HardwareManagerStatus defines the observed state of HardwareManager

func (*HardwareManagerStatus) DeepCopy

func (in *HardwareManagerStatus) DeepCopy() *HardwareManagerStatus

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

func (*HardwareManagerStatus) DeepCopyInto

func (in *HardwareManagerStatus) DeepCopyInto(out *HardwareManagerStatus)

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

type LoopbackData

type LoopbackData struct {
	// A test string
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	AddtionalInfo string `json:"additionalInfo,omitempty"`
}

LoopbackData defines configuration data for loopback adaptor instance

func (*LoopbackData) DeepCopy

func (in *LoopbackData) DeepCopy() *LoopbackData

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

func (*LoopbackData) DeepCopyInto

func (in *LoopbackData) DeepCopyInto(out *LoopbackData)

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

type OAuthGrantType

type OAuthGrantType string

OAuthGrantType is a string representing the OAuth2 grant type

type PerSiteResourcePoolList

type PerSiteResourcePoolList map[string]ResourcePoolList

func (PerSiteResourcePoolList) DeepCopy

func (in PerSiteResourcePoolList) DeepCopy() PerSiteResourcePoolList

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

func (PerSiteResourcePoolList) DeepCopyInto

func (in PerSiteResourcePoolList) DeepCopyInto(out *PerSiteResourcePoolList)

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

type ResourcePoolList

type ResourcePoolList []string

func (ResourcePoolList) DeepCopy

func (in ResourcePoolList) DeepCopy() ResourcePoolList

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

func (ResourcePoolList) DeepCopyInto

func (in ResourcePoolList) DeepCopyInto(out *ResourcePoolList)

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