Browse Source

Added a requirement for Internet access

Added a requirement for the Internet access on the OS
in the README.md
Also added header describes the scripts.

Change-Id: Ib4b59ecca9b49163d64e8c6b1595ab44519be762
Partial-bug: #1551443
Maksim Malchuk 3 years ago
parent
commit
f1ce1d7be5
1 changed files with 24 additions and 8 deletions
  1. 24
    8
      README.md

+ 24
- 8
README.md View File

@@ -1,5 +1,14 @@
1
-VirtualBox enviropment kit
2
-==========================
1
+Mirantis VirtualBox scripts
2
+===========================
3
+
4
+Mirantis VirtualBox scripts are used to automate the installation of Fuel and
5
+Mirantis OpenStack. When you install Mirantis OpenStack using the Mirantis
6
+VirtualBox scripts, you do not need to configure the virtual machine network
7
+and hardware settings. The script automatically provisions the virtual machines
8
+with all required settings. However, you must place the latest Mirantis
9
+OpenStack ISO image in the iso directory. You may also modify the number of
10
+Fuel Slave nodes using the config.sh script.
11
+
3 12
 
4 13
 Requirements
5 14
 ------------
@@ -11,25 +20,31 @@ Requirements
11 20
 - xxd
12 21
 - Cygwin for Windows host PC
13 22
 - Enable VT-x/AMD-V acceleration option on your hardware for 64-bits guests
23
+- Enable Internet access
24
+
14 25
 
15 26
 Run
16 27
 ---
17 28
 
18 29
 In order to successfully run Mirantis OpenStack under VirtualBox, you need to:
19 30
 - download the official release (.iso) and place it under 'iso/' directory
20
-- run "./launch.sh" (or "./launch\_8GB.sh" or "./launch\_16GB.sh" according to your system resources). It will automatically pick up the iso and spin up master node and slave nodes
31
+- run "./launch.sh" (or "./launch\_8GB.sh" or "./launch\_16GB.sh" according
32
+to your system resources). It will automatically pick up the iso and spin up
33
+master node and slave nodes
21 34
 
22
-If you run this script under Cygwin, you may have to add path to VirtualBox directory to your PATH.
23
-Usually it is enough to run: export PATH=$PATH:/cygdrive/c/Program Files/Oracle/VirtualBox
35
+If you run this script under Cygwin, it will automatically add the path to the
36
+VirtualBox directory to your PATH.
24 37
 
25 38
 If there are any errors, the script will report them and abort.
26 39
 
27
-If you want to change settings (number of OpenStack nodes, CPU, RAM, HDD), please refer to "config.sh".
40
+If you want to change settings (number of OpenStack nodes, CPU, RAM, HDD),
41
+please refer to "config.sh".
28 42
 
29 43
 To shutdown VMs and clean environment just run "./clean.sh"
30 44
 
31
-To deploy on a remote machine just set environment variable REMOTE_HOST with ssh connection string.
32
-The variable REMOTE_PORT allows to specify custom port for ssh.
45
+To deploy on a remote machine just set environment variable REMOTE_HOST with
46
+ssh connection string. The variable REMOTE_PORT allows to specify custom port
47
+for ssh.
33 48
 
34 49
 ```bash
35 50
  REMOTE_HOST=user@user.mos.mirantis.net ./launch_8GB.sh
@@ -37,6 +52,7 @@ The variable REMOTE_PORT allows to specify custom port for ssh.
37 52
  REMOTE_HOST=user@user.mos.mirantis.net REMOTE_PORT=23 ./launch_8GB.sh
38 53
 ```
39 54
 
55
+
40 56
 TODO
41 57
 ----
42 58
 

Loading…
Cancel
Save