Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the crossplane core v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/crossplaneio/crossplane/pkg/apis/storage +k8s:defaulter-gen=TypeMeta +groupName=storage.crossplane.io
Package v1alpha1 contains API Schema definitions for the crossplane core v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/crossplaneio/crossplane/pkg/apis/storage +k8s:defaulter-gen=TypeMeta +groupName=storage.crossplane.io
Index ¶
- Constants
- Variables
- type Bucket
- func (b *Bucket) ClaimStatus() *corev1alpha1.ResourceClaimStatus
- func (b *Bucket) ClassRef() *corev1.ObjectReference
- func (in *Bucket) DeepCopy() *Bucket
- func (in *Bucket) DeepCopyInto(out *Bucket)
- func (in *Bucket) DeepCopyObject() runtime.Object
- func (b *Bucket) ObjectReference() *corev1.ObjectReference
- func (b *Bucket) OwnerReference() metav1.OwnerReference
- func (b *Bucket) ResourceRef() *corev1.ObjectReference
- func (b *Bucket) SetResourceRef(ref *corev1.ObjectReference)
- type BucketList
- type BucketSpec
- type LocalPermissionType
- type MySQLInstance
- func (m *MySQLInstance) ClaimStatus() *corev1alpha1.ResourceClaimStatus
- func (m *MySQLInstance) ClassRef() *corev1.ObjectReference
- func (in *MySQLInstance) DeepCopy() *MySQLInstance
- func (in *MySQLInstance) DeepCopyInto(out *MySQLInstance)
- func (in *MySQLInstance) DeepCopyObject() runtime.Object
- func (m *MySQLInstance) ObjectReference() *corev1.ObjectReference
- func (m *MySQLInstance) OwnerReference() metav1.OwnerReference
- func (m *MySQLInstance) ResourceRef() *corev1.ObjectReference
- func (m *MySQLInstance) SetResourceRef(ref *corev1.ObjectReference)
- type MySQLInstanceList
- type MySQLInstanceSpec
- type PostgreSQLInstance
- func (p *PostgreSQLInstance) ClaimStatus() *corev1alpha1.ResourceClaimStatus
- func (p *PostgreSQLInstance) ClassRef() *corev1.ObjectReference
- func (in *PostgreSQLInstance) DeepCopy() *PostgreSQLInstance
- func (in *PostgreSQLInstance) DeepCopyInto(out *PostgreSQLInstance)
- func (in *PostgreSQLInstance) DeepCopyObject() runtime.Object
- func (p *PostgreSQLInstance) ObjectReference() *corev1.ObjectReference
- func (p *PostgreSQLInstance) OwnerReference() metav1.OwnerReference
- func (p *PostgreSQLInstance) ResourceRef() *corev1.ObjectReference
- func (p *PostgreSQLInstance) SetResourceRef(ref *corev1.ObjectReference)
- type PostgreSQLInstanceList
- type PostgreSQLInstanceSpec
- type PredefinedACL
Constants ¶
const ( Group = "storage.crossplane.io" Version = "v1alpha1" APIVersion = Group + "/" + Version MySQLInstanceKind = "mysqlinstance" MySQLInstanceKindAPIVersion = MySQLInstanceKind + "." + APIVersion PostgreSQLInstanceKind = "postgresqlinstance" PostgreSQLInstanceKindAPIVersion = PostgreSQLInstanceKind + "." + APIVersion BucketKind = "bucket" BucketKindAPIVersion = BucketKind + "." + APIVersion )
Kubernetes Group, Version, and Kind metadata.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
This section is empty.
Types ¶
type Bucket ¶
type Bucket struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BucketSpec `json:"spec,omitempty"` Status corev1alpha1.ResourceClaimStatus `json:"status,omitempty"` }
Bucket is the Schema for the Bucket API +k8s:openapi-gen=true +groupName=storage +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status.bindingPhase" +kubebuilder:printcolumn:name="CLASS",type="string",JSONPath=".spec.classReference.name" +kubebuilder:printcolumn:name="PREDEFINED-ACL",type="string",JSONPath=".spec.predefinedACL" +kubebuilder:printcolumn:name="LOCAL-PERMISSION",type="string",JSONPath=".spec.localPermission" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
func (*Bucket) ClaimStatus ¶ added in v0.2.0
func (b *Bucket) ClaimStatus() *corev1alpha1.ResourceClaimStatus
ClaimStatus returns the status of this resource claim.
func (*Bucket) ClassRef ¶ added in v0.2.0
func (b *Bucket) ClassRef() *corev1.ObjectReference
ClassRef returns the resource class used by this resource claim.
func (*Bucket) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Bucket.
func (*Bucket) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Bucket) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Bucket) ObjectReference ¶ added in v0.2.0
func (b *Bucket) ObjectReference() *corev1.ObjectReference
ObjectReference to this S3Bucket
func (*Bucket) OwnerReference ¶ added in v0.2.0
func (b *Bucket) OwnerReference() metav1.OwnerReference
OwnerReference to use this instance as an owner
func (*Bucket) ResourceRef ¶ added in v0.2.0
func (b *Bucket) ResourceRef() *corev1.ObjectReference
ResourceRef returns the resource claimed by this resource claim.
func (*Bucket) SetResourceRef ¶ added in v0.2.0
func (b *Bucket) SetResourceRef(ref *corev1.ObjectReference)
SetResourceRef specifies the resource claimed by this resource claim.
type BucketList ¶
type BucketList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Bucket `json:"items"` }
BucketList contains a list of Buckets
func (*BucketList) DeepCopy ¶
func (in *BucketList) DeepCopy() *BucketList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketList.
func (*BucketList) DeepCopyInto ¶
func (in *BucketList) DeepCopyInto(out *BucketList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BucketList) DeepCopyObject ¶
func (in *BucketList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BucketSpec ¶
type BucketSpec struct { ClassRef *corev1.ObjectReference `json:"classReference,omitempty"` ResourceRef *corev1.ObjectReference `json:"resourceName,omitempty"` Selector metav1.LabelSelector `json:"selector,omitempty"` // Name properties // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:MinLength=3 Name string `json:"name,omitempty"` // +kubebuilder:validation:Enum=Private,PublicRead,PublicReadWrite,AuthenticatedRead // NOTE: AWS S3 and GCP Bucket values (not in Azure) PredefinedACL *PredefinedACL `json:"predefinedACL,omitempty"` // LocalPermission is the permissions granted on the bucket for the provider specific // bucket service account that is available in a secret after provisioning. // +kubebuilder:validation:Enum=Read,Write,ReadWrite // NOTE: AWS S3 Specific value LocalPermission *LocalPermissionType `json:"localPermission,omitempty"` // +kubebuilder:validation:MaxLength=255 // +kubebuilder:validation:MinLength=1 ConnectionSecretNameOverride string `json:"connectionSecretNameOverride,omitempty"` }
BucketSpec defines the desired state of Bucket
func (*BucketSpec) DeepCopy ¶
func (in *BucketSpec) DeepCopy() *BucketSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketSpec.
func (*BucketSpec) DeepCopyInto ¶
func (in *BucketSpec) DeepCopyInto(out *BucketSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LocalPermissionType ¶ added in v0.2.0
type LocalPermissionType string
LocalPermissionType - Base type for LocalPermissions
const ( // ReadOnlyPermission will grant read objects in a bucket ReadOnlyPermission LocalPermissionType = "Read" // WriteOnlyPermission will grant write/delete objects in a bucket WriteOnlyPermission LocalPermissionType = "Write" // ReadWritePermission LocalPermissionType Grant both read and write permissions ReadWritePermission LocalPermissionType = "ReadWrite" )
type MySQLInstance ¶
type MySQLInstance struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MySQLInstanceSpec `json:"spec,omitempty"` Status corev1alpha1.ResourceClaimStatus `json:"status,omitempty"` }
MySQLInstance is the CRD type for abstract MySQL database instances +k8s:openapi-gen=true +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status.bindingPhase" +kubebuilder:printcolumn:name="CLASS",type="string",JSONPath=".spec.classReference.name" +kubebuilder:printcolumn:name="VERSION",type="string",JSONPath=".spec.engineVersion" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
func (*MySQLInstance) ClaimStatus ¶ added in v0.2.0
func (m *MySQLInstance) ClaimStatus() *corev1alpha1.ResourceClaimStatus
ClaimStatus returns the status of this resource claim.
func (*MySQLInstance) ClassRef ¶ added in v0.2.0
func (m *MySQLInstance) ClassRef() *corev1.ObjectReference
ClassRef returns the resource class used by this resource claim.
func (*MySQLInstance) DeepCopy ¶
func (in *MySQLInstance) DeepCopy() *MySQLInstance
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MySQLInstance.
func (*MySQLInstance) DeepCopyInto ¶
func (in *MySQLInstance) DeepCopyInto(out *MySQLInstance)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MySQLInstance) DeepCopyObject ¶
func (in *MySQLInstance) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*MySQLInstance) ObjectReference ¶
func (m *MySQLInstance) ObjectReference() *corev1.ObjectReference
ObjectReference to using this object as a reference
func (*MySQLInstance) OwnerReference ¶
func (m *MySQLInstance) OwnerReference() metav1.OwnerReference
OwnerReference to use this object as an owner
func (*MySQLInstance) ResourceRef ¶ added in v0.2.0
func (m *MySQLInstance) ResourceRef() *corev1.ObjectReference
ResourceRef returns the resource claimed by this resource claim.
func (*MySQLInstance) SetResourceRef ¶ added in v0.2.0
func (m *MySQLInstance) SetResourceRef(ref *corev1.ObjectReference)
SetResourceRef specifies the resource claimed by this resource claim.
type MySQLInstanceList ¶
type MySQLInstanceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MySQLInstance `json:"items"` }
MySQLInstanceList contains a list of MySQLInstance
func (*MySQLInstanceList) DeepCopy ¶
func (in *MySQLInstanceList) DeepCopy() *MySQLInstanceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MySQLInstanceList.
func (*MySQLInstanceList) DeepCopyInto ¶
func (in *MySQLInstanceList) DeepCopyInto(out *MySQLInstanceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MySQLInstanceList) DeepCopyObject ¶
func (in *MySQLInstanceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MySQLInstanceSpec ¶
type MySQLInstanceSpec struct { ClassRef *corev1.ObjectReference `json:"classReference,omitempty"` ResourceRef *corev1.ObjectReference `json:"resourceName,omitempty"` Selector metav1.LabelSelector `json:"selector,omitempty"` // mysql instance properties // +kubebuilder:validation:Enum=5.6,5.7 EngineVersion string `json:"engineVersion"` }
MySQLInstanceSpec specifies the configuration of a MySQL instance.
func (*MySQLInstanceSpec) DeepCopy ¶
func (in *MySQLInstanceSpec) DeepCopy() *MySQLInstanceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MySQLInstanceSpec.
func (*MySQLInstanceSpec) DeepCopyInto ¶
func (in *MySQLInstanceSpec) DeepCopyInto(out *MySQLInstanceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PostgreSQLInstance ¶ added in v0.2.0
type PostgreSQLInstance struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PostgreSQLInstanceSpec `json:"spec,omitempty"` Status corev1alpha1.ResourceClaimStatus `json:"status,omitempty"` }
PostgreSQLInstance is the CRD type for abstract PostgreSQL database instances +k8s:openapi-gen=true +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status.bindingPhase" +kubebuilder:printcolumn:name="CLASS",type="string",JSONPath=".spec.classReference.name" +kubebuilder:printcolumn:name="VERSION",type="string",JSONPath=".spec.engineVersion" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
func (*PostgreSQLInstance) ClaimStatus ¶ added in v0.2.0
func (p *PostgreSQLInstance) ClaimStatus() *corev1alpha1.ResourceClaimStatus
ClaimStatus returns the status of this resource claim.
func (*PostgreSQLInstance) ClassRef ¶ added in v0.2.0
func (p *PostgreSQLInstance) ClassRef() *corev1.ObjectReference
ClassRef returns the resource class used by this resource claim.
func (*PostgreSQLInstance) DeepCopy ¶ added in v0.2.0
func (in *PostgreSQLInstance) DeepCopy() *PostgreSQLInstance
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PostgreSQLInstance.
func (*PostgreSQLInstance) DeepCopyInto ¶ added in v0.2.0
func (in *PostgreSQLInstance) DeepCopyInto(out *PostgreSQLInstance)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PostgreSQLInstance) DeepCopyObject ¶ added in v0.2.0
func (in *PostgreSQLInstance) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PostgreSQLInstance) ObjectReference ¶ added in v0.2.0
func (p *PostgreSQLInstance) ObjectReference() *corev1.ObjectReference
ObjectReference to using this object as a reference
func (*PostgreSQLInstance) OwnerReference ¶ added in v0.2.0
func (p *PostgreSQLInstance) OwnerReference() metav1.OwnerReference
OwnerReference to use this object as an owner
func (*PostgreSQLInstance) ResourceRef ¶ added in v0.2.0
func (p *PostgreSQLInstance) ResourceRef() *corev1.ObjectReference
ResourceRef returns the resource claimed by this resource claim.
func (*PostgreSQLInstance) SetResourceRef ¶ added in v0.2.0
func (p *PostgreSQLInstance) SetResourceRef(ref *corev1.ObjectReference)
SetResourceRef specifies the resource claimed by this resource claim.
type PostgreSQLInstanceList ¶ added in v0.2.0
type PostgreSQLInstanceList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []PostgreSQLInstance `json:"items"` }
PostgreSQLInstanceList contains a list of PostgreSQLInstance
func (*PostgreSQLInstanceList) DeepCopy ¶ added in v0.2.0
func (in *PostgreSQLInstanceList) DeepCopy() *PostgreSQLInstanceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PostgreSQLInstanceList.
func (*PostgreSQLInstanceList) DeepCopyInto ¶ added in v0.2.0
func (in *PostgreSQLInstanceList) DeepCopyInto(out *PostgreSQLInstanceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PostgreSQLInstanceList) DeepCopyObject ¶ added in v0.2.0
func (in *PostgreSQLInstanceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PostgreSQLInstanceSpec ¶ added in v0.2.0
type PostgreSQLInstanceSpec struct { ClassRef *corev1.ObjectReference `json:"classReference,omitempty"` ResourceRef *corev1.ObjectReference `json:"resourceName,omitempty"` Selector metav1.LabelSelector `json:"selector,omitempty"` // postgresql instance properties // +kubebuilder:validation:Enum=9.6 EngineVersion string `json:"engineVersion,omitempty"` }
PostgreSQLInstanceSpec specifies the configuration of this PostgreSQLInstance.
func (*PostgreSQLInstanceSpec) DeepCopy ¶ added in v0.2.0
func (in *PostgreSQLInstanceSpec) DeepCopy() *PostgreSQLInstanceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PostgreSQLInstanceSpec.
func (*PostgreSQLInstanceSpec) DeepCopyInto ¶ added in v0.2.0
func (in *PostgreSQLInstanceSpec) DeepCopyInto(out *PostgreSQLInstanceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PredefinedACL ¶ added in v0.2.0
type PredefinedACL string
PredefinedACL represents predefied bucket ACLs.
const ( ACLPrivate PredefinedACL = "Private" ACLPublicRead PredefinedACL = "PublicRead" ACLPublicReadWrite PredefinedACL = "PublicReadWrite" ACLAuthenticatedRead PredefinedACL = "AuthenticatedRead" )
Predefined ACLs.