-
Notifications
You must be signed in to change notification settings - Fork 265
DOC-4367 RDI K8s docs #817
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| - Installation on [Kubernetes]({{< relref "/integrate/redis-data-integration/installation/install-k8s" >}}) using a [Helm chart](https://helm.sh/docs/). You can install on [OpenShift](https://docs.openshift.com/) or other flavours of K8s using Helm. | ||
|
|
||
| - Improvements for installation on VMs: | ||
| - Installer checks if the OS firewall is enabled on Ubuntu and RHEL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is it linked to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The links are to the Helm docs and the OpenShift docs. Would you prefer to remove the links?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think they need to linking just the particular words or not have them at all
| - Improved verification of RDI installation. | ||
| - Installer verifies if the RDI database is in use by another instance of RDI. | ||
| - Installer checks and warns if any [`iptables`](https://www.netfilter.org/projects/iptables/index.html) rules are set. | ||
| - Improved message when RDI tries to connect to its Redis database with invalid TLS keys. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is it linked to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Links to the iptable home page. Again, I'll remove it if you think it's better without it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the link needs to be just on the word IPtables
| ## Limitations | ||
|
|
||
| - RDI can write data to a Redis Active-Active database. However, it doesn't support writing data to two or more Active-Active replicas. Writing data from RDI to several Active-Active replicas could easily harm data integrity as RDI is not synchronous with the source database commits. | ||
| - RDI write-behind (which is currently in preview) should not be used on the same data set that RDI ingest is writing to Redis. This would either cause an infinite loop or would harm the data integrity, since both ingest and write-behind are asynchronous, eventually-consistent processes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove write-behind. We already removed it to another section in docs and about to stop selling it in few days
| when you start a pipeline from the CLI tool. This means that you must | ||
| provide the operator with a service account that has permissions to create and manipulate pods in the namespace. | ||
| You can use the RDI [Helm chart](https://helm.sh/docs/topics/charts/) to install | ||
| on [Kubernetes (K8s)](https://kubernetes.io/). This creates: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's good to explicitly mention Openshift as most customers will use it
something like on Kubernetes (K8s) including Red Hat Openshift
| - Installation on [Kubernetes]({{< relref "/integrate/redis-data-integration/installation/install-k8s" >}}) using a [Helm chart](https://helm.sh/docs/). You can install on [OpenShift](https://docs.openshift.com/) or other flavours of K8s using Helm. | ||
|
|
||
| - Improvements for installation on VMs: | ||
| - Installer checks if the OS firewall is enabled on Ubuntu and RHEL. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think they need to linking just the particular words or not have them at all
| - Improved verification of RDI installation. | ||
| - Installer verifies if the RDI database is in use by another instance of RDI. | ||
| - Installer checks and warns if any [`iptables`](https://www.netfilter.org/projects/iptables/index.html) rules are set. | ||
| - Improved message when RDI tries to connect to its Redis database with invalid TLS keys. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the link needs to be just on the word IPtables
| 1. Start the installation: | ||
|
|
||
| ```bash | ||
| helm install <The logical chart name> rdi-k8s/<rdi-tag>/helm |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please add --create-namespace -n rdi at the end of the helm install command
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
| global: | ||
| imagePullSecrets: [] | ||
| # - name: "image-pull-secret" | ||
| # or |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove lines 78-79. :
imagePullSecrets: []
# - name: "image-pull-secret"
image:
registry: docker.io
repository: redis
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
DOC-4367
I'll make a separate PR to add the release notes to the RDI repo when we're happy with them.