Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the kubefiler v1alpha1 API group +kubebuilder:object:generate=true +groupName=kubefiler.ctera.com
Index ¶
- Variables
- type KubeFiler
- type KubeFilerExport
- type KubeFilerExportList
- type KubeFilerExportSpec
- type KubeFilerExportStatus
- type KubeFilerList
- type KubeFilerPhase
- type KubeFilerPortal
- type KubeFilerPortalCredentialsSpec
- type KubeFilerPortalList
- type KubeFilerPortalSpec
- type KubeFilerPortalStatus
- type KubeFilerPvcSpec
- type KubeFilerSpec
- type KubeFilerStatus
- type KubeFilerStorageSpec
- type VolumeIDMap
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "kubefiler.ctera.com", 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 )
Functions ¶
This section is empty.
Types ¶
type KubeFiler ¶
type KubeFiler struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KubeFilerSpec `json:"spec,omitempty"`
Status KubeFilerStatus `json:"status,omitempty"`
}
KubeFiler is the Schema for the kubefilers API
func (*KubeFiler) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFiler.
func (*KubeFiler) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubeFiler) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubeFilerExport ¶
type KubeFilerExport struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KubeFilerExportSpec `json:"spec,omitempty"`
Status KubeFilerExportStatus `json:"status,omitempty"`
}
KubeFilerExport is the Schema for the kubefilerexports API
func (*KubeFilerExport) DeepCopy ¶
func (in *KubeFilerExport) DeepCopy() *KubeFilerExport
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerExport.
func (*KubeFilerExport) DeepCopyInto ¶
func (in *KubeFilerExport) DeepCopyInto(out *KubeFilerExport)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubeFilerExport) DeepCopyObject ¶
func (in *KubeFilerExport) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubeFilerExportList ¶
type KubeFilerExportList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KubeFilerExport `json:"items"`
}
KubeFilerExportList contains a list of KubeFilerExport
func (*KubeFilerExportList) DeepCopy ¶
func (in *KubeFilerExportList) DeepCopy() *KubeFilerExportList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerExportList.
func (*KubeFilerExportList) DeepCopyInto ¶
func (in *KubeFilerExportList) DeepCopyInto(out *KubeFilerExportList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubeFilerExportList) DeepCopyObject ¶
func (in *KubeFilerExportList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubeFilerExportSpec ¶
type KubeFilerExportSpec struct {
// KubeFiler is the name of the KubeFiler object to which this KubeFilerExport is linked
KubeFiler string `json:"kubefiler,omitempty"`
// Path is the path on the KubeFiler to export
Path string `json:"path,omitempty"`
// ReadOnly controls if this export is to be read-only or not.
// +kubebuilder:default:=false
// +optional
ReadOnly bool `json:"readOnly,omitempty"`
}
KubeFilerExportSpec defines the desired state of KubeFilerExport
func (*KubeFilerExportSpec) DeepCopy ¶
func (in *KubeFilerExportSpec) DeepCopy() *KubeFilerExportSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerExportSpec.
func (*KubeFilerExportSpec) DeepCopyInto ¶
func (in *KubeFilerExportSpec) DeepCopyInto(out *KubeFilerExportSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerExportStatus ¶
type KubeFilerExportStatus struct {
// Attachments keeps a map between the nodes and the volumes IDs attached to each one
Attachments map[string]VolumeIDMap `json:"attachments,omitempty"`
}
KubeFilerExportStatus defines the observed state of KubeFilerExport
func (*KubeFilerExportStatus) DeepCopy ¶
func (in *KubeFilerExportStatus) DeepCopy() *KubeFilerExportStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerExportStatus.
func (*KubeFilerExportStatus) DeepCopyInto ¶
func (in *KubeFilerExportStatus) DeepCopyInto(out *KubeFilerExportStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerList ¶
type KubeFilerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KubeFiler `json:"items"`
}
KubeFilerList contains a list of KubeFiler
func (*KubeFilerList) DeepCopy ¶
func (in *KubeFilerList) DeepCopy() *KubeFilerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerList.
func (*KubeFilerList) DeepCopyInto ¶
func (in *KubeFilerList) DeepCopyInto(out *KubeFilerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubeFilerList) DeepCopyObject ¶
func (in *KubeFilerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubeFilerPhase ¶
type KubeFilerPhase string
KubeFilerPhase is a label for the condition of a kubefiler at the current time.
const ( // KubeFilerPending means the kubefiler has been accepted by the system, but the deployment of its child // resources has not yet started KubeFilerPending KubeFilerPhase = "Pending" // KubeFilerDeploying means that the system is currently deploying the kubefiler's child resources KubeFilerDeploying KubeFilerPhase = "Deploying" // KubeFilerDeployed means that the system has completed deploying the kubefiler's child resources and is now waiting // for them to start KubeFilerDeployed KubeFilerPhase = "Deployed" // KubeFilerConfiguring means that the kubefiler's child resources are running and are being configured KubeFilerConfiguring KubeFilerPhase = "Configuring" // KubeFilerRunning means the kubefiler's child resources are configured and running as expected KubeFilerRunning KubeFilerPhase = "Running" // KubeFilerError means that one of the kubefiler's child resources is in error state KubeFilerError KubeFilerPhase = "Error" // KubeFilerUnknown means that for some reason the state of the kubefiler could not be obtained, typically due // to an error in communicating with the host of the filer. KubeFilerUnknown KubeFilerPhase = "Unknown" )
These are the valid statuses of pods.
type KubeFilerPortal ¶
type KubeFilerPortal struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KubeFilerPortalSpec `json:"spec,omitempty"`
Status KubeFilerPortalStatus `json:"status,omitempty"`
}
KubeFilerPortal is the Schema for the kubefilerportals API
func (*KubeFilerPortal) DeepCopy ¶
func (in *KubeFilerPortal) DeepCopy() *KubeFilerPortal
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerPortal.
func (*KubeFilerPortal) DeepCopyInto ¶
func (in *KubeFilerPortal) DeepCopyInto(out *KubeFilerPortal)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubeFilerPortal) DeepCopyObject ¶
func (in *KubeFilerPortal) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubeFilerPortalCredentialsSpec ¶
type KubeFilerPortalCredentialsSpec struct {
// Secret identifies the name of the secret storing username and password keys
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength:=1
Secret string `json:"secret,omitempty"`
// UsernameKey identifies the key within the secret that stores the Username
// +kubebuilder:default:=username
// +optional
UsernameKey string `json:"username_key,omitempty"`
// PasswordKey identifies the key within the secret that stores the Password
// +kubebuilder:default:=password
// +optional
PasswordKey string `json:"password_key,omitempty"`
}
KubeFilerPortalCredentialsSpec defines the secret used to access the Portal
func (*KubeFilerPortalCredentialsSpec) DeepCopy ¶
func (in *KubeFilerPortalCredentialsSpec) DeepCopy() *KubeFilerPortalCredentialsSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerPortalCredentialsSpec.
func (*KubeFilerPortalCredentialsSpec) DeepCopyInto ¶
func (in *KubeFilerPortalCredentialsSpec) DeepCopyInto(out *KubeFilerPortalCredentialsSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerPortalList ¶
type KubeFilerPortalList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KubeFilerPortal `json:"items"`
}
KubeFilerPortalList contains a list of KubeFilerPortal
func (*KubeFilerPortalList) DeepCopy ¶
func (in *KubeFilerPortalList) DeepCopy() *KubeFilerPortalList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerPortalList.
func (*KubeFilerPortalList) DeepCopyInto ¶
func (in *KubeFilerPortalList) DeepCopyInto(out *KubeFilerPortalList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KubeFilerPortalList) DeepCopyObject ¶
func (in *KubeFilerPortalList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KubeFilerPortalSpec ¶
type KubeFilerPortalSpec struct {
// Hostname or IP address of the Portal
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength:=1
Address string `json:"address,omitempty"`
// Credentials for the Portal
// +kubebuilder:validation:Required
Credentials *KubeFilerPortalCredentialsSpec `json:"credentials,omitempty"`
// Always trust the credentials provided by the Portal
// +kubebuilder:default:=false
// +optional
Trust bool `json:"trust,omitempty"`
}
KubeFilerPortalSpec defines the desired state of KubeFilerPortal
func (*KubeFilerPortalSpec) DeepCopy ¶
func (in *KubeFilerPortalSpec) DeepCopy() *KubeFilerPortalSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerPortalSpec.
func (*KubeFilerPortalSpec) DeepCopyInto ¶
func (in *KubeFilerPortalSpec) DeepCopyInto(out *KubeFilerPortalSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerPortalStatus ¶
type KubeFilerPortalStatus struct {
}
KubeFilerPortalStatus defines the observed state of KubeFilerPortal
func (*KubeFilerPortalStatus) DeepCopy ¶
func (in *KubeFilerPortalStatus) DeepCopy() *KubeFilerPortalStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerPortalStatus.
func (*KubeFilerPortalStatus) DeepCopyInto ¶
func (in *KubeFilerPortalStatus) DeepCopyInto(out *KubeFilerPortalStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerPvcSpec ¶
type KubeFilerPvcSpec struct {
// Name of the PVC to use for the share.
// +optional
Name string `json:"name,omitempty"`
// Spec defines a new, temporary, PVC to use for the share.
// Behaves similar to the embedded PVC spec for pods.
// +optional
Spec *corev1.PersistentVolumeClaimSpec `json:"spec,omitempty"`
}
KubeFilerPvcSpec defines how a PVC may be associated with the KubeFiler.
func (*KubeFilerPvcSpec) DeepCopy ¶
func (in *KubeFilerPvcSpec) DeepCopy() *KubeFilerPvcSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerPvcSpec.
func (*KubeFilerPvcSpec) DeepCopyInto ¶
func (in *KubeFilerPvcSpec) DeepCopyInto(out *KubeFilerPvcSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerSpec ¶
type KubeFilerSpec struct {
// Portal configuration
// +kubebuilder:validation:Required
// +kubebuilder:validation:MinLength:=1
Portal string `json:"portal,omitempty"`
// Storage defines the type and location of the storage that backs this
// share.
Storage KubeFilerStorageSpec `json:"storage"`
}
KubeFilerSpec defines the desired state of KubeFiler
func (*KubeFilerSpec) DeepCopy ¶
func (in *KubeFilerSpec) DeepCopy() *KubeFilerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerSpec.
func (*KubeFilerSpec) DeepCopyInto ¶
func (in *KubeFilerSpec) DeepCopyInto(out *KubeFilerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerStatus ¶
type KubeFilerStatus struct {
// The phase of a KubeFiler is a simple, high-level summary of where the KubeFiler is in its lifecycle.
// The status of the kubefiler's child resources contain more detail about the kubefiler's status.
// There are seven possible phase values:
// Pending: The kubefiler has been accepted by the system, but the deployment of its child
// resources has not yet started
// Deploying: The system is currently deploying the kubefiler's child resources
// Deployed: The system has completed deploying the kubefiler's child resources and is now waiting
// for them to start
// Configuring: The kubefiler's child resources are running and are being configured
// Running: The kubefiler's child resources are configured and running as expected
// Error: One of the kubefiler's child resources is in error state
// Unknown: For some reason the state of the kubefiler could not be obtained, typically due
// to an error in communicating with the host of the filer.
//
// +optional
Phase KubeFilerPhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=KubeFilerPhase"`
}
KubeFilerStatus defines the observed state of KubeFiler
func (*KubeFilerStatus) DeepCopy ¶
func (in *KubeFilerStatus) DeepCopy() *KubeFilerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerStatus.
func (*KubeFilerStatus) DeepCopyInto ¶
func (in *KubeFilerStatus) DeepCopyInto(out *KubeFilerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KubeFilerStorageSpec ¶
type KubeFilerStorageSpec struct {
// Pvc defines PVC backed storage for this share.
// +optional
Pvc *KubeFilerPvcSpec `json:"pvc,omitempty"`
}
KubeFilerStorageSpec defines how storage is associated with the KubeFiler.
func (*KubeFilerStorageSpec) DeepCopy ¶
func (in *KubeFilerStorageSpec) DeepCopy() *KubeFilerStorageSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeFilerStorageSpec.
func (*KubeFilerStorageSpec) DeepCopyInto ¶
func (in *KubeFilerStorageSpec) DeepCopyInto(out *KubeFilerStorageSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VolumeIDMap ¶
VolumeIDMap defines the value of the Attachments map
func (VolumeIDMap) DeepCopy ¶
func (in VolumeIDMap) DeepCopy() VolumeIDMap
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeIDMap.
func (VolumeIDMap) DeepCopyInto ¶
func (in VolumeIDMap) DeepCopyInto(out *VolumeIDMap)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.