c718a25d7d
* add integration tests * add tests * add checkout * check cat of the file * updatng tests * rename folder * update action * test str api key * update config file name * updated versions for tests * updated action * updated action * update test * updated ytests * updated check * Delete play.yml * updated check * update delete test * updated conditional check * updated check * updated tests * updated tests * Updated tests * Add folder test * fail test * updated tests * updated tests * update tests * add cloud stack test * update stack test * update test * update test * update test * update test * update test * update test * update tests * update tests * updated test * add plugin test * updated tests * add api key test * updat etest * updated tests * add notification policy tree test * reorg * fix * fix * update * add contact point test * update action * Seperate actions * update action name * update action * update action * update seq number * Updating CI tests * Edit Actions |
||
---|---|---|
.github/workflows | ||
changelogs | ||
meta | ||
plugins/modules | ||
tests/integration/targets | ||
CHANGELOG.rst | ||
galaxy.yml | ||
LICENSE | ||
README.md |
Ansible Collection - grafana.grafana
This collection contains modules and plugins to assist in automating managing of resources in Grafana with Ansible.
- Ansible collection Documentation: https://grafana.github.io/grafana-ansible-collection/
- Grafana website: https://grafana.com
- Grafana Cloud website: https://grafana.com/products/cloud/
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 commoand:
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.
Code of Conduct
This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this doc
More information
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Collection Developer Guide
- Ansible Community code of conduct
License
GPL-3.0-or-later