Command line tool for managing Scylla Clusters
Project description
Scylla-API-Client
Scylla API Client is a command line utility implementing a thin client directly utilizing the Scylla REST API
Requirements
- python > 3.8
- requests
- pytest (developers)
Installation
pip install scylla-api-client
Usage
See scylla-api-client --help
for all options, below are some sample uses:
-
Show all API modules
$ scylla-api-client --list-modules system compaction_manager gossiper endpoint_snitch_info storage_proxy column_family stream_manager messaging_service storage_service cache_service failure_detector hinted_handoff lsa commitlog collectd error_injection
-
Show all API commands for specific module system
$ scylla-api-client --list-module-commands system system/logger: GET: Get all logger names POST: Set all logger level system/drop_sstable_caches: POST: Drop in-memory caches for data which is in sstables system/uptime_ms: GET: Get system uptime, in milliseconds system/logger/{name}: GET: Get logger level POST: Set logger level
-
Get loglevel for specific logger httpd
$ scylla-api-client system/logger/{name} GET --name httpd "info"
-
Set loglevel level=debug for specific logger httpd
$ scylla-api-client system/logger/{name} POST --name httpd --level debug
Tests
pytest is used for writing and executing tests to run tests you can execute:
pip install -r dev-requirements.txt
pytest -s -v tests/
Design
Release
Releases are published automatically by GitHub Actions when a tag (v**) is pushed to GitHub.
- Make sure you tag the correct commit
- Pushing a tag to GitHub requires maintainers/admin privileges
git tag v1.0 <some-commit-hash>
git push upstream v1.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
scylla-api-client-1.0.tar.gz
(116.1 kB
view hashes)
Built Distribution
Close
Hashes for scylla_api_client-1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76d1c3b698b65d7fb2fadc3f9124d1104f8dff96e318174b9c49639c1b078a64 |
|
MD5 | f292c3b8b23898bcff5f74b6617800bc |
|
BLAKE2b-256 | abb60245ebfe86c429a520586bcdbf53f6fdab60bcc1543e8e5e3f7c4be0b0ea |