CephObjectStoreUser
ceph.rook.io / v1
apiVersion: ceph.rook.io/v1
kind: CephObjectStoreUser
metadata:
name: example
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
object required
spec object required
ObjectStoreUserSpec represents the spec of a CephObjectStoreUser
accountRef object
AccountRef is a reference to a CephObjectStoreAccount to associate this user with.
The referenced account must be in the same namespace as the user.
When set, the user is created as an account user with no default permissions,
and resources created by this user are owned by the account.
name
string required
Name of the CephObjectStoreAccount CR
pattern:
^[a-zA-Z0-9 ._-]+$minLength:
1maxLength:
2048capabilities object
Additional admin-level capabilities for the Ceph object store user
accounts
string
Add capabilities for user to manage accounts. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
Note: Only supported from Ceph Squid (v19.2.3) onwards
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
datalog
string
Add capabilities for user to change data logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
mdlog
string
Add capabilities for user to change metadata logging. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
enum:
*, read, write, read, write
metadata
string
Admin capabilities to read/write Ceph object store metadata. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
roles
string
Admin capabilities to read/write roles for user. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
userInfoWithoutKeys
string
Add capabilities for user to fetch user info without keys. Documented in https://docs.ceph.com/en/latest/radosgw/admin/?#add-remove-admin-capabilities
Note: Only supported from Ceph Squid (v19.2.0) onwards
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
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
enum:
*, read, write, read, write
clusterNamespace
string
The namespace where the parent CephCluster and CephObjectStore are found
defaultPlacement
string
DefaultPlacement sets the default pool placement target for buckets
created by this user. It must name a placement target known to the
zonegroup serving the referenced object store; RGW rejects unknown
targets. If this field is absent the controller does not manage the
user's placement: an existing value (set previously through this
field, or outside of Rook) is left in place.
pattern:
^[a-zA-Z0-9._-]+$minLength:
1maxLength:
2048
defaultStorageClass
string
DefaultStorageClass sets the default storage class for objects created
by this user, within the placement set by DefaultPlacement (which must
also be set). The storage class must exist on that placement target;
RGW rejects unknown storage classes. If this field is absent the
controller does not manage the user's storage class: an existing value
is preserved, except when DefaultPlacement changes, which resets the
storage class to the new target's default (STANDARD).
pattern:
^[a-zA-Z0-9._-]+$minLength:
1maxLength:
2048
displayName
string
The display name for the ceph user.
keys []object
Allows specifying credentials for the user. If not provided, the operator
will generate them.
accessKeyRef object
Secret key selector for the access_key (commonly referred to as AWS_ACCESS_KEY_ID).
key
string required
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
secretKeyRef object
Secret key selector for the secret_key (commonly referred to as AWS_SECRET_ACCESS_KEY).
key
string required
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
opMask
[]string
The op-mask of the user.
minItems:
0maxItems:
3quotas object
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
maxBuckets
integer
Maximum bucket limit for the ceph user
maxObjects
integer
Maximum number of objects across all the user's buckets
format:
int64
maxSize
string | integer
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.
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
store
string
The store the user will be created in
status object
ObjectStoreUserStatus represents the status Ceph Object Store Gateway User
info
object
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.
observedGeneration
integer
ObservedGeneration is the latest generation observed by the controller.
format:
int64
phase
string
No matches. Try .spec.accountRef for an exact path