Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/saltstack-formulas/carbon-relay-ng-formula

A saltstack formula to install and configure carbon-relay-ng (https://github.com/graphite-ng/carbon-relay-ng), an alternative carbon-relay written in Go.
https://github.com/saltstack-formulas/carbon-relay-ng-formula

carbon graphite saltstack saltstack-formula

Last synced: 12 days ago
JSON representation

A saltstack formula to install and configure carbon-relay-ng (https://github.com/graphite-ng/carbon-relay-ng), an alternative carbon-relay written in Go.

Awesome Lists containing this project

README 

        
.. _readme:



carbon-relay-ng-formula

=======================



|img_travis| |img_sr| |img_pc|



.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/carbon-relay-ng-formula.svg?branch=master

   :alt: Travis CI Build Status

   :scale: 100%

   :target: https://travis-ci.com/saltstack-formulas/carbon-relay-ng-formula

.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg

   :alt: Semantic Release

   :scale: 100%

   :target: https://github.com/semantic-release/semantic-release

.. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white

   :alt: pre-commit

   :scale: 100%

   :target: https://github.com/pre-commit/pre-commit



A saltstack formula to install and configure [carbon-relay-ng](https://github.com/graphite-ng/carbon-relay-ng),

an alternative carbon-cache written in Go.



.. contents:: **Table of Contents**

   :depth: 1



General notes

-------------



See the full `SaltStack Formulas installation and usage instructions

`_.



If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section

`_.



If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,

which contains the currently released version. This formula is versioned according to `Semantic Versioning `_.



See `Formula Versioning Section `_ for more details.



If you need (non-default) configuration, please refer to:



- `how to configure the formula with map.jinja `_

- the ``pillar.example`` file

- the `Special notes`_ section



Contributing to this repo

-------------------------



Commit messages

^^^^^^^^^^^^^^^



**Commit message formatting is significant!!**



Please see `How to contribute `_ for more details.



pre-commit

^^^^^^^^^^



`pre-commit `_ is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.

First install  the ``pre-commit`` package manager using the appropriate `method `_, then run ``bin/install-hooks`` and

now ``pre-commit`` will run automatically on each ``git commit``. ::



  $ bin/install-hooks

  pre-commit installed at .git/hooks/pre-commit

  pre-commit installed at .git/hooks/commit-msg



Special notes

-------------



None.



Available states

----------------



.. contents::

   :local:



``carbon-relay-ng``

^^^^^^^^^^^^^^^^^^^



*Meta-state (This is a state that includes other states)*.



Calls the install, config and service states below.



``carbon-relay-ng.install``

^^^^^^^^^^^^^^^^^^^^^^^^^^^



Installs the carbon-relay-ng package and manages some directories and files.



``carbon-relay-ng.config``

^^^^^^^^^^^^^^^^^^^^^^^^^^



Manages the configuration file using defined pillars.



``carbon-relay-ng.service``

^^^^^^^^^^^^^^^^^^^^^^^^^^^



Manages the carbon-relay-ng service.



this state will undo everything performed in the ``carbon-relay-ng`` meta-state in reverse order, i.e.

stops the service,

removes the configuration file and

then uninstalls the package.



Testing

-------



Linux testing is done with ``kitchen-salt``.



Requirements

^^^^^^^^^^^^



* Ruby

* Docker



.. code-block:: bash



   $ gem install bundler

   $ bundle install

   $ bin/kitchen test [platform]



Where ``[platform]`` is the platform name defined in ``kitchen.yml``,

e.g. ``debian-9-2019-2-py3``.



``bin/kitchen converge``

^^^^^^^^^^^^^^^^^^^^^^^^



Creates the docker instance and runs the ``carbon-relay-ng`` main state, ready for testing.



``bin/kitchen verify``

^^^^^^^^^^^^^^^^^^^^^^



Runs the ``inspec`` tests on the actual instance.



``bin/kitchen destroy``

^^^^^^^^^^^^^^^^^^^^^^^



Removes the docker instance.



``bin/kitchen test``

^^^^^^^^^^^^^^^^^^^^



Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.



``bin/kitchen login``

^^^^^^^^^^^^^^^^^^^^^



Gives you SSH access to the instance for manual testing.