Skip to content

Commit

Permalink
README: improve (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
Andersson007 authored Oct 10, 2024
1 parent 11c27fc commit 5385a27
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ you are encouraged to contribute, share insights, and collaborate with fellow en
We strive to make managing ClickHouse deployments as effortless and efficient as possible with automation,
enabling users to focus on their core objectives.

## Included content

See the list of included modules and their documentation for your installed version on the [collection Galaxy page](https://galaxy.ansible.com/ui/repo/published/community/clickhouse/docs/).

## External requirements

- [clickhouse-driver](https://clickhouse-driver.readthedocs.io/en/latest/) Python connector installed on a target machine.
Expand Down Expand Up @@ -47,7 +51,7 @@ ansible-galaxy collection install community.clickhouse --upgrade
You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax:

```bash
ansible-galaxy collection install community.clickhouse:==0.1.0
ansible-galaxy collection install community.clickhouse:==0.6.0
```

See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
Expand All @@ -70,12 +74,10 @@ See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_gui
ansible.builtin.debug:
var: result

# Note: it runs SELECT version() just for the sake of example.
# You can get it with the task above much more conveniently.
- name: Query DB using non-default user & DB to connect to
register: result
community.clickhouse.clickhouse_client:
execute: SELECT version()
execute: SELECT * FROM my_table
login_host: localhost
login_user: alice
login_db: foo
Expand Down Expand Up @@ -144,10 +146,6 @@ We maintain each major release version (1.x.y, 2.x.y, ...) for two years after t
Here is the table for the support timeline:
- 1.x.y: to be released

## Included content

See the list of included modules and their documentation for your installed version on the [collection Galaxy page](https://galaxy.ansible.com/ui/repo/published/community/clickhouse/docs/).

## Tested with

See our [CI matrix](https://github.com/ansible-collections/community.clickhouse/blob/main/.github/workflows/ansible-test-plugins.yml) for more information about ansible-core and ClickHouse versions the collection is tested with.
Expand Down

0 comments on commit 5385a27

Please sign in to comment.