summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorseshukm <seshu.kumar.m@huawei.com>2019-07-24 15:36:05 +0530
committerseshukm <seshu.kumar.m@huawei.com>2019-07-24 15:36:05 +0530
commitecbc47eb9ceee96280df3647c55438a8ea45b5f8 (patch)
treebdb810162ea6d78b7c245e4f536d7767f94f46a1
parent5184b28f6ec1170ae035ddd749d8bdf5b2064904 (diff)
updated the doc as per the request
Issue-ID: SO-1230 Signed-off-by: seshukm <seshu.kumar.m@huawei.com> Change-Id: I52ec2fc97abfd71b31a59fcb0416b0472e83d39c
-rw-r--r--docs/Developer_Info.rst14
-rw-r--r--docs/developer_info/developer_information.rst9
-rw-r--r--docs/installation.rst112
3 files changed, 5 insertions, 130 deletions
diff --git a/docs/Developer_Info.rst b/docs/Developer_Info.rst
deleted file mode 100644
index 46c114f193..0000000000
--- a/docs/Developer_Info.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018 Huawei Technologies Co., Ltd.
-
-Developer Information
-======================
-
-.. toctree::
- :maxdepth: 1
-
- Install_Configure_SO.rst
- architecture.rst
-
- \ No newline at end of file
diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst
index bae1e2e348..ac1a15b8b9 100644
--- a/docs/developer_info/developer_information.rst
+++ b/docs/developer_info/developer_information.rst
@@ -13,8 +13,9 @@ SO Developer Information
Working_with_SO_Docker.rst
Camunda_Cockpit_Community_Edition.rst
Camunda_Cockpit_Enterprise_Edition.rst
+ Camunda_Modeler
+ BPMN_Project_Structure.rst
+ BPMN_Main_Process_Flows.rst
+ BPMN_Subprocess_Process_Flows.rst
+ BPMN_Project_Deployment_Strategy.rst
FAQs.rst
-.. developer_info_Project_Structure.rst
-.. developer_info_Main_Process_Flows.rst
-.. developer_info_Subprocess_Process_Flows.rst
-.. developer_info_Project_Deployment_Strategy.rst \ No newline at end of file
diff --git a/docs/installation.rst b/docs/installation.rst
deleted file mode 100644
index cde26e021a..0000000000
--- a/docs/installation.rst
+++ /dev/null
@@ -1,112 +0,0 @@
-.. _onap_so_schema_version_2_0:
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2018 Huawei Technologies Co., Ltd.
-
-Install and Configure Service Orchestrator
-==========================================
-
-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 /media/sf_Users
-
-Further Reading
-----------------------------------------
-https://wiki.onap.org/display/DW/Development+Environment