Skip to content

Commit 9efb5f4

Browse files
committed
Add README
1 parent 25dcd55 commit 9efb5f4

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# StackHPC cephadm collection
2+
3+
This repo contains `stackhpc.cephadm` Ansible Collection. The collection includes modules and plugins supported by StackHPC for cephadm based deployments.
4+
5+
## Tested with Ansible
6+
7+
Tested with the current Ansible 2.9 releases.
8+
9+
## Included content
10+
11+
cephadm_deploy role
12+
13+
## Using this collection
14+
15+
Before using the collection, you need to install the collection with the `ansible-galaxy` CLI:
16+
17+
ansible-galaxy collection install stackhpc.cephadm
18+
19+
You can also include it in a `requirements.yml` file and install it via ansible-galax collection install -r requirements.yml` using the format:
20+
21+
```yaml
22+
collections:
23+
- name: stackhpc.cephadm
24+
```
25+
26+
See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
27+
28+
## More information
29+
30+
- [Ansible Collection overview](https://github.com/ansible-collections/overview)
31+
- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
32+
- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
33+
- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
34+
35+
## Licensing
36+
37+
Apache License Version 2.0

0 commit comments

Comments
 (0)