From f5e2b0be16a20a7b6cf6b41956107a93593f4f22 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 30 Aug 2018 18:48:23 +0800 Subject: Fix the readthedocs Fix to Increase the modularity of the misc in readthedocs Issue-ID: SO-675 Change-Id: If7fbaed0a88fa652110b224a7f7e31169b3c0298 Signed-off-by: seshukm --- docs/Install_Configure_SO.rst | 164 ------------------------- docs/installconfigure/Install_Configure_SO.rst | 164 +++++++++++++++++++++++++ docs/release-notes.rst | 111 ----------------- docs/release_notes/release-notes.rst | 111 +++++++++++++++++ 4 files changed, 275 insertions(+), 275 deletions(-) delete mode 100644 docs/Install_Configure_SO.rst create mode 100644 docs/installconfigure/Install_Configure_SO.rst delete mode 100644 docs/release-notes.rst create mode 100644 docs/release_notes/release-notes.rst (limited to 'docs') diff --git a/docs/Install_Configure_SO.rst b/docs/Install_Configure_SO.rst deleted file mode 100644 index e06385e39b..0000000000 --- a/docs/Install_Configure_SO.rst +++ /dev/null @@ -1,164 +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 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: - -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: - -Read-only: - -.. 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 diff --git a/docs/installconfigure/Install_Configure_SO.rst b/docs/installconfigure/Install_Configure_SO.rst new file mode 100644 index 0000000000..bdfd328fc5 --- /dev/null +++ b/docs/installconfigure/Install_Configure_SO.rst @@ -0,0 +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: + +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: + +Read-only: + +.. 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.rst deleted file mode 100644 index b27b2a3eca..0000000000 --- a/docs/release-notes.rst +++ /dev/null @@ -1,111 +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 Intellectual Property. All rights reserved. - - -Service Orchestrator Release Notes -================================== - -The SO provides the highest level of service orchestration in the ONAP architecture. - -Version: 1.2.2 --------------- - -:Release Date: 2018-06-07 - -The Beijing release is the second release of the Service Orchestrator (SO) project. - -**New Features** - -* Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki `_. -* Manual scaling of network services and VNFs. -* Homing and placement capabiliities through OOF interaction. -* Ability to perform change management. -* Integrated to APPC -* Integrated to OOF -* Integrated to OOM - -**Bug Fixes** - - The defects fixed in this release could be found `here `_. - -**Known Issues** - - SO docker image is still on ecmop and not onap in the repository. - This will be addressed in the next release. - -**Security Notes** - - SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. - -Quick Links: - -- `SO project page `_ -- `Passing Badge information for SO `_ -- `Project Vulnerability Review Table for SO `_ - -**Upgrade Notes** - NA - -**Deprecation Notes** - NA - -Version: 1.1.2 --------------- - -:Release Date: 2018-01-18 - -Bug Fixes ---------- -The key defects fixed in this release : - -- `SO-344 `_ - Only pass one VNF to DoCreateVnfAndModules. - -- `SO-348 `_ - Json Analyze Exception in PreProcessRequest. - -- `SO-352 `_ - SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process. - -- `SO-354 `_ - Change the Service Type And Service Role - - -Version: 1.1.1 --------------- - -:Release Date: 2017-11-16 - - -**New Features** - -The SO provides the highest level of service orchestration in the ONAP architecture. -It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. - -The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. - -* Orchestration services will process workflows based on defined models and recipe. -* The service model maintains consistency and reusability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment. -* Orchestration processes interact with other platform components or external systems via standard and well-defined APIs. - - -**Deprecation Notes** - -There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system. -The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release. -The Gerrit repos of mso/* are voided and already locked as read-only. -Following are the deprecated SO projects in gerrit repo: - -- mso -- mso/chef-repo -- mso/docker-config -- mso/libs -- mso/mso-config - -**Other** - NA - -=========== - -End of Release Notes diff --git a/docs/release_notes/release-notes.rst b/docs/release_notes/release-notes.rst new file mode 100644 index 0000000000..b27b2a3eca --- /dev/null +++ b/docs/release_notes/release-notes.rst @@ -0,0 +1,111 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Huawei Intellectual Property. All rights reserved. + + +Service Orchestrator Release Notes +================================== + +The SO provides the highest level of service orchestration in the ONAP architecture. + +Version: 1.2.2 +-------------- + +:Release Date: 2018-06-07 + +The Beijing release is the second release of the Service Orchestrator (SO) project. + +**New Features** + +* Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki `_. +* Manual scaling of network services and VNFs. +* Homing and placement capabiliities through OOF interaction. +* Ability to perform change management. +* Integrated to APPC +* Integrated to OOF +* Integrated to OOM + +**Bug Fixes** + + The defects fixed in this release could be found `here `_. + +**Known Issues** + + SO docker image is still on ecmop and not onap in the repository. + This will be addressed in the next release. + +**Security Notes** + + SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. + +Quick Links: + +- `SO project page `_ +- `Passing Badge information for SO `_ +- `Project Vulnerability Review Table for SO `_ + +**Upgrade Notes** + NA + +**Deprecation Notes** + NA + +Version: 1.1.2 +-------------- + +:Release Date: 2018-01-18 + +Bug Fixes +--------- +The key defects fixed in this release : + +- `SO-344 `_ + Only pass one VNF to DoCreateVnfAndModules. + +- `SO-348 `_ + Json Analyze Exception in PreProcessRequest. + +- `SO-352 `_ + SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process. + +- `SO-354 `_ + Change the Service Type And Service Role + + +Version: 1.1.1 +-------------- + +:Release Date: 2017-11-16 + + +**New Features** + +The SO provides the highest level of service orchestration in the ONAP architecture. +It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. + +The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. + +* Orchestration services will process workflows based on defined models and recipe. +* The service model maintains consistency and reusability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment. +* Orchestration processes interact with other platform components or external systems via standard and well-defined APIs. + + +**Deprecation Notes** + +There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system. +The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release. +The Gerrit repos of mso/* are voided and already locked as read-only. +Following are the deprecated SO projects in gerrit repo: + +- mso +- mso/chef-repo +- mso/docker-config +- mso/libs +- mso/mso-config + +**Other** + NA + +=========== + +End of Release Notes -- cgit 1.2.3-korg