v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the efs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=efs.storage.openshift.io

Package v1alpha1 contains API Schema definitions for the efs v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=efs.storage.openshift.io

Index

• Variables
• type EFSProvisioner
  • func (in *EFSProvisioner) DeepCopy() *EFSProvisioner
  • func (in *EFSProvisioner) DeepCopyInto(out *EFSProvisioner)
  • func (in *EFSProvisioner) DeepCopyObject() runtime.Object
  • func (p *EFSProvisioner) SetDefaults() bool
• type EFSProvisionerList
  • func (in *EFSProvisionerList) DeepCopy() *EFSProvisionerList
  • func (in *EFSProvisionerList) DeepCopyInto(out *EFSProvisionerList)
  • func (in *EFSProvisionerList) DeepCopyObject() runtime.Object
• type EFSProvisionerSpec
  • func (in *EFSProvisionerSpec) DeepCopy() *EFSProvisionerSpec
  • func (in *EFSProvisionerSpec) DeepCopyInto(out *EFSProvisionerSpec)
• type EFSProvisionerStatus
  • func (in *EFSProvisionerStatus) DeepCopy() *EFSProvisionerStatus
  • func (in *EFSProvisionerStatus) DeepCopyInto(out *EFSProvisionerStatus)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "efs.storage.openshift.io", Version: "v1alpha1"}

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

Types

type EFSProvisioner

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

	Spec   EFSProvisionerSpec   `json:"spec,omitempty"`
	Status EFSProvisionerStatus `json:"status,omitempty"`
}

EFSProvisioner is the Schema for the efsprovisioners API +k8s:openapi-gen=true

func (*EFSProvisioner) DeepCopy

func (in *EFSProvisioner) DeepCopy() *EFSProvisioner

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

func (*EFSProvisioner) DeepCopyInto

func (in *EFSProvisioner) DeepCopyInto(out *EFSProvisioner)

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

func (*EFSProvisioner) DeepCopyObject

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

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

func (*EFSProvisioner) SetDefaults

func (p *EFSProvisioner) SetDefaults() bool

SetDefaults sets the default vaules for the external provisioner spec and returns true if the spec was changed

type EFSProvisionerList

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

EFSProvisionerList contains a list of EFSProvisioner

func (*EFSProvisionerList) DeepCopy

func (in *EFSProvisionerList) DeepCopy() *EFSProvisionerList

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

func (*EFSProvisionerList) DeepCopyInto

func (in *EFSProvisionerList) DeepCopyInto(out *EFSProvisionerList)

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

func (*EFSProvisionerList) DeepCopyObject

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

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

type EFSProvisionerSpec

type EFSProvisionerSpec struct {
	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
	// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
	operatorv1alpha1.OperatorSpec `json:",inline"`

	// Number of replicas to deploy for a provisioner deployment.
	// Optional, defaults to 1.
	Replicas int32 `json:"replicas"`

	// Name of storage class to create. If the storage class already exists, it will not be updated.
	//// This allows users to create their storage classes in advance.
	// Required, no default.
	StorageClassName string `json:"storageClassName"`

	// The reclaim policy of the storage class
	// Optional, defaults to OpenShift default "Delete."
	ReclaimPolicy *v1.PersistentVolumeReclaimPolicy `json:"reclaimPolicy,omitempty"`

	// ID of the EFS to use as base for dynamically provisioned PVs.
	// Such EFS must be created by admin before starting a provisioner!
	// Required, no default.
	FSID string `json:"fsid"`

	// AWS region the provisioner is running in
	// Required, no default.
	Region string `json:"region"`

	// Custom DNS name of the EFS share to mount instead of fsid.efs.region.amazonaws.com
	// Optional, no default.
	DNSName *string `json:"dnsName,omitempty"`

	// Subdirectory on the EFS specified by FSID that should be used as base
	// of all dynamically provisioner PVs.
	// Optional, defaults to "/".
	BasePath *string `json:"basePath,omitempty"`

	// Group that can write to the EFS. The provisioner will run with this
	// supplemental group to be able to create new PVs.
	// Optional, no default.
	SupplementalGroup *int64 `json:"supplementalGroup,omitempty"`

	// Whether to allocate a unique GID in the range gidMin-gidMax to each
	// volume. Each volume will be secured to its allocated GID. Any pod that
	// consumes the claim will be able to read/write the
	// volume because the pod will automatically receive the volume's allocated
	// GID as a supplemental group, but non-pod mounters outside the system will
	// not have read/write access unless they have the GID or root privileges.
	// Optional, defaults to true.
	GidAllocate *bool `json:"gidAllocate,omitempty"`

	// Min in allocation range gidMin-gidMax when GidAllocate is true.
	// Optional, defaults to 2000.
	GidMin *int `json:"gidMin,omitempty"`

	// Max in allocation range gidMin-gidMax when GidAllocate is true.
	// Optional, defaults to 2147483647.
	GidMax *int `json:"gidMax,omitempty"`
}

EFSProvisionerSpec defines the desired state of EFSProvisioner

func (*EFSProvisionerSpec) DeepCopy

func (in *EFSProvisionerSpec) DeepCopy() *EFSProvisionerSpec

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

func (*EFSProvisionerSpec) DeepCopyInto

func (in *EFSProvisionerSpec) DeepCopyInto(out *EFSProvisionerSpec)

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

type EFSProvisionerStatus

type EFSProvisionerStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
	operatorv1alpha1.OperatorStatus `json:",inline"`
}

EFSProvisionerStatus defines the observed state of EFSProvisioner

func (*EFSProvisionerStatus) DeepCopy

func (in *EFSProvisionerStatus) DeepCopy() *EFSProvisionerStatus

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

func (*EFSProvisionerStatus) DeepCopyInto

func (in *EFSProvisionerStatus) DeepCopyInto(out *EFSProvisionerStatus)

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