API Reference

Packages:

• pkg.internal/v1beta1

pkg.internal/v1beta1

Resource Types:

• XStorage

XStorage

^{↩ Parent}

Name	Type	Description	Required
apiVersion	string	pkg.internal/v1beta1	true
kind	string	XStorage	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		true

XStorage.spec

^{↩ Parent}

Name	Type	Description	Required
buckets	[]object	List of buckets to create and which are owned by the `owner`.	true
owner	string	Owner of the buckets to create.	true
bucketAccessGrants	[]object	List of buckets where the `owner` grants either ReadWrite or ReadOnly permissions to other `owners` (defined in separate `Storage` claims).	false
bucketAccessRequests	[]object	List of buckets where the `owner` requests either ReadWrite or ReadOnly permissions from other `owners` (defined in separate `Storage` claims).	false

XStorage.spec.buckets[index]

^{↩ Parent}

Name	Type	Description	Required
bucketName	string	Name of the bucket to create.	true
discoverable	boolean	Whether this bucket should be discoverable through the catalog by other `owners` (defined in separate `Storage` claims). Default: false	false

XStorage.spec.bucketAccessGrants[index]

^{↩ Parent}

Name	Type	Description	Required
bucketName	string	Name of the bucket to grant permissions to.	true
grantees	[]string	List of `owners` (defined in separate `Storage` claims) that the permission is granted to.	true
permission	enum	Permission that is granted. Enum: ReadWrite, ReadOnly	true

XStorage.spec.bucketAccessRequests[index]

^{↩ Parent}

Name	Type	Description	Required
bucketName	string	Name of the bucket to request permissions to.	true
permission	enum	Permission that is requested. Enum: ReadWrite, ReadOnly	true