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

描述: CephObjectStoreUser represents a Ceph Object Store Gateway User
类型: object
必填: metadataspec

规格

属性	类型	描述
`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
`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
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	ObjectStoreUserSpec represent the spec of an Objectstoreuser
`status`	`object`	ObjectStoreUserStatus represents the status Ceph Object Store Gateway User

.spec

描述: ObjectStoreUserSpec represent the spec of an Objectstoreuser
类型: object

属性	类型	描述
`capabilities`	`object`	Additional admin-level capabilities for the Ceph object store user
`clusterNamespace`	`string`	The namespace where the parent CephCluster and CephObjectStore are found
`displayName`	`string`	The display name for the ceph user.
`keys`	`array`	Allows specifying credentials for the user. If not provided, the operator will generate them.
`quotas`	`object`	ObjectUserQuotaSpec can be used to set quotas for the object store user to limit their usage. See the Ceph docs for more
`store`	`string`	The store the user will be created in

.spec.capabilities

描述: Additional admin-level capabilities for the Ceph object store user
类型: object

属性	类型	描述
`amz-cache`	`string`	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
`bilog`	`string`	Add capabilities for user to change bucket index logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`bucket`	`string`	Admin capabilities to read/write Ceph object store buckets. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`buckets`	`string`	Admin capabilities to read/write Ceph object store buckets. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`datalog`	`string`	Add capabilities for user to change data logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`info`	`string`	Admin capabilities to read/write information about the user. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`mdlog`	`string`	Add capabilities for user to change metadata logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`metadata`	`ObjectMeta`	Admin capabilities to read/write Ceph object store metadata. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`oidc-provider`	`string`	Add capabilities for user to change oidc provider. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`ratelimit`	`string`	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
`roles`	`string`	Admin capabilities to read/write roles for user. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`usage`	`string`	Admin capabilities to read/write Ceph object store usage. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`user`	`string`	Admin capabilities to read/write Ceph object store users. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`user-policy`	`string`	Add capabilities for user to change user policies. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`users`	`string`	Admin capabilities to read/write Ceph object store users. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
`zone`	`string`	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

描述: Allows specifying credentials for the user. If not provided, the operator will generate them.
类型: array

.spec.keys[]

描述: ObjectUserKey defines a set of rgw user access credentials to be retrieved from secret resources.
类型: object

属性	类型	描述
`accessKeyRef`	`object`	Secret key selector for the access_key (commonly referred to as AWS_ACCESS_KEY_ID).
`secretKeyRef`	`object`	Secret key selector for the secret_key (commonly referred to as AWS_SECRET_ACCESS_KEY).

.spec.keys[].accessKeyRef

描述: Secret key selector for the access_key (commonly referred to as AWS_ACCESS_KEY_ID).
类型: object
必填: key

属性	类型	描述
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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
`optional`	`boolean`	Specify whether the Secret or its key must be defined

.spec.keys[].secretKeyRef

描述: Secret key selector for the secret_key (commonly referred to as AWS_SECRET_ACCESS_KEY).
类型: object
必填: key

属性	类型	描述
`key`	`string`	The key of the secret to select from. Must be a valid secret key.
`name`	`string`	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
`optional`	`boolean`	Specify whether the Secret or its key must be defined

.spec.quotas

描述: 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
类型: object

属性	类型	描述
`maxBuckets`	`integer`	Maximum bucket limit for the ceph user
`maxObjects`	`integer`	Maximum number of objects across all the user's buckets
`maxSize`	`integer\|string`	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

描述: ObjectStoreUserStatus represents the status Ceph Object Store Gateway User
类型: object

属性	类型	描述
`info`	`object`
`keys`	`array`
`observedGeneration`	`integer`	ObservedGeneration is the latest generation observed by the controller.
`phase`	`string`

.status.info

类型: object

.status.keys

类型: array

.status.keys[]

类型: object

属性	类型	描述
`name`	`string`	name is unique within a namespace to reference a secret resource.
`namespace`	`string`	namespace defines the space within which the secret name must be unique.
`resourceVersion`	`string`
`uid`	`string`	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 端点

可用的 API 端点如下：

/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 方法: DELETE
描述: delete collection of CephObjectStoreUser
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind CephObjectStoreUser
HTTP 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUserList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new CephObjectStoreUser

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`CephObjectStoreUser` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUser` schema
201 - Created	`CephObjectStoreUser` schema
202 - Accepted	`CephObjectStoreUser` schema
401 - Unauthorized	Empty

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

HTTP 方法: DELETE
描述: delete the specified CephObjectStoreUser

查询参数

参数	类型	描述
`dryRun`	`string`	When 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 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified CephObjectStoreUser
HTTP 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUser` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified CephObjectStoreUser

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUser` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified CephObjectStoreUser

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`CephObjectStoreUser` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUser` schema
201 - Created	`CephObjectStoreUser` schema
401 - Unauthorized	Empty

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

HTTP 方法: GET
描述: read status of the specified CephObjectStoreUser
HTTP 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUser` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update status of the specified CephObjectStoreUser

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUser` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace status of the specified CephObjectStoreUser

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`CephObjectStoreUser` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`CephObjectStoreUser` schema
201 - Created	`CephObjectStoreUser` schema
401 - Unauthorized	Empty

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

#规格

#.spec

#.spec.capabilities

#.spec.keys

#.spec.keys[]

#.spec.keys[].accessKeyRef

#.spec.keys[].secretKeyRef

#.spec.quotas

#.status

#.status.info

#.status.keys

#.status.keys[]

API 端点#

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

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

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

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

规格

.spec

.spec.capabilities

.spec.keys

.spec.keys[]

.spec.keys[].accessKeyRef

.spec.keys[].secretKeyRef

.spec.quotas

.status

.status.info

.status.keys

.status.keys[]

API 端点

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

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

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