gitops/patroni
1
0
Fork 0
mirror of https://github.com/outbackdingo/patroni.git synced 2026-08-25 14:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change all links and org references (#3086)

Browse Source 
* Change all links and org references

* Update coverage status badge
This commit is contained in:
Polina Bungina
2024-06-17 10:28:21 +02:00
committed by GitHub
parent 6e1f9f7a6e
commit d4fd782038
13 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rst
+12 -12
View File
@@ -14,9 +14,9 @@ We call Patroni a "template" because it is far from being a one-size-fits-all or
Currently supported PostgreSQL versions: 9.3 to 16. Currently supported PostgreSQL versions: 9.3 to 16.
**Note to Citus users**: Starting from 3.0 Patroni nicely integrates with the `Citus <https://github.com/citusdata/citus>`__ database extension to Postgres. Please check the `Citus support page <https://github.com/zalando/patroni/blob/master/docs/citus.rst>`__ in the Patroni documentation for more info about how to use Patroni high availability together with a Citus distributed cluster. **Note to Citus users**: Starting from 3.0 Patroni nicely integrates with the `Citus <https://github.com/citusdata/citus>`__ database extension to Postgres. Please check the `Citus support page <https://github.com/patroni/patroni/blob/master/docs/citus.rst>`__ 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 <https://github.com/zalando/patroni/blob/master/docs/kubernetes.rst>`__ chapter of the Patroni documentation. **Note to Kubernetes users**: Patroni can run natively on top of Kubernetes. Take a look at the `Kubernetes <https://github.com/patroni/patroni/blob/master/docs/kubernetes.rst>`__ chapter of the Patroni documentation.
.. contents:: .. contents::
:local: :local:
@@ -39,15 +39,15 @@ For additional background info, see:
Development Status Development Status
================== ==================
Patroni is in active development and accepts contributions. See our `Contributing <https://github.com/zalando/patroni/blob/master/docs/contributing_guidelines.rst>`__ section below for more details. Patroni is in active development and accepts contributions. See our `Contributing <https://github.com/patroni/patroni/blob/master/docs/contributing_guidelines.rst>`__ section below for more details.
We report new releases information `here <https://github.com/zalando/patroni/releases>`__. We report new releases information `here <https://github.com/patroni/patroni/releases>`__.
========= =========
Community Community
========= =========
There are two places to connect with the Patroni community: `on github <https://github.com/zalando/patroni>`__, via Issues and PRs, and on channel `#patroni <https://postgresteam.slack.com/archives/C9XPYG92A>`__ in the `PostgreSQL Slack <https://pgtreats.info/slack-invite>`__. If you're using Patroni, or just interested, please join us. There are two places to connect with the Patroni community: `on github <https://github.com/patroni/patroni>`__, via Issues and PRs, and on channel `#patroni <https://postgresteam.slack.com/archives/C9XPYG92A>`__ in the `PostgreSQL Slack <https://pgtreats.info/slack-invite>`__. If you're using Patroni, or just interested, please join us.
=================================== ===================================
Technical Requirements/Installation Technical Requirements/Installation
@@ -149,19 +149,19 @@ run:
YAML Configuration YAML Configuration
================== ==================
Go `here <https://github.com/zalando/patroni/blob/master/docs/dynamic_configuration.rst>`__ for comprehensive information about settings for etcd, consul, and ZooKeeper. And for an example, see `postgres0.yml <https://github.com/zalando/patroni/blob/master/postgres0.yml>`__. Go `here <https://github.com/patroni/patroni/blob/master/docs/dynamic_configuration.rst>`__ for comprehensive information about settings for etcd, consul, and ZooKeeper. And for an example, see `postgres0.yml <https://github.com/patroni/patroni/blob/master/postgres0.yml>`__.
========================= =========================
Environment Configuration Environment Configuration
========================= =========================
Go `here <https://github.com/zalando/patroni/blob/master/docs/ENVIRONMENT.rst>`__ for comprehensive information about configuring(overriding) settings via environment variables. Go `here <https://github.com/patroni/patroni/blob/master/docs/ENVIRONMENT.rst>`__ for comprehensive information about configuring(overriding) settings via environment variables.
=================== ===================
Replication Choices Replication Choices
=================== ===================
Patroni uses Postgres' streaming replication, which is asynchronous by default. Patroni's asynchronous replication configuration allows for ``maximum_lag_on_failover`` settings. This setting ensures failover will not occur if a follower is more than a certain number of bytes behind the leader. This setting should be increased or decreased based on business requirements. It's also possible to use synchronous replication for better durability guarantees. See `replication modes documentation <https://github.com/zalando/patroni/blob/master/docs/replication_modes.rst>`__ for details. Patroni uses Postgres' streaming replication, which is asynchronous by default. Patroni's asynchronous replication configuration allows for ``maximum_lag_on_failover`` settings. This setting ensures failover will not occur if a follower is more than a certain number of bytes behind the leader. This setting should be increased or decreased based on business requirements. It's also possible to use synchronous replication for better durability guarantees. See `replication modes documentation <https://github.com/patroni/patroni/blob/master/docs/replication_modes.rst>`__ for details.
====================================== ======================================
Applications Should Not Use Superusers Applications Should Not Use Superusers
@@ -169,7 +169,7 @@ Applications Should Not Use Superusers
When connecting from an application, always use a non-superuser. Patroni requires access to the database to function properly. By using a superuser from an application, you can potentially use the entire connection pool, including the connections reserved for superusers, with the ``superuser_reserved_connections`` setting. If Patroni cannot access the Primary because the connection pool is full, behavior will be undesirable. When connecting from an application, always use a non-superuser. Patroni requires access to the database to function properly. By using a superuser from an application, you can potentially use the entire connection pool, including the connections reserved for superusers, with the ``superuser_reserved_connections`` setting. If Patroni cannot access the Primary because the connection pool is full, behavior will be undesirable.
.. |Tests Status| image:: https://github.com/zalando/patroni/actions/workflows/tests.yaml/badge.svg .. |Tests Status| image:: https://github.com/patroni/patroni/actions/workflows/tests.yaml/badge.svg
:target: https://github.com/zalando/patroni/actions/workflows/tests.yaml?query=branch%3Amaster :target: https://github.com/patroni/patroni/actions/workflows/tests.yaml?query=branch%3Amaster
.. |Coverage Status| image:: https://coveralls.io/repos/zalando/patroni/badge.svg?branch=master .. |Coverage Status| image:: https://coveralls.io/repos/patroni/patroni/badge.svg?branch=master
:target: https://coveralls.io/github/zalando/patroni?branch=master :target: https://coveralls.io/github/patroni/patroni?branch=master
docker-compose-citus.yml
+1 -1
View File
@@ -8,7 +8,7 @@
# The cluster could be started as: # The cluster could be started as:
# $ docker-compose -f docker-compose-citus.yml up -d # $ docker-compose -f docker-compose-citus.yml up -d
# You can read more about it in the: # You can read more about it in the:
# https://github.com/zalando/patroni/blob/master/docker/README.md#citus-cluster # https://github.com/patroni/patroni/blob/master/docker/README.md#citus-cluster
version: "2" version: "2"
networks: networks:
docker-compose.yml
+1 -1
View File
@@ -6,7 +6,7 @@
# The cluster could be started as: # The cluster could be started as:
# $ docker-compose up -d # $ docker-compose up -d
# You can read more about it in the: # You can read more about it in the:
# https://github.com/zalando/patroni/blob/master/docker/README.md # https://github.com/patroni/patroni/blob/master/docker/README.md
version: "2" version: "2"
networks: networks:
docs/README.rst
+2 -2
View File
@@ -37,7 +37,7 @@ perfectly fine. You can add more standby nodes later.
Running and Configuring Running and Configuring
----------------------- -----------------------
The following section assumes Patroni repository as being cloned from https://github.com/zalando/patroni. Namely, you The following section assumes Patroni repository as being cloned from https://github.com/patroni/patroni. Namely, you
will need example configuration files `postgres0.yml` and `postgres1.yml`. If you installed Patroni with pip, you can will need example configuration files `postgres0.yml` and `postgres1.yml`. If you installed Patroni with pip, you can
obtain those files from the git repository and replace `./patroni.py` below with `patroni` command. obtain those files from the git repository and replace `./patroni.py` below with `patroni` command.
@@ -67,7 +67,7 @@ run:
YAML Configuration YAML Configuration
------------------ ------------------
Go :ref:`here <yaml_configuration>` for comprehensive information about settings for etcd, consul, and ZooKeeper. And for an example, see `postgres0.yml <https://github.com/zalando/patroni/blob/master/postgres0.yml>`__. Go :ref:`here <yaml_configuration>` for comprehensive information about settings for etcd, consul, and ZooKeeper. And for an example, see `postgres0.yml <https://github.com/patroni/patroni/blob/master/postgres0.yml>`__.
Environment Configuration Environment Configuration
docs/citus.rst
+1 -1
View File
@@ -335,7 +335,7 @@ new Kubernetes objects ConfigMaps or Endpoints, it automatically puts the
You can find a complete example of Patroni deployment on Kubernetes with Citus You can find a complete example of Patroni deployment on Kubernetes with Citus
support in the `kubernetes`__ folder of the Patroni repository. support in the `kubernetes`__ folder of the Patroni repository.
__ https://github.com/zalando/patroni/tree/master/kubernetes __ https://github.com/patroni/patroni/tree/master/kubernetes
There are two important files for you: There are two important files for you:
docs/conf.py
+1 -1
View File
@@ -134,7 +134,7 @@ html_static_path = ['_static']
# Replace "source" links with "edit on GitHub" when using rtd theme # Replace "source" links with "edit on GitHub" when using rtd theme
html_context = { html_context = {
'display_github': True, 'display_github': True,
'github_user': 'zalando', 'github_user': 'patroni',
'github_repo': 'patroni', 'github_repo': 'patroni',
'github_version': 'master', 'github_version': 'master',
'conf_py_path': '/docs/', 'conf_py_path': '/docs/',
docs/contributing_guidelines.rst
+1 -1
View File
@@ -16,7 +16,7 @@ Reporting bugs
-------------- --------------
Before reporting a bug please make sure to **reproduce it with the latest Patroni version**! Before reporting a bug please make sure to **reproduce it with the latest Patroni version**!
Also please double check if the issue already exists in our `Issues Tracker <https://github.com/zalando/patroni/issues>`__. Also please double check if the issue already exists in our `Issues Tracker <https://github.com/patroni/patroni/issues>`__.
Running tests Running tests
------------- -------------
docs/kubernetes.rst
+1 -1
View File
@@ -87,7 +87,7 @@ Note that if you migrate from default role labels to custom ones, you can reduce
Examples Examples
-------- --------
- The `kubernetes <https://github.com/zalando/patroni/tree/master/kubernetes>`__ folder of the Patroni repository contains - The `kubernetes <https://github.com/patroni/patroni/tree/master/kubernetes>`__ folder of the Patroni repository contains
examples of the Docker image, and the Kubernetes manifest to test Patroni Kubernetes setup. examples of the Docker image, and the Kubernetes manifest to test Patroni Kubernetes setup.
Note that in the current state it will not be able to use PersistentVolumes because of permission issues. Note that in the current state it will not be able to use PersistentVolumes because of permission issues.
docs/releases.rst
+6 -6
View File
@@ -1741,7 +1741,7 @@ Released 2019-12-05
- Don't expose password when running ``pg_rewind`` (Alexander Kukushkin) - Don't expose password when running ``pg_rewind`` (Alexander Kukushkin)
Bug was introduced in the `#1301 <https://github.com/zalando/patroni/pull/1301>`__ Bug was introduced in the `#1301 <https://github.com/patroni/patroni/pull/1301>`__
- Apply connection parameters specified in the ``postgresql.authentication`` to ``pg_basebackup`` and custom replica creation methods (Alexander Kukushkin) - Apply connection parameters specified in the ``postgresql.authentication`` to ``pg_basebackup`` and custom replica creation methods (Alexander Kukushkin)
@@ -2251,11 +2251,11 @@ This version implements support of permanent replication slots, adds support of
- A few bugfixes in the "standby cluster" workflow (Alexander Kukushkin) - A few bugfixes in the "standby cluster" workflow (Alexander Kukushkin)
Please see https://github.com/zalando/patroni/pull/823 for more details. Please see https://github.com/patroni/patroni/pull/823 for more details.
- Fix REST API health check when cluster management is paused and DCS is not accessible (Alexander Kukushkin) - Fix REST API health check when cluster management is paused and DCS is not accessible (Alexander Kukushkin)
Regression was introduced in https://github.com/zalando/patroni/commit/90cf930036a9d5249265af15d2b787ec7517cf57 Regression was introduced in https://github.com/patroni/patroni/commit/90cf930036a9d5249265af15d2b787ec7517cf57
Version 1.5.0 Version 1.5.0
------------- -------------
@@ -2481,7 +2481,7 @@ Released 2018-03-05
- Single user mode was waiting for user input and never finish (Alexander Kukushkin) - Single user mode was waiting for user input and never finish (Alexander Kukushkin)
Regression was introduced in https://github.com/zalando/patroni/pull/576 Regression was introduced in https://github.com/patroni/patroni/pull/576
Version 1.4.2 Version 1.4.2
@@ -2991,7 +2991,7 @@ In addition, the documentation, including these release notes, has been moved to
**Documentation improvements** **Documentation improvements**
- Add a Patroni main `loop workflow diagram <https://raw.githubusercontent.com/zalando/patroni/master/docs/ha_loop_diagram.png>`__. (Alejandro Martínez, Alexander Kukushkin) - Add a Patroni main `loop workflow diagram <https://raw.githubusercontent.com/patroni/patroni/master/docs/ha_loop_diagram.png>`__. (Alejandro Martínez, Alexander Kukushkin)
- Improve README, adding the Helm chart and links to release notes. (Lauri Apple) - Improve README, adding the Helm chart and links to release notes. (Lauri Apple)
@@ -3305,4 +3305,4 @@ This release adds support for *cascading replication* and simplifies Patroni man
The tests can be launched manually using the *behave* command. They are also launched automatically for pull requests and after commits. The tests can be launched manually using the *behave* command. They are also launched automatically for pull requests and after commits.
Release notes for some older versions can be found on `project's github page <https://github.com/zalando/patroni/releases>`__. Release notes for some older versions can be found on `project's github page <https://github.com/patroni/patroni/releases>`__.
kubernetes/Dockerfile
+1 -1
View File
@@ -10,7 +10,7 @@ RUN export DEBIAN_FRONTEND=noninteractive \
## Make sure we have a en_US.UTF-8 locale available ## Make sure we have a en_US.UTF-8 locale available
&& localedef -i en_US -c -f UTF-8 -A /usr/share/locale/locale.alias en_US.UTF-8 \ && localedef -i en_US -c -f UTF-8 -A /usr/share/locale/locale.alias en_US.UTF-8 \
&& pip3 install --break-system-packages setuptools \ && pip3 install --break-system-packages setuptools \
&& pip3 install --break-system-packages 'git+https://github.com/zalando/patroni.git#egg=patroni[kubernetes]' \ && pip3 install --break-system-packages 'git+https://github.com/patroni/patroni.git#egg=patroni[kubernetes]' \
&& PGHOME=/home/postgres \ && PGHOME=/home/postgres \
&& mkdir -p $PGHOME \ && mkdir -p $PGHOME \
&& chown postgres $PGHOME \ && chown postgres $PGHOME \
kubernetes/Dockerfile.citus
+1 -1
View File
@@ -27,7 +27,7 @@ RUN export DEBIAN_FRONTEND=noninteractive \
&& apt-get -y install postgresql-16-citus-12.1; \ && apt-get -y install postgresql-16-citus-12.1; \
fi \ fi \
&& pip3 install --break-system-packages setuptools \ && pip3 install --break-system-packages setuptools \
&& pip3 install --break-system-packages 'git+https://github.com/zalando/patroni.git#egg=patroni[kubernetes]' \ && pip3 install --break-system-packages 'git+https://github.com/patroni/patroni.git#egg=patroni[kubernetes]' \
&& PGHOME=/home/postgres \ && PGHOME=/home/postgres \
&& mkdir -p $PGHOME \ && mkdir -p $PGHOME \
&& chown postgres $PGHOME \ && chown postgres $PGHOME \
kubernetes/openshift-example/README.md
+1 -1
View File
@@ -16,7 +16,7 @@ Note: If deploying as a template for multiple users, the following commands shou
``` ```
oc import-image postgres:10 --confirm -n openshift oc import-image postgres:10 --confirm -n openshift
oc new-build https://github.com/zalando/patroni --context-dir=kubernetes -n openshift oc new-build https://github.com/patroni/patroni --context-dir=kubernetes -n openshift
``` ```
## Deploy the Image ## Deploy the Image
setup.py
+1 -1
View File
@@ -17,7 +17,7 @@ NAME = 'patroni'
MAIN_PACKAGE = NAME MAIN_PACKAGE = NAME
DESCRIPTION = 'PostgreSQL High-Available orchestrator and CLI' DESCRIPTION = 'PostgreSQL High-Available orchestrator and CLI'
LICENSE = 'The MIT License' LICENSE = 'The MIT License'
URL = 'https://github.com/zalando/patroni' URL = 'https://github.com/patroni/patroni'
AUTHOR = 'Alexander Kukushkin, Polina Bungina' AUTHOR = 'Alexander Kukushkin, Polina Bungina'
AUTHOR_EMAIL = '[email protected], [email protected]' AUTHOR_EMAIL = '[email protected], [email protected]'
KEYWORDS = 'etcd governor patroni postgresql postgres ha haproxy confd' +\ KEYWORDS = 'etcd governor patroni postgresql postgres ha haproxy confd' +\