Alauda Container Platform

CephObjectStoreUser [cephobjectstoreusers.ceph.rook.io/v1]

Description
CephObjectStoreUser represents a Ceph Object Store Gateway User
Type
object
Required
metadataspec

Specification

PropertyTypeDescription
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

ObjectStoreUserSpec represent the spec of an Objectstoreuser

statusobject

ObjectStoreUserStatus represents the status Ceph Object Store Gateway User

.spec

Description
ObjectStoreUserSpec represent the spec of an Objectstoreuser
Type
object
PropertyTypeDescription
capabilitiesobject

Additional admin-level capabilities for the Ceph object store user

clusterNamespacestring

The namespace where the parent CephCluster and CephObjectStore are found

displayNamestring

The display name for the ceph user.

keysarray

Allows specifying credentials for the user. If not provided, the operator will generate them.

quotasobject

ObjectUserQuotaSpec can be used to set quotas for the object store user to limit their usage. See the Ceph docs for more

storestring

The store the user will be created in

.spec.capabilities

Description
Additional admin-level capabilities for the Ceph object store user
Type
object
PropertyTypeDescription
amz-cachestring

Add capabilities for user to send request to RGW Cache API header. Documented in https://docs.ceph.com/en/latest/radosgw/rgw-cache/#cache-api

bilogstring

Add capabilities for user to change bucket index logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

bucketstring

Admin capabilities to read/write Ceph object store buckets. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

bucketsstring

Admin capabilities to read/write Ceph object store buckets. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

datalogstring

Add capabilities for user to change data logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

infostring

Admin capabilities to read/write information about the user. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

mdlogstring

Add capabilities for user to change metadata logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

metadataObjectMeta

Admin capabilities to read/write Ceph object store metadata. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

oidc-providerstring

Add capabilities for user to change oidc provider. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

ratelimitstring

Add capabilities for user to set rate limiter for user and bucket. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

rolesstring

Admin capabilities to read/write roles for user. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

usagestring

Admin capabilities to read/write Ceph object store usage. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

userstring

Admin capabilities to read/write Ceph object store users. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

user-policystring

Add capabilities for user to change user policies. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

usersstring

Admin capabilities to read/write Ceph object store users. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

zonestring

Admin capabilities to read/write Ceph object store zones. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities

.spec.keys

Description
Allows specifying credentials for the user. If not provided, the operator will generate them.
Type
array

.spec.keys[]

Description
ObjectUserKey defines a set of rgw user access credentials to be retrieved from secret resources.
Type
object
PropertyTypeDescription
accessKeyRefobject

Secret key selector for the access_key (commonly referred to as AWS_ACCESS_KEY_ID).

secretKeyRefobject

Secret key selector for the secret_key (commonly referred to as AWS_SECRET_ACCESS_KEY).

.spec.keys[].accessKeyRef

Description
Secret key selector for the access_key (commonly referred to as AWS_ACCESS_KEY_ID).
Type
object
Required
key
PropertyTypeDescription
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optionalboolean

Specify whether the Secret or its key must be defined

.spec.keys[].secretKeyRef

Description
Secret key selector for the secret_key (commonly referred to as AWS_SECRET_ACCESS_KEY).
Type
object
Required
key
PropertyTypeDescription
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

optionalboolean

Specify whether the Secret or its key must be defined

.spec.quotas

Description
ObjectUserQuotaSpec can be used to set quotas for the object store user to limit their usage. See the [Ceph docs](https://docs.ceph.com/en/latest/radosgw/admin/?#quota-management) for more
Type
object
PropertyTypeDescription
maxBucketsinteger

Maximum bucket limit for the ceph user

maxObjectsinteger

Maximum number of objects across all the user's buckets

maxSize

Maximum size limit of all objects across all the user's buckets See https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity for more info.

.status

Description
ObjectStoreUserStatus represents the status Ceph Object Store Gateway User
Type
object
PropertyTypeDescription
infoobject
keysarray
observedGenerationinteger

ObservedGeneration is the latest generation observed by the controller.

phasestring

.status.info

Type
object

.status.keys

Type
array

.status.keys[]

Type
object
PropertyTypeDescription
namestring

name is unique within a namespace to reference a secret resource.

namespacestring

namespace defines the space within which the secret name must be unique.

resourceVersionstring
uidstring

UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

API Endpoints

The following API endpoints are available:

  • /apis/ceph.rook.io/v1/namespaces/{namespace}/cephobjectstoreusers
    • DELETE: delete collection of CephObjectStoreUser
    • GET: list objects of kind CephObjectStoreUser
    • POST: create a new CephObjectStoreUser
  • /apis/ceph.rook.io/v1/namespaces/{namespace}/cephobjectstoreusers/{name}
    • DELETE: delete the specified CephObjectStoreUser
    • GET: read the specified CephObjectStoreUser
    • PATCH: partially update the specified CephObjectStoreUser
    • PUT: replace the specified CephObjectStoreUser
  • /apis/ceph.rook.io/v1/namespaces/{namespace}/cephobjectstoreusers/{name}/status
    • GET: read status of the specified CephObjectStoreUser
    • PATCH: partially update status of the specified CephObjectStoreUser
    • PUT: replace status of the specified CephObjectStoreUser

/apis/ceph.rook.io/v1/namespaces/{namespace}/cephobjectstoreusers

HTTP method
DELETE
Description
delete collection of CephObjectStoreUser
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind CephObjectStoreUser
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUserList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new CephObjectStoreUser
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyCephObjectStoreUser schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUser schema
201 - CreatedCephObjectStoreUser schema
202 - AcceptedCephObjectStoreUser schema
401 - UnauthorizedEmpty

/apis/ceph.rook.io/v1/namespaces/{namespace}/cephobjectstoreusers/{name}

HTTP method
DELETE
Description
delete the specified CephObjectStoreUser
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified CephObjectStoreUser
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUser schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified CephObjectStoreUser
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUser schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified CephObjectStoreUser
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyCephObjectStoreUser schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUser schema
201 - CreatedCephObjectStoreUser schema
401 - UnauthorizedEmpty

/apis/ceph.rook.io/v1/namespaces/{namespace}/cephobjectstoreusers/{name}/status

HTTP method
GET
Description
read status of the specified CephObjectStoreUser
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUser schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified CephObjectStoreUser
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUser schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified CephObjectStoreUser
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyCephObjectStoreUser schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKCephObjectStoreUser schema
201 - CreatedCephObjectStoreUser schema
401 - UnauthorizedEmpty