v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the objectstorage v1alpha1 API group +kubebuilder:object:generate=true +groupName=objectstorage.giantswarm.io

Index

• Constants
• Variables
• type Bucket
  • func (in *Bucket) DeepCopy() *Bucket
  • func (in *Bucket) DeepCopyInto(out *Bucket)
  • func (in *Bucket) DeepCopyObject() runtime.Object
• type BucketAccessRole
  • func (in *BucketAccessRole) DeepCopy() *BucketAccessRole
  • func (in *BucketAccessRole) DeepCopyInto(out *BucketAccessRole)
• type BucketExpirationPolicy
  • func (in *BucketExpirationPolicy) DeepCopy() *BucketExpirationPolicy
  • func (in *BucketExpirationPolicy) DeepCopyInto(out *BucketExpirationPolicy)
• type BucketList
  • func (in *BucketList) DeepCopy() *BucketList
  • func (in *BucketList) DeepCopyInto(out *BucketList)
  • func (in *BucketList) DeepCopyObject() runtime.Object
• type BucketSpec
  • func (in *BucketSpec) DeepCopy() *BucketSpec
  • func (in *BucketSpec) DeepCopyInto(out *BucketSpec)
• type BucketStatus
  • func (in *BucketStatus) DeepCopy() *BucketStatus
  • func (in *BucketStatus) DeepCopyInto(out *BucketStatus)
• type BucketTag
  • func (in *BucketTag) DeepCopy() *BucketTag
  • func (in *BucketTag) DeepCopyInto(out *BucketTag)

Constants

const (
	// Finalizer needs to follow the format "domain name, a forward slash and the name of the finalizer"
	// See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers
	BucketFinalizer      = "objectstorage.giantswarm.io/bucket"
	AzureSecretFinalizer = "objectstorage.giantswarm.io/secret" // #nosec G101
	ReclaimPolicyRetain  = "Retain"
	ReclaimPolicyDelete  = "Delete"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "objectstorage.giantswarm.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
)

Types

type Bucket

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

	Spec   BucketSpec   `json:"spec,omitempty"`
	Status BucketStatus `json:"status,omitempty"`
}

Bucket is the Schema for the buckets API

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.

type BucketAccessRole

type BucketAccessRole struct {
	// Name of the role to create
	RoleName string `json:"roleName"`

	// ExtraBucketNames is a list of bucket names to add to the role policy in case the role needs to be able to access multiple buckets.
	ExtraBucketNames []string `json:"extraBucketNames,omitempty"`

	// Name of the service account
	ServiceAccountName string `json:"serviceAccountName"`

	// Namespace of the service account
	ServiceAccountNamespace string `json:"serviceAccountNamespace"`
}

BucketAccessRole defines the bucket access role to create in the cloud account

func (*BucketAccessRole) DeepCopy

func (in *BucketAccessRole) DeepCopy() *BucketAccessRole

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

func (*BucketAccessRole) DeepCopyInto

func (in *BucketAccessRole) DeepCopyInto(out *BucketAccessRole)

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

type BucketExpirationPolicy

type BucketExpirationPolicy struct {
	// Days sets a number of days before the data expires
	Days int32 `json:"days"`
}

BucketExpirationPolicy defines the expiration policy on all objects contained in the bucket

func (*BucketExpirationPolicy) DeepCopy

func (in *BucketExpirationPolicy) DeepCopy() *BucketExpirationPolicy

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

func (*BucketExpirationPolicy) DeepCopyInto

func (in *BucketExpirationPolicy) DeepCopyInto(out *BucketExpirationPolicy)

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

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 {
	// Name is the name of the bucket to create.
	Name string `json:"name"`

	// Expiration policy on the objects in the bucket.
	// +optional
	ExpirationPolicy *BucketExpirationPolicy `json:"expirationPolicy,omitempty"`

	// Reclaim policy on the bucket.
	// +optional
	ReclaimPolicy string `json:"reclaimPolicy,omitempty"`

	// Access role that can be assumed to access the bucket
	AccessRole *BucketAccessRole `json:"accessRole,omitempty"`

	// Tags to add to the bucket.
	// +optional
	Tags []BucketTag `json:"tags,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 BucketStatus

type BucketStatus struct {
	// BucketReady is a boolean condition to reflect the successful creation
	// of a bucket.
	BucketReady bool `json:"bucketReady,omitempty"`

	// BucketID is the unique id of the bucket.
	// +optional
	BucketID string `json:"bucketID,omitempty"`
}

BucketStatus defines the observed state of Bucket

func (*BucketStatus) DeepCopy

func (in *BucketStatus) DeepCopy() *BucketStatus

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

func (*BucketStatus) DeepCopyInto

func (in *BucketStatus) DeepCopyInto(out *BucketStatus)

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

type BucketTag

type BucketTag struct {
	// Key is the key of the bucket tag to add to the bucket.
	Key string `json:"key"`

	// Key is the key of the bucket tag to add to the bucket.
	Value string `json:"value"`
}

BucketTag defines the type for bucket tags

func (*BucketTag) DeepCopy

func (in *BucketTag) DeepCopy() *BucketTag

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

func (*BucketTag) DeepCopyInto

func (in *BucketTag) DeepCopyInto(out *BucketTag)

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