Alauda Cache Service for Redis OSS

RedisUser

Description
RedisUser is the Schema for the redisusers API. Represents a Redis user account with associated ACL permissions.
Type
object

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

RedisUserSpec defines the desired state of RedisUser

statusobject

RedisUserStatus defines the observed state of RedisUser

.spec

Description
RedisUserSpec defines the desired state of RedisUser
Type
object
Required
redisNameusername
PropertyTypeDescription
accountTypestring

AccountType defines the user account category. Options: system (privileged system accounts), custom (general user accounts), default (default user configuration)

aclRulesstring

AclRules defines the Redis ACL rules as a string. Format follows Redis ACL syntax for permissions and command restrictions. See: https://redis.io/docs/management/security/acl/

archstring

Arch specifies the Redis architecture type for this user. Must match the architecture of the referenced Redis instance.

passwordSecretsarray

PasswordSecrets is a list of Kubernetes Secret names containing user passwords. Each secret must have a 'password' key containing the Redis password. Multiple secrets allow for credential rotation.

redisNamestring

RedisName specifies the target Redis instance name. Must reference an existing Redis resource in the same namespace.

usernamestring

Username specifies the Redis user account name. Required for user identification during authentication.

.spec.passwordSecrets

Description
PasswordSecrets is a list of Kubernetes Secret names containing user passwords. Each secret must have a 'password' key containing the Redis password. Multiple secrets allow for credential rotation.
Type
array

.spec.passwordSecrets[]

Type
string

.status

Description
RedisUserStatus defines the observed state of RedisUser
Type
object
PropertyTypeDescription
Phasestring

Phase indicates the current state of the RedisUser resource. Values: Fail, Success, Pending

aclRulesstring

AclRules reflects the actual ACL rules applied to Redis.

lastUpdateSuccessstring

LastUpdatedSuccess records the timestamp of the last successful configuration update. Format: RFC3339 timestamp string.

messagestring

Message provides additional details about the current status. Contains error information or operation details.

API Endpoints

The following API endpoints are available:

  • /apis/redis.middleware.alauda.io/v1/namespaces/{namespace}/redisusers
    • DELETE: delete collection of RedisUser
    • GET: list objects of kind RedisUser
    • POST: create a new RedisUser
  • /apis/redis.middleware.alauda.io/v1/namespaces/{namespace}/redisusers/{name}
    • DELETE: delete the specified RedisUser
    • GET: read the specified RedisUser
    • PATCH: partially update the specified RedisUser
    • PUT: replace the specified RedisUser
  • /apis/redis.middleware.alauda.io/v1/namespaces/{namespace}/redisusers/{name}/status
    • GET: read status of the specified RedisUser
    • PATCH: partially update status of the specified RedisUser
    • PUT: replace status of the specified RedisUser

/apis/redis.middleware.alauda.io/v1/namespaces/{namespace}/redisusers

HTTP method
DELETE
Description
delete collection of RedisUser
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind RedisUser
HTTP responses
HTTP codeResponse body
200 - OKRedisUserList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new RedisUser
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
bodyRedisUser schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKRedisUser schema
201 - CreatedRedisUser schema
202 - AcceptedRedisUser schema
401 - UnauthorizedEmpty

/apis/redis.middleware.alauda.io/v1/namespaces/{namespace}/redisusers/{name}

HTTP method
DELETE
Description
delete the specified RedisUser
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 RedisUser
HTTP responses
HTTP codeResponse body
200 - OKRedisUser schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified RedisUser
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 - OKRedisUser schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified RedisUser
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
bodyRedisUser schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKRedisUser schema
201 - CreatedRedisUser schema
401 - UnauthorizedEmpty

/apis/redis.middleware.alauda.io/v1/namespaces/{namespace}/redisusers/{name}/status

HTTP method
GET
Description
read status of the specified RedisUser
HTTP responses
HTTP codeResponse body
200 - OKRedisUser schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified RedisUser
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 - OKRedisUser schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified RedisUser
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
bodyRedisUser schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKRedisUser schema
201 - CreatedRedisUser schema
401 - UnauthorizedEmpty