7.0 KiB
Ansible Collection for Grafana Cloud
This collection (grafana.grafana) contains modules and plugins to assist in automating managing of resources in Grafana Cloud with Ansible.
Ansible version compatibility
The collection is tested and supported with: ansible >= 2.9
Installing the collection
Before using the Grafana collection, you need to install it using the below command:
ansible-galaxy collection install grafana.grafana
You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:
---
collections:
- name: grafana.grafana
A specific version of the collection can be installed by using the version keyword in the requirements.yml file:
---
collections:
- name: grafana.grafana
version: 1.0.0
Using this collection
You can call modules by their Fully Qualified Collection Namespace (FQCN), such as grafana.grafana.cloud_stack:
- name: Using grafana collection
hosts: localhost
tasks:
- name: Create a Grafana Cloud stack
grafana.grafana.cloud_stack:
name: mystack
stack_slug: mystack
org_slug: myorg
cloud_api_key: "{{ cloud_api_key }}"
region: eu
state: present
or you can add full namespace and collection name in the collections element in your playbook
- name: Using grafana collection
hosts: localhost
collection:
- grafana.grafana
tasks:
- name: Create a Grafana Cloud stack
cloud_stack:
name: mystack
stack_slug: mystack
org_slug: myorg
cloud_api_key: "{{ cloud_api_key }}"
region: eu
state: present
Contributing
We are accepting GitHub pull requests and issues. 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 GitHub pull requests
- Add new modules for more Grafana resources
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,
and work on it there.
Testing with ansible-test
We use ansible-test for sanity.
Commands
| Command | Description |
|---|---|
make setup |
Checks to see if necessary tools are installed |
make install |
Installs project dependencies |
make lint |
Performs all linting commands |
make lint-sh / make lint-shell |
Performs shell script linting |
make lint-md / make lint-markdown |
Performs Markdown linting |
make lint-txt / make lint-text |
Performs text linting |
make lint-yml / make lint-yaml |
Performs Yaml linting |
make lint-ec / make lint-editorconfig |
Performs EditorConfig Checks |
make lint-ansible |
Performs Ansible linting |
make clean |
Removes the ./node_modules and ./build directories |
make reinstall |
Shortcut to make clean and make install |
Releasing, Versioning and Deprecation
This collection follows Semantic Versioning. More details on versioning can be found in the Ansible docs.
We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.
Releasing the current major version on GitHub happens from the main branch by the
GitHub Release Workflow.
Before the GitHub Release Workflow
is run, Contributors should push the new version on Ansible Galaxy Manually.
We currently are not planning any deprecations or new major releases. The current landscape includes minor version updates for
module's documentation in 2.0.1.
To generate changelogs for a new release, Refer Generating Changelogs
To generate the tarball to be uploaded on Ansible Galaxy, Refer Building collection tarball
Code of Conduct
This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this doc
More information
- Maintainer guidelines
- Subscribe to the news-for-maintainers repository and track announcements there.
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Collection Developer Guide
- Ansible Community code of conduct
License
GPL-3.0-or-later