diff --git a/content/embeds/k8s/log_collector_role_all_mode.md b/content/embeds/k8s/log_collector_role_all_mode.md index 6f56c7a6d1..2a96722342 100644 --- a/content/embeds/k8s/log_collector_role_all_mode.md +++ b/content/embeds/k8s/log_collector_role_all_mode.md @@ -170,13 +170,6 @@ rules: verbs: - get - list -- apiGroups: - - policy - resources: - - podsecuritypolicy - verbs: - - get - - list - apiGroups: - certificates.k8s.io resources: diff --git a/content/embeds/k8s/openshift_rec.md b/content/embeds/k8s/openshift_rec.md index 7f4978586d..ac360007fd 100644 --- a/content/embeds/k8s/openshift_rec.md +++ b/content/embeds/k8s/openshift_rec.md @@ -6,11 +6,27 @@ metadata: labels: app: redis-enterprise spec: - # Add fields here + # The number of Redis Enterprise nodes in the clusters. nodes: 3 + + persistentSpec: + # Whether to enable persistent storage for the Redis Enterprise nodes. + enabled: true + + # The size of the persistent volume for each Redis Enterprise node. + volumeSize: 20Gi + + # The resources allocated to each Redis Enterprise node. + redisEnterpriseNodeResources: + requests: + cpu: 2 + memory: 4Gi + limits: + cpu: 2 + memory: 4Gi redisEnterpriseImageSpec: repository: registry.connect.redhat.com/redislabs/redis-enterprise - versionTag: 7.8.4-66.rhel8-openshift + versionTag: 7.8.6-13 redisEnterpriseServicesRiggerImageSpec: repository: registry.connect.redhat.com/redislabs/services-manager bootstrapperImageSpec: diff --git a/content/embeds/k8s/openshift_role.md b/content/embeds/k8s/openshift_role.md index e228260e83..4ec70f6635 100644 --- a/content/embeds/k8s/openshift_role.md +++ b/content/embeds/k8s/openshift_role.md @@ -22,18 +22,7 @@ rules: - apiGroups: - app.redislabs.com resources: - - redisenterpriseclusters - - redisenterpriseclusters/status - - redisenterpriseclusters/finalizers - - redisenterprisedatabases - - redisenterprisedatabases/status - - redisenterprisedatabases/finalizers - - redisenterpriseremoteclusters - - redisenterpriseremoteclusters/status - - redisenterpriseremoteclusters/finalizers - - redisenterpriseactiveactivedatabases - - redisenterpriseactiveactivedatabases/status - - redisenterpriseactiveactivedatabases/finalizers + - "*" verbs: - delete - get @@ -93,6 +82,7 @@ rules: - get - list - watch + - update - apiGroups: - "" resources: @@ -138,14 +128,6 @@ rules: - create - delete - watch - - apiGroups: - - policy - resourceNames: - - redis-enterprise-psp - resources: - - podsecuritypolicies - verbs: - - use - apiGroups: - networking.k8s.io resources: diff --git a/content/embeds/k8s/reaadb.md b/content/embeds/k8s/reaadb.md index 744c6f65e2..b68cfeb78c 100644 --- a/content/embeds/k8s/reaadb.md +++ b/content/embeds/k8s/reaadb.md @@ -2,13 +2,14 @@ apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseActiveActiveDatabase metadata: - name: reaadb-1 + name: reaadb labels: app: redis-enterprise spec: participatingClusters: # Participating cluster pointing to RERC named: 'new-york-1'. - name: new-york-1 + # Participating cluster pointing to RERC named: 'boston-1'. - name: boston-1 ``` diff --git a/content/embeds/k8s/rec.md b/content/embeds/k8s/rec.md index 0092204c5c..d24e1e874c 100644 --- a/content/embeds/k8s/rec.md +++ b/content/embeds/k8s/rec.md @@ -6,6 +6,22 @@ metadata: labels: app: redis-enterprise spec: - # Add fields here + # The number of Redis Enterprise nodes in the clusters. nodes: 3 + + persistentSpec: + # Whether to enable persistent storage for the Redis Enterprise nodes. + enabled: true + + # The size of the persistent volume for each Redis Enterprise node. + volumeSize: 20Gi + + # The resources allocated to each Redis Enterprise node. + redisEnterpriseNodeResources: + requests: + cpu: 2 + memory: 4Gi + limits: + cpu: 2 + memory: 4Gi ``` diff --git a/content/embeds/k8s/redb.md b/content/embeds/k8s/redb.md index 5470c080c6..e5dfd2a2bb 100644 --- a/content/embeds/k8s/redb.md +++ b/content/embeds/k8s/redb.md @@ -2,7 +2,16 @@ apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseDatabase metadata: - name: redis-enterprise-database + name: redb labels: app: redis-enterprise +spec: + # Memory size of the database. + memorySize: 256MB + + # Number of shards in the database. + shardCount: 1 + + # Determines whether replication will be enabled for the database. + replication: false ``` diff --git a/content/embeds/k8s/rerc.md b/content/embeds/k8s/rerc.md index 48e80bee38..0bbe2ca09b 100644 --- a/content/embeds/k8s/rerc.md +++ b/content/embeds/k8s/rerc.md @@ -2,21 +2,24 @@ apiVersion: app.redislabs.com/v1alpha1 kind: RedisEnterpriseRemoteCluster metadata: - # Your name of the RERC. name: new-york-1 labels: app: redis-enterprise spec: - # The name of the REC that the RERC is pointing at + # The name of the REC that the RERC is pointing at. recName: rec - # The Namespace of the REC that the RERC is pointing at + + # The namespace of the REC that the RERC is pointing at. recNamespace: ns1 - # The URL of the cluster, will be used for the active-active database URL + + # The URL of the cluster, will be used for the active-active database URL. apiFqdnUrl: testapi-new-york-1-ns1.redislabs.com + # The database URL suffix, will be used for the active-active - # database replication endpoint and replication endpoint SNI + # database replication endpoint and replication endpoint SNI. dbFqdnSuffix: -example-new-york-1-ns1.redislabs.com + # The name of the secret containing cluster credentials. - # Need to follow format: "redis-enterprise-"' + # Needs to be formatted as: "redis-enterprise-" secretName: redis-enterprise-new-york-1 ``` diff --git a/content/embeds/k8s/role.md b/content/embeds/k8s/role.md index 661fad55be..54e8004198 100644 --- a/content/embeds/k8s/role.md +++ b/content/embeds/k8s/role.md @@ -22,18 +22,7 @@ rules: - apiGroups: - app.redislabs.com resources: - - redisenterpriseclusters - - redisenterpriseclusters/status - - redisenterpriseclusters/finalizers - - redisenterprisedatabases - - redisenterprisedatabases/status - - redisenterprisedatabases/finalizers - - redisenterpriseremoteclusters - - redisenterpriseremoteclusters/status - - redisenterpriseremoteclusters/finalizers - - redisenterpriseactiveactivedatabases - - redisenterpriseactiveactivedatabases/status - - redisenterpriseactiveactivedatabases/finalizers + - "*" verbs: - delete - get @@ -93,6 +82,7 @@ rules: - get - list - watch + - update - apiGroups: - "" resources: @@ -138,14 +128,6 @@ rules: - create - delete - watch - - apiGroups: - - policy - resourceNames: - - redis-enterprise-psp - resources: - - podsecuritypolicies - verbs: - - use - apiGroups: - networking.k8s.io resources: diff --git a/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md b/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md index 013a201a28..86be70118a 100644 --- a/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md +++ b/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md @@ -128,6 +128,13 @@ RedisEnterpriseActiveActiveDatabaseSpec defines the desired state of RedisEnterp The name of the remote cluster CR to link.
true + + externalReplicationPort + integer + + The desired replication endpoint's port number for users who utilize LoadBalancers for sync between AA replicas and need to provide the specific port number that the LoadBalancer listens to.
+ + false @@ -227,7 +234,7 @@ The Active-Active database global configurations, contains the global properties modulesList []object - List of modules associated with database. Note - For Active-Active databases this feature is currently in preview. For this feature to take effect for Active-Active databases, set a boolean environment variable with the name "ENABLE_ALPHA_FEATURES" to True. This variable can be set via the redis-enterprise-operator pod spec, or through the operator-environment-config Config Map.
+ List of modules associated with the database. The list of valid modules for the specific cluster can be retrieved from the status of the REC object. Use the "name" and "versions" fields for the specific module configuration. If specifying an explicit version for a module, automatic modules versions upgrade must be disabled by setting the '.upgradeSpec.upgradeModulesToLatest' field in the REC to 'false'. Note that the option to specify module versions is deprecated, and will be removed in future releases.
false @@ -712,7 +719,7 @@ MountPointStorage ### spec.globalConfigurations.modulesList[] [↩ Parent](#specglobalconfigurations) -Redis Enterprise Module: https://redislabs.com/redis-enterprise/modules/ +Redis Enterprise module (see https://redis.io/docs/latest/develop/reference/modules/) @@ -727,28 +734,21 @@ Redis Enterprise Module: https://redislabs.com/redis-enterprise/modules/ - - - - - @@ -897,7 +897,7 @@ Specifications for DB upgrade. diff --git a/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md b/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md index 5b9bd89676..045a522829 100644 --- a/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md +++ b/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md @@ -283,14 +283,6 @@ RedisEnterpriseClusterSpec defines the desired state of RedisEnterpriseCluster Override for the default anti-affinity rules of the Redis Enterprise pods. More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#an-example-of-a-pod-that-uses-pod-affinity
- - - - - @@ -12161,6 +12153,15 @@ Specification for service rigger + + + + + + + + + + + + + + + + + + + + @@ -26649,6 +26675,31 @@ Stores information about cluster certificates and their update process. In Activ
+ + + + + + + + + + + + + + + @@ -26656,6 +26707,13 @@ Stores information about cluster certificates and their update process. In Activ
+ + + + +
name string - The module's name e.g "ft" for redissearch
+ The name of the module, e.g. "search" or "ReJSON". The complete list of modules available in the cluster can be retrieved from the '.status.modules' field in the REC.
 true
config string - Module command line arguments e.g. VKEY_MAX_ENTITY_COUNT 30
- 		false
uidstring - Module's uid - do not set, for system use only nolint:staticcheck // custom json tag unknown to the linter
+ Module command line arguments e.g. VKEY_MAX_ENTITY_COUNT 30 30
 false
version string - Module's semantic version e.g "1.6.12" - optional only in REDB, must be set in REAADB
+ The semantic version of the module, e.g. '1.6.12'. Optional for REDB, must be set for REAADB. Note that this field is deprecated, and will be removed in future releases.
 false
upgradeModulesToLatest boolean - Upgrades the modules to the latest version that supportes the DB version during a DB upgrade action, to upgrade the DB version view the 'redisVersion' field. Note - This field is currently not supported for Active-Active databases.
+ Upgrades the modules to the latest version that supports the DB version during a DB upgrade action, to upgrade the DB version view the 'redisVersion' field. Note - This field is currently not supported for Active-Active databases.
 true
false
podSecurityPolicyNamestring - DEPRECATED PodSecurityPolicy support is removed in Kubernetes v1.25 and the use of this field is invalid for use when running on Kubernetes v1.25+. Future versions of the RedisEnterpriseCluster API will remove support for this field altogether. For migration instructions, see https://kubernetes.io/docs/tasks/configure-pod-container/migrate-from-psp/ - Name of pod security policy to use on pods
- 		false
podStartingPolicy object
databaseServicePortPolicyenum + databaseServicePortPolicy instructs how to determine the service ports for REDB services. Defaults to DatabasePortForward, if not specified otherwise. DatabasePortForward - The service port will be the same as the database port. RedisDefaultPort - The service port will be the default Redis port (6379).
+
+ Enum: DatabasePortForward, RedisDefaultPort
+ 		false
databaseServiceType string @@ -26642,6 +26643,31 @@ Stores information about cluster certificates and their update process. In Activ
false
features[]string +
+ 		false
flashShardsinteger +
+
+ Format: int32
+ 		false
flashShardsLimitinteger +
+
+ Format: int32
+ 		false
licenseState string false
ownerstring +
+ 		false
ramShardsinteger +
+
+ Format: int32
+ 		false
ramShardsLimitinteger +
+
+ Format: int32
+ 		false
shardsLimit integer false
shardsUsagestring +
+ 		false
diff --git a/content/operate/kubernetes/reference/redis_enterprise_database_api.md b/content/operate/kubernetes/reference/redis_enterprise_database_api.md index 5205ddf989..e74581ed01 100644 --- a/content/operate/kubernetes/reference/redis_enterprise_database_api.md +++ b/content/operate/kubernetes/reference/redis_enterprise_database_api.md @@ -171,7 +171,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase modulesList []object - List of modules associated with database. Note - For Active-Active databases this feature is currently in preview. For this feature to take effect for Active-Active databases, set a boolean environment variable with the name "ENABLE_ALPHA_FEATURES" to True. This variable can be set via the redis-enterprise-operator pod spec, or through the operator-environment-config Config Map. Note - if you do not want to upgrade to the latest version you must set upgradeSpec -> upgradeModulesToLatest to false. if you specify a version and do not set the upgradeModulesToLatest it can result errors in the operator. in addition, the option to specify specific version is Deprecated and will be deleted in next releases.
+ List of modules associated with the database. The list of valid modules for the specific cluster can be retrieved from the status of the REC object. Use the "name" and "versions" fields for the specific module configuration. If specifying an explicit version for a module, automatic modules versions upgrade must be disabled by setting the '.upgradeSpec.upgradeModulesToLatest' field in the REC to 'false'. Note that the option to specify module versions is deprecated, and will be removed in future releases.
false @@ -1125,7 +1125,7 @@ MountPointStorage ### spec.modulesList[] [↩ Parent](#spec) -Redis Enterprise Module: https://redislabs.com/redis-enterprise/modules/ +Redis Enterprise module (see https://redis.io/docs/latest/develop/reference/modules/) @@ -1140,21 +1140,21 @@ Redis Enterprise Module: https://redislabs.com/redis-enterprise/modules/ diff --git a/content/operate/rc/databases/create-database/create-pro-database-new.md b/content/operate/rc/databases/create-database/create-pro-database-new.md index 1c54d9297e..db4c60949b 100644 --- a/content/operate/rc/databases/create-database/create-pro-database-new.md +++ b/content/operate/rc/databases/create-database/create-pro-database-new.md @@ -160,11 +160,10 @@ By default, you're shown basic settings, which include: | Database setting | Description | |:---------|:-----------| | **Name** | A custom name for your database (_required_) | -| **Advanced Capabilities** | [Advanced features and data types]({{< relref "/operate/rc/databases/configuration/advanced-capabilities" >}}) used by the database. Choose from [Search and query]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search" >}}), [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}), [Time series]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries" >}}), or [Probabilistic]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom" >}}).
Databases with Search and query have specific sizing requirements, see [Search and query sizing]({{< relref "/operate/rc/databases/configuration/advanced-capabilities#search-and-query-sizing" >}}) for more information. | -| **Query performance factor** | *(Search and query databases on Redis 7.2 or later only)* Adds additional compute power to process your query and vector search workloads and boost your queries per second. See [Search and query sizing]({{< relref "/operate/rc/databases/configuration/advanced-capabilities#search-and-query-sizing" >}}) for more information. | -| **Throughput** | Identifies maximum throughput for the database, which is specified in terms of operations per second (**Ops/sec**). See [Throughput]({{< relref "/operate/rc/databases/configuration/clustering#throughput" >}}) for more information.
Databases with Search and query have specific throughput requirements, see [Search and query sizing]({{< relref "/operate/rc/databases/configuration/advanced-capabilities#search-and-query-sizing" >}}) for more information. | | **Dataset size (GB)** | The amount of data for your dataset. Specify small sizes as decimals of 1.0 GB; example: `0.1` GB (minimum). We calculate the total memory limit for you based on the other settings you choose for your database.
Databases with Search and query have specific sizing requirements, see [Search and query sizing]({{< relref "/operate/rc/databases/configuration/advanced-capabilities#search-and-query-sizing" >}}) for more information. | | **High Availability** | Indicates whether a replica copy of the database is maintained in case the primary database becomes unavailable. (Warning: Doubles memory consumption). See [High Availability]({{< relref "/operate/rc/databases/configuration/high-availability" >}}). | +| **Throughput** | Identifies maximum throughput for the database, which is specified in terms of operations per second (**Ops/sec**). See [Throughput]({{< relref "/operate/rc/databases/configuration/clustering#throughput" >}}) for more information.
Databases with Search and query have specific throughput requirements, see [Search and query sizing]({{< relref "/operate/rc/databases/configuration/advanced-capabilities#search-and-query-sizing" >}}) for more information. | +| **Query performance factor** | *(Search and query databases on Redis 7.2 or later only)* Adds additional compute power to process your query and vector search workloads and boost your queries per second. See [Search and query sizing]({{< relref "/operate/rc/databases/configuration/advanced-capabilities#search-and-query-sizing" >}}) for more information. | | **Data Persistence** | Defines the data persistence policy, if any. See [Data persistence]({{< relref "/operate/rc/databases/configuration/data-persistence.md" >}}). | Select **More options** to specify values for the following settings. @@ -173,6 +172,7 @@ Select **More options** to specify values for the following settings. | Database option | Description | |:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Advanced Capabilities** | [Advanced features and data types]({{< relref "/operate/rc/databases/configuration/advanced-capabilities" >}}) used by the database. Choose from [Search and query]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search" >}}), [JSON]({{< relref "/operate/oss_and_stack/stack-with-enterprise/json" >}}), [Time series]({{< relref "/operate/oss_and_stack/stack-with-enterprise/timeseries" >}}), or [Probabilistic]({{< relref "/operate/oss_and_stack/stack-with-enterprise/bloom" >}}).
Databases with Search and query have specific sizing requirements, see [Search and query sizing]({{< relref "/operate/rc/databases/configuration/advanced-capabilities#search-and-query-sizing" >}}) for more information. | | **OSS Cluster API** | Enable to use the [Redis Cluster API]({{< relref "/operate/rc/databases/configuration/clustering#oss-cluster-api" >}}). | | **Type** | Set to **Redis**, otherwise **Memcached** database for legacy database support. | | **Supported Protocol(s)** | Choose between RESP2 and RESP3 _(Redis 7.2 only)_. See [Redis serialization protocol]({{< relref "/develop/reference/protocol-spec" >}}#resp-versions) for details | diff --git a/static/images/rc/flexible-add-database-advanced.png b/static/images/rc/flexible-add-database-advanced.png index 1a5922af2f..490d4ca946 100644 Binary files a/static/images/rc/flexible-add-database-advanced.png and b/static/images/rc/flexible-add-database-advanced.png differ diff --git a/static/images/rc/flexible-add-database-basic.png b/static/images/rc/flexible-add-database-basic.png index db0d967565..8305733ad8 100644 Binary files a/static/images/rc/flexible-add-database-basic.png and b/static/images/rc/flexible-add-database-basic.png differ
name string - The module's name e.g "ft" for redissearch
+ The name of the module, e.g. "search" or "ReJSON". The complete list of modules available in the cluster can be retrieved from the '.status.modules' field in the REC.
 true
config string - Module command line arguments e.g. VKEY_MAX_ENTITY_COUNT 30
+ Module command line arguments e.g. VKEY_MAX_ENTITY_COUNT 30 30
 false
version string - DEPRECATED - Module's semantic version e.g "1.6.12" - optional only in REDB, must be set in REAADB
+ The semantic version of the module, e.g. '1.6.12'. Optional for REDB, must be set for REAADB. Note that this field is deprecated, and will be removed in future releases.
 false