RedisEnterpriseDatabase API 参考

api版本：

app.redislabs.com/v1alpha1

RedisEnterpriseDatabase 是 redisenterprisedatabases API 的架构

姓名 类型 描述 必需的
api版本 细绳 app.redislabs.com/v1alpha1 真的
种类 细绳 Redis企业数据库 真的
元数据 目的 有关“元数据”字段的详细信息，请参阅 Kubernetes API 文档。 真的
规格 目的 RedisEnterpriseDatabaseSpec 定义 RedisEnterpriseDatabase 的期望状态
 错误的
地位 目的 RedisEnterpriseDatabaseStatus 定义观察到的 RedisEnterpriseDatabase 状态
 错误的

规格

↩ 家长

RedisEnterpriseDatabaseSpec 定义 RedisEnterpriseDatabase 的期望状态

姓名 类型 描述 必需的
活跃活跃 目的 与 Active-Active 数据库的连接/关联。
 错误的
警报设置 目的 数据库警报设置
 错误的
备份 目的 自动数据库备份的目标。
 错误的
客户端身份验证证书 []细绳 包含用于身份验证的 TLS 客户端证书的 Secrets
 错误的
数据节点间加密 布尔值 节点间加密 (INE) 设置。可选的布尔设置，覆盖类似的集群范围策略。如果设置为 False，则保证为此数据库关闭 INE（无论集群范围策略如何）。如果设置为 True，则将打开 INE，除非数据库不支持该功能（在这种情况下，我们将收到错误并且数据库创建将失败）。如果未指定，则如果数据库不支持节点间加密（无论集群默认值如何），则将被禁用。在明确设置其值后删除此属性将不起作用。
 错误的
数据库端口 整数 数据库端口号。数据库可用的 TCP 端口。如果省略，将自动生成。创建后无法更改
 错误的
数据库机密名称 细绳 保存数据库密码的密钥的名称（仅限 redis 数据库）。如果密钥不存在，则会创建该密钥。要定义密码，请创建一个不透明密钥并在规范中设置名称。密码将从“password”键的值中获取。使用空字符串作为密钥中的值可禁用数据库的身份验证。注意 - 对于 Active-Active 数据库，不会自动创建此密钥，并且不能为 memcached 数据库设置值，也不会为其自动创建密钥/密码。使用 memcachedSaslSecretName 字段设置 memcached 数据库的身份验证参数。
 错误的
默认用户 布尔值 是否允许使用默认用户连接？
 错误的
驱逐政策 细绳 数据库驱逐政策。更多信息请参见 https://docs.redislabs.com/latest/rs/administering/database-operations/eviction-policy/
 错误的
伊斯罗夫 布尔值 是否为 RoF 数据库。仅适用于“REDIS”类型的数据库。如果留空则假定为 false。
 错误的
memcachedSaslSecret名称 细绳 用于 memcached 数据库中二进制身份验证的凭据。凭据应保存为不透明的机密，并且应使用此字段配置该机密的名称。对于用户名，使用“用户名”作为键，实际用户名作为值。对于密码，使用“密码”作为键，实际密码作为值。请注意，连接未加密。
 错误的
内存大小 细绳 数据库内存大小。使用 100MB、0.1GB 等格式。最小值为 100MB。当启用 redis on flash (RoF) 时，此值指的是 RAM+Flash 内存，并且不得低于 1GB。
 错误的
模块列表 []目的 与数据库关联的模块列表。注意 - 对于 Active-Active 数据库，此功能目前处于预览阶段。要使此功能对 Active-Active 数据库生效，请将名为“ENABLE_ALPHA_FEATURES”的布尔环境变量设置为 True。此变量可以通过 redis-enterprise-operator pod 规范或通过 operator-environment-config 配置映射进行设置。
 错误的
oss集群 布尔值 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/
 错误的
redis企业集群 目的 连接到 Redis 企业集群
 错误的
redis版本 细绳 Redis OSS 版本。版本可以通过以下方式指定前缀，或通过渠道 - 对于现有数据库 - 升级 Redis OSS 版本。对于新数据库 - 将使用其创建数据库的版本。如果设置为“major”- 将始终升级到最新的主要 Redis 版本。如果设置为“latest”- 将始终升级到最新的 Redis 版本。取决于“redisUpgradePolicy”- 如果要将某些数据库的值设置为“latest”，则必须先在集群上设置 redisUpgradePolicy。可能的值是“major”或“latest”使用升级时 - 请确保先备份数据库。此值仅用于数据库类型“redis”
 错误的
副本源 []目的 从哪些数据库进行复制
 错误的
复制 布尔值 内存数据库复制。启用后，数据库将为每个主服务器提供副本分片 - 从而提高可用性。默认为 false。
 错误的
响应3 布尔值 此数据库是否支持 RESP3 协议。注意 - 明确设置其值后删除此属性将不起作用。请查看 RS 文档中的相应字段以获取更多信息。
 错误的
内存大小 细绳 RoF 数据库的 RAM 部分的大小。与“memorySize”类似，使用 100MB、0.1GB 等格式。它必须至少为“memorySize”指定的总内存大小（RAM 和闪存）的 10%。
 错误的
角色权限 []目的 要应用的 Redis Enteprise ACL 和角色绑定列表
 错误的
分片数量 整数 数据库服务器端分片的数量
 错误的
已启用分片 布尔值 切换 REAADB（主动主动数据库）的数据库分片，默认情况下启用。此字段对于 REDB（非主动主动数据库）是屏蔽的，分片通过 shardCount 字段切换 - 当 shardCount 为 1 时，此字段被禁用，否则启用。
 错误的
shards放置 枚举 控制分片的密度 - 它们应该驻留在尽可能少的还是尽可能多的节点上。可用选项为“密集”或“稀疏”。如果未设置，则默认为“密集”。

枚举：密集、稀疏
 错误的
tls模式 枚举 要求与数据库建立 SSL 认证和加密连接。已启用 - 所有传入数据库的连接都必须使用 SSL。已禁用 - 传入数据库的连接均不应使用 SSL。replica_ssl - 从此数据库复制的数据库需要使用 SSL。

枚举：已禁用、已启用、replica_ssl
 错误的
类型 枚举 数据库类型（redis 或 memcached）。默认为“redis”。

枚举：redis、memcached
 错误的
升级规格 目的 DB 升级的规范。
 错误的

spec.active活动

↩ 家长

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

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

spec.alert设置

↩ 家长

数据库警报设置

姓名 类型 描述 必需的
备份延迟 目的 定期备份已延迟超过指定的阈值 [分钟]。-注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_crdt_src_high_syncer_lag 目的 主动-主动源 - 同步滞后高于指定阈值 [秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_crdt_src_syncer_connection_error 目的 主动-主动源 - 尝试连接副本源时同步出现连接错误 - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_crdt_src_syncer_general_error 目的 主动-主动源 - 同步遇到一般错误 - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
db_high_latency 目的 延迟高于指定阈值 [微秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_high_throughput 目的 吞吐量高于指定阈值 [请求数/秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
长运行动作 目的 对运行时间过长的状态机发出警报 - 注意阈值已被注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
db_low_throughput 目的 吞吐量低于指定阈值 [请求数/秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_ram_dataset_overhead 目的 分片的数据集 RAM 开销已达到阈值 [其 RAM 限制的 %] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
变量 bdb_ram_values 目的 分片 RAM 中保存的值的百分比低于 [其键计数的百分比] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_replica_src_high_syncer_lag 目的 源副本 - 同步滞后高于指定阈值 [秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_replica_src_syncer_connection_error 目的 源的副本 - 尝试连接副本源时，同步出现连接错误 - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
bdb_shard_num_ram_values 目的 分片 RAM 中保存的值的数量低于 [值] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的
 错误的
数据库大小 目的 数据集大小已达到阈值 [内存限制的百分比] 预期字段：-注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但为必填项
 错误的

spec.alertSettings.bdb_backup_delayed

↩ 家长

定期备份已延迟超过指定的阈值 [分钟]。-注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_crdt_src_high_syncer_lag

↩ 家长

主动-主动源 - 同步滞后高于指定阈值 [秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_crdt_src_syncer_connection_error

↩ 家长

主动-主动源 - 尝试连接副本源时同步出现连接错误 - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_crdt_src_syncer_general_error

↩ 家长

主动-主动源 - 同步遇到一般错误 - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_high_latency

↩ 家长

延迟高于指定阈值 [微秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_high_throughput

↩ 家长

吞吐量高于指定阈值 [请求数/秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_long_running_action

↩ 家长

对运行时间过长的状态机发出警报 - 注意阈值已被注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_low_throughput

↩ 家长

吞吐量低于指定阈值 [请求数/秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_ram_dataset_overhead

↩ 家长

分片的数据集 RAM 开销已达到阈值 [其 RAM 限制的 %] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_ram_values

↩ 家长

分片 RAM 中保存的值的百分比低于 [其键计数的百分比] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_replica_src_high_syncer_lag

↩ 家长

源副本 - 同步滞后高于指定阈值 [秒] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_replica_src_syncer_connection_error

↩ 家长

源的副本 - 尝试连接副本源时，同步出现连接错误 - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_shard_num_ram_values

↩ 家长

分片 RAM 中保存的值的数量低于 [值] - 注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但这是必需的

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

spec.alertSettings.bdb_size

↩ 家长

数据集大小已达到阈值 [内存限制的百分比] 预期字段：-注意阈值已注释（允许字符串/整数/浮点数并支持向后兼容）但为必填项

姓名 类型 描述 必需的
已启用 布尔值 已启用或禁用警报
 错误的

规格备份

↩ 家长

自动数据库备份的目标。

姓名 类型 描述 必需的
腹肌 目的
错误的
FTP 目的
错误的
气相色谱 目的 Google存储
 错误的
间隔 整数 备份间隔（秒）
 错误的
山 目的 安装点存储
 错误的
s3 目的
错误的
安全FTP 目的
错误的
迅速 目的
错误的

规格.备份.abs

↩ 家长

姓名 类型 描述 必需的
绝对秘密名称 细绳 保存 ABS 凭证的 K8s 密钥的名称。密钥必须包含密钥“AccountName”和“AccountKey”，并且这些密钥必须保存相应的凭证
 真的
容器 细绳 Azure Blob 存储容器名称。
 真的
子目录 细绳 可选。容器下的 Azure Blob 存储子目录。
 错误的

规范.备份.ftp

↩ 家长

姓名 类型 描述 必需的
网址 细绳 ftps://[USER[:PASSWORD]@]HOST[:PORT]/PATH[/] 的 URI
 真的

规范.备份.gcs

↩ 家长

Google存储

姓名 类型 描述 必需的
bucket名称 细绳 Google 存储空间名称。
 真的
gcsSecret名称 细绳 保存 Google Cloud Storage 凭据的 K8s 密钥的名称。密钥必须包含密钥“CLIENT_ID”、“PRIVATE_KEY”、“PRIVATE_KEY_ID”、“CLIENT_EMAIL”，并且这些密钥必须保存相应的凭据。密钥应与密钥 JSON 中的值相对应。
 真的
子目录 细绳 可选。存储桶下的 Google Storage 子目录。
 错误的

规范.备份.挂载

↩ 家长

安装点存储

姓名 类型 描述 必需的
小路 细绳 本地挂载点的路径。您必须在所有节点上创建挂载点，并且 redislabs:redislabs 用户必须对本地挂载点具有读写权限。
 真的

规格.备份.s3

↩ 家长

姓名 类型 描述 必需的
awsSecret名称 细绳 保存 AWS 凭证的 K8s 密钥的名称。密钥必须包含密钥“AWS_ACCESS_KEY_ID”和“AWS_SECRET_ACCESS_KEY”，并且这些密钥必须保存相应的凭证。
 真的
bucket名称 细绳 Amazon S3 存储桶名称。
 真的
子目录 细绳 可选。存储桶下的 Amazon S3 子目录。
 错误的

规范.备份.sftp

↩ 家长

姓名 类型 描述 必需的
sftpSecret名称 细绳 保存 SFTP 凭据的 K8s 机密的名称。机密必须包含“Key”密钥，即用于连接到 sftp 服务器的 SSH 私钥。
 真的
sftp_url 细绳 SFTP 网址
 真的

规格.备份.swift

↩ 家长

姓名 类型 描述 必需的
验证网址 细绳 Swift 服务认证 URL。
 真的
容器 细绳 用于存储备份文件的 Swift 对象存储容器。
 真的
swiftSecret名称 细绳 保存 Swift 凭证的 K8s 机密的名称。机密必须包含密钥“Key”和“User”，并且这些密钥必须保存相应的凭证：服务访问密钥和服务用户名（后者的模式不允许使用特殊字符 &、<、>、”）
 真的
前缀 细绳 可选。swift 容器中备份文件的前缀（路径）。
 错误的

规格.模块列表[]

↩ 家长

Redis 企业模块：https://redislabs.com/redis-enterprise/modules/

姓名 类型 描述 必需的
姓名 细绳 模块的名称，例如 redissearch 的“ft”
 真的
配置 细绳 模块命令行参数，例如 VKEY_MAX_ENTITY_COUNT 30
 错误的
版本 细绳 模块的语义版本，例如“1.6.12”- 仅在 REDB 中可选，必须在 REAADB 中设置
 错误的

spec.redisEnterpriseCluster

↩ 家长

连接到 Redis 企业集群

姓名 类型 描述 必需的
姓名 细绳 应存储数据库的 Redis 企业集群的名称。
 真的

spec.replicaSources[]

↩ 家长

姓名 类型 描述 必需的
副本源名称 细绳 源数据库 URI 所源自的资源的名称。资源类型必须与 ReplicaSourceType 字段中指定的类型匹配。
 真的
副本源类型 细绳 源数据库 URI 所源自的资源类型。如果设置为“SECRET”，则源数据库 URI 源自 ReplicaSourceName 字段中指定的机密。机密必须具有一个名为“uri”的键，该键以“redis://...”的形式定义源数据库的 URI。机密的类型（kubernetes、vault 等）由底层 REC 对象使用的机密机制决定。如果设置为“REDB”，则源数据库 URI 源自 ReplicaSourceName 字段中指定的 RedisEnterpriseDatabase 资源。
 真的
客户端密钥秘密 细绳 定义目标数据库集群中的同步器使用的客户端证书和密钥的密钥。密钥的映射中必须包含 2 个密钥：“cert”（PEM 编码的证书）和“key”（PEM 编码的私钥）。
 错误的
压缩 整数 用于复制的 GZIP 压缩级别（0-6）。
 错误的
服务器证书机密 细绳 定义源数据库集群中的代理使用的服务器证书的密钥。密钥的映射中必须有 1 个密钥：“cert”，即 PEM 编码的证书。
 错误的
tlsSni名称 细绳 用于复制链接的 TLS SNI 名称。
 错误的

规范.rolesPermissions[]

↩ 家长

Redis 企业角色和 ACL 绑定

姓名 类型 描述 必需的
访问控制列表 细绳 RolePermissionType 的 Acl 名称
 真的
角色 细绳 RolePermissionType 的角色名称
 真的
类型 细绳 Redis Enterprise 数据库角色权限类型
 真的

spec.upgradeSpec

↩ 家长

DB 升级的规范。

姓名 类型 描述 必需的
升级模块到最新版 布尔值 在数据库升级操作期间将模块升级到支持数据库版本的最新版本，要升级数据库版本，请查看“redisVersion”字段。注意 - 所有模块都必须不指定版本。此外，此字段目前不支持 Active-Active 数据库。
 真的

地位

↩ 家长

RedisEnterpriseDatabaseStatus 定义观察到的 RedisEnterpriseDatabase 状态

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

格式：int64
 错误的
redis企业集群 细绳 与此资源关联的 Redis 企业集群对象
 错误的
副本源状态 []目的 ReplicaSource 状态
 错误的
分片状态 映射[字符串]整数 分片的聚合状态
 错误的
规格状态 细绳 所需规范是否有效
 错误的
地位 细绳 数据库的状态
 错误的
版本 细绳 数据库兼容版本
 错误的

status.active 活跃

↩ 家长

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

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

状态.备份信息

↩ 家长

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

姓名 类型 描述 必需的
备份失败原因 细绳 上次备份过程失败的原因
 错误的
备份历史 整数 备份历史保留策略（天数，0 为永久）
 错误的
备份间隔 整数 启动自动备份的间隔（秒）
 错误的
备份间隔偏移量 整数 自动备份启动时的备份间隔偏移量（以秒为单位）（应小于 backup_interval）
 错误的
备份进度百分比 整数 数据库计划定期备份进度（百分比）
 错误的
备份状态 细绳 计划定期备份进程的状态
 错误的
上次备份时间 细绳 上次成功备份的时间
 错误的

状态.内部端点[]

↩ 家长

姓名 类型 描述 必需的
主持人 细绳 分配给数据库的主机名
 错误的
港口 整数 数据库端口名称
 错误的

status.replicaSourceStatuses[]

↩ 家长

姓名 类型 描述 必需的
端点主机 细绳 副本源数据库的内部主机名。可用作标识符。请参阅 REDB 状态上的 internalEndpoints 列表。
 真的
落后 整数 源和目标之间的延迟（以毫秒为单位）（同步时）。
 错误的
最后错误 细绳 从源同步时遇到的最后一个错误。
 错误的
最后更新时间 细绳 我们上次从源接收更新的时间。
 错误的
数据库大小 整数 同步阶段要传输的源的 RDB 大小。
 错误的
rdb已转移 整数 同步阶段从源 RDB 传输的字节数。
 错误的
地位 细绳 此源的同步状态
 错误的
给此页面评分
返回顶部 ↑