From aeecf234b56e4ccd7ca5a41d42c31b5366cc80c8 Mon Sep 17 00:00:00 2001 From: Abhishek Dubey Date: Wed, 26 Jan 2022 18:33:55 +0530 Subject: [PATCH] Updated release information for v0.10.0 (#223) Signed-off-by: iamabhishek-dubey --- CHANGELOG.md | 21 ++++++++++ docs/src/.vuepress/config.js | 19 ++++++--- docs/src/guide/changelog.md | 21 ++++++++++ docs/src/guide/redis-cluster-config.md | 53 ++++++++++++++++++++++++++ docs/src/guide/redis-config.md | 51 +++++++++++++++++++++++++ docs/src/guide/release.md | 8 ++++ 6 files changed, 167 insertions(+), 6 deletions(-) create mode 100644 docs/src/guide/release.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d5d12a26..98220847e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,24 @@ +### v0.10.0 +##### January 26, 2022 + +#### :tada: Features + +- Added custom probes capability +- Added sidecar support for redis +- Added option for namespaced operator +- Added finalizers for Kubernetes resources +- Adding PodDisruptionBudget support +- Added TLS cluster support +- Pass through Annotations and Labels to all Child resources +- Adding Rudimentry IPv6 Support + +#### :beetle: Bug Fixes + +- Fix up RedisClusterStatus Spec being incorrect object +- Fixed invalid RBAC kustomization +- Fixed RBAC role for operator +- Fixed service creation for leader and follower +- ### v0.9.0 ##### November 13, 2021 diff --git a/docs/src/.vuepress/config.js b/docs/src/.vuepress/config.js index e1eaf687a..c47f4d017 100755 --- a/docs/src/.vuepress/config.js +++ b/docs/src/.vuepress/config.js @@ -46,7 +46,7 @@ module.exports = { sidebar: { '/guide/': [ { - title: 'Guide', + title: 'GUIDE', collapsable: false, children: [ '', @@ -54,7 +54,7 @@ module.exports = { ] }, { - title: 'Getting Started', + title: 'GETTING STARTED', collapsable: false, children: [ 'installation.md', @@ -64,7 +64,7 @@ module.exports = { ] }, { - title: 'Configuration', + title: 'CONFIGURATION', collapsable: false, children: [ 'redis-config.md', @@ -72,7 +72,7 @@ module.exports = { ] }, { - title: 'Monitoring', + title: 'MONITORING', collapsable: false, children: [ 'monitoring.md', @@ -80,14 +80,21 @@ module.exports = { ] }, { - title: 'Development', + title: 'DEVELOPMENT', collapsable: false, children: [ 'development.md', ] }, { - title: 'Changelog', + title: 'RELEASE MANAGEMENT', + collapsable: false, + children: [ + 'release.md', + ] + }, + { + title: 'CHANGELOG', collapsable: false, children: [ 'changelog.md', diff --git a/docs/src/guide/changelog.md b/docs/src/guide/changelog.md index f44c03611..84f01dadf 100644 --- a/docs/src/guide/changelog.md +++ b/docs/src/guide/changelog.md @@ -1,3 +1,24 @@ +### v0.10.0 +**January 26, 2022** + +**:tada: Features** + +- Added custom probes capability +- Added sidecar support for redis +- Added option for namespaced operator +- Added finalizers for Kubernetes resources +- Adding PodDisruptionBudget support +- Added TLS cluster support +- Pass through Annotations and Labels to all Child resources +- Adding Rudimentry IPv6 Support + +**:beetle: Bug Fixes** + +- Fix up RedisClusterStatus Spec being incorrect object +- Fixed invalid RBAC kustomization +- Fixed RBAC role for operator +- Fixed service creation for leader and follower + ### v0.9.0 **November 13, 2021** diff --git a/docs/src/guide/redis-cluster-config.md b/docs/src/guide/redis-cluster-config.md index 827328a8c..e0a197e4b 100644 --- a/docs/src/guide/redis-cluster-config.md +++ b/docs/src/guide/redis-cluster-config.md @@ -221,3 +221,56 @@ Sidecars for redis pods - name: VAR_NAME value: "value1" ``` + +**pdb** + +PodDisruptionBugets for redis cluster pods + +```yaml + pdb: + enabled: true + maxUnavailable: 1 + minAvailable: 1 +``` + +**probes** + +Probes for redis leader and follower pods + +```yaml +# redisFollower: +# redisLeader: + readinessProbe: + exec: + command: + - bash + - /usr/bin/healthcheck.sh + failureThreshold: 5 + initialDelaySeconds: 15 + periodSeconds: 15 + successThreshold: 1 + timeoutSeconds: 5 + livenessProbe: + exec: + command: + - bash + - /usr/bin/healthcheck.sh + failureThreshold: 5 + initialDelaySeconds: 15 + periodSeconds: 15 + successThreshold: 1 + timeoutSeconds: 5 +``` + +**TLS** + +TLS configuration for redis cluster + +```yaml + TLS: + ca: ca.key + cert: tls.crt + key: tls.key + secret: + secretName: sample-cert +``` \ No newline at end of file diff --git a/docs/src/guide/redis-config.md b/docs/src/guide/redis-config.md index b18a2362e..41c25cc33 100644 --- a/docs/src/guide/redis-config.md +++ b/docs/src/guide/redis-config.md @@ -190,3 +190,54 @@ Sidecars for redis pods - name: VAR_NAME value: "value1" ``` + +**pdb** + +PodDisruptionBugets for redis standalone pods + +```yaml + pdb: + enabled: true + maxUnavailable: 1 + minAvailable: 1 +``` + +**probes** + +Probes for redis standalone pods + +```yaml + readinessProbe: + exec: + command: + - bash + - /usr/bin/healthcheck.sh + failureThreshold: 5 + initialDelaySeconds: 15 + periodSeconds: 15 + successThreshold: 1 + timeoutSeconds: 5 + livenessProbe: + exec: + command: + - bash + - /usr/bin/healthcheck.sh + failureThreshold: 5 + initialDelaySeconds: 15 + periodSeconds: 15 + successThreshold: 1 + timeoutSeconds: 5 +``` + +**TLS** + +TLS configuration for redis standalone + +```yaml + TLS: + ca: ca.key + cert: tls.crt + key: tls.key + secret: + secretName: sample-cert +``` \ No newline at end of file diff --git a/docs/src/guide/release.md b/docs/src/guide/release.md new file mode 100644 index 000000000..9bfba0a07 --- /dev/null +++ b/docs/src/guide/release.md @@ -0,0 +1,8 @@ +# Release Management + +Redis operator will have a release cycle from 26th January 2022. Here are few key pointers for release management of redis-operator. + +- Release will follow the semantic versioning. +- Major release will happen at every quarter. +- Minor release will happen every month. +- For security issues and potential bugs, adhoc releases can be made.