=========
Elasticsearch cluster management, namely rolling restart and upgrades.
Your cluster should be deployed/managed via SaltStack; this is meant to be ran on your Salt master.
While currently not a *hard* requirement (as far as states applied on an upgrade, a highstate is performed), we
recommend to use our fork of the elasticsearch Salt formula: https://github.com/vkgit/saltstack-elasticsearch-formula,
as further integration will happen in the future.
Install
-------
```
pip install rollastic
```
Usage
-----
### Restart
```
Usage: rollastic restart [OPTIONS] MASTER_NODE
Rolling restart of cluster.
MASTER_NODE is the initial node to query to get the list of master nodes
to connect to. Rollastic will connect to all master nodes to avoid relying
on one to be up for the roll procedure.
This will:
- Collect and order the nodes to roll.
If you opted to include master nodes, they are always done first.
- Wait until cluster is in green health
- For each node from #1 above
If node's heap used percentage is over kill-at-heap:
* Disable cluster allocation
* Ping node through Salt to verify connectivity
* Shutdown node
* Wait for ES to die for 2m.
If it's not dead, run a killall java and wait another 2m.
If it's still not dead, fail.
* Start elasticsearch service through Salt
* Wait until node joins cluster with an uptime within 120s.
* Enable allocation
* Wait until cluster is in green health
Options:
--masters / --no-masters Restart master nodes as well [false]
--datas / --no-datas Restart data nodes [true]
--kill-at-heap INTEGER Heap used percentage threshold to restart that
node [85]
--help Show this message and exit.
```
### Upgrade
```
Usage: rollastic upgrade [OPTIONS] MASTER_NODE
Rolling upgrade of cluster.
MASTER_NODE is the initial node to query to get the list of master nodes
to connect to. Rollastic will connect to all master nodes to avoid relying
on one to be up for the roll procedure.
This will:
- Collect and order the nodes to roll.
If you opted to include master nodes, they are always done first.
- Wait until cluster is in green health
- For each node from #1 above
If node's ES version is under minimum_version:
* Disable cluster allocation
* Ping node through Salt to verify connectivity
* Run a Salt highstate
* Check for an available upgrade on the Elasticsearch package, if so:
- Shutdown node
- Wait for ES to die for 2m.
If it's not dead, run a killall java and wait another 2m.
If it's still not dead, fail.
* If ES was stopped at any point in this:
- Start elasticsearch service if it's not already started
- Wait until node joins cluster with an uptime within 120s.
* Enable allocation
* Wait until cluster is in green health
Options:
--masters / --no-masters Restart master nodes as well [false]
--datas / --no-datas Restart data nodes [true]
--minimum-version TEXT Minimum version to upgrade to [1.7.1]
--help Show this message and exit.
```
Metadata
Release files for rollastic 0.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rollastic-0.0.7.tar.gz | 20.8 kB | Without provenance | Details for rollastic-0.0.7.tar.gz |
Release files / rollastic-0.0.7.tar.gz
| Download URL | rollastic-0.0.7.tar.gz |
|---|---|
| Size | 20.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b9febb2068d014ba7f02a9ccce83c120fb11d44b3ad84295d3b5f687263fc1fe
|
|
BLAKE2b-256 checksum How to use checksums |
c9c48269e64d023cba4ed2bcc025858ca9b62066a9c23d3bc56f9eff5f1c7b88
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for rollastic 0.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.