github.com/greenboxal/deis@v1.12.1/docs/installing_deis/vagrant.rst (about)

     1  :title: Installing Deis on Vagrant
     2  :description: How to provision a multi-node Deis cluster on Vagrant
     3  
     4  .. _deis_on_vagrant:
     5  
     6  Vagrant
     7  =======
     8  
     9  `Vagrant`_ is a tool for building complete development environments with a focus on automation.
    10  This guide demonstrates how you can stand up a Deis cluster for development purposes using Vagrant.
    11  
    12  Please :ref:`get the source <get_the_source>` and refer to the ``Vagrantfile``
    13  while following this documentation.
    14  
    15  
    16  Install Prerequisites
    17  ---------------------
    18  
    19  Please install `Vagrant`_ v1.6.5+ and `VirtualBox`_.
    20  
    21  The ``Vagrantfile`` requires the plugin `vagrant-triggers`_. To install the plugin run:
    22  
    23  .. code-block:: console
    24  
    25      $ vagrant plugin install vagrant-triggers
    26  
    27  .. note::
    28  
    29      For Ubuntu users: the VirtualBox package in Ubuntu has some issues when running in
    30      RAM-constrained environments. Please install the latest version of VirtualBox from Oracle's
    31      website.
    32  
    33  
    34  Generate a New Discovery URL
    35  ----------------------------
    36  
    37  .. include:: ../_includes/_generate-discovery-url.rst
    38  
    39  
    40  Generate SSH Key
    41  ----------------
    42  
    43  .. note::
    44  
    45      For Vagrant clusters you don't need to create a key pair, instead use the insecure_private_key located in ``~/.vagrant.d/insecure_private_key``.
    46  
    47  
    48  Boot CoreOS
    49  -----------
    50  
    51  Start the CoreOS cluster on VirtualBox. From a command prompt, switch directories to the root of
    52  the Deis project and type:
    53  
    54  .. code-block:: console
    55  
    56      $ vagrant up
    57  
    58  This instructs Vagrant to spin up 3 VMs. To be able to connect to the VMs, you must add your
    59  Vagrant-generated SSH key to the ssh-agent (``deisctl`` requires the agent to have this key):
    60  
    61  .. code-block:: console
    62  
    63      $ ssh-add ~/.vagrant.d/insecure_private_key
    64  
    65  
    66  Configure DNS
    67  -------------
    68  
    69  For convenience, we have set up a few DNS records for users running on Vagrant.
    70  ``local3.deisapp.com`` is set up for 3-node clusters and ``local5.deisapp.com`` is set up for
    71  5-node clusters.
    72  
    73  Since ``local3.deisapp.com`` is your cluster domain, use ``local3.deisapp.com`` anywhere you see
    74  ``example.com`` in the documentation.
    75  
    76  It is not necessary to configure DNS for Vagrant clusters, but it is possible - if you want to set up
    77  your own DNS records, see :ref:`configure-dns` for more information.
    78  
    79  
    80  Install Deis Platform
    81  ---------------------
    82  
    83  Now that you've finished provisioning a cluster, please refer to :ref:`install_deis_platform` to
    84  start installing the platform.
    85  
    86  
    87  .. _Vagrant: http://www.vagrantup.com/
    88  .. _VirtualBox: https://www.virtualbox.org/wiki/Downloads
    89  .. _vagrant-triggers: https://github.com/emyl/vagrant-triggers