diff --git a/docs/guides/redis/clustering/redis-cluster.md b/docs/guides/redis/clustering/redis-cluster.md index dbac2d68d3..28817935e7 100644 --- a/docs/guides/redis/clustering/redis-cluster.md +++ b/docs/guides/redis/clustering/redis-cluster.md @@ -116,7 +116,7 @@ redis-cluster ClusterIP 10.96.115.92 6379/TCP 3m4s redis-cluster-pods ClusterIP None 6379/TCP 3m4s ``` -KubeDB operator sets the `status.phase` to `Running` once the database is successfully created. Run the following command to see the modified `Redis` object: +KubeDB operator sets the `status.phase` to `Ready` once the database is successfully created. Run the following command to see the modified `Redis` object: ```bash $ kubectl get rd -n demo redis-cluster -o yaml diff --git a/docs/guides/redis/concepts/autoscaler.md b/docs/guides/redis/concepts/autoscaler.md index ac1ee79302..af14d09637 100644 --- a/docs/guides/redis/concepts/autoscaler.md +++ b/docs/guides/redis/concepts/autoscaler.md @@ -24,7 +24,7 @@ section_menu_id: guides Like any official Kubernetes resource, a `RedisAutoscaler` has `TypeMeta`, `ObjectMeta`, `Spec` and `Status` sections. -Here is a sample `RedisAutoscaler` CROs for autoscaling different components of database is given below: +Here is a sample `RedisAutoscaler` CRDs for autoscaling different components of database is given below: **Sample `RedisAutoscaler` for standalone database:** @@ -60,7 +60,7 @@ spec: scalingThreshold: 20 ``` -Here is a sample `RedisSentinelAutoscaler` CROs for autoscaling different components of database is given below: +Here is a sample `RedisSentinelAutoscaler` CRDs for autoscaling different components of database is given below: **Sample `RedisSentinelAutoscaler` for standalone database:** ```yaml @@ -101,7 +101,7 @@ A `RedisAutoscaler` object has the following fields in the `spec` section. - **spec.databaseRef.name :** specifies the name of the [Redis](/docs/guides/redis/concepts/redis.md) object. ### spec.opsRequestOptions -These are the options to pass in the internally created opsRequest CRO. `opsRequestOptions` has three fields. They have been described in details [here](/docs/guides/redis/concepts/redisopsrequest.md#specreadinesscriteria). +These are the options to pass in the internally created opsRequest CRD. `opsRequestOptions` has three fields. They have been described in details [here](/docs/guides/redis/concepts/redisopsrequest.md#specreadinesscriteria). ### spec.compute diff --git a/docs/guides/redis/concepts/catalog.md b/docs/guides/redis/concepts/catalog.md index 113873025e..ab8a4fe175 100644 --- a/docs/guides/redis/concepts/catalog.md +++ b/docs/guides/redis/concepts/catalog.md @@ -104,7 +104,7 @@ On the other hand, `DenyList` contains all the rejected versions for the update ### spec.podSecurityPolicies.databasePolicyName -`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running. To use a user-defined policy, the name of the polict has to be set in `spec.podSecurityPolicies` and in the list of allowed policy names in KubeDB operator like below: +`spec.podSecurityPolicies.databasePolicyName` is a required field that specifies the name of the pod security policy required to get the database server pod(s) running. To use a user-defined policy, the name of the policy has to be set in `spec.podSecurityPolicies` and in the list of allowed policy names in KubeDB operator like below: ```bash helm upgrade kubedb-operator appscode/kubedb --namespace kube-system \ diff --git a/docs/guides/redis/concepts/redis.md b/docs/guides/redis/concepts/redis.md index f5004eefc1..cc43823cfe 100644 --- a/docs/guides/redis/concepts/redis.md +++ b/docs/guides/redis/concepts/redis.md @@ -335,11 +335,10 @@ Uses of some field of `spec.podTemplate` is described below, `spec.podTemplate.spec.resources` is an optional field. This can be used to request compute resources required by the database pods. To learn more, visit [here](http://kubernetes.io/docs/user-guide/compute-resources/). -### spec.serviceTemplate +### spec.serviceTemplates -You can also provide a template for the services created by KubeDB operator for Redis server through `spec.serviceTemplate`. This will allow you to set the type and other properties of the services. +You can also provide a template for the services created by KubeDB operator for Redis server through `spec.serviceTemplates`. This will allow you to set the type and other properties of the services. -KubeDB allows following fields to set in `spec.serviceTemplate`: KubeDB allows following fields to set in `spec.serviceTemplates`: - `alias` represents the identifier of the service. It has the following possible value: - `primary` is used for the primary service identification. diff --git a/docs/guides/redis/concepts/redissentinel.md b/docs/guides/redis/concepts/redissentinel.md index f1ef182477..c2dd7a72db 100644 --- a/docs/guides/redis/concepts/redissentinel.md +++ b/docs/guides/redis/concepts/redissentinel.md @@ -311,11 +311,11 @@ spec.podTemplate.spec.env `spec.podTemplate.spec.resources` is an optional field. This can be used to request compute resources required by the database pods. To learn more, visit [here](http://kubernetes.io/docs/user-guide/compute-resources/). -### spec.serviceTemplate +### spec.serviceTemplates -You can also provide a template for the services created by KubeDB operator for Redis server through `spec.serviceTemplate`. This will allow you to set the type and other properties of the services. +You can also provide a template for the services created by KubeDB operator for Redis server through `spec.serviceTemplates`. This will allow you to set the type and other properties of the services. -KubeDB allows following fields to set in `spec.serviceTemplate`: +KubeDB allows following fields to set in `spec.serviceTemplates`: - metadata: - annotations diff --git a/docs/guides/redis/scaling/horizontal-scaling/sentinel.md b/docs/guides/redis/scaling/horizontal-scaling/sentinel.md index d4ab14c0c6..5f6efba380 100644 --- a/docs/guides/redis/scaling/horizontal-scaling/sentinel.md +++ b/docs/guides/redis/scaling/horizontal-scaling/sentinel.md @@ -41,7 +41,7 @@ namespace/demo created ### Prepare Redis Sentinel Database -Now, we are going to deploy a `RedisSentinel` instance with version `6.2.7` and a `Redis` database with version `6.2.5`. Then, in the next section we are going to apply horizontal scaling on the sentinel and the database using `RedisOpsRequest` CRD +Now, we are going to deploy a `RedisSentinel` instance with version `6.2.7` and a `Redis` database with version `6.2.5`. Then, in the next section we are going to apply horizontal scaling on the sentinel and the database using `RedisSentinelOpsRequest` and `RedisOpsRequest` CRD. ### Deploy RedisSentinel : diff --git a/docs/guides/redis/sentinel/redis-sentinel.md b/docs/guides/redis/sentinel/redis-sentinel.md index 2f1620f042..086c656720 100644 --- a/docs/guides/redis/sentinel/redis-sentinel.md +++ b/docs/guides/redis/sentinel/redis-sentinel.md @@ -69,7 +69,7 @@ Here, - `spec.replicas` denotes the number of replica nodes - `spec.storage` specifies the StorageClass of PVC dynamically allocated to store data for this database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. So, each members will have a pod of this storage configuration. You can specify any StorageClass available in your cluster with appropriate resource requests. -KubeDB operator watches for `RedisSentinel` objects using Kubernetes API. When a `RedisSentinel` object is created, KubeDB operator will create a new StatefulSet and a Service with the matching Redis object name. KubeDB operator will also create a governing service for StatefulSets named `kubedb`, if one is not already present. +KubeDB operator watches for `RedisSentinel` objects using Kubernetes API. When a `RedisSentinel` object is created, KubeDB operator will create a new StatefulSet and a Service with the matching RedisSentinel object name. KubeDB operator will also create a governing service for StatefulSets named `kubedb`, if one is not already present. Now we will deploy a Redis instance with giving the sentinelRef to the previously created RedisSentinel instance. @@ -108,7 +108,7 @@ redis.kubedb.com/rd-demo created Here, -- `spec.mode` specifies the mode for Redis. Here we have used `Redis` to tell the operator that we want to deploy Redis in cluster mode. +- `spec.mode` specifies the mode for Redis. Here we have used `Redis` to tell the operator that we want to deploy Redis in sentinel mode. - `spec.replicas` denotes the number of replica nodes - `spec.storage` specifies the StorageClass of PVC dynamically allocated to store data for this database. This storage spec will be passed to the StatefulSet created by KubeDB operator to run database pods. So, each members will have a pod of this storage configuration. You can specify any StorageClass available in your cluster with appropriate resource requests. @@ -158,7 +158,7 @@ sen-demo ClusterIP 10.96.249.99 26379/TCP 14m sen-demo-pods ClusterIP None 26379/TCP 14m ``` -KubeDB operator sets the `status.phase` to `Running` once the database is successfully created. `status.phase` section is similar for +KubeDB operator sets the `status.phase` to `Ready` once the database is successfully created. `status.phase` section is similar for `Redis` object and `RedisSentinel` object. Run the following command to see the modified `RedisSentinel` object: ```bash @@ -412,7 +412,7 @@ $ kubectl exec -it rd-demo-0 -n demo -c redis -- bash /data # # now ensure that you are connected to the 1st pod -/data # redis-cli -c -h +/data # redis-cli -c -h 10.244.0.140 10.244.0.140:6379> # set 'world' as value for the key 'hello' diff --git a/docs/guides/redis/sentinel/replacesentinel/replace-sentinel.md b/docs/guides/redis/sentinel/replacesentinel/replace-sentinel.md index 49742ac2fc..8112de0948 100644 --- a/docs/guides/redis/sentinel/replacesentinel/replace-sentinel.md +++ b/docs/guides/redis/sentinel/replacesentinel/replace-sentinel.md @@ -44,7 +44,7 @@ Here, we are going to deploy a `Redis` and `RedisSentinel` instance using a sup ### Prepare RedisSentinel -Now, we are going to deploy a `RedisSentinel` version `6.2.5`. +Now, we are going to deploy a `RedisSentinel` version `6.2.8`. ```yaml apiVersion: kubedb.com/v1alpha2 kind: RedisSentinel @@ -53,7 +53,7 @@ metadata: namespace: demo spec: version: 6.2.8 - replicas: 5 + replicas: 3 storageType: Durable storage: resources: diff --git a/docs/guides/redis/update-version/sentinel.md b/docs/guides/redis/update-version/sentinel.md index b4a7a7240b..2c4e4f2927 100644 --- a/docs/guides/redis/update-version/sentinel.md +++ b/docs/guides/redis/update-version/sentinel.md @@ -175,7 +175,7 @@ NAME TYPE STATUS AGE update-sen-version UpdateVersion Successful 3m30s ``` -We can see from the above output that the `RedisOpsRequest` has succeeded. +We can see from the above output that the `RedisSentinelOpsRequest` has succeeded. Now, we are going to verify whether the `RedisSentinel` and the related `StatefulSets` their `Pods` have the new version image. Let's check,