SO readthedocs in platform perspective

IssueId:SO-201

Change-Id: Ib440d2a93e8700c47d56b2e85c8e50d460362e50
Signed-off-by: seshukm <seshu.kumar.m@huawei.com>

5 files changed, 214 insertions, 6 deletions

diff --git a/docs/Install_Configure_SO.rst b/docs/Install_Configure_SO.rst
new file mode 100644
index 0000000000..026a287989
--- /dev/null
+++ b/docs/Install_Configure_SO.rst
@@ -0,0 +1,96 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.

+.. http://creativecommons.org/licenses/by/4.0

+.. Copyright 2017 Huawei Technologies Co., Ltd.

+

+Install and Configure an Ubuntu VM

+==================================

+

+Get Ubuntu

+----------

+Get the Ubuntu ISO image from ubuntu.com. The recommended version is 16.04.3 LTS (Long Term Support), desktop edition.

+

+Get VirtualBox and VirtualBox Guest Additions

+---------------------------------------------

+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:

+	http://download.virtualbox.org/virtualbox

+*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.

+

+Create a new VM in VirtualBox for Ubuntu

+----------------------------------------

+Type: Linux

+Version: Ubuntu (64-bit)

+At least 2048 MB memory

+At least 40 GB VDI

+Network: Attached to: NAT

+

+Create a port-forwarding rule for SSH

+-------------------------------------

+Create a port-forwarding rule so that you can use PuTTY (or other SSH client) to connect to the VM.

+Go to "Network" settings in VirtualBox, add a port forwarding rule:

+Name: SSH

+Protocol: TCP

+Host IP: 127.0.0.1

+Host Port: 1022

+Guest IP: <leave blank>

+Guest Port: 22

+

+Create Shared Folder

+--------------------

+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.

+Go to "Shared Folders" settings in VirtualBox, add a share:

+Folder Path: C:\Users

+Folder Name: Users

+Auto-mount: <checked>

+Read-only: <unchecked>

+

+Install Ubuntu in the VM

+------------------------

+On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your Ubuntu ISO image.

+

+After selecting the ISO image, start the VM.

+Follow the prompts to install Ubuntu.

+

+Proxy Configuration (optional)

+------------------------------

+If you're behind a corporate firewall, configure some proxy settings.  NOTE: your proxy configuration may require username and password credentials, not shown here.

+**Ubuntu system proxy setting:**

+	System Settings → Network → Network proxy

+	(Replace "proxyhost" and port with your actual proxy information)

+

+**apt proxy setting:**

+	Edit /etc/apt/apt.conf and add one line at the top (replace "proxyhost:port" with your actual proxy information):

+		Acquire::http::Proxy "http://proxyhost:port";

+	Reboot the VM.

+	

+Install SSH Server

+------------------

+sudo apt update

+sudo apt install openssh-server

+

+Connect to the VM from your host computer

+-----------------------------------------

+	The PuTTY SSH client is popular.  A connection to localhost:1022 (or whatever port you have forwarded) will go to the VM.

+

+Install VirtualBox Guest Additions

+----------------------------------

+On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your VirtualBox Guest Additions ISO image.

+

+In a VM terminal window, mount the cdrom:

+	sudo mkdir -p /media/cdrom

+	sudo mount /dev/cdrom /media/cdrom

+Install necessary dependencies:

+	sudo apt update

+	sudo apt install gcc g++ dkms

+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.

+	cd /media/cdrom

+	sudo ./VBoxLinuxAdditions.run

+

+Add yourself to the vboxsf user group (replace "userid" with your user ID):

+	sudo usermod -a -G vboxsf userid

+Reboot the VM.

+In a VM terminal window, verify that you can access your home directory on the host computer, which should be mounted under here:

+	/media/sf_Users

+	

+Further Reading

+----------------------------------------	

+https://wiki.onap.org/display/DW/Development+Environment
\ No newline at end of file
diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644
index 0000000000..58aaabbc90
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.

+.. http://creativecommons.org/licenses/by/4.0

+.. Copyright 2017 Huawei Technologies Co., Ltd.

+

+ONAP Service Orchestration Documentation - Architecture

+========================================================

+

+.. toctree::

+   :maxdepth: 1

+   https://wiki.onap.org/pages/viewpage.action?pageId=9830754
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 094de08c57..7a1a2b2b6d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,9 +10,4 @@ ONAP Service Orchestration Documentation
 

    architecture.rst

    offered_consumed_apis.rst

-   delivery.rst

-   logging.rst

-   installation.rst

-   configuration.rst

-   administration.rst

-   humaninterfaces.rst

+   Install_Configure_SO.rst
\ No newline at end of file
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 0000000000..6e4570944e
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,97 @@
+.. _open_cli_schema_version_1_0:

+.. This work is licensed under a Creative Commons Attribution 4.0 International License.

+.. http://creativecommons.org/licenses/by/4.0

+.. Copyright 2017 Huawei Technologies Co., Ltd.

+

+Install and Configure an Ubuntu VM

+==================================

+

+Get Ubuntu

+----------

+Get the Ubuntu ISO image from ubuntu.com. The recommended version is 16.04.3 LTS (Long Term Support), desktop edition.

+

+Get VirtualBox and VirtualBox Guest Additions

+---------------------------------------------

+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:

+	http://download.virtualbox.org/virtualbox

+*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.

+

+Create a new VM in VirtualBox for Ubuntu

+----------------------------------------

+Type: Linux

+Version: Ubuntu (64-bit)

+At least 2048 MB memory

+At least 40 GB VDI

+Network: Attached to: NAT

+

+Create a port-forwarding rule for SSH

+-------------------------------------

+Create a port-forwarding rule so that you can use PuTTY (or other SSH client) to connect to the VM.

+Go to "Network" settings in VirtualBox, add a port forwarding rule:

+Name: SSH

+Protocol: TCP

+Host IP: 127.0.0.1

+Host Port: 1022

+Guest IP: <leave blank>

+Guest Port: 22

+

+Create Shared Folder

+--------------------

+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.

+Go to "Shared Folders" settings in VirtualBox, add a share:

+Folder Path: C:\Users

+Folder Name: Users

+Auto-mount: <checked>

+Read-only: <unchecked>

+

+Install Ubuntu in the VM

+------------------------

+On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your Ubuntu ISO image.

+

+After selecting the ISO image, start the VM.

+Follow the prompts to install Ubuntu.

+

+Proxy Configuration (optional)

+------------------------------

+If you're behind a corporate firewall, configure some proxy settings.  NOTE: your proxy configuration may require username and password credentials, not shown here.

+**Ubuntu system proxy setting:**

+	System Settings → Network → Network proxy

+	(Replace "proxyhost" and port with your actual proxy information)

+

+**apt proxy setting:**

+	Edit /etc/apt/apt.conf and add one line at the top (replace "proxyhost:port" with your actual proxy information):

+		Acquire::http::Proxy "http://proxyhost:port";

+	Reboot the VM.

+	

+Install SSH Server

+------------------

+sudo apt update

+sudo apt install openssh-server

+

+Connect to the VM from your host computer

+-----------------------------------------

+	The PuTTY SSH client is popular.  A connection to localhost:1022 (or whatever port you have forwarded) will go to the VM.

+

+Install VirtualBox Guest Additions

+----------------------------------

+On the "Storage" panel in VirtualBox, click on "[ optical drive ]" and then "Choose Disk Image".  Select your VirtualBox Guest Additions ISO image.

+

+In a VM terminal window, mount the cdrom:

+	sudo mkdir -p /media/cdrom

+	sudo mount /dev/cdrom /media/cdrom

+Install necessary dependencies:

+	sudo apt update

+	sudo apt install gcc g++ dkms

+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.

+	cd /media/cdrom

+	sudo ./VBoxLinuxAdditions.run

+

+Add yourself to the vboxsf user group (replace "userid" with your user ID):

+	sudo usermod -a -G vboxsf userid

+Reboot the VM.

+In a VM terminal window, verify that you can access your home directory on the host computer, which should be mounted under here:

+	/media/sf_Users

+	

+Further Reading

+----------------------------------------	

+https://wiki.onap.org/display/DW/Development+Environment
\ No newline at end of file
diff --git a/docs/offered_consumed_apis.rst b/docs/offered_consumed_apis.rst
new file mode 100644
index 0000000000..623e7da1e3
--- /dev/null
+++ b/docs/offered_consumed_apis.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.

+.. http://creativecommons.org/licenses/by/4.0

+.. Copyright 2017 Huawei Technologies Co., Ltd.

+

+ONAP Service Orchestration Documentation - Architecture

+========================================================

+

+.. toctree::

+   :maxdepth: 1

+   https://wiki.onap.org/display/DW/SO+R1+Interfaces
\ No newline at end of file