Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeromepin/esctl
Easy to use CLI tool to manage Elasticsearch, preventing long curl commands.
https://github.com/jeromepin/esctl
cli elasticsearch
Last synced: 25 days ago
JSON representation
Easy to use CLI tool to manage Elasticsearch, preventing long curl commands.
- Host: GitHub
- URL: https://github.com/jeromepin/esctl
- Owner: jeromepin
- License: gpl-3.0
- Created: 2019-10-17T06:39:31.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T08:00:04.000Z (5 months ago)
- Last Synced: 2024-11-07T10:08:39.130Z (about 1 month ago)
- Topics: cli, elasticsearch
- Language: Python
- Size: 184 KB
- Stars: 39
- Watchers: 4
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-elasticsearch - Esctl - High-level command line interface to manage Elasticsearch clusters. (Elasticsearch developer tools and utilities / Management)
- elasticsearch-collection - Esctl - High-level command line interface to manage Elasticsearch clusters. (Elasticsearch developer tools and utilities / Management)
README
Esctl
A Command-Line Interface designed to ease Elasticsearch administration.
Key Features •
Installation •
How To Use •
Examples •
License •
Developing
Esctl is a CLI tool for Elasticsearch. [I designed it](https://jeromepin.fr/posts/esctl-managing-elasticsearch-from-command-line/) to shorten huge `curl` commands Elasticsearch operators were running like :
```bash
curl -XPUT --user "john:doe" 'http://elasticsearch.example.com:9200/_cluster/settings' -d '{
"transient" : {
"cluster.routing.allocation.enable": "NONE"
}
}'
```
The equivalent with `esctl` is
```bash
esctl cluster routing allocation enable none
```
## Key Features
* **Easy to use CLI** rather than long curl commands (thanks to [cliff](https://github.com/openstack/cliff))
* Cluster-level informations : **stats**, **info**, **health**, **allocation explanation**
* Node-level informations : **list**, **hot threads**, **exclusion**, **stats**
* Cluster-level and index-level **settings**
* `_cat` API for **allocation**, **plugins** and **thread pools**
* **Index management** : open, close, create, delete, list
* `raw` command to perform raw HTTP calls when esctl doesn't provide a nice interface for a given route.
* Per-module **log configuration**
* X-Pack APIs : **users** and **roles**
* **Multiple output formats** : table, csv, json, value, yaml
* [JMESPath](https://jmespath.org/) queries using the `--jmespath` flag
* Colored output !
* Run arbitrary pre-commands before issuing the call to Elasticsearch (like running `kubectl port-forward` for example)
* Fetch cluster's credentials from external commands instead of having them shown in cleartext in the config file
## Installation
### Using PIP
```bash
pip install esctl
```
### From source
```bash
pip install git+https://github.com/jeromepin/esctl.git
```
## How To Use
Esctl relies on a `~/.esctlrc` file containing its config. This file is automatically created on the first start if it doesn't exists :
```yaml
clusters:
bar:
servers:
- https://bar.example.com
users:
john-doe:
username: john
external_password:
command:
run: kubectl --context=bar --namespace=baz get secrets -o json my-secret | jq -r '.data.password||@base64d'
contexts:
foo:
user: john-doe
cluster: bar
default-context: foo
```
### Running pre-commands
Sometimes, you need to execute a shell command right before running the `esctl` command. Like running a `kubectl port-forward` in order to connect to your Kubernetes cluster.
There is a `pre_commands` block inside the context which can take care of that :
```yaml
clusters:
remote-kubernetes:
servers:
- http://localhost:9200
contexts:
my-distant-cluster:
cluster: remote-kubernetes
pre_commands:
- command: kubectl --context=my-kubernetes-context --namespace=elasticsearch port-forward svc/elasticsearch 9200
wait_for_exit: false
wait_for_output: Forwarding from
user: john-doe
```
Along with `command`, you can pass two options :
* `wait_for_exit` (_default_: `true`) : wait for the command to exit before continuing. Usually set to `false` when the command is running in the foreground.
* `wait_for_output` : if `wait_for_exit` is `false`, look for a specific output in the command's stdout. The string to look-for is interpreted as a regular expression passed to Python's [re.compile()](https://docs.python.org/3.7/library/re.html).
## Examples
## License
`esctl` is licensed under the GNU GPLv3. See [LICENCE](https://github.com/jeromepin/esctl/blob/master/LICENSE) file.
## Developing
### Install
```bash
make install
```
### Run tests
```bash
make test
```
### Format and lint code
```bash
make lint
```