-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add redis reconfigura ops request docs
Signed-off-by: Tamal Saha <[email protected]>
- Loading branch information
Showing
7 changed files
with
532 additions
and
1 deletion.
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
content/docs/v2024.1.31/examples/redis/reconfigure/rdops-inline-reconfig.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
apiVersion: ops.kubedb.com/v1alpha1 | ||
kind: RedisOpsRequest | ||
metadata: | ||
name: rdops-inline-reconfig | ||
namespace: demo | ||
spec: | ||
type: Reconfigure | ||
databaseRef: | ||
name: sample-redis | ||
configuration: | ||
inlineConfig: maxclients 3000 |
12 changes: 12 additions & 0 deletions
12
content/docs/v2024.1.31/examples/redis/reconfigure/rdops-reconfigure.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
apiVersion: ops.kubedb.com/v1alpha1 | ||
kind: RedisOpsRequest | ||
metadata: | ||
name: rdops-reconfigure | ||
namespace: demo | ||
spec: | ||
type: Reconfigure | ||
databaseRef: | ||
name: sample-redis | ||
configuration: | ||
configSecret: | ||
name: new-custom-config |
17 changes: 17 additions & 0 deletions
17
content/docs/v2024.1.31/examples/redis/reconfigure/sample-redis-config.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
apiVersion: kubedb.com/v1alpha2 | ||
kind: Redis | ||
metadata: | ||
name: sample-redis | ||
namespace: demo | ||
spec: | ||
version: "6.2.14" | ||
storageType: Durable | ||
storage: | ||
storageClassName: "standard" | ||
accessModes: | ||
- ReadWriteOnce | ||
resources: | ||
requests: | ||
storage: 1Gi | ||
configSecret: | ||
name: rd-custom-config |
22 changes: 22 additions & 0 deletions
22
content/docs/v2024.1.31/guides/redis/reconfigure/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: Reconfigure | ||
menu: | ||
docs_v2024.1.31: | ||
identifier: rd-reconfigure | ||
name: Reconfigure | ||
parent: rd-redis-guides | ||
weight: 46 | ||
menu_name: docs_v2024.1.31 | ||
info: | ||
autoscaler: v0.26.0 | ||
cli: v0.41.0 | ||
dashboard: v0.17.0 | ||
installer: v2024.1.31 | ||
ops-manager: v0.28.0 | ||
provisioner: v0.41.0 | ||
schema-manager: v0.17.0 | ||
ui-server: v0.17.0 | ||
version: v2024.1.31 | ||
webhook-server: v0.17.0 | ||
--- | ||
|
65 changes: 65 additions & 0 deletions
65
content/docs/v2024.1.31/guides/redis/reconfigure/overview.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
title: Reconfiguring Redis | ||
menu: | ||
docs_v2024.1.31: | ||
identifier: rd-reconfigure-overview | ||
name: Overview | ||
parent: rd-reconfigure | ||
weight: 10 | ||
menu_name: docs_v2024.1.31 | ||
section_menu_id: guides | ||
info: | ||
autoscaler: v0.26.0 | ||
cli: v0.41.0 | ||
dashboard: v0.17.0 | ||
installer: v2024.1.31 | ||
ops-manager: v0.28.0 | ||
provisioner: v0.41.0 | ||
schema-manager: v0.17.0 | ||
ui-server: v0.17.0 | ||
version: v2024.1.31 | ||
webhook-server: v0.17.0 | ||
--- | ||
|
||
> New to KubeDB? Please start [here](/docs/v2024.1.31/README). | ||
# Reconfiguring Redis | ||
|
||
This guide will give an overview on how KubeDB Ops-manager operator reconfigures `Redis` database. | ||
|
||
## Before You Begin | ||
|
||
- You should be familiar with the following `KubeDB` concepts: | ||
- [Redis](/docs/v2024.1.31/guides/redis/concepts/redis) | ||
- [RedisOpsRequest](/docs/v2024.1.31/guides/redis/concepts/redisopsrequest) | ||
|
||
## How Reconfiguring Redis Process Works | ||
|
||
The following diagram shows how KubeDB Ops-manager operator reconfigures `Redis` database components. Open the image in a new tab to see the enlarged version. | ||
|
||
<figure align="center"> | ||
<img alt="Reconfiguring process of Redis" src="/docs/v2024.1.31/images/day-2-operation/redis/rd-reconfigure.svg"> | ||
<figcaption align="center">Fig: Reconfiguring process of Redis</figcaption> | ||
</figure> | ||
|
||
The Reconfiguring Redis process consists of the following steps: | ||
|
||
1. At first, a user creates a `Redis` Custom Resource (CR). | ||
|
||
2. `KubeDB` operator watches the `Redis` CR. | ||
|
||
3. When the operator finds a `Redis` CR, it creates required number of `StatefulSets` and related necessary stuff like secrets, services, etc. | ||
|
||
4. Then, in order to reconfigure the `Redis` database the user creates a `RedisOpsRequest` CR with desired information. | ||
|
||
5. `KubeDB` Ops-manager operator watches the `RedisOpsRequest` CR. | ||
|
||
6. When it finds a `RedisOpsRequest` CR, it halts the `Redis` object which is referred from the `RedisOpsRequest`. So, the `KubeDB` Provisioner operator doesn't perform any operations on the `Redis` object during the reconfiguring process. | ||
|
||
7. Then the `KubeDB` Ops-manager operator will replace the existing configuration with the new configuration provided or merge the new configuration with the existing configuration according to the `RedisOpsRequest` CR. | ||
|
||
8. Then the `KubeDB` Ops-manager operator will restart the related StatefulSet Pods so that they restart with the new configuration defined in the `RedisOpsRequest` CR. | ||
|
||
9. After the successful reconfiguring of the `Redis` components, the `KubeDB` Ops-manager operator resumes the `Redis` object so that the `KubeDB` Provisioner operator resumes its usual operations. | ||
|
||
In the next docs, we are going to show a step by step guide on reconfiguring Redis database components using `RedisOpsRequest` CRD. |
Oops, something went wrong.