diff options
Diffstat (limited to 'docs')
55 files changed, 1306 insertions, 137 deletions
diff --git a/docs/BPMN_Main_Process_Flows.rst b/docs/BPMN_Main_Process_Flows.rst new file mode 100644 index 0000000000..abc006e813 --- /dev/null +++ b/docs/BPMN_Main_Process_Flows.rst @@ -0,0 +1,40 @@ +.. 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.
+
+BPMN Main Process Flows
+========================
+
+Characteristics
+----------------
+
+**Invoked by an API Handler**
+
+ The BPMN application (war) exposes a REST endpoint to which the API Handler(s) send requests for flow execution. The message sent by the API Handler to this endpoint is a JSON wrapper containing:
+
+ * The original request received by the API handler from the portal or other client.
+ * Metadata such as the request-id generated by the API Handler for the request.
+ * The name of the BPMN process to execute (obtained by the API Handler from the mso_catalog.service_recipe table.
+
+**Asynchronous Service Model**
+
+ All main process flows implement an asynchronous service model. The connection to the API Handler is kept open until the main process flow sends back a response. In the flow shown below, this is done by the "Send Sync Ack Response" script task. A flow is expected to send a response after validating the request, but before performing any long running tasks or tasks that could cause the process to be suspended.
+
+ After the synchronous response is sent, the flow continues to execute. When the flow ends, it may optionally send an asynchronous notification to a callback URL provided in the original request (behavior depends on the API agreement)
+
+**Typically calls one or more subprocess flows**
+
+ Main process flows usually implement the high-level service logic, delegating the "real" work to reusable subflows (Building Blocks) or custom subflows
+
+**Handles "Completion" and "Fallout" tasks**
+
+ "Completion" tasks are those that occur when the process ends successfully, and "Fallout" tasks are those that occur when the process fails. Activities include:
+
+ * Updating the mso_requests database.
+ * Rolling back uncompleted work.
+ * Sending an asynchronous callback notification.
+
+Example: CreateVfModuleVolumeInfraV1.bpmn
+------------------------------------------
+
+.. image:: images/BPMN_Main_Process_Flows_1.png
\ No newline at end of file diff --git a/docs/BPMN_Project_Deployment_Strategy.rst b/docs/BPMN_Project_Deployment_Strategy.rst new file mode 100644 index 0000000000..50f48363ed --- /dev/null +++ b/docs/BPMN_Project_Deployment_Strategy.rst @@ -0,0 +1,35 @@ +.. 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. + +BPMN Project Deployment Strategy +================================== + +Single Application with Embedded Process Engine +------------------------------------------------ + +Deployment in SO is currently limited to a single process application: MSOInfrastructureBPMN. The WAR file for this application contains everything needed to execute the infrastructure process flows, including: + + * BPMN process flows, java classes, groovy scripts, and resource files from MSOInfrastructureBPMN itself. + + * BPMN process flows, java classes, groovy scripts, and resource files from other SO projects, like MSOCommonBPMN and MSOCoreBPMN. + + * An embedded Camunda Process Engine to execute the flows. + +The process application exposes a REST endpoint to the API Handler(s) for receiving flow execution requests. + +Development is required in SO to be able to support one a more versatile deployment strategy, probably one of the following: + +Shared Process Engine +---------------------- + +The Camunda Process Engine is created and manged as a Wildfly module. This single engine is shared by all process applications. + +Multiple Applications, each with an Embedded Process Engine +------------------------------------------------------------- + +More than one application could be deployed, each having its own embedded process engine. + + + + diff --git a/docs/BPMN_Project_Structure.rst b/docs/BPMN_Project_Structure.rst new file mode 100644 index 0000000000..3c5ccc3e7d --- /dev/null +++ b/docs/BPMN_Project_Structure.rst @@ -0,0 +1,47 @@ +.. 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.
+
+BPMN Project Structure
+=======================
+
+BPMN main process flow
+----------------------
+
+A BPMN main process flow is a top-level flow. All main process flows are under the src/main/resources/process folder.
+
+CreateVfModuleVolumeInfraV1 is a main process flow.
+
+.. image:: images/bpmn_project_structure_1.png
+
+Open BPMN files with the camunda modeler (standalone application). To launch the modeler from eclipse, right-click→open-with→Other→Browse. Select Check the boxes on the dialog so that eclipse will open all .bpmn files with the camunda-modeler executable.
+
+BPMN subprocess flow
+---------------------
+
+A BPMN subprocess flow is meant to be invoked by other flows (either main process flows or other subprocess flows). All subprocess flows are under the src/main/resources/subprocess folder.
+
+The CreateVfModuleVolumeInfraV1 process flow is delivered with two custom subflows: DoCreateVfModuleVolumeV2 and DoCreateVfModuleVolumeRollback.
+
+.. image:: images/bpmn_project_structure_2.png
+
+Groovy scripts
+---------------
+
+There is one groovy script for each BPMN file. Groovy scripts are invoked by script tasks within the BPMN flows.
+
+.. image:: images/bpmn_project_structure_3.png
+
+Unit Tests
+-----------
+
+Normally, we create a unit test class for every flow. This one is missing a unit test for its rollback flow.
+
+.. image:: images/bpmn_project_structure_4.png
+
+Unit Test Resource Files
+------------------------
+
+Any files needed by the unit tests are kept under the src/test/resources/__files folder.
+
+.. image:: images/bpmn_project_structure_5.png
\ No newline at end of file diff --git a/docs/BPMN_Subprocess_Process_Flows.rst b/docs/BPMN_Subprocess_Process_Flows.rst new file mode 100644 index 0000000000..cf2da40e87 --- /dev/null +++ b/docs/BPMN_Subprocess_Process_Flows.rst @@ -0,0 +1,32 @@ +.. 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.
+
+BPMN Subprocess Process Flows
+==============================
+
+Characteristics
+----------------
+
+**Invoked by other flows**
+
+ A BPMN Call_Activity_ provides the mechanism to invoke subprocess flows. The Called Element attribute of the Call Activity specifies the name of the subprocess to execute.
+
+.. _Call_Activity: https://docs.camunda.org/manual/7.7/reference/bpmn20/subprocesses/call-activity/
+
+**Input and Output variable mapping**
+
+ In the modeler, you can specify a list of "In Mappings". With this, you can map execution variables from the calling flow to the subprocess. The subprocess always has its own copy of each variable. To transfer values back to the calling flow, you specify "Out Mappings".
+
+**May throw MSOWorkflowException**
+
+ The current best practice for reporting errors from subprocess is described here:
+
+ * The subprocess should create a WorkflowException object and store it in an execution called WorkflowException.
+ * The WorkflowException object contains an error code and an error message.
+ * The subprocess should then throw an MSOWorkflowException BPMN event which may be handled by the calling flow.
+
+Example: VnfAdapterRestV1.bpmn
+-------------------------------
+
+.. image:: images/BPMN_Subprocess_process_flows_1.png
diff --git a/docs/Building_SO.rst b/docs/Building_SO.rst new file mode 100644 index 0000000000..29ff6bd0e8 --- /dev/null +++ b/docs/Building_SO.rst @@ -0,0 +1,79 @@ +.. 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. + +Building SO +============ + +Build software with unit tests +------------------------------ + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/libs + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install + + cd $HOME/onap/workspace/SO/so + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install + +Build software without unit tests +---------------------------------- + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/libs + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml -DskipTests -Dmaven.test.skip=true clean install + + cd $HOME/onap/workspace/SO/so + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml -DskipTests -Dmaven.test.skip=true clean install + +Build docker images +-------------------- + +SO docker images are built using the "docker" maven profile. During the build, the chef-repo and so-docker repositories are cloned from gerrit into the "so" directory structure. Extra definitions are required in the build environment to make this happen. You may need to adjust the definition of mso.chef.git.url.prefix to match the way you authenticate yourself when performing git clone. + +If you are behind a corporate firewall, you can specify proxy definitions for the constructed docker images. + +**Remove existing docker containers and images** + +.. code-block:: bash + + docker stop $(docker ps -qa) + + docker rm $(docker ps -aq) + + docker rmi -f $(docker images -q) + +**Build docker images (without proxy definition):** + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/so/packages + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install -P docker + -Dmso.chef.git.url.prefix=ssh://$USER@gerrit.onap.org:29418 -Dmso.chef.git.branchname=master + -Dmso.chef.git.url.suffix.chef.repo=so/chef-repo -Dmso.chef.git.url.suffix.chef.config=so/so-config + -Ddocker.buildArg.http_proxy=http://one.proxy.att.com:8080 + -Ddocker.buildArg.https_proxy=http://one.proxy.att.com:8080 + +**Build docker images (with proxy definition):** + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/so/packages + + $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install -P docker + -Dmso.chef.git.url.prefix=ssh://$USER@gerrit.onap.org:29418 -Dmso.chef.git.branchname=master + -Dmso.chef.git.url.suffix.chef.repo=so/chef-repo -Dmso.chef.git.url.suffix.chef.config=so/so-config + -Ddocker.buildArg.http_proxy=http://proxyhost:port -Ddocker.buildArg.https_proxy=http://proxyhost:port + +Build with Integration Tests +----------------------------- + +This is done exactly as described for building docker images, except that the maven profile to use is "with-integration-tests" instead of "docker". Integration tests are executed inside docker containers constructed by the build. + + diff --git a/docs/Camunda_Cockpit_Community_Edition.rst b/docs/Camunda_Cockpit_Community_Edition.rst new file mode 100644 index 0000000000..a9379decc9 --- /dev/null +++ b/docs/Camunda_Cockpit_Community_Edition.rst @@ -0,0 +1,44 @@ +.. 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. + +Camunda Cockpit Community Edition +================================= + +On a deployed instance of SO, you can use the Camunda_Cockpit to view BPMN 2.0 workflow definitions in the deployment. + +.. _Camunda_Cockpit: https://camunda.org/features/cockpit/ + +Unfortunately, the Community Edition of Camunda included with SO is not fully featured. It cannot be used to inspect running and completed process instances. For that, the Enterprise Edition is required. + +Logging In +----------- + +Because port 8080 on the docker host machine is forwarded to port 8080 in the SO docker container you can log into the cockpit by browsing to this URL: + + http://*dockerhost*:8080/camunda/app/admin/default/#/login + + Where dockerhost is the docker host system. + +If you can use a browser on the docker host system, then use a localhost address: + + http://localhost:8080/camunda/app/admin/default/#/login + +The user is "admin" and the password is the same as the jboss admin password, which is not displayed here. + +.. image:: images/Camunda_Cockpit_1.png + +Viewing Process Definitions +--------------------------- + +Use the drop-down menu next to the home icon and select the "Cockpit" option: + +.. image:: images/Camunda_Cockpit_2.png + +The number of deployed process definitions should be displayed. Click on it. + +.. image:: images/Camunda_Cockpit_3.png + +Now you should see an actual list of deployed process definitions. You can click on any of them to view them. + +.. image:: images/Camunda_Cockpit_4.png diff --git a/docs/Camunda_Cockpit_Enterprise_Edition.rst b/docs/Camunda_Cockpit_Enterprise_Edition.rst new file mode 100644 index 0000000000..3e2d15bf15 --- /dev/null +++ b/docs/Camunda_Cockpit_Enterprise_Edition.rst @@ -0,0 +1,143 @@ +.. 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. + +Camunda Cockpit Enterprise Edition +================================== + +The Community Edition of Camunda is the version normally built into SO. With the Community Edition, you can see process definitions, but you cannot inspect running or completed process instances, which is an essential debugging capability. This capability is available only in the Enterprise Edition and requires a commercial license. If you have such a license, you can build SO with the Enterprise Edition. Your use must be consistent with the terms of your license, of course. + +With the Enterprise Edition cockpit, you can: + + * See a trace of tasks executed by a running or completed process instance. + * Look at execution variables in a running or completed process instance. + * Look at called subprocesses in a running or completed process instance. + +Maven Repository for Camunda EE Artifacts +------------------------------------------ + +To build with Camunda EE, you will need a maven repository containing the Camunda EE artifacts. This can be a nexus repository or a local repository in your filesystem. + +To construct a local repository, start with this structure for the 7.7.3-ee version of Camunda: + + camunda-ee-repository.zip_ + +.. _camunda-ee-repository.zip: https://wiki.onap.org/download/attachments/16001686/camunda-ee-repository.zip?version=1&modificationDate=1507838888000&api=v2 + +*NOTE*: the zip archive does not contain the actual Enterprise Edition JAR and WAR files. It contains zero-length files as placeholders. You will need to replace the zero-length files with files you obtain from Camunda. The archive does contain all the poms, checksums, and metadata required to make it a functional maven repository. + +Here's the minimum set of artifacts you need to build the SO Amsterdam release software: + + camunda-engine-7.7.3-ee.jar + + camunda-webapp-7.7.3-ee-classes.jar + + camunda-webapp-7.7.3-ee.war + + camunda-webapp-ee-jboss-standalone-7.7.3-ee.war + + camunda-engine-cdi-7.7.3-ee.jar + + camunda-engine-rest-7.7.3-ee-classes.jar + + camunda-engine-plugin-spin-7.7.3-ee.jar + + camunda-engine-plugin-connect-7.7.3-ee.jar + + camunda-engine-rest-core-7.7.3-ee.jar + + camunda-engine-feel-api-7.7.3-ee.jar + + camunda-engine-feel-juel-7.7.3-ee.jar + + camunda-engine-dmn-7.7.3-ee.jar + + camunda-engine-spring-7.7.3-ee.jar + + camunda-bpmn-model-7.7.3-ee.jar + + camunda-xml-model-7.7.3-ee.jar + + camunda-dmn-model-7.7.3-ee.jar + + camunda-cmmn-model-7.7.3-ee.jar + +Maven settings.xml +------------------ + +Add a profile to your maven settings.xml to include the repository containing your Camunda EE artifacts. + +For example: + +.. code-block:: bash + + <profile> + <!-- profile for artifacts not in public repositories --> + <id>my-local-artifacts</id> + <repositories> + <repository> + <!-- Local repository for Camunda Enterprise Edition --> + <!-- YOU MUST HAVE A VALID LICENSE TO USE THIS --> + <id>camunda-ee</id> + <name>camunda-ee</name> + <url>file:///home/john/onap/camunda-ee-repository</url> + </repository> + </repositories> + </profile> + +And add your profile to the list of active profiles: + +.. code-block:: bash + + <activeProfiles> + + <activeProfile>my-local-artifacts</activeProfile> + + <activeProfile>openecomp-staging</activeProfile> + + <activeProfile>openecomp-public</activeProfile> + + <activeProfile>openecomp-release</activeProfile> + + <activeProfile>openecomp-snapshots</activeProfile> + + <activeProfile>opendaylight-release</activeProfile> + + <activeProfile>opendaylight-snapshots</activeProfile> + + </activeProfiles> + +Building +-------- + +Add these options to the mvn command line when you build "so" + +.. code-block:: bash + + -Dcamunda.version=7.7.3-ee -Dcamunda.bpm.webapp.artifact=camunda-webapp-ee-jboss-standalone + +Installation +------------- + +The cockpit is part of the SO image. There are no special installation requirements. When you log in, you will need to enter your license information. Alternatively, you can insert your license directly into the camundabpmn database before you log in: + +.. code-block:: bash + + INSERT INTO camundabpmn.ACT_GE_PROPERTY VALUES ('camunda-license-key','YOUR-LICENCE-KEY-HERE',1); + +Logging In +----------- + +Because port 8080 on the docker host machine is forwarded to port 8080 in the SO docker container you can log into the Enterprise Edition cockpit by browsing to this URL: + + http://*dockerhost*:8080/camunda + + Where dockerhost is the docker host system. + +If you can use a browser on the docker host system, then use a localhost address: + + http://localhost:8080/camunda + +The user is "admin" and the password is the same as the jboss admin password, which is not displayed here. + +.. image:: images/Camunda_Cockpit_Enterprise_1.png diff --git a/docs/Camunda_Modeler.rst b/docs/Camunda_Modeler.rst new file mode 100644 index 0000000000..e2ff06d595 --- /dev/null +++ b/docs/Camunda_Modeler.rst @@ -0,0 +1,19 @@ +.. 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.
+
+Camunda Modeler
+=================
+
+The Camunda_Modeler_ is the editor for BPMN 2.0 process flows. It is a standalone application. NOTE: the Camunda eclipse plugin is no longer supported and should not be used.
+
+.. _Camunda_Modeler: https://docs.camunda.org/manual/latest/modeler/camunda-modeler/
+
+.. image:: images/camunda_modeler_1.png
+
+Modeler Templates
+------------------
+
+Some work has already been done in MSO to develop templates_ for "building block" subprocess flows. When a template is provided for a BPMN element, the modeler displays a custom form for inputting parameters. This significantly simplifies flow construction and reduces the chance of making mistakes.
+
+.. _templates: https://docs.camunda.org/manual/7.7/modeler/camunda-modeler/element-templates/
\ No newline at end of file diff --git a/docs/Configure_git_and_gerrit.rst b/docs/Configure_git_and_gerrit.rst new file mode 100644 index 0000000000..c4598faf7b --- /dev/null +++ b/docs/Configure_git_and_gerrit.rst @@ -0,0 +1,93 @@ +.. 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. + +Configure git and gerrit +======================== + +Basics +------ +The recommended version of git is 2.7.4 or later. Check the installed version in the Ubuntu VM: + +.. code-block:: bash + + git --version + +Create an SSH key to user with gerrit. Use no passphrase. + +.. code-block:: bash + + ssh-keygen -t rsa + +Enter your SSH public key (id_rsa) into gerrit: + +- Browse to https://gerrit.onap.org +- Log in +- Open the menu next to your name (under the green search button) + +.. image:: images/Configure_git_1.png + +- Select "Settings" +- In the "Settings" sidebar, click "SSH Public Keys"` +- Click "Add Key..." +- Paste the entire contents of $HOME/.ssh/id_rsa.pub into the text area and click "Add". + +.. image:: images/Configure_git_2.png + +Install the git-review package. + +.. code-block:: bash + + sudo apt update + sudo apt install git-review + +Create $HOME/.gitconfig (replace highlighted values with your own information): + [user] + + name = FirstName LastName + + email = you@yourcompany.com + + [core] + + autocrlf = false + + [merge] + + tool = vimdiff + + [gitreview] + + username = YourLinuxFoundationId + +**If you're behind a corporate firewall and your proxy server has SOCKS support...** + +You may be able to use the SSH protocol with git, which is preferred versus HTTP. This method is known to work in the AT&T corporate network. +Install the socat package, which allows you to tunnel SSH connections through a proxy that supports SOCKS: + +.. code-block:: bash + + sudo apt update + sudo apt install socat + +Create (or append to) $HOME/.ssh/config (replace highlighted values with your information) + + Host gerrit.onap.org + + User userid + + Hostname gerrit.onap.org + + ProxyCommand socat - PROXY:host:%h:%p,proxyport=port + + IdentityFile /home/userid/.ssh/id_rsa + + ServerAliveInterval 10 + +Verify that you have connectivity to gerrit through the proxy. Answer "yes" to continue connecting, if prompted. + +.. code-block:: bash + + ssh -p 29418 gerrit.onap.org + +.. image:: images/Configure_git_3.png diff --git a/docs/Developer_Info.rst b/docs/Developer_Info.rst new file mode 100644 index 0000000000..d077323f71 --- /dev/null +++ b/docs/Developer_Info.rst @@ -0,0 +1,13 @@ +.. 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.
+
+Developer Information
+======================
+
+.. toctree::
+ :maxdepth: 1
+
+ Install_Configure_SO.rst
+ architecture.rst
+ offered_consumed_apis.rst
\ No newline at end of file diff --git a/docs/Install_Configure_SO.rst b/docs/Install_Configure_SO.rst index 5771a10e84..3f7b903ac8 100644 --- a/docs/Install_Configure_SO.rst +++ b/docs/Install_Configure_SO.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-Install and Configure Service Orchestrator
+SO Install & Configure
==========================================
Get Ubuntu
@@ -18,79 +18,147 @@ Make sure you have the VirtualBox Guest Additions ISO for your version of Virtua 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
------------------
-sudo apt update
-sudo apt install openssh-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:
- sudo apt update
- sudo apt install gcc g++ dkms
+
+.. 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
----------------------------------------
-https://wiki.onap.org/display/DW/Development+Environment
\ No newline at end of file +
+.. 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/Install_Docker.rst b/docs/Install_Docker.rst new file mode 100644 index 0000000000..5712691dbf --- /dev/null +++ b/docs/Install_Docker.rst @@ -0,0 +1,85 @@ +.. 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 Docker
+===============
+
+Make sure curl is installed on the Ubuntu VM:
+
+.. code-block:: bash
+
+ sudo apt update
+ sudo apt install curl
+
+If you are behind a corporate firewall (replace "proxyhost:port" with your actual proxy information)
+ https_proxy="https://*proxyhost:port*" curl -fsSL https://apt.dockerproject.org/gpg | sudo apt-key add -
+
+Otherwise:
+ curl -fsSL https://apt.dockerproject.org/gpg | sudo apt-key add -
+Expected Response:
+ OK
+Add the docker package repository:
+ sudo apt-add-repository "deb https://apt.dockerproject.org/repo ubuntu-xenial main"
+
+Install packages:
+
+.. code-block:: bash
+
+ sudo apt update
+ sudo apt-cache policy docker-engine
+ sudo apt install docker-engine
+ sudo apt install docker-compose
+
+If you are behind a corporate firewall, you will need to configure proxy settings for docker so that images may be obtained from internet repositories. In the commands shown here, replace *"proxyhost:port"*, *"yourdomain1.com"*, and *"yourdomain2.com"* with appropriate values.
+
+ Make the docker configuration directory:
+
+.. code-block:: bash
+
+ sudo mkdir -p /etc/systemd/system/docker.service.d
+
+ Edit (create) this file:
+
+.. code-block:: bash
+
+ sudo vi /etc/systemd/system/docker.service.d/http-proxy.conf
+
+ Add these lines:
+
+ [Service]
+
+ Environment="HTTP_PROXY=https://*proxyhost:port*"
+
+ Environment="HTTPS_PROXY=https://*proxyhost:port*"
+
+ Environment="NO_PROXY=localhost,127.0.0.1,.yourdomain1.com,.yourdomain2.com"
+
+ Restart docker:
+
+.. code-block:: bash
+
+ sudo systemctl daemon-reload
+ sudo systemctl restart docker
+
+Add yourself to the docker user group (replace "userid" with your user ID):
+
+.. code-block:: bash
+
+ sudo usermod -a -G docker *userid*
+
+Log out and log back in so that the user group change will takeeffect.
+
+Verify that you can connect to docker as yourself (i.e. not as root):
+
+.. code-block:: bash
+
+ docker ps
+
+Verify that you can download and run the hello-world container
+
+.. code-block:: bash
+
+ docker run hello-world
+
+.. image:: images/Docker_install_1.png
\ No newline at end of file diff --git a/docs/SO_API_v0.1.pdf b/docs/SO_API_v0.1.pdf Binary files differnew file mode 100644 index 0000000000..42fdc5fe3d --- /dev/null +++ b/docs/SO_API_v0.1.pdf diff --git a/docs/SO_R1_Interface.rst b/docs/SO_R1_Interface.rst new file mode 100644 index 0000000000..41e127d225 --- /dev/null +++ b/docs/SO_R1_Interface.rst @@ -0,0 +1,17 @@ +.. 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 R1 Interfaces
+================
+
+.. image:: images/SO_R1_1.png
+
+Service Orchestrator in R1 uses interfaces from both the MSO seed code and as well as new interfaces between the new components of ONAP.
+The below documentation of the SO APIs and are reviewed in the architecture committee meeting on 22/08/2017.
+
+See :download:`SO_API_v0.1.pdf`
+
+The interface between UUi and SO for the E2E VoLTE service:
+
+See :download:`UUI-SO_API_Specification_v0.1.docx`
\ No newline at end of file diff --git a/docs/UUI-SO API Specification v0.1(1).docx b/docs/UUI-SO_API_Specification_v0.1.docx Binary files differindex a6dfbd0b1a..d68cccf4d3 100644 --- a/docs/UUI-SO API Specification v0.1(1).docx +++ b/docs/UUI-SO_API_Specification_v0.1.docx diff --git a/docs/Working_with_SO_Docker.rst b/docs/Working_with_SO_Docker.rst new file mode 100644 index 0000000000..ee958efa41 --- /dev/null +++ b/docs/Working_with_SO_Docker.rst @@ -0,0 +1,208 @@ +.. 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. + +Working with SO Docker +====================== + +Verify that docker images are built +------------------------------------ + +.. code-block:: bash + + docker images openecomp/mso + + *Example Output:* + + REPOSITORY TAG IMAGE ID CREATED SIZE + + openecomp/mso 1.1-SNAPSHOT-latest 419e9d8a17e8 3 minutes ago 1.62GB + + openecomp/mso 1.1.0-SNAPSHOT-STAGING-20170926T2015 419e9d8a17e8 3 minutes ago 1.62GB + + openecomp/mso latest 419e9d8a17e8 3 minutes ago 1.62GB + +Start the mariadb container +---------------------------- + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/docker-config + + MTU=1500 docker-compose up mariadb + +*Example Output:* + +.. code-block:: bash + + . . . many lines omitted . . . + mariadb_1 | Version: '10.1.11-MariaDB-1~jessie-log' socket: '/var/run/mysqld/mysqld.sock' port: 3306 mariadb.org binary distribution + +Log into the mariadb container and run the mysql client program +--------------------------------------------------------------- + +.. code-block:: bash + + docker exec -it dockerconfig_mariadb_1 /bin/bash + mysql -uroot -ppassword + +Start the mso container +----------------------- + +.. code-block:: bash + + cd $HOME/onap/workspace/SO/docker-config + + MTU=1500 docker-compose up mso + +*Example Output:* + +.. code-block:: bash + + . . . many lines omitted . . . + mso_1 | 20:59:31,586 INFO [org.jboss.as] (Controller Boot Thread) WFLYSRV0025: WildFly Full 10.1.0.Final + (WildFly Core 2.2.0.Final) started in 59937ms - Started 2422 of 2747 services (604 services are lazy, passive or + on-demand) + +Log into the mso container +-------------------------- + +.. code-block:: bash + + docker exec -it dockerconfig_mso_1 /bin/bash + +Inspect a docker image +---------------------- + +This command shows interesting information about the structure of the mso image. Note that an image is NOT a running container. It is the template that a container is created from. + +.. code-block:: bash + + docker inspect openecomp/mso + Example Output: + + [ + { + "Id": "sha256:419e9d8a17e8d7e876dfc36c1f3ed946bccbb29aa6faa6cd8e32fbc77c0ef6e5", + "RepoTags": [ + "openecomp/mso:1.1-SNAPSHOT-latest", + "openecomp/mso:1.1.0-SNAPSHOT-STAGING-20170926T2015", + "openecomp/mso:latest" + ], + "RepoDigests": [], + "Parent": "sha256:70f1ba3d6289411fce96ba78755a3fd6055a370d33464553d72c753889b12693", + "Comment": "", + "Created": "2017-09-26T20:40:10.179358574Z", + "Container": "284aa05909390a3c0ffc1ec6d0f6e2071799d56b08369707505897bc73d2ea30", + "ContainerConfig": { + "Hostname": "6397aa10f0c4", + "Domainname": "", + "User": "root", + "AttachStdin": false, + "AttachStdout": false, + "AttachStderr": false, + "ExposedPorts": { + "8080/tcp": {} + }, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": [ + "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", + "HTTP_PROXY=", + "HTTPS_PROXY=", + "http_proxy=", + "https_proxy=", + "JBOSS_HOME=/opt/jboss", + "CHEF_REPO_NAME=chef-repo", + "CHEF_CONFIG_NAME=mso-config" + ], + "Cmd": [ + "/bin/sh", + "-c", + "#(nop) ", + "CMD [\"/opt/mso/scripts/start-jboss-server.sh\"]" + ], + "ArgsEscaped": true, + "Image": "sha256:70f1ba3d6289411fce96ba78755a3fd6055a370d33464553d72c753889b12693", + "Volumes": { + "/shared": {} + }, + "WorkingDir": "", + "Entrypoint": null, + "OnBuild": [], + "Labels": { + "Description": "This image contains the ONAP SO", + "Version": "1.0" + } + }, + "DockerVersion": "17.05.0-ce", + "Author": "\"The ONAP Team\"", + "Config": { + "Hostname": "6397aa10f0c4", + "Domainname": "", + "User": "root", + "AttachStdin": false, + "AttachStdout": false, + "AttachStderr": false, + "ExposedPorts": { + "8080/tcp": {} + }, + "Tty": false, + "OpenStdin": false, + "StdinOnce": false, + "Env": [ + "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", + "HTTP_PROXY=", + "HTTPS_PROXY=", + "http_proxy=", + "https_proxy=", + "JBOSS_HOME=/opt/jboss", + "CHEF_REPO_NAME=chef-repo", + "CHEF_CONFIG_NAME=mso-config" + ], + "Cmd": [ + "/opt/mso/scripts/start-jboss-server.sh" + ], + "ArgsEscaped": true, + "Image": "sha256:70f1ba3d6289411fce96ba78755a3fd6055a370d33464553d72c753889b12693", + "Volumes": { + "/shared": {} + }, + "WorkingDir": "", + "Entrypoint": null, + "OnBuild": [], + "Labels": { + "Description": "This image contains the ONAP SO", + "Version": "1.0" + } + }, + "Architecture": "amd64", + "Os": "linux", + "Size": 1616881263, + "VirtualSize": 1616881263, + "GraphDriver": { + "Data": null, + "Name": "aufs" + }, + "RootFS": { + "Type": "layers", + "Layers": [ + "sha256:a2022691bf950a72f9d2d84d557183cb9eee07c065a76485f1695784855c5193", + "sha256:ae620432889d2553535199dbdd8ba5a264ce85fcdcd5a430974d81fc27c02b45", + . . . many lines omitted . . . + "sha256:0f9e9dacce9191617e979f05e32ee782b1632e07130fd7fee19b0b2d635aa006", + "sha256:84572c6389f8ae41150e14a8f1a28a70720de91ab1032f8755b5449dc04449c9" + ] + } + } +] + +Log into the mso image +----------------------- + +This command allows you to inspect the files inside the mso image. Note that an image is NOT a running container. It is the template that a container is created from. + +.. code-block:: bash + + docker run -it --entrypoint=/bin/bash openecomp/mso -i diff --git a/docs/Workspace_and_Development_Tools.rst b/docs/Workspace_and_Development_Tools.rst new file mode 100644 index 0000000000..2012a20b09 --- /dev/null +++ b/docs/Workspace_and_Development_Tools.rst @@ -0,0 +1,107 @@ +.. 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.
+
+Workspace and Development Tools
+===============================
+
+We recognize that there are different ways to set up a workspace and different tools that may be chosen. This is just one way to set things up.
+
+Suggested Directory Structure
+------------------------------
+*NOTE*: You may have different versions of eclipse and java.
+
+ onap
+
+ .m2
+
+ apache-maven-3.3.9
+
+ camunda-modeler
+
+ eclipse-jee-neon-3-linux-gtk-x86_64
+
+ jdk1.8.0_131
+
+ workspace
+
+ SO
+ chef-repo
+
+ docker-config
+
+ libs
+
+ so
+
+ so-config
+
+Java
+-----
+Download the latest Java_8_SE_Development_Kit_ from Oracle. Select a Linux x64 package.
+
+Unpack it.
+
+.. _Java_8_SE_Development_Kit: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
+
+Maven
+------
+
+Download the Apache_Maven_3.3.9_ binary. NOTE: 3.3.9 is the recommended version, even though much higher versions are available.
+
+Unpack it.
+
+.. _Apache_Maven_3.3.9: https://archive.apache.org/dist/maven/maven-3/3.3.9/binaries/
+
+Create an .m2 directory for maven and put settings.xml_ in it. Edit the local repository path in settings.xml to make it correct for your environment. Everything else should be OK.
+
+.. _settings.xml: https://wiki.onap.org/download/attachments/15997820/settings.xml?version=1&modificationDate=1506156303000&api=v2
+
+Camunda Modeler
+---------------
+
+Download the Camunda_Modeler_. Select the Linux x64 package.
+Unpack it.
+
+.. _Camunda_Modeler: https://camunda.org/download/modeler/
+
+Eclipse
+-------
+
+Download Eclipse_for_Linux_. Select the 64-bit Eclipse IDE for Java EE Developers. Oxygen seems to be the latest version. These instructions were written for Neon.
+Unpack it.
+
+.. _Eclipse_for_Linux: https://www.eclipse.org/downloads/eclipse-packages/?osType=linux
+
+In the eclipse directory, edit eclipse.ini
+
+ Add (or change) the -vm setting so that it points to your JDK.
+
+ Adjust the maximum heap space (2GB is recommended).
+
+ Example:
+
+.. image:: images/Workspace_and_Development_Tools.png
+
+Eclipse Settings
+----------------
+
+**Configure eclipse to use your external maven 3.3.9 installation:**
+ Go to Window→Preferences→Maven→Installations
+
+ Click "Add" and browse to your apache-maven-3.3.9 directory. Click "OK" to select it.
+
+ Click "Finish"
+
+.. image:: images/Workspace_and_Development_Tools_2.png
+
+Make sure the external installation is selected:
+
+.. image:: images/Workspace_and_Development_Tools_3.png
+
+**Configure eclipse to use your settings.xml**
+ Go to Window→Preferences→Maven→User Settings
+
+ Type the full path to your settings.xml file into the "User Settings" box and click "OK".
+
+.. image:: images/Workspace_and_Development_Tools_4.png
\ No newline at end of file diff --git a/docs/architecture.rst b/docs/architecture.rst index c9f6838216..7c01077dcc 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -2,15 +2,108 @@ .. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-Service Orchestrator
+SO - Service Orchestration
========================================================
SO Architecture
----------------
-SO architecture and internal details could be found in the below wiki link
-https://wiki.onap.org/pages/viewpage.action?pageId=9830754
+.. image:: images/SO_Architecture_1.png
+
+SO Sub-Components
+------------------
+
+**API Handler**
+
+ RESTful interface to northbound clients
+
+ * Handle service-level and infrastructure (VNF & network) requests
+
+ Service-agnostic APIs
+ * “Service Instantiation API”
+
+ Model-driven recipe selection
+ * Use SO Catalog to map input requests to BPMN flows
+ * Dynamic lookup based on service-model + action
+ * Input data forwarded to BPMN flow
+
+ Track open and completed requests via SO Request DB
+
+ Multiple API-H modules may support different APIs
+
+**BPMN Execution Engine**
+
+ Open-source Camunda platform
+ * Support BPMN 2.0 service recipes
+
+ Expose RESTful interface to API-H (unique path per recipe)
+
+ Make use of common “building block” sub-flows
+
+ Sequence orchestration steps for each Resource in the recipe
+ * Request and configure network resources via SDN-C
+ * Manage cloud resources via PO (OpenStack)
+ * Update inventory via A&AI
+
+ Perform error handling/rollback
+
+**Resource Adapters**
+
+ Interfaces to lower level controllers and other ONAP components
+ * Platform Orchestrator, SDN-Controller, APP-Controller, VFC-Controllers
+ * Hides the details of complex interfaces (e.g. OpenStack APIs)
+ * Expose interfaces to BPMN flows as SOAP or REST APIs
+ * Support synchronous and asynchronous operations
+
+ Provided as part of SO platform for use by all BPMN flows
+
+ Use SO Catalog to map resource requests to a recipe/template
+
+ Data-driven design
+ * Catalog templates may be updated via self-service (outside of release cycles)
+ * Merge input parameters with templates at run-time
+
+**Data Stores**
+
+ Request DB
+ * Tracks open and completed requests
+
+ SO Catalog
+ * SO view of the SDC Catalog
+ * service and resource models, recipes, and templates
+ * Populated via SDC distribution service from TOSCA models
+
+ Camunda DB
+ * Maintain state for BPMN flows
+ * Supports multiple active engines
+
+**SDC Distribution Client**
+
+ Receive updated service models from SDC
+ * Event-bus notifications when new models available
+ * HTTP retrieval of models (TOSCA) and artifacts (Heat)
+
+ Receive distributions as TOSCA models
+
+ Populate SO Catalog
+
+ Support self-service updates to models and artifacts
+
+Third Party and Open Source
+---------------------------
+
+**BPMN Engine**
+ Camunda (open source)
+
+**Other Open Source Components of Note:**
+ JBOSS EAP/Wildfly
+ MySQL/MariaDB
+ Openstack Java SDK (“woorea”)
+
+
+
+
+
+
+
-.. toctree::
- :maxdepth: 1
-
\ No newline at end of file diff --git a/docs/developer_information.rst b/docs/developer_information.rst new file mode 100644 index 0000000000..739a1f2050 --- /dev/null +++ b/docs/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
+
+ 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/images/BPMN_Main_Process_Flows_1.png b/docs/images/BPMN_Main_Process_Flows_1.png Binary files differnew file mode 100644 index 0000000000..57337d621f --- /dev/null +++ b/docs/images/BPMN_Main_Process_Flows_1.png diff --git a/docs/images/BPMN_Subprocess_process_flows_1.png b/docs/images/BPMN_Subprocess_process_flows_1.png Binary files differnew file mode 100644 index 0000000000..5ec7e7ce9c --- /dev/null +++ b/docs/images/BPMN_Subprocess_process_flows_1.png diff --git a/docs/images/Camunda_Cockpit_1.png b/docs/images/Camunda_Cockpit_1.png Binary files differnew file mode 100644 index 0000000000..cdcc6f3b8e --- /dev/null +++ b/docs/images/Camunda_Cockpit_1.png diff --git a/docs/images/Camunda_Cockpit_2.png b/docs/images/Camunda_Cockpit_2.png Binary files differnew file mode 100644 index 0000000000..a696a68cb0 --- /dev/null +++ b/docs/images/Camunda_Cockpit_2.png diff --git a/docs/images/Camunda_Cockpit_3.png b/docs/images/Camunda_Cockpit_3.png Binary files differnew file mode 100644 index 0000000000..a298fe0669 --- /dev/null +++ b/docs/images/Camunda_Cockpit_3.png diff --git a/docs/images/Camunda_Cockpit_4.png b/docs/images/Camunda_Cockpit_4.png Binary files differnew file mode 100644 index 0000000000..ff445f364d --- /dev/null +++ b/docs/images/Camunda_Cockpit_4.png diff --git a/docs/images/Camunda_Cockpit_Enterprise_1.png b/docs/images/Camunda_Cockpit_Enterprise_1.png Binary files differnew file mode 100644 index 0000000000..cdcc6f3b8e --- /dev/null +++ b/docs/images/Camunda_Cockpit_Enterprise_1.png diff --git a/docs/images/Configure_git_1.png b/docs/images/Configure_git_1.png Binary files differnew file mode 100644 index 0000000000..2d4ce85036 --- /dev/null +++ b/docs/images/Configure_git_1.png diff --git a/docs/images/Configure_git_2.png b/docs/images/Configure_git_2.png Binary files differnew file mode 100644 index 0000000000..44ceeff5fe --- /dev/null +++ b/docs/images/Configure_git_2.png diff --git a/docs/images/Configure_git_3.png b/docs/images/Configure_git_3.png Binary files differnew file mode 100644 index 0000000000..f44a0b4bff --- /dev/null +++ b/docs/images/Configure_git_3.png diff --git a/docs/images/Configure_ubuntu_SO_1.png b/docs/images/Configure_ubuntu_SO_1.png Binary files differnew file mode 100644 index 0000000000..a5a8301628 --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_1.png diff --git a/docs/images/Configure_ubuntu_SO_2.png b/docs/images/Configure_ubuntu_SO_2.png Binary files differnew file mode 100644 index 0000000000..d3b215f76f --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_2.png diff --git a/docs/images/Configure_ubuntu_SO_3.png b/docs/images/Configure_ubuntu_SO_3.png Binary files differnew file mode 100644 index 0000000000..ef4f21bbf4 --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_3.png diff --git a/docs/images/Configure_ubuntu_SO_4.png b/docs/images/Configure_ubuntu_SO_4.png Binary files differnew file mode 100644 index 0000000000..f857eff017 --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_4.png diff --git a/docs/images/Configure_ubuntu_SO_5.png b/docs/images/Configure_ubuntu_SO_5.png Binary files differnew file mode 100644 index 0000000000..01d2016752 --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_5.png diff --git a/docs/images/Configure_ubuntu_SO_6.png b/docs/images/Configure_ubuntu_SO_6.png Binary files differnew file mode 100644 index 0000000000..17b9986d90 --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_6.png diff --git a/docs/images/Configure_ubuntu_SO_7.png b/docs/images/Configure_ubuntu_SO_7.png Binary files differnew file mode 100644 index 0000000000..d233847306 --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_7.png diff --git a/docs/images/Configure_ubuntu_SO_8.png b/docs/images/Configure_ubuntu_SO_8.png Binary files differnew file mode 100644 index 0000000000..01d2016752 --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_8.png diff --git a/docs/images/Configure_ubuntu_SO_9.png b/docs/images/Configure_ubuntu_SO_9.png Binary files differnew file mode 100644 index 0000000000..2cc96b379f --- /dev/null +++ b/docs/images/Configure_ubuntu_SO_9.png diff --git a/docs/images/Docker_install_1.png b/docs/images/Docker_install_1.png Binary files differnew file mode 100644 index 0000000000..1e9c177ee5 --- /dev/null +++ b/docs/images/Docker_install_1.png diff --git a/docs/images/SO_Architecture_1.png b/docs/images/SO_Architecture_1.png Binary files differnew file mode 100644 index 0000000000..a50c01bdd9 --- /dev/null +++ b/docs/images/SO_Architecture_1.png diff --git a/docs/images/SO_R1_1.png b/docs/images/SO_R1_1.png Binary files differnew file mode 100644 index 0000000000..7bf98fcfb2 --- /dev/null +++ b/docs/images/SO_R1_1.png diff --git a/docs/images/Workspace_and_Development_Tools.png b/docs/images/Workspace_and_Development_Tools.png Binary files differnew file mode 100644 index 0000000000..46f8fe4baf --- /dev/null +++ b/docs/images/Workspace_and_Development_Tools.png diff --git a/docs/images/Workspace_and_Development_Tools_2.png b/docs/images/Workspace_and_Development_Tools_2.png Binary files differnew file mode 100644 index 0000000000..1f3fff0776 --- /dev/null +++ b/docs/images/Workspace_and_Development_Tools_2.png diff --git a/docs/images/Workspace_and_Development_Tools_3.png b/docs/images/Workspace_and_Development_Tools_3.png Binary files differnew file mode 100644 index 0000000000..3d2f35df82 --- /dev/null +++ b/docs/images/Workspace_and_Development_Tools_3.png diff --git a/docs/images/Workspace_and_Development_Tools_4.png b/docs/images/Workspace_and_Development_Tools_4.png Binary files differnew file mode 100644 index 0000000000..31a424e4d2 --- /dev/null +++ b/docs/images/Workspace_and_Development_Tools_4.png diff --git a/docs/images/bpmn_project_structure_1.png b/docs/images/bpmn_project_structure_1.png Binary files differnew file mode 100644 index 0000000000..d94b6fb1e2 --- /dev/null +++ b/docs/images/bpmn_project_structure_1.png diff --git a/docs/images/bpmn_project_structure_2.png b/docs/images/bpmn_project_structure_2.png Binary files differnew file mode 100644 index 0000000000..15f63603c6 --- /dev/null +++ b/docs/images/bpmn_project_structure_2.png diff --git a/docs/images/bpmn_project_structure_3.png b/docs/images/bpmn_project_structure_3.png Binary files differnew file mode 100644 index 0000000000..e9f0d8d0db --- /dev/null +++ b/docs/images/bpmn_project_structure_3.png diff --git a/docs/images/bpmn_project_structure_4.png b/docs/images/bpmn_project_structure_4.png Binary files differnew file mode 100644 index 0000000000..c5cbb8b148 --- /dev/null +++ b/docs/images/bpmn_project_structure_4.png diff --git a/docs/images/bpmn_project_structure_5.png b/docs/images/bpmn_project_structure_5.png Binary files differnew file mode 100644 index 0000000000..3c3e9064ea --- /dev/null +++ b/docs/images/bpmn_project_structure_5.png diff --git a/docs/images/camunda_modeler_1.png b/docs/images/camunda_modeler_1.png Binary files differnew file mode 100644 index 0000000000..2316c9849c --- /dev/null +++ b/docs/images/camunda_modeler_1.png diff --git a/docs/index.rst b/docs/index.rst index e2fbfcdc1e..9fd4cc3f97 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-ONAP Service Orchestration Documentation
+ONAP SO
========================================
.. toctree::
@@ -11,4 +11,5 @@ ONAP Service Orchestration Documentation Install_Configure_SO.rst
architecture.rst
offered_consumed_apis.rst
-
\ No newline at end of file + developer_information.rst
+ release-notes.rst
\ No newline at end of file diff --git a/docs/installation.rst b/docs/installation.rst index fc5af916e1..07f534e1b3 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,97 +1,112 @@ -.. _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 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 here:
- /media/sf_Users
-
-Further Reading
-----------------------------------------
-https://wiki.onap.org/display/DW/Development+Environment
\ No newline at end of file +.. _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 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 diff --git a/docs/offered_consumed_apis.rst b/docs/offered_consumed_apis.rst index f7110c7eba..8888c6437e 100644 --- a/docs/offered_consumed_apis.rst +++ b/docs/offered_consumed_apis.rst @@ -2,15 +2,14 @@ .. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
-ONAP Service Orchestration APIs
+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.
-
- https://wiki.onap.org/display/DW/SO+R1+Interfaces
-
-
+
.. toctree::
:maxdepth: 1
+
+ SO_R1_Interface.rst
diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 7c7c1371cc..c0a2984c65 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -3,46 +3,57 @@ .. Copyright 2017 Huawei Intellectual Property. All rights reserved. -Service Orchestrator Release Notes -================================== - -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. +SO Release Notes +================ + Version: 1.1.0 -------------- -:Release Date: yyyy-mm-dd +:Release Date: 2017-11-16 **New Features** - Initial release of Service Orchestrator (SO) for Open Network Automation Platform (ONAP) - +The SO provides the highest level of service orchestration in the ONAP architecture. +SO is implemented via BPMN flows that operate on Models distributed from SDC that describe the Services and associated VNFs and other Resource components. +Cloud orchestration currently based on HEAT and TOSCA templates. +The orchestration engine is a reusable service. Any component of the architecture can execute process workflows. +Orchestration services can consume a process workflow and execute it. +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. **Bug Fixes** - - ``_ and a sentence explaining what this defect is addressing. +This is the initial release of ONAP SO. +Issues of the Ecomp 1710 release are fixed in this release. + **Known Issues** - - ``_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. +1. The articatfs of SO are under the openecomp/mso folder in nexus. + This is not impacting the release but is good to be moved to the ONAP +2. Current SO release does not support PNF orchestration. + The usecases demonstrated in ONAP Amsterdam release does not include PNF. +3. ARIA Plugin is not in full fledged in the current release. + The VNFs provided in the vCPE and vFW usecase are heat based and dont require ARIA. **Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ - +This is the initial release of ONAP SO. +Security aspects are not included in the current release. **Upgrade Notes** +This is the initial release of ONAP SO. **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** |
