Update README with additional information

Change-Id: Icf45bf7ecb00a2afe9d076e413a212b1e8399ad1
2020-05-14 08:39:47 +03:00 · 2020-05-14 08:39:47 +03:00 · 8aa0412e75
commit 8aa0412e75
parent 5ff16c9420
1 changed files with 96 additions and 3 deletions
--- a/README.md
+++ b/README.md
@ -1,6 +1,99 @@
 [![OpenDev Zuul Builds - Ansible Collection OpenStack](https://zuul-ci.org/gated.svg)](http://zuul.opendev.org/t/openstack/builds?project=openstack%2Fansible-collections-openstack#)

-Ansible Collection: openstack.cloud
-===================================
+# Ansible Collection: openstack.cloud

-For information on contributing, please see https://opendev.org/openstack/ansible-collections-openstack/src/branch/master/CONTRIBUTING.rst
+
+This repo hosts the `openstack.cloud` Ansible Collection.
+
+The collection includes the Openstack modules and plugins supported by Openstack community to help the management of Openstack infrastructure.
+
+## Installation and Usage
+
+### Installing the Collection from Ansible Galaxy
+
+Before using the Openstack Cloud collection, you need to install the collection with the `ansible-galaxy` CLI:
+
+`ansible-galaxy collection install openstack.cloud`
+
+You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format:
+
+```yaml
+collections:
+- name: openstack.cloud
+```
+
+### Playbooks
+
+To use a module from Openstack Cloud collection, please reference the full namespace, collection name, and modules name that you want to use:
+
+```yaml
+---
+- name: Using Openstack Cloud collection
+  hosts: localhost
+  tasks:
+    - openstack.cloud.server:
+        name: vm
+        state: present
+        cloud: openstack
+        region_name: ams01
+        image: Ubuntu Server 14.04
+        flavor_ram: 4096
+        boot_from_volume: True
+        volume_size: 75
+```
+
+Or you can add full namepsace and collecton name in the `collections` element:
+
+```yaml
+---
+- name: Using Openstack Cloud collection
+  hosts: localhost
+  collections:
+    - openstack.cloud
+  tasks:
+    - server_volume:
+        state: present
+        cloud: openstack
+        server: Mysql-server
+        volume: mysql-data
+        device: /dev/vdb
+```
+
+## Contributing
+
+For information on contributing, please see [CONTRIBUTING](https://opendev.org/openstack/ansible-collections-openstack/src/branch/master/CONTRIBUTING.rst)
+
+There are many ways in which you can participate in the project, for example:
+
+- Submit bugs and feature requests, and help us verify them
+- Submit and review source code changes in [Openstack Gerrit](https://review.opendev.org/#/q/project:openstack/ansible-collections-openstack)
+- Add new modules for Openstack Cloud
+
+We work with [OpenDev Gerrit](https://review.opendev.org/), pull requests submitted through GitHub will be ignored.
+
+## Testing and Development
+
+If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
+
+### Testing with `ansible-test`
+
+We use `ansible-test` for sanity:
+
+```bash
+tox -e linters
+```
+
+## More Information
+
+TBD
+
+## Communication
+
+We have a dedicated Interest Group for Openstack Ansible modules.
+You can find other people interested in this in `#openstack-ansible-sig` on Freenode IRC.
+
+## License
+
+GNU General Public License v3.0 or later
+
+See [LICENCE](https://opendev.org/openstack/ansible-collections-openstack/src/branch/master/COPYING) to see the full text.