Add SO BPMN name for NAME in tbl workflow
[so.git] / docs / installconfigure / Install_Configure_SO.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 Huawei Technologies Co., Ltd.
4
5 SO Install & Configure
6 ==========================================
7
8 Get Ubuntu
9 ----------
10 Get the Ubuntu ISO image from ubuntu.com. The recommended version is 16.04.3 LTS (Long Term Support), desktop edition.
11
12 Get VirtualBox and VirtualBox Guest Additions
13 ---------------------------------------------
14 Make sure you have the VirtualBox Guest Additions ISO for your version of VirtualBox.  I'm using VirtualBox 5.1.28.  Save the Guest Additions ISO on your host computer along with the Ubuntu ISO.  Get the Guest Additions ISO from here:
15     http://download.virtualbox.org/virtualbox
16 *NOTE*: Guest Additions versions prior to 5.1 will not work with Ubuntu 16.04.3.  If you have an earlier version of VirtualBox, you should upgrade to the latest 5.1 version.
17
18 Create a new VM in VirtualBox for Ubuntu
19 ----------------------------------------
20 Type: Linux
21
22 Version: Ubuntu (64-bit)
23
24 At least 2048 MB memory
25
26 At least 40 GB VDI
27
28 Network: Attached to: NAT
29
30 Create a port-forwarding rule for SSH
31 -------------------------------------
32 Create a port-forwarding rule so that you can use PuTTY (or other SSH client) to connect to the VM.
33
34 Go to "Network" settings in VirtualBox, add a port forwarding rule:
35
36 Name: SSH
37
38 Protocol: TCP
39
40 Host IP: 127.0.0.1
41
42 Host Port: 1022
43
44 Guest IP: <leave blank>
45
46 Guest Port: 22
47
48 .. image:: ../images/Configure_ubuntu_SO_1.png
49
50 .
51
52 .. image:: ../images/Configure_ubuntu_SO_2.png
53
54 Create Shared Folder
55 --------------------
56 This is oriented to Windows users.  If you're using a MAC or a Linux host computer, the details may be different.  You can share any folder on the host computer with the Ubuntu VM.  On Windows, a practical choice is to share the C:\Users folder, so that your Windows home directory will be accessible from the Ubuntu VM.
57
58 Go to "Shared Folders" settings in VirtualBox, add a share:
59
60 Folder Path: C:\Users
61
62 Folder Name: Users
63
64 Auto-mount: <checked>
65
66 Read-only: <unchecked>
67
68 .. image:: ../images/Configure_ubuntu_SO_3.png
69
70 .
71
72 .. image:: ../images/Configure_ubuntu_SO_4.png
73
74 Install Ubuntu in the VM
75 ------------------------
76 On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your Ubuntu ISO image.
77
78 .. image:: images/Configure_ubuntu_SO_5.png
79
80 After selecting the ISO image, start the VM.
81
82 Follow the prompts to install Ubuntu.
83
84 Proxy Configuration (optional)
85 ------------------------------
86 If you're behind a corporate firewall, configure some proxy settings.  NOTE: your proxy configuration may require username and password credentials, not shown here.
87 **Ubuntu system proxy setting:**
88
89         System Settings → Network → Network proxy
90         
91         (Replace "proxyhost" and port with your actual proxy information)
92
93 .. image:: images/Configure_ubuntu_SO_6.png
94         
95 **apt proxy setting:**
96         Edit /etc/apt/apt.conf and add one line at the top (replace "proxyhost:port" with your actual proxy information):
97         
98                 Acquire::http::Proxy "http://proxyhost:port";
99                 
100         Reboot the VM.
101         
102 Install SSH Server
103 ------------------
104
105 .. code-block:: bash
106
107     sudo apt update
108     sudo apt install openssh-server
109
110 Connect to the VM from your host computer
111 -----------------------------------------
112         The PuTTY SSH client is popular.  A connection to localhost:1022 (or whatever port you have forwarded) will go to the VM.
113
114 .. image:: ../images/Configure_ubuntu_SO_7.png
115         
116 Install VirtualBox Guest Additions
117 ----------------------------------
118 On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your VirtualBox Guest Additions ISO image.
119
120 .. image:: images/Configure_ubuntu_SO_8.png
121
122 In a VM terminal window, mount the cdrom:
123
124 .. code-block:: bash
125
126         sudo mkdir -p /media/cdrom
127         sudo mount /dev/cdrom /media/cdrom
128         
129 Install necessary dependencies:
130
131 .. code-block:: bash
132
133     sudo apt update
134     sudo apt install gcc g++ dkms
135         
136 Install the guest additions.  NOTE: look for errors in the command output!  If you see an error that says you are missing kernel headers, the most likely cause is that you are using a VirtualBox version that is too old.  The error message is misleading.
137
138 .. code-block:: bash
139
140         cd /media/cdrom
141         sudo ./VBoxLinuxAdditions.run
142
143 .. image:: ../images/Configure_ubuntu_SO_9.png  
144         
145 Add yourself to the vboxsf user group (replace "userid" with your user ID):
146         
147 .. code-block:: bash    
148         
149         sudo usermod -a -G vboxsf userid
150         
151 Reboot the VM.
152
153 In a VM terminal window, verify that you can access your home directory on the host computer, which should be mounted under here:
154         /media/sf_Users
155         
156 Further Reading
157 ----------------------------------------        
158
159 .. toctree::
160    :maxdepth: 1
161
162    Install_Docker.rst
163    Configure_git_and_gerrit.rst
164    Workspace_and_Development_Tools.rst