[](https://github.com/yandex/ch-tools/blob/main/LICENSE)
[](https://github.com/yandex/ch-tools/actions/workflows/workflow.yml?query=event%3Apush)
# clickhouse-tools
**clickhouse-tools** is a set of tools for administration and diagnostics of [ClickHouse](https://clickhouse.com/) DBMS.
## Tools
**clickhouse-tools** consist of following components:
- [chadmin](./src/chtools/chadmin/README.md) - ClickHouse administration tool
- [ch-monitoring](./src/chtools/monrun_checks/README.md) - ClickHouse monitoring tool
- [keeper-monitoring](./src/chtools/monrun_checks_keeper/README.md) - ClickHouse Keeper / ZooKeeper monitoring tool
- [ch-s3-credentials](./src/chtools/s3_credentials/README.md) - ClickHouse S3 credentials management tool
All of these tools must be run on the same host as ClickHouse server is running.
## Local development (using poetry)
```sh
sudo make install-poetry
# or to install in user's home directory
make POETRY_HOME=~/opt/poetry install-poetry
# lint
make lint
# unit tests
make test-unit
make test-unit PYTEST_ARGS="-k test_name"
# integration tests (rebuild docker images using a .whl file)
make test-integration
make test-integration BEHAVE_ARGS="-i feature_name"
# integration tests (supply a custom ClickHouse version to test against)
CLICKHOUSE_VERSION="1.2.3.4" make test-integration
# If you want to have containers running on failure, supply a flag:
# BEHAVE_ARGS="-D no_stop_on_fail"
# For building deb packages
make prepare-build-deb
make build-deb-package
```
Please note: base images for tests are pulled from [chtools Dockerhub](https://hub.docker.com/u/chtools).
If you want to build base images locally, run
```sh
docker buildx bake -f tests/bake.hcl
```
If you want to build base images for multiple versions of ClickHouse, run:
```sh
CLICKHOUSE_VERSIONS='1.2.3.4, 5.6.7.8, latest' docker buildx bake -f tests/bake.hcl
```
Raw data
{
"_id": null,
"home_page": "https://github.com/yandex/ch-tools",
"name": "clickhouse-tools",
"maintainer": "Alexander Burmak",
"docs_url": null,
"requires_python": ">=3.6.2,<4.0.0",
"maintainer_email": "alex-burmak@yandex-team.ru",
"keywords": "clickhouse,database,monitoring,diagnostics,administration",
"author": "Alexander Burmak",
"author_email": "alex-burmak@yandex-team.ru",
"download_url": "",
"platform": null,
"description": "[](https://github.com/yandex/ch-tools/blob/main/LICENSE)\n[](https://github.com/yandex/ch-tools/actions/workflows/workflow.yml?query=event%3Apush)\n\n# clickhouse-tools\n\n**clickhouse-tools** is a set of tools for administration and diagnostics of [ClickHouse](https://clickhouse.com/) DBMS.\n\n## Tools\n\n**clickhouse-tools** consist of following components:\n- [chadmin](./src/chtools/chadmin/README.md) - ClickHouse administration tool\n- [ch-monitoring](./src/chtools/monrun_checks/README.md) - ClickHouse monitoring tool\n- [keeper-monitoring](./src/chtools/monrun_checks_keeper/README.md) - ClickHouse Keeper / ZooKeeper monitoring tool\n- [ch-s3-credentials](./src/chtools/s3_credentials/README.md) - ClickHouse S3 credentials management tool\n\nAll of these tools must be run on the same host as ClickHouse server is running.\n\n## Local development (using poetry)\n\n```sh\nsudo make install-poetry\n# or to install in user's home directory\nmake POETRY_HOME=~/opt/poetry install-poetry\n\n# lint\nmake lint\n\n# unit tests\nmake test-unit\nmake test-unit PYTEST_ARGS=\"-k test_name\"\n\n# integration tests (rebuild docker images using a .whl file)\nmake test-integration\nmake test-integration BEHAVE_ARGS=\"-i feature_name\"\n\n# integration tests (supply a custom ClickHouse version to test against)\nCLICKHOUSE_VERSION=\"1.2.3.4\" make test-integration\n# If you want to have containers running on failure, supply a flag:\n# BEHAVE_ARGS=\"-D no_stop_on_fail\"\n\n# For building deb packages\nmake prepare-build-deb\nmake build-deb-package \n```\n\nPlease note: base images for tests are pulled from [chtools Dockerhub](https://hub.docker.com/u/chtools).\nIf you want to build base images locally, run\n\n```sh\ndocker buildx bake -f tests/bake.hcl\n```\n\nIf you want to build base images for multiple versions of ClickHouse, run:\n\n```sh\nCLICKHOUSE_VERSIONS='1.2.3.4, 5.6.7.8, latest' docker buildx bake -f tests/bake.hcl\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "clickhouse-tools is a set of tools for administration and diagnostics of ClickHouse DBMS.",
"version": "2.1.71613250",
"project_urls": {
"Homepage": "https://github.com/yandex/ch-tools",
"Repository": "https://github.com/yandex/ch-tools"
},
"split_keywords": [
"clickhouse",
"database",
"monitoring",
"diagnostics",
"administration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14d4969a45bca6f769629110ab99f26fe08c7d3af12a7f347bd36de46e7a3a1d",
"md5": "39a4e0cc7086b50828479227be045b97",
"sha256": "043c60b128bcd92f79517cc4f026b40e9ff39d67609ae1009558fd6398782dfc"
},
"downloads": -1,
"filename": "clickhouse_tools-2.1.71613250-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39a4e0cc7086b50828479227be045b97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.2,<4.0.0",
"size": 112832,
"upload_time": "2023-08-11T16:01:44",
"upload_time_iso_8601": "2023-08-11T16:01:44.037714Z",
"url": "https://files.pythonhosted.org/packages/14/d4/969a45bca6f769629110ab99f26fe08c7d3af12a7f347bd36de46e7a3a1d/clickhouse_tools-2.1.71613250-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-11 16:01:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yandex",
"github_project": "ch-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "clickhouse-tools"
}
JSON
