patroni-cli

Name	patroni-cli JSON
Version	0.1.2 JSON
	download
home_page	None
Summary	A CLI tool to manage Patroni cluster, elect new leaders, and perform switchover.
upload_time	2024-09-14 19:54:36
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT
keywords	patroni cluster failover switchover
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Patroni CLI

Patroni CLI is a command-line tool that allows you to manage a Patroni PostgreSQL cluster. You can use it to view cluster status, elect new leaders, and perform switchovers between nodes.

## Features

- **View Cluster Status**: List all cluster members and their roles.
- **Elect New Leader**: Trigger a failover and elect a new leader for the cluster.
- **Switchover**: Perform a switchover to a specified node or any healthy node.

## Installation

You can install the Patroni CLI via pip after packaging:

```bash
pip install patroni-cli
```

### Usage
Here are the available commands:

#### Check Cluster Status
```bash
patroni-cli --url http://localhost:8008 --username admin --password admin status
```

#### Elect a New Leader
```bash
patroni-cli --url http://localhost:8008 --username admin --password admin elect new_leader_name
```
#### Perform a Switchover
```bash
patroni-cli --url http://localhost:8008 --username admin --password admin switchover target_leader_name
```
If you want to perform a switchover without specifying a target leader, use:

```bash
patroni-cli --url http://localhost:8008 --username admin --password admin switchover
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "patroni-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "patroni, cluster, failover, switchover",
    "author": null,
    "author_email": "Brian Hartford <bh419@protonmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/3b/8a/916dc47357c5ad4537e092d0cd9c92acb69e1778c66c26230bdb8433092c/patroni_cli-0.1.2.tar.gz",
    "platform": null,
    "description": "# Patroni CLI\n\nPatroni CLI is a command-line tool that allows you to manage a Patroni PostgreSQL cluster. You can use it to view cluster status, elect new leaders, and perform switchovers between nodes.\n\n## Features\n\n- **View Cluster Status**: List all cluster members and their roles.\n- **Elect New Leader**: Trigger a failover and elect a new leader for the cluster.\n- **Switchover**: Perform a switchover to a specified node or any healthy node.\n\n## Installation\n\nYou can install the Patroni CLI via pip after packaging:\n\n```bash\npip install patroni-cli\n```\n\n### Usage\nHere are the available commands:\n\n#### Check Cluster Status\n```bash\npatroni-cli --url http://localhost:8008 --username admin --password admin status\n```\n\n#### Elect a New Leader\n```bash\npatroni-cli --url http://localhost:8008 --username admin --password admin elect new_leader_name\n```\n#### Perform a Switchover\n```bash\npatroni-cli --url http://localhost:8008 --username admin --password admin switchover target_leader_name\n```\nIf you want to perform a switchover without specifying a target leader, use:\n\n```bash\npatroni-cli --url http://localhost:8008 --username admin --password admin switchover\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A CLI tool to manage Patroni cluster, elect new leaders, and perform switchover.",
    "version": "0.1.2",
    "project_urls": null,
    "split_keywords": [
        "patroni",
        " cluster",
        " failover",
        " switchover"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3cf24265e7091694f94d735b3f2bcf2e70e4296a80ae113cea999cdfe1ea54ce",
                "md5": "6c7af9d4b8b8a02f442e71f719d4a266",
                "sha256": "651175ba97c75e47eb011ac3bb7b35c20b15eb981a1157f270e4216bef5042e5"
            },
            "downloads": -1,
            "filename": "patroni_cli-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6c7af9d4b8b8a02f442e71f719d4a266",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 4563,
            "upload_time": "2024-09-14T19:54:34",
            "upload_time_iso_8601": "2024-09-14T19:54:34.751961Z",
            "url": "https://files.pythonhosted.org/packages/3c/f2/4265e7091694f94d735b3f2bcf2e70e4296a80ae113cea999cdfe1ea54ce/patroni_cli-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b8a916dc47357c5ad4537e092d0cd9c92acb69e1778c66c26230bdb8433092c",
                "md5": "1d36dc11394bc4260d24fa27f6c0ca6c",
                "sha256": "1ff20e96b61143bffa33d8f9af847a8ced1b966d696044df92ffc78d1eff6915"
            },
            "downloads": -1,
            "filename": "patroni_cli-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "1d36dc11394bc4260d24fa27f6c0ca6c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 3996,
            "upload_time": "2024-09-14T19:54:36",
            "upload_time_iso_8601": "2024-09-14T19:54:36.541401Z",
            "url": "https://files.pythonhosted.org/packages/3b/8a/916dc47357c5ad4537e092d0cd9c92acb69e1778c66c26230bdb8433092c/patroni_cli-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-14 19:54:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "patroni-cli"
}