From 8ac8ed65848435a787d7ce5249d1756b93c0b7f0 Mon Sep 17 00:00:00 2001 From: Alexander Kukushkin Date: Thu, 2 Feb 2023 11:50:19 +0100 Subject: [PATCH] Update Citus link to the github.com repo (#2546) Per suggestion from @clairegiordano --- README.rst | 2 +- docs/citus.rst | 13 ++++++++----- docs/index.rst | 2 +- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 0c1cc2271..704e284a9 100644 --- a/README.rst +++ b/README.rst @@ -14,7 +14,7 @@ We call Patroni a "template" because it is far from being a one-size-fits-all or Currently supported PostgreSQL versions: 9.3 to 15. -**Note to Citus users**: Starting from 3.0 Patroni nicely integrates with `Citus `__. Please check `Citus support `__ page for more information. +**Note to Citus users**: Starting from 3.0 Patroni nicely integrates with the `Citus `__ database extension to Postgres. Please check the `Citus support page `__ in the Patroni documentation for more info about how to use Patroni high availability together with a Citus distributed cluster. **Note to Kubernetes users**: Patroni can run natively on top of Kubernetes. Take a look at the `Kubernetes `__ chapter of the Patroni documentation. diff --git a/docs/citus.rst b/docs/citus.rst index 0c349bb72..030cf93e3 100644 --- a/docs/citus.rst +++ b/docs/citus.rst @@ -12,9 +12,10 @@ TL;DR There are only a few simple rules you need to follow: -1. Citus extension must be available on all nodes. Absolute minimum supported - Citus version is 10.0, but, to take all benefits from transparent - switchovers and restarts of workers we recommend using at least Citus 11.2. +1. `Citus `__ database extension to + PostgreSQL must be available on all nodes. Absolute minimum supported Citus + version is 10.0, but, to take all benefits from transparent switchovers and + restarts of workers we recommend using at least Citus 11.2. 2. Cluster name (``scope``) must be the same for all Citus nodes! 3. Superuser credentials must be the same on coordinator and all worker nodes, and ``pg_hba.conf`` should allow superuser access between all nodes. @@ -51,8 +52,10 @@ patronictl ---------- Coordinator and worker clusters are physically different PostgreSQL/Patroni -clusters that are just logically groupped together using Citus. Therefore in -most cases it is not possible to manage them as a single entity. +clusters that are just logically groupped together using the +`Citus `__ database extension to +PostgreSQL. Therefore in most cases it is not possible to manage them as a +single entity. It results in two major differences in ``patronictl`` behaviour when ``patroni.yaml`` has the ``citus`` section comparing with the usual: diff --git a/docs/index.rst b/docs/index.rst index c0d35e446..9cff0aa7d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,7 +12,7 @@ We call Patroni a "template" because it is far from being a one-size-fits-all or Currently supported PostgreSQL versions: 9.3 to 15. -**Note to Citus users**: Starting from 3.0 Patroni nicely integrates with `Citus `__. Please check :ref:`Citus support ` page for more information. +**Note to Citus users**: Starting from 3.0 Patroni nicely integrates with the `Citus `__ database extension to Postgres. Please check the :ref:`Citus support page ` in the Patroni documentation for more info about how to use Patroni high availability together with a Citus distributed cluster. **Note to Kubernetes users**: Patroni can run natively on top of Kubernetes. Take a look at the :ref:`Kubernetes ` chapter of the Patroni documentation.