v1alpha1

package
v0.7.0-rc Latest Latest
Warning

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

 Go to latest Published: Jan 18, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package v1alpha1 contains portable resource claims for storage services such as buckets. +kubebuilder:object:generate=true +groupName=storage.crossplane.io +versionName=v1alpha1

Index

Constants

View Source 
const (
	Group   = "storage.crossplane.io"
	Version = "v1alpha1"
)

Package type metadata.

Variables

View Source 
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}
)
View Source 
var (
	BucketKind             = reflect.TypeOf(Bucket{}).Name()
	BucketKindAPIVersion   = BucketKind + "." + SchemeGroupVersion.String()
	BucketGroupVersionKind = SchemeGroupVersion.WithKind(BucketKind)
)

Bucket type metadata.

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 runtimev1alpha1.ResourceClaimStatus `json:"status,omitempty"`
}

A Bucket is a portable resource claim that may be satisfied by binding to a managed resource such as an AWS S3 bucket or Azure storage container. +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status.bindingPhase" +kubebuilder:printcolumn:name="CLASS-KIND",type="string",JSONPath=".spec.classRef.kind" +kubebuilder:printcolumn:name="CLASS-NAME",type="string",JSONPath=".spec.classRef.name" +kubebuilder:printcolumn:name="RESOURCE-KIND",type="string",JSONPath=".spec.resourceRef.kind" +kubebuilder:printcolumn:name="RESOURCE-NAME",type="string",JSONPath=".spec.resourceRef.name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status

func (*Bucket) DeepCopy 

func (in *Bucket) DeepCopy() *Bucket

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

func (*Bucket) DeepCopyInto 

func (in *Bucket) DeepCopyInto(out *Bucket)

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

func (*Bucket) DeepCopyObject 

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

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

func (*Bucket) GetBindingPhase 

func (cm *Bucket) GetBindingPhase() runtimev1alpha1.BindingPhase

GetBindingPhase of this Bucket.

func (*Bucket) GetClassReference added in v0.4.0 

func (cm *Bucket) GetClassReference() *corev1.ObjectReference

GetClassReference of this Bucket.

func (*Bucket) GetClassSelector added in v0.4.0 

func (cm *Bucket) GetClassSelector() *metav1.LabelSelector

GetClassSelector of this Bucket.

func (*Bucket) GetCondition added in v0.4.0 

func (cm *Bucket) GetCondition(ct runtimev1alpha1.ConditionType) runtimev1alpha1.Condition

GetCondition of this Bucket.

func (*Bucket) GetResourceReference 

func (cm *Bucket) GetResourceReference() *corev1.ObjectReference

GetResourceReference of this Bucket.

func (*Bucket) GetWriteConnectionSecretToReference 

func (cm *Bucket) GetWriteConnectionSecretToReference() *runtimev1alpha1.LocalSecretReference

GetWriteConnectionSecretToReference of this Bucket.

func (*Bucket) SetBindingPhase 

func (cm *Bucket) SetBindingPhase(p runtimev1alpha1.BindingPhase)

SetBindingPhase of this Bucket.

func (*Bucket) SetClassReference added in v0.4.0 

func (cm *Bucket) SetClassReference(r *corev1.ObjectReference)

SetClassReference of this Bucket.

func (*Bucket) SetClassSelector added in v0.4.0 

func (cm *Bucket) SetClassSelector(s *metav1.LabelSelector)

SetClassSelector of this Bucket.

func (*Bucket) SetConditions 

func (cm *Bucket) SetConditions(c ...runtimev1alpha1.Condition)

SetConditions of this Bucket.

func (*Bucket) SetResourceReference 

func (cm *Bucket) SetResourceReference(r *corev1.ObjectReference)

SetResourceReference of this Bucket.

func (*Bucket) SetWriteConnectionSecretToReference 

func (cm *Bucket) SetWriteConnectionSecretToReference(r *runtimev1alpha1.LocalSecretReference)

SetWriteConnectionSecretToReference of this Bucket.

type BucketList 

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

BucketList contains a list of Bucket.

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 {
	runtimev1alpha1.ResourceClaimSpec `json:",inline"`

	// Name specifies the desired name of the bucket.
	// +kubebuilder:validation:MaxLength=63
	// +kubebuilder:validation:MinLength=3
	Name string `json:"name,omitempty"`

	// PredefinedACL specifies a predefined ACL (e.g. Private, ReadWrite, etc)
	// to be applied to the bucket.
	// +kubebuilder:validation:Enum=Private;PublicRead;PublicReadWrite;AuthenticatedRead
	PredefinedACL *PredefinedACL `json:"predefinedACL,omitempty"`

	// LocalPermission specifies permissions granted to a provider specific
	// service account for this bucket, e.g. Read, ReadWrite, or Write.
	// +kubebuilder:validation:Enum=Read;Write;ReadWrite
	LocalPermission *LocalPermissionType `json:"localPermission,omitempty"`
}

BucketSpec specifies the desired state of a 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 

type LocalPermissionType string

A LocalPermissionType is a type of permission that may be granted to a Bucket. 

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 PredefinedACL 

type PredefinedACL string

A PredefinedACL is a predefined ACL that may be applied to a Bucket. 

const (
	ACLPrivate           PredefinedACL = "Private"
	ACLPublicRead        PredefinedACL = "PublicRead"
	ACLPublicReadWrite   PredefinedACL = "PublicReadWrite"
	ACLAuthenticatedRead PredefinedACL = "AuthenticatedRead"
)

Predefined ACLs.

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.