blob: 309604a22d6cc8a57c1e4f5dbb1e461d08858cd4 [file] [log] [blame]
Simon Pasquier418cacc2016-11-24 17:19:05 +01001
2==================================
3aodh
4==================================
5
6Service aodh description
7
8Sample pillars
9==============
10
11Single aodh service
12
13.. code-block:: yaml
14
15 aodh:
16 server:
17 enabled: true
18 version: icehouse
19
20
21Development and testing
22=======================
23
24Development and test workflow with `Test Kitchen <http://kitchen.ci>`_ and
25`kitchen-salt <https://github.com/simonmcc/kitchen-salt>`_ provisioner plugin.
26
27Test Kitchen is a test harness tool to execute your configured code on one or more platforms in isolation.
28There is a ``.kitchen.yml`` in main directory that defines *platforms* to be tested and *suites* to execute on them.
29
30Kitchen CI can spin instances locally or remote, based on used *driver*.
31For local development ``.kitchen.yml`` defines a `vagrant <https://github.com/test-kitchen/kitchen-vagrant>`_ or
32`docker <https://github.com/test-kitchen/kitchen-docker>`_ driver.
33
34To use backend drivers or implement your CI follow the section `INTEGRATION.rst#Continuous Integration`__.
35
36The `Busser <https://github.com/test-kitchen/busser>`_ *Verifier* is used to setup and run tests
37implementated in `<repo>/test/integration`. It installs the particular driver to tested instance
38(`Serverspec <https://github.com/neillturner/kitchen-verifier-serverspec>`_,
39`InSpec <https://github.com/chef/kitchen-inspec>`_, Shell, Bats, ...) prior the verification is executed.
40
41Usage:
42
43.. code-block:: shell
44
45 # list instances and status
46 kitchen list
47
48 # manually execute integration tests
49 kitchen [test || [create|converge|verify|exec|login|destroy|...]] [instance] -t tests/integration
50
51 # use with provided Makefile (ie: within CI pipeline)
52 make kitchen
53
54
55
56Read more
57=========
58
59* links
Filip Pytloun744de4b2017-02-02 12:52:17 +010060
61Documentation and Bugs
62======================
63
64To learn how to install and update salt-formulas, consult the documentation
65available online at:
66
67 http://salt-formulas.readthedocs.io/
68
69In the unfortunate event that bugs are discovered, they should be reported to
70the appropriate issue tracker. Use Github issue tracker for specific salt
71formula:
72
73 https://github.com/salt-formulas/salt-formula-aodh/issues
74
75For feature requests, bug reports or blueprints affecting entire ecosystem,
76use Launchpad salt-formulas project:
77
78 https://launchpad.net/salt-formulas
79
80You can also join salt-formulas-users team and subscribe to mailing list:
81
82 https://launchpad.net/~salt-formulas-users
83
84Developers wishing to work on the salt-formulas projects should always base
85their work on master branch and submit pull request against specific formula.
86
87 https://github.com/salt-formulas/salt-formula-aodh
88
89Any questions or feedback is always welcome so feel free to join our IRC
90channel:
91
92 #salt-formulas @ irc.freenode.net