alainivars/utils2devops

.. include:: links.inc

Welcome to Utils2devops documentation!
======================================

.. image:: https://api.travis-ci.org/alainivars/utils2devops.svg?branch=master
    :target: http://travis-ci.org/alainivars/utils2devops
    :alt: Build status

.. image:: https://coveralls.io/repos/github/alainivars/utils2devops/badge.svg?branch=master
    :target: https://coveralls.io/github/alainivars/utils2devops?branch=master
    :alt: Test coverage status

.. image:: https://requires.io/github/alainivars/utils2devops/requirements.svg?branch=master
    :target: https://requires.io/github/alainivars/utils2devops/requirements/?branch=master
    :alt: Requirements Status

.. image:: https://img.shields.io/pypi/docker_machine/utils2devops.svg
   :target: https://pypi.python.org/pypi/utils2devops/
   :alt: pypi download

.. image:: https://img.shields.io/pypi/pyversions/utils2devops.svg
   :target: https://pypi.python.org/pypi/utils2devops/
   :alt: python supported

.. image:: https://img.shields.io/pypi/l/utils2devops.svg
   :target: https://pypi.python.org/pypi/utils2devops/
   :alt: licence

.. image:: https://img.shields.io/pypi/v/utils2devops.svg
   :target: https://pypi.python.org/pypi/utils2devops
   :alt: PyPi version

.. image:: https://api.codeclimate.com/v1/badges/1ba86a1707cdb492ddf6/maintainability
   :target: https://codeclimate.com/github/alainivars/utils2devops/maintainability
   :alt: Maintainability

.. image:: https://readthedocs.org/projects/utils2devops/badge/?version=latest
   :target: https://readthedocs.org/projects/utils2devops/?badge=latest
   :alt: Documentation status

.. image:: https://pypip.in/wheel/utils2devops/badge.svg
   :target: https://pypi.python.org/pypi/utils2devops/
   :alt: PyPi wheel


Contents
========
.. toctree::
   :maxdepth: 2
   :caption: How to use it:

    We will use::

    **Terraform** will create your cloud infrastructure
    **Vagrant** will reproduce a production-like environment locally
    **Ansible** will provision Virtual Machines and set up the Docker Swarm cluster
    **Ansible** again to deploy your stacks

   bins
   vagrant
   swarm/SwarmStackBase
   swarm/local-proxy-prom-elk
   swarm/local-proxy-prom-Icinga2
   swarm/aws
   testing
   aws
   lxc_lxd
   releases_notes
   terraform
   source/modules

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Infrastructure As Code
======================

Utils2devops is a package that contain python 3 functions and class that can be helpful in the
all working day. Any help for develop, test, validate, documentation are
welcome!

With utils2devops you will  learn if you don't already know::

    How to create a Docker swarm locally and deploy it automatically
    How to populate a Docker swarm locally and deploy it automatically
    How to add an existing AWS Ec2 instance in Docker-machine
    ...

TAKE CARE THIS LIBRARY AND THE TOOLS will do what ever you ask to do, even for
destroy image, network, container, ...

One of my main principles is not to reinvent the wheel, and if someone has
already created a function, a class and sharing it, and if I like its implementation,
I will use this function / class and say a big thank you to this person in all respect of the Copyright and the Licence.
This library is in development and the folder structure will change certainly

We already use :

    - `AWS Tools`_
    - `AWS Cloud`_ Ami, Security group, Ec2
    - `Docker`_
    - `Ansible`_
    - `Traefik`_
    - `Portainer`_
    - `Terraform`_
    - `Swarmprom`_
    - `Elk`_
    - `Icinga2`_ + `plugin logs`_ WORK IN PROGRESS

We will add :

    - `AWS Cloud`_ S3, RDS, Cloudwatch, ...
    - `GPC tools`_
    - `GPC Cloud`_
    - `OpenFaaS`_
    - `Consul`_
    - `Etcd`_
    - Kubernetes
    - ...

We will remove :

    - The use of docker-machine everywhere we use it in version 0.2.0

To develop or improve this library you can run it with the env DEBUG_OR_IMPROVE

Something disturb you in the code? Don't hesitate to open a an issue and contribute.

Online documentation is here on `Readthedoc`_
Online source code available on `Github`_