<commit_before>.. Copyright 2016 tsuru authors. All rights reserved.
   Use of this source code is governed by a BSD-style
   license that can be found in the LICENSE file.

:title: tsuru Installer
:description: Installs tsuru and it`s dependencies

.. _installer:

###############
tsuru Installer
###############

tsuru Installer provides a way to install tsuru API and it's required components
locally or on remote hosts.

.. note::

    tsuru Installer is distributed inside the tsuru client. To use it, you must
    first install the client. Check the tsuru client documentation for a full
    reference, including how to install it: https://tsuru-client.readthedocs.org.


To install tsuru locally, one can simply run
(requires `VirtualBox <https://www.virtualbox.org/wiki/Downloads>`_):

.. highlight:: bash

::

    $ tsuru install


After a couple of minutes you will have a full tsuru installation, inside a local
VirtualBox VM, where you can start deploying your applications and experience the
tsuru workflow.

How it works
============

tsuru installer uses `docker machine <https://www.docker.com/products/docker-machine>`_
to provision docker hosts, this means that it's possible to use any of the core or
3rd party docker machine drivers on the installation.

It will create a directory inside your ``~/.tsuru/installs``, with every file created
and needed by docker machine to manage and provision your hosts: certificates,
configuration files, your CA file etc.

After provisioning the hosts, the installer will install and start every tsuru
component as a swarm service on the hosts.

Docker Machine drivers
----------------------

Docker Machine drivers are responsible for provisioning docker hosts on different
iaas'. The installer comes bundled with all `docker machine core drivers <https://docs.docker.com/machine/drivers/>`_
and also supports the 3rd party ones; just make sure they are available in your $PATH.

For a list of 3rd party plugins supported by the community
check `here <https://github.com/docker/machine/blob/master/docs/AVAILABLE_DRIVER_PLUGINS.md>`_.

Swarm Mode<commit_msg>fix link to docs of docker-machine drivers<commit_after>.. Copyright 2016 tsuru authors. All rights reserved.
   Use of this source code is governed by a BSD-style
   license that can be found in the LICENSE file.

:title: tsuru Installer
:description: Installs tsuru and it`s dependencies

.. _installer:

###############
tsuru Installer
###############

tsuru Installer provides a way to install tsuru API and it's required components
locally or on remote hosts.

.. note::

    tsuru Installer is distributed inside the tsuru client. To use it, you must
    first install the client. Check the tsuru client documentation for a full
    reference, including how to install it: https://tsuru-client.readthedocs.org.


To install tsuru locally, one can simply run
(requires `VirtualBox <https://www.virtualbox.org/wiki/Downloads>`_):

.. highlight:: bash

::

    $ tsuru install


After a couple of minutes you will have a full tsuru installation, inside a local
VirtualBox VM, where you can start deploying your applications and experience the
tsuru workflow.

How it works
============

tsuru installer uses `docker machine <https://www.docker.com/products/docker-machine>`_
to provision docker hosts, this means that it's possible to use any of the core or
3rd party docker machine drivers on the installation.

It will create a directory inside your ``~/.tsuru/installs``, with every file created
and needed by docker machine to manage and provision your hosts: certificates,
configuration files, your CA file etc.

After provisioning the hosts, the installer will install and start every tsuru
component as a swarm service on the hosts.

Docker Machine drivers
----------------------

Docker Machine drivers are responsible for provisioning docker hosts on different
iaas'. The installer comes bundled with all `docker machine core drivers <https://docs.docker.com/machine/drivers/>`_
and also supports the 3rd party ones; just make sure they are available in your $PATH.

For a list of 3rd party plugins supported by the community
check `here <https://github.com/docker/docker.github.io/blob/master/machine/AVAILABLE_DRIVER_PLUGINS.md>`_.

Swarm Mode
{'fraction_non_alphanumeric': 0.0882284109524924, 'fraction_numerical': 0.003276386613620407, 'mean_word_length': 4.161835748792271, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 10, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7534125', 'n_tokens_mistral': 1180, 'n_tokens_neox': 1100, 'n_words': 555}