diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/SO_API_v0.1.2.pdf (renamed from docs/SO_API_v0.1.2.pdf) | bin | 355169 -> 355169 bytes | |||
| -rw-r--r-- | docs/api/SO_MultiCloud.xlsx (renamed from docs/SO_MultiCloud.xlsx) | bin | 9771 -> 9771 bytes | |||
| -rw-r--r-- | docs/api/UUI-SO_API_Specification_v0.1.docx (renamed from docs/UUI-SO_API_Specification_v0.1.docx) | bin | 61243 -> 61243 bytes | |||
| -rw-r--r-- | docs/api/offered_consumed_apis.rst (renamed from docs/offered_consumed_apis.rst) | 30 | ||||
| -rw-r--r-- | docs/architecture/architecture.rst | 3 | ||||
| -rw-r--r-- | docs/developer_info/BPMN_Main_Process_Flows.rst (renamed from docs/bpmn/BPMN_Main_Process_Flows.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/BPMN_Project_Deployment_Strategy.rst (renamed from docs/bpmn/BPMN_Project_Deployment_Strategy.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/BPMN_Project_Structure.rst (renamed from docs/bpmn/BPMN_Project_Structure.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/BPMN_Subprocess_Process_Flows.rst (renamed from docs/bpmn/BPMN_Subprocess_Process_Flows.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/Building_SO.rst (renamed from docs/Building_SO.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/Camunda_Cockpit_Community_Edition.rst (renamed from docs/bpmn/Camunda_Cockpit_Community_Edition.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/Camunda_Cockpit_Enterprise_Edition.rst (renamed from docs/bpmn/Camunda_Cockpit_Enterprise_Edition.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/Camunda_Modeler.rst (renamed from docs/bpmn/Camunda_Modeler.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/ONAP_SO_Env_Setup_Guide.pdf (renamed from docs/ONAP_SO_Env_Setup_Guide.pdf) | bin | 777004 -> 777004 bytes | |||
| -rw-r--r-- | docs/developer_info/Working_with_SO_Docker.rst (renamed from docs/Working_with_SO_Docker.rst) | 0 | ||||
| -rw-r--r-- | docs/developer_info/developer_information.rst | 20 | ||||
| -rw-r--r-- | docs/developer_information.rst | 20 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/installconfigure/Install_Configure_SO.rst (renamed from docs/Install_Configure_SO.rst) | 328 | ||||
| -rw-r--r-- | docs/release_notes/release-notes.rst (renamed from docs/release-notes.rst) | 0 |
20 files changed, 204 insertions, 203 deletions
diff --git a/docs/SO_API_v0.1.2.pdf b/docs/api/SO_API_v0.1.2.pdf Binary files differindex cac440da5c..cac440da5c 100644 --- a/docs/SO_API_v0.1.2.pdf +++ b/docs/api/SO_API_v0.1.2.pdf diff --git a/docs/SO_MultiCloud.xlsx b/docs/api/SO_MultiCloud.xlsx Binary files differindex 9dcabd6eb8..9dcabd6eb8 100644 --- a/docs/SO_MultiCloud.xlsx +++ b/docs/api/SO_MultiCloud.xlsx diff --git a/docs/UUI-SO_API_Specification_v0.1.docx b/docs/api/UUI-SO_API_Specification_v0.1.docx Binary files differindex d68cccf4d3..d68cccf4d3 100644 --- a/docs/UUI-SO_API_Specification_v0.1.docx +++ b/docs/api/UUI-SO_API_Specification_v0.1.docx diff --git a/docs/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst index 78f531db61..6f8b7fcb89 100644 --- a/docs/offered_consumed_apis.rst +++ b/docs/api/offered_consumed_apis.rst @@ -1,15 +1,15 @@ -.. 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.
-
-SO Offered and Consumed APIs
-=====================================
-
-SO APIs
---------
-All the Service Orchestrator APIs, both inward and outward are documented in the below link of onap wiki.
-
-.. toctree::
- :maxdepth: 1
-
- api/SO_Interface.rst
+.. 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. + +SO Offered and Consumed APIs +===================================== + +SO APIs +-------- +All the Service Orchestrator APIs, both inward and outward are documented in the below link of onap wiki. + +.. toctree:: + :maxdepth: 1 + + SO_Interface.rst diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index 754c6f888e..7965e1d50f 100644 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -86,7 +86,8 @@ SO Sub-Components Support self-service updates to models and artifacts -** SO Monitoring** +**SO Monitoring** + Monitor BPMN Workflow execution by providing * Service list search based on search criteria * Service statistic diff --git a/docs/bpmn/BPMN_Main_Process_Flows.rst b/docs/developer_info/BPMN_Main_Process_Flows.rst index 43e08ffd9c..43e08ffd9c 100644 --- a/docs/bpmn/BPMN_Main_Process_Flows.rst +++ b/docs/developer_info/BPMN_Main_Process_Flows.rst diff --git a/docs/bpmn/BPMN_Project_Deployment_Strategy.rst b/docs/developer_info/BPMN_Project_Deployment_Strategy.rst index 50f48363ed..50f48363ed 100644 --- a/docs/bpmn/BPMN_Project_Deployment_Strategy.rst +++ b/docs/developer_info/BPMN_Project_Deployment_Strategy.rst diff --git a/docs/bpmn/BPMN_Project_Structure.rst b/docs/developer_info/BPMN_Project_Structure.rst index 209ec727c3..209ec727c3 100644 --- a/docs/bpmn/BPMN_Project_Structure.rst +++ b/docs/developer_info/BPMN_Project_Structure.rst diff --git a/docs/bpmn/BPMN_Subprocess_Process_Flows.rst b/docs/developer_info/BPMN_Subprocess_Process_Flows.rst index 098f38ff02..098f38ff02 100644 --- a/docs/bpmn/BPMN_Subprocess_Process_Flows.rst +++ b/docs/developer_info/BPMN_Subprocess_Process_Flows.rst diff --git a/docs/Building_SO.rst b/docs/developer_info/Building_SO.rst index 7d68e433cc..7d68e433cc 100644 --- a/docs/Building_SO.rst +++ b/docs/developer_info/Building_SO.rst diff --git a/docs/bpmn/Camunda_Cockpit_Community_Edition.rst b/docs/developer_info/Camunda_Cockpit_Community_Edition.rst index a9379decc9..a9379decc9 100644 --- a/docs/bpmn/Camunda_Cockpit_Community_Edition.rst +++ b/docs/developer_info/Camunda_Cockpit_Community_Edition.rst diff --git a/docs/bpmn/Camunda_Cockpit_Enterprise_Edition.rst b/docs/developer_info/Camunda_Cockpit_Enterprise_Edition.rst index 3e2d15bf15..3e2d15bf15 100644 --- a/docs/bpmn/Camunda_Cockpit_Enterprise_Edition.rst +++ b/docs/developer_info/Camunda_Cockpit_Enterprise_Edition.rst diff --git a/docs/bpmn/Camunda_Modeler.rst b/docs/developer_info/Camunda_Modeler.rst index 54f3534210..54f3534210 100644 --- a/docs/bpmn/Camunda_Modeler.rst +++ b/docs/developer_info/Camunda_Modeler.rst diff --git a/docs/ONAP_SO_Env_Setup_Guide.pdf b/docs/developer_info/ONAP_SO_Env_Setup_Guide.pdf Binary files differindex 44b8d9cad6..44b8d9cad6 100644 --- a/docs/ONAP_SO_Env_Setup_Guide.pdf +++ b/docs/developer_info/ONAP_SO_Env_Setup_Guide.pdf diff --git a/docs/Working_with_SO_Docker.rst b/docs/developer_info/Working_with_SO_Docker.rst index ee958efa41..ee958efa41 100644 --- a/docs/Working_with_SO_Docker.rst +++ b/docs/developer_info/Working_with_SO_Docker.rst diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst new file mode 100644 index 0000000000..8613f2605c --- /dev/null +++ b/docs/developer_info/developer_information.rst @@ -0,0 +1,20 @@ +.. 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. + +SO Developer Information +======================== + +.. toctree:: + :maxdepth: 1 + +.. developer_info/developer_info_Project_Structure.rst + developer_info/Camunda_Modeler.rst +.. developer_info/developer_info_Main_Process_Flows.rst +.. developer_info/developer_info_Subprocess_Process_Flows.rst +.. developer_info/developer_info_Project_Deployment_Strategy.rst + developer_info/Building_SO.rst + developer_info/Working_with_SO_Docker.rst + developer_info/Camunda_Cockpit_Community_Edition.rst + developer_info/Camunda_Cockpit_Enterprise_Edition.rst +
\ No newline at end of file diff --git a/docs/developer_information.rst b/docs/developer_information.rst deleted file mode 100644 index 739a1f2050..0000000000 --- a/docs/developer_information.rst +++ /dev/null @@ -1,20 +0,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.
-
-SO Developer Information
-========================
-
-.. toctree::
- :maxdepth: 1
-
- BPMN_Project_Structure.rst
- Camunda_Modeler.rst
- BPMN_Main_Process_Flows.rst
- BPMN_Subprocess_Process_Flows.rst
- BPMN_Project_Deployment_Strategy.rst
- Building_SO.rst
- Working_with_SO_Docker.rst
- Camunda_Cockpit_Community_Edition.rst
- Camunda_Cockpit_Enterprise_Edition.rst
-
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 553b7f4cbc..ebb8b0b552 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,6 @@ ONAP SO installconfigure/Install_Configure_SO.rst
architecture/architecture.rst
- offered_consumed_apis.rst
- developer_information.rst
- release-notes.rst
\ No newline at end of file + api/offered_consumed_apis.rst
+ developer_info/developer_information.rst
+ release_notes/release-notes.rst
\ No newline at end of file diff --git a/docs/Install_Configure_SO.rst b/docs/installconfigure/Install_Configure_SO.rst index e06385e39b..bdfd328fc5 100644 --- a/docs/Install_Configure_SO.rst +++ b/docs/installconfigure/Install_Configure_SO.rst @@ -1,164 +1,164 @@ -.. 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.
-
-SO Install & Configure
-==========================================
-
-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
-
-.. image:: ../images/Configure_ubuntu_SO_1.png
-
-.
-
-.. image:: ../images/Configure_ubuntu_SO_2.png
-
-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>
-
-.. image:: ../images/Configure_ubuntu_SO_3.png
-
-.
-
-.. image:: ../images/Configure_ubuntu_SO_4.png
-
-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.
-
-.. image:: images/Configure_ubuntu_SO_5.png
-
-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)
-
-.. image:: images/Configure_ubuntu_SO_6.png
-
-**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
-------------------
-
-.. code-block:: bash
-
- 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.
-
-.. image:: ../images/Configure_ubuntu_SO_7.png
-
-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.
-
-.. image:: images/Configure_ubuntu_SO_8.png
-
-In a VM terminal window, mount the cdrom:
-
-.. code-block:: bash
-
- sudo mkdir -p /media/cdrom
- sudo mount /dev/cdrom /media/cdrom
-
-Install necessary dependencies:
-
-.. code-block:: bash
-
- 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.
-
-.. code-block:: bash
-
- cd /media/cdrom
- sudo ./VBoxLinuxAdditions.run
-
-.. image:: ../images/Configure_ubuntu_SO_9.png
-
-Add yourself to the vboxsf user group (replace "userid" with your user ID):
-
-.. code-block:: bash
-
- 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
-----------------------------------------
-
-.. toctree::
- :maxdepth: 1
-
- installconfigure/Install_Docker.rst
- installconfigure/Configure_git_and_gerrit.rst
- installconfigure/Workspace_and_Development_Tools.rst
\ No newline at end of file +.. 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. + +SO Install & Configure +========================================== + +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 + +.. image:: ../images/Configure_ubuntu_SO_1.png + +. + +.. image:: ../images/Configure_ubuntu_SO_2.png + +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> + +.. image:: ../images/Configure_ubuntu_SO_3.png + +. + +.. image:: ../images/Configure_ubuntu_SO_4.png + +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. + +.. image:: images/Configure_ubuntu_SO_5.png + +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) + +.. image:: images/Configure_ubuntu_SO_6.png + +**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 +------------------ + +.. code-block:: bash + + 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. + +.. image:: ../images/Configure_ubuntu_SO_7.png + +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. + +.. image:: images/Configure_ubuntu_SO_8.png + +In a VM terminal window, mount the cdrom: + +.. code-block:: bash + + sudo mkdir -p /media/cdrom + sudo mount /dev/cdrom /media/cdrom + +Install necessary dependencies: + +.. code-block:: bash + + 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. + +.. code-block:: bash + + cd /media/cdrom + sudo ./VBoxLinuxAdditions.run + +.. image:: ../images/Configure_ubuntu_SO_9.png + +Add yourself to the vboxsf user group (replace "userid" with your user ID): + +.. code-block:: bash + + 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 +---------------------------------------- + +.. toctree:: + :maxdepth: 1 + + Install_Docker.rst + Configure_git_and_gerrit.rst + Workspace_and_Development_Tools.rst
\ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release_notes/release-notes.rst index b27b2a3eca..b27b2a3eca 100644 --- a/docs/release-notes.rst +++ b/docs/release_notes/release-notes.rst |