Merge "Change from using chef to local config files"
[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/2.0.1/vagrant_2.0.1_x86_64.deb
19     $ sudo dpkg -i vagrant_2.0.1_x86_64.deb
20
21     $ echo "deb http://download.virtualbox.org/virtualbox/debian trusty contrib" >> /etc/apt/sources.list
22     $ wget -q https://www.virtualbox.org/download/oracle_vbox_2016.asc -O- | sudo apt-key add -
23     $ wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add -
24     $ sudo apt-get update -y
25     $ sudo apt-get install -y virtualbox-5.1 dkms
26
27     $ sudo apt install -y nfs-kernel-server
28
29 .. end
30
31 CentOS
32 ------
33
34 .. code-block:: console
35
36     $ wget -q https://releases.hashicorp.com/vagrant/2.0.1/vagrant_2.0.1_x86_64.rpm
37     $ sudo yum install vagrant_2.0.1_x86_64.rpm
38
39     $ wget -q http://download.virtualbox.org/virtualbox/rpm/rhel/virtualbox.repo -P /etc/yum.repos.d
40     $ sudo yum --enablerepo=epel install dkms
41     $ wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | rpm --import -
42     $ sudo yum install -y VirtualBox-5.1
43
44     $ sudo yum install -y nfs-utils nfs-utils-lib
45
46 .. end
47
48 Mac OS
49 ------
50
51 .. code-block:: console
52
53     $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
54     $ brew cask install vagrant
55     $ brew cask install virtualbox
56
57 .. end
58
59 Windows 7+ (PowerShell v2+)
60 ---------------------------
61
62 .. code-block:: console
63
64     PS C:\> Set-ExecutionPolicy AllSigned
65     PS C:\> iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
66     PS C:\> choco install vagrant
67     PS C:\> choco install virtualbox
68
69 .. end
70
71 .. note::
72
73     Some corporations use Proxy Servers to protect their assets
74     from security threats. This project uses the Proxy Environment
75     variables to connect to those servers in order to download the
76     content required during the setup. The methods to setup these
77     variables depends on the Operating system that is used.
78
79     * Linux or Mac OS
80
81     .. code-block:: console
82
83         $ export http_proxy=<proxy>
84         $ export https_proxy=<proxy>
85         $ export no_proxy=<no_proxy_urls>
86
87     .. end
88
89     * Windows
90
91     .. code-block:: console
92
93         C:\> setx http_proxy <proxy>
94         C:\> setx https_proxy <proxy>
95         C:\> setx no_proxy <no_proxy_urls>
96
97     .. end
98
99 .. note::
100
101     Vagrant can be configured to use a different default provider
102     through the environment variable **VAGRANT_DEFAULT_PROVIDER**.