Merge "Add further configuration for the docker engine"
[integration.git] / bootstrap / vagrant-onap / doc / source / install / index.rst
1 ==================
2 Installation Guide
3 ==================
4
5 This project collects instructions related to the automatic creation
6 of a development environment. However, this requires only two
7 components previous to its execution.  These are an automation
8 building tool (Vagrant) and a provider platform (VirtualBox, Libvirt
9 and OpenStack). This section explains how to install the most common
10 set of configuration(Vagrant/VirtualBox) in different Operating
11 Systems.
12
13 Ubuntu 14.04 ("Trusty")
14 -----------------------
15
16 .. code-block:: console
17
18     $ wget -q https://releases.hashicorp.com/vagrant/1.9.7/vagrant_1.9.7_x86_64.deb
19     $ sudo dpkg -i vagrant_1.9.7_x86_64.deb
20     $ echo "deb http://download.virtualbox.org/virtualbox/debian trusty contrib" >> /etc/apt/sources.list
21     $ wget -q https://www.virtualbox.org/download/oracle_vbox_2016.asc -O- | sudo apt-key add -
22     $ wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add -
23     $ sudo apt-get update -y
24     $ sudo apt-get install -y virtualbox-5.1 dkms
25
26 .. end
27
28 CentOS
29 ------
30
31 .. code-block:: console
32
33     $ wget -q https://releases.hashicorp.com/vagrant/1.9.7/vagrant_1.9.7_x86_64.rpm
34     $ sudo yum install vagrant_1.9.7_x86_64.rpm
35     $ wget -q http://download.virtualbox.org/virtualbox/rpm/rhel/virtualbox.repo -P /etc/yum.repos.d
36     $ sudo yum --enablerepo=epel install dkms
37     $ wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | rpm --import -
38     $ sudo yum install VirtualBox-5.1
39
40 .. end
41
42 Mac OS
43 ------
44
45 .. code-block:: console
46
47     $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
48     $ brew cask install vagrant
49     $ brew cask install virtualbox
50
51 .. end
52
53 Windows 7+ (PowerShell v2+)
54 ---------------------------
55
56 .. code-block:: console
57
58     PS C:\> Set-ExecutionPolicy AllSigned
59     PS C:\> iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
60     PS C:\> choco install vagrant
61     PS C:\> choco install virtualbox
62
63 .. end
64
65 .. note::
66
67     Some corporations use Proxy Servers to protect their assets
68     from security threats. This project uses the Proxy Environment
69     variables to connect to those servers in order to download the
70     content required during the setup. The methods to setup these
71     variables depends on the Operating system that is used.
72
73     * Linux or Mac OS
74
75     .. code-block:: console
76
77         $ export http_proxy=<proxy>
78         $ export https_proxy=<proxy>
79         $ export no_proxy=<no_proxy_urls>
80
81     .. end
82
83     * Windows
84
85     .. code-block:: console
86
87         C:\> setx http_proxy <proxy>
88         C:\> setx https_proxy <proxy>
89         C:\> setx no_proxy <no_proxy_urls>
90
91     .. end
92
93 .. note::
94
95     Vagrant can be configured to use a different default provider
96     through the environment variable **VAGRANT_DEFAULT_PROVIDER**.