RedisEnterpriseDatabase API 参考

适用于 Kubernetes 的 Redis Enterprise

apiVersion 的 API 版本：

app.redislabs.com/v1alpha1

RedisEnterpriseDatabase 是 redisenterprisedatabases API 的架构

名字 类型 描述 必填
apiVersion 字符串 app.redislabs.com/v1alpha1 真
类 字符串 RedisEnterprise数据库 真
元数据 对象 请参阅 Kubernetes API 文档，了解 'metadata' 字段的字段。 真
规范 对象 RedisEnterpriseDatabaseSpec 定义 RedisEnterpriseDatabase 的所需状态
 假
地位 对象 RedisEnterpriseDatabaseStatus 定义 RedisEnterpriseDatabase 的观察状态
 假

规范

↩ 父母

RedisEnterpriseDatabaseSpec 定义 RedisEnterpriseDatabase 的所需状态

名字 类型 描述 必填
主动主动 对象 与主动-主动数据库的连接/关联。
 假
alertSettings 对象 数据库警报的设置
 假
备份 对象 自动数据库备份的目标。
 假
clientAuthenticationCertificates []字符串 包含用于身份验证的 TLS 客户端证书的密钥
 假
dataInternodeEncryption 布尔 节点间加密 （INE） 设置。可选的布尔设置，覆盖类似的集群范围策略。如果设置为 False，则保证此数据库的 INE 处于关闭状态（无论集群范围的策略如何）。如果设置为 True，则 INE 将打开，除非数据库不支持该功能（在这种情况下，我们将收到错误，并且数据库创建将失败）。如果未指定，则如果数据库不支持节点间加密（无论集群默认值如何），将禁用。在显式设置其值后删除此属性将不起作用。
 假
数据库端口 整数 数据库端口号。数据库可用的 TCP 端口。如果省略，将自动生成。创建后无法更改
 假
数据库 SecretName 字符串 保存数据库密码的密钥的名称（仅限 redis 数据库）。如果 secret 不存在，则创建 secret。要定义密码，请创建一个不透明的密钥并在规范中设置名称。密码将从 'password' 键的值中获取。在密钥中使用空字符串作为值以禁用数据库的身份验证。注意 - 对于主动-主动数据库，不会自动创建此密钥，并且不得使用 memcached 数据库设置值，并且不会自动为它们创建密钥/密码。使用 memcachedSaslSecretName 字段设置 memcached 数据库的身份验证参数。
 假
默认用户 布尔 是否允许与默认用户连接？
 假
驱逐策略 字符串 数据库驱逐策略。查看更多 https://docs.redislabs.com/latest/rs/administering/database-operations/eviction-policy/
 假
isRof 布尔 无论它是否是 RoF 数据库。仅适用于 “REDIS” 类型的数据库。如果留空，则假定为 false。
 假
memcachedSaslSecretName 字符串 用于 memcached 数据库中二进制身份验证的凭证。凭证应保存为不透明密钥，并且应使用此字段配置该密钥的名称。对于 username，使用 'username' 作为键，使用实际 username 作为值。对于 password，使用 'password' 作为键，使用实际密码作为值。请注意，连接未加密。
 假
memorySize （内存大小） 字符串 数据库的内存大小。使用 100MB、0.1GB 等格式。最小值（以 100MB 为单位）。启用 redis on flash （RoF） 时，此值是指 RAM+Flash 内存，并且不得低于 1GB。
 假
modulesList 模块 []对象 与数据库关联的模块列表。可以从 REC 对象的状态中检索特定集群的有效模块列表。将 “name” 和 “versions” 字段用于特定模块配置。如果为模块指定显式版本，则必须通过将 REC 中的“.upgradeSpec.upgradeModulesToLatest”字段设置为“false”来禁用自动模块版本升级。请注意，指定模块版本的选项已弃用，并将在未来版本中删除。
 假
ossCluster作系统集群 布尔 OSS 集群模式选项。请注意，并非所有客户端库都支持 OSS 集群模式。
 假
坚持 枚举 数据库磁盘持久性策略

枚举：disabled、aofEverySecond、aofAlways、snapshotEvery1Hour、snapshotEvery6Hour、snapshotEvery12Hour
 假
代理策略 字符串 用于代理绑定到终端节点的策略。支持的代理策略为： single/all-master-shards/all-nodes 留空时，将根据 ossCluster 的值选择默认值 - 如果禁用，则为 single，启用时为 all-master-shards
 假
机架感知 布尔 数据库是否应为机架感知型数据库。这提高了可用性 - 更多信息：https://docs.redislabs.com/latest/rs/concepts/high-availability/rack-zone-awareness/
 假
redisEnterpriseCluster 对象 连接到 Redis Enterprise Cluster
 假
redisVersion 字符串 Redis OSS 版本。可以通过前缀指定版本，也可以通过通道指定版本 - 对于现有数据库 - 升级 Redis OSS 版本。对于新数据库 - 将使用其创建数据库的版本。如果设置为 'major' - 将始终升级到最新的主要 Redis 版本。如果设置为 'latest' - 将始终升级到最新的 Redis 版本。取决于 'redisUpgradePolicy' - 如果你想将某些数据库的值设置为 'latest'，你必须在集群上之前设置 redisUpgradePolicy。可能的值为 'major' 或 'latest' 使用升级时 - 请确保在之前备份数据库。此值仅用于数据库类型 'redis'
 假
replicaSources 的 []对象 要从哪些数据库复制
 假
复制 布尔 内存中数据库复制。启用后，数据库将为每个 master 提供副本分片，从而提高可用性。默认为 false。
 假
回复 3 布尔 此数据库是否支持 RESP3 协议。注 - 在显式设置此属性的值后删除此属性将不起作用。请查看 RS doc 中的相应字段以获取更多信息。
 假
rofRamSize 字符串 RoF 数据库的 RAM 部分的大小。与 “memorySize” 类似，请使用 100MB、0.1GB 等格式。它必须至少是 “memorySize” 指定的组合内存大小（RAM 和 Flash）的 10%。
 假
roles权限 []对象 要应用的 Redis 企业 ACL 和角色绑定列表
 假
分片计数 整数 数据库服务器端分片数
 假
sharding已启用 布尔 切换 REAADB （Active Active databases） 的数据库分片，并默认启用。对于 REDB（非活动活动数据库），此字段被阻止，分片通过 shardCount 字段切换 - 当 shardCount 为 1 时，将禁用此字段，否则启用。
 假
shards放置 枚举 控制分片的密度 - 它们应该驻留在尽可能少或尽可能多的节点上。可用选项包括 “dense” 或 “sparse”。如果未设置，则默认为 “dense”。

枚举：密集、稀疏
 假
tlsMode 枚举 需要对数据库进行 SSL 身份验证和加密的连接。enabled - 数据库的所有传入连接都必须使用 SSL。disabled - 数据库的传入连接不应使用 SSL。replica_ssl - 从此数据库复制的数据库需要使用 SSL。

枚举：disabled、enabled replica_ssl
 假
类型 枚举 数据库的类型（redis 或 memcached）。默认为 “redis”。

枚举：redis、memcached
 假
upgrade规格 对象 数据库升级规格。
 假

spec.activeActive 的

↩ 父母

与主动-主动数据库的连接/关联。

名字 类型 描述 必填
名字 字符串 相应的主动-主动数据库名称，Redis Enterprise 主动主动数据库自定义资源名称，与此资源相关联。如果此资源是在活动活动数据库创建时手动创建的，则必须通过用户填写此字段，否则，作员将自动分配此字段。注意：此功能目前不受支持。
 真
participatingClusterName 字符串 相应的参与集群名称，Redis Enterprise Remote Cluster 自定义资源名称，在主动-主动数据库中，如果此资源是在活动活动数据库创建时手动创建的，则必须通过用户填写此字段，否则，作员将自动分配此字段。注意：此功能目前不受支持。
 真

spec.alert设置

↩ 父母

数据库警报的设置

名字 类型 描述 必填
bdb_backup_delayed 对象 定期备份的延迟时间超过指定的阈值 [分钟]。- 注意阈值是注释的（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_crdt_src_high_syncer_lag 对象 主动-主动源 - 同步滞后高于指定的阈值 [秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_crdt_src_syncer_connection_error 对象 主动-主动源 - 同步在尝试连接副本源时出现连接错误 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_crdt_src_syncer_general_error 对象 主动-主动源 - 在一般错误中遇到同步 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_high_latency 对象 延迟高于指定的阈值 [微秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_high_throughput 对象 吞吐量高于指定的阈值 [请求 / 秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_long_running_action 对象 针对运行时间过长的状态机的警报 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_low_throughput 对象 吞吐量低于指定的阈值 [请求/秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_ram_dataset_overhead 对象 分片的数据集 RAM 开销已达到阈值 [% of its RAM limit] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_ram_values 对象 分片 RAM 中保留的值百分比低于 [其键计数的百分比] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_replica_src_high_syncer_lag 对象 源副本 - 同步滞后高于指定的阈值 [秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_replica_src_syncer_connection_error 对象 源的副本 - 尝试连接副本源时同步出现连接错误 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_shard_num_ram_values 对象 分片 RAM 中保留的值数低于 [values] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假
bdb_size 对象 数据集大小已达到阈值 [内存限制的百分比] 预期字段：-注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的
 假

spec.alertSettings.bdb_backup_delayed

↩ 父母

定期备份的延迟时间超过指定的阈值 [分钟]。- 注意阈值是注释的（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_crdt_src_high_syncer_lag

↩ 父母

主动-主动源 - 同步滞后高于指定的阈值 [秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_crdt_src_syncer_connection_error

↩ 父母

主动-主动源 - 同步在尝试连接副本源时出现连接错误 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_crdt_src_syncer_general_error

↩ 父母

主动-主动源 - 在一般错误中遇到同步 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_high_latency

↩ 父母

延迟高于指定的阈值 [微秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_high_throughput

↩ 父母

吞吐量高于指定的阈值 [请求 / 秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_long_running_action

↩ 父母

针对运行时间过长的状态机的警报 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_low_throughput

↩ 父母

吞吐量低于指定的阈值 [请求/秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_ram_dataset_overhead

↩ 父母

分片的数据集 RAM 开销已达到阈值 [% of its RAM limit] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_ram_values

↩ 父母

分片 RAM 中保留的值百分比低于 [其键计数的百分比] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_replica_src_high_syncer_lag

↩ 父母

源副本 - 同步滞后高于指定的阈值 [秒] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_replica_src_syncer_connection_error

↩ 父母

源的副本 - 尝试连接副本源时同步出现连接错误 - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_shard_num_ram_values

↩ 父母

分片 RAM 中保留的值数低于 [values] - 注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.alertSettings.bdb_size

↩ 父母

数据集大小已达到阈值 [内存限制的百分比] 预期字段：-注意阈值已注释（允许 string/int/float 并支持向后兼容性），但这是必需的

名字 类型 描述 必填
启用 布尔 警报已启用或已禁用
 假

spec.backup

↩ 父母

自动数据库备份的目标。

名字 类型 描述 必填
ABS 抗体 对象
假
FTP （英文） 对象
假
GCS （英语） 对象 GoogleStorage
 假
间隔 整数 备份间隔（秒）
 假
安装 对象 MountPoint存储
 假
S3 系列 对象
假
SFTP 对象
假
迅速 对象
假

spec.backup.abs 的

↩ 父母

名字 类型 描述 必填
绝对秘密名称 字符串 保存 ABS 凭证的 K8s 密钥的名称。密钥必须包含密钥“AccountName”和“AccountKey”，并且它们必须包含相应的凭据
 真
容器 字符串 Azure Blob 存储容器名称。
 真
子目录 字符串 自选。container 下的 Azure Blob Storage subdir。
 假

spec.backup.ftp 文件

↩ 父母

名字 类型 描述 必填
网址 字符串 ftps:// 的 URI[USER[:P ASSWORD]@]HOST[:P ORT]/PATH[/]
 真

spec.backup.gcs 文件

↩ 父母

GoogleStorage

名字 类型 描述 必填
bucketName （存储桶名称） 字符串 Google Storage 存储桶名称。
 真
gcsSecretName 字符串 保存 Google Cloud Storage 凭证的 K8s 密钥的名称。密钥必须包含密钥 “CLIENT_ID”、“PRIVATE_KEY”、“PRIVATE_KEY_ID”、“CLIENT_EMAIL”，并且这些密钥必须包含相应的凭据。键应与键 JSON 中的值相对应。
 真
子目录 字符串 自选。bucket 下的 Google Storage subdir。
 假

spec.backup.mount

↩ 父母

MountPoint存储

名字 类型 描述 必填
路径 字符串 本地挂载点的路径。您必须在所有节点上创建挂载点，并且 redislabs：redislabs 用户必须具有对本地挂载点的读写权限。
 真

spec.backup.s3 的

↩ 父母

名字 类型 描述 必填
awsSecretName 字符串 保存 AWS 凭证的 K8s 密钥的名称。密钥必须包含密钥 “AWS_ACCESS_KEY_ID” 和 “AWS_SECRET_ACCESS_KEY”，并且这些密钥必须包含相应的凭据。
 真
bucketName （存储桶名称） 字符串 Amazon S3 存储桶名称。
 真
子目录 字符串 自选。存储桶下的 Amazon S3 子目录。
 假

spec.backup.sftp 命令

↩ 父母

名字 类型 描述 必填
sftpSecret名称 字符串 保存 SFTP 凭证的 K8s 密钥的名称。密钥必须包含 “Key” 密钥，这是用于连接到 sftp 服务器的 SSH 私钥。
 真
sftp_url 字符串 SFTP 网址
 真

spec.backup.swift 的

↩ 父母

名字 类型 描述 必填
auth_url 字符串 Swift 服务认证 URL。
 真
容器 字符串 用于存储备份文件的 Swift 对象存储容器。
 真
swiftSecretName （swiftSecret名称） 字符串 保存 Swift 凭据的 K8s 密钥的名称。密钥必须包含密钥 “Key” 和 “User”，并且这些密钥必须包含相应的凭据：服务访问密钥和服务用户名（后者的模式不允许特殊字符 &，<，>，”）
 真
前缀 字符串 自选。swift 容器中备份文件的前缀 （path）。
 假

spec.modulesList[]

↩ 父母

Redis Enterprise 模块（请参阅 https://redis.io/docs/latest/develop/reference/modules/)

名字 类型 描述 必填
名字 字符串 模块的名称，例如 “search” 或 “ReJSON”。集群中可用模块的完整列表可以从 REC 的 '.status.modules' 字段中检索。
 真
配置 字符串 模块命令行参数，例如 VKEY_MAX_ENTITY_COUNT 30、30
 假
版本 字符串 模块的语义版本，例如 '1.6.12'。对于 REDB 是可选的，必须为 REAADB 设置。请注意，此字段已弃用，并将在未来版本中删除。
 假

spec.redisEnterpriseCluster

↩ 父母

连接到 Redis Enterprise Cluster

名字 类型 描述 必填
名字 字符串 应存储数据库的 Redis Enterprise Cluster 的名称。
 真

spec.replicaSources的

↩ 父母

名字 类型 描述 必填
replicaSourceName （复制源名称） 字符串 从中派生源数据库 URI 的资源的名称。资源类型必须与 ReplicaSourceType 字段中指定的类型匹配。
 真
replicaSourceType 字符串 从中派生源数据库 URI 的资源类型。如果设置为 'SECRET'，则源数据库 URI 派生自 ReplicaSourceName 字段中命名的密钥。密钥必须具有一个名为“uri”的密钥，该密钥以“redis://...”的形式定义源数据库的 URI。密钥的类型（kubernetes、vault 等）由底层 REC 对象使用的密钥机制决定。如果设置为 'REDB'，则源数据库 URI 派生自 ReplicaSourceName 字段中命名的 RedisEnterpriseDatabase 资源。
 真
clientKeySecret 客户端密钥 字符串 定义目标数据库集群中 syncer 使用的客户端证书和密钥的 Secret。密钥的映射中必须有 2 个密钥：“cert”是 PEM 编码的证书，“key”是 PEM 编码的私钥。
 假
压缩 整数 用于复制的 GZIP 压缩级别 （0-6）。
 假
服务器 CertSecret 字符串 定义源数据库集群中代理使用的服务器证书的密钥。密钥的映射中必须有 1 个密钥：“cert”，这是 PEM 编码的证书。
 假
tlsSniName 字符串 用于复制链接的 TLS SNI 名称。
 假

spec.roles权限

↩ 父母

Redis Enterprise 角色和 ACL 绑定

名字 类型 描述 必填
ACL 字符串 RolePermissionType 的 acl 名称
 真
角色 字符串 RolePermissionType 的角色名称
 真
类型 字符串 Redis 企业级数据库角色权限的类型
 真

spec.upgrade规格

↩ 父母

数据库升级规格。

名字 类型 描述 必填
upgradeModulesToLatest 布尔 已弃用 在数据库升级作期间将模块升级到支持数据库版本的最新版本，要升级数据库版本，请查看“redisVersion”字段。注意 - 所有模块都必须不指定版本。此外，主动-主动数据库当前不支持此字段。默认值为 true
 真

地位

↩ 父母

RedisEnterpriseDatabaseStatus 定义 RedisEnterpriseDatabase 的观察状态

名字 类型 描述 必填
主动主动 对象 与主动-主动数据库的连接/关联。
 假
备份信息 对象 有关数据库定期备份的信息
 假
createdTime （创建时间） 字符串 创建数据库的时间
 假
数据库 UID 字符串 redis enterprise 提供的数据库 UID
 假
internalEndpoints []对象 Redis Enterprise Cluster 内部列出的终端节点。可用于关联 ReplicaSourceStatus 条目。
 假
lastAction状态 字符串 作员在此数据库上完成的最后一个作的状态
 假
lastActionUid 字符串 作员对此数据库执行的最后一个作的 UID
 假
lastUpdated 字符串 上次更新数据库的时间
 假
观察生成 整数 完全执行作的 REDB 资源的生成（K8s 的内置更新计数器），这意味着所有更改都已处理并作为 API 调用发送到 Redis 企业集群 （REC）。此字段值应等于处理资源更改时的当前代值。注意：lastActionStatus 字段跟踪 Redis Enterprise Cluster 异步处理的作。

格式：int64
 假
redisEnterpriseCluster 字符串 与此资源关联的 Redis Enterprise Cluster Object
 假
replicaSource状态 []对象 ReplicaSource 状态
 假
shardStatuses map[string]整数 分片的聚合状态
 假
specStatus 字符串 所需的规格是否有效
 假
地位 字符串 数据库的状态
 假
版本 字符串 数据库兼容性版本
 假

状态.activeActive

↩ 父母

与主动-主动数据库的连接/关联。

名字 类型 描述 必填
名字 字符串 相应的主动-主动数据库名称，Redis Enterprise 主动主动数据库自定义资源名称，与此资源相关联。如果此资源是在活动活动数据库创建时手动创建的，则必须通过用户填写此字段，否则，作员将自动分配此字段。注意：此功能目前不受支持。
 真
participatingClusterName 字符串 相应的参与集群名称，Redis Enterprise Remote Cluster 自定义资源名称，在主动-主动数据库中，如果此资源是在活动活动数据库创建时手动创建的，则必须通过用户填写此字段，否则，作员将自动分配此字段。注意：此功能目前不受支持。
 真

status.backupInfo

↩ 父母

有关数据库定期备份的信息

名字 类型 描述 必填
backupFailureReason 备份失败原因 字符串 上次备份过程失败的原因
 假
备份历史 整数 备份历史记录保留策略（天数，0 表示永久）
 假
backupInterval 备份间隔 整数 启动自动备份的时间间隔（以秒为单位）
 假
backupIntervalOffset 整数 启动自动备份时与轮次备份间隔的偏移量（以秒为单位）（应小于 backup_interval）
 假
backupProgressPercentage 备份进度百分比 整数 数据库计划的定期备份进度（百分比）
 假
backupStatus 字符串 计划的定期备份过程的状态
 假
lastBackupTime （上次备份时间） 字符串 上次成功备份的时间
 假

status.internalEndpoints[]

↩ 父母

名字 类型 描述 必填
主机 字符串 分配给数据库的主机名
 假
港口 整数 数据库端口名称
 假

status.replicaSource状态

↩ 父母

名字 类型 描述 必填
端点主机 字符串 副本源数据库的内部主机名。可用作标识符。请参阅 redb 状态上的 internalEndpoints 列表。
 真
滞后 整数 源和目标之间的滞后（以毫秒为单位）（同步时）。
 假
lastError 字符串 从源同步时遇到的最后一个错误。
 假
lastUpdate （上次更新） 字符串 我们上次从源接收更新的时间。
 假
rdbSize 整数 在同步阶段要传输的源的 RDB 大小。
 假
rdb已转移 整数 在同步阶段从源的 RDB 传输的字节数。
 假
地位 字符串 此源的同步状态
 假