API Reference

Packages

Package v1alpha3 contains API Schema definitions for the storage v1alpha3 API group

Bucket is the Schema for the buckets API.

Field	Description	Default	Validation
`apiVersion` string	`storage.evroclabs.net/v1alpha3`
`kind` string	`Bucket`
`kind` string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`apiVersion` string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` BucketSpec

Appears in:

Field	Description	Default	Validation
`kind` BucketOwnerKind	Kind represents the kind of owner we are talking about, currently this may be either "User.[username]" or "ServiceAccount.[accountname]"		Enum: [User ServiceAccount]
`name` string	Name represents the name of the object of the referred to kind, living in the same namespace as the bucket		MaxLength: 255

Underlying type: string

Appears in:

Field	Description
`ServiceAccount`
`User`

BucketSpec defines the desired state of Bucket.

Appears in:

Field	Description	Default	Validation
`owners` BucketOwner array	Owners represents the list of owners that have blanket full access to this bucket		MaxItems: 20
`objectVersioningMode` ObjectVersioningMode	ObjectVersioningMode controls how versioning of objects behave. If not explicitly set, the default behavior depends on whether or not object locking is enabled. If object locking is enabled, then object versioning mode is enforced to `Enabled`. If object locking is disabled, the default mode is `Disabled`. If versioning is ever set to either `Enabled` or `Suspended`, then it can not be reset back to `Disabled` again.		Enum: [Disabled Suspended Enabled] Optional: {}
`enableObjectLock` boolean	Enable object in the bucket to be configured with object lock	false	Optional: {}
`defaultObjectLockRetention` DefaultObjectLockRetention	DefaultObjectLockRetention can be used when `EnableObjectLock` is set to true. It control the default object lock behavior for objects stored in the bucket. The defaults can be overridden on a per-object level.		Optional: {}

Appears in:

Field	Description	Default	Validation
`mode` ObjectLockMode	Mode defines what type of protection is applied on objects when object lock is enabled.		Enum: [S3Governance S3Compliance] Required: {}
`period` ObjectLockRetentionPeriod	Period specified the default time period that objects are locked, if no other value is explicitly provided.		Required: {}

Underlying type: string

Appears in:

Field	Description
`S3Governance`
`S3Compliance`

Appears in:

Field	Description	Default	Validation
`count` integer	Count is how long the period is, in the provided `Unit`.		Minimum: 1 Required: {}
`unit` ObjectLockRetentionPeriodUnit	Unit is the unit for the period, either Days or Years.		Enum: [Days Years] Required: {}

Underlying type: string

Appears in:

Underlying type: string

Appears in: