summaryrefslogtreecommitdiffstats
path: root/docs/platform/installation
diff options
context:
space:
mode:
authorguochuyicmri <guochuyi@chinamobile.com>2019-06-11 15:35:08 +0800
committerguochuyicmri <guochuyi@chinamobile.com>2019-06-11 15:35:09 +0800
commitb74f1453b2c309b7395b909762a3d3543dab6406 (patch)
tree018a756281c78059f4e6813989ba2afcc9c1b728 /docs/platform/installation
parent88e152431069d134edeb8ad80e1cd3944708a6f5 (diff)
add usecase-ui user guide
Change-Id: I97155072f9cf212ce6a2155bd07a6c57546222e5 Issue-ID: USECASEUI-194 Signed-off-by: guochuyicmri <guochuyi@chinamobile.com>
Diffstat (limited to 'docs/platform/installation')
-rw-r--r--docs/platform/installation/index.rst14
-rw-r--r--docs/platform/installation/installation/index.rst7
-rw-r--r--docs/platform/installation/installation/uui-over-oom.rst75
-rw-r--r--docs/platform/installation/user-guide/index.rst7
-rw-r--r--docs/platform/installation/user-guide/uui-guide.rst28
5 files changed, 131 insertions, 0 deletions
diff --git a/docs/platform/installation/index.rst b/docs/platform/installation/index.rst
new file mode 100644
index 00000000..68d43b97
--- /dev/null
+++ b/docs/platform/installation/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Usecase-UI Installation and User Guide
+======================================
+
+
+.. toctree::
+ :maxdepth: 1
+
+ installation/index
+
+ user-guide/index
diff --git a/docs/platform/installation/installation/index.rst b/docs/platform/installation/installation/index.rst
new file mode 100644
index 00000000..5f84d857
--- /dev/null
+++ b/docs/platform/installation/installation/index.rst
@@ -0,0 +1,7 @@
+Usecase-UI Installation over OOM
+--------------------------------
+
+.. toctree::
+ :titlesonly:
+
+ uui-over-oom
diff --git a/docs/platform/installation/installation/uui-over-oom.rst b/docs/platform/installation/installation/uui-over-oom.rst
new file mode 100644
index 00000000..ea87d3e8
--- /dev/null
+++ b/docs/platform/installation/installation/uui-over-oom.rst
@@ -0,0 +1,75 @@
+.. contents::
+ :depth: 3
+..
+
+
+**1. Scope**
+============
+
+This is a guide to help developer or tester to try to install Usecase-UI over OOM.
+
+**2. Component & function**
+===========================
+
+Usecase-UI Repositories
+
++--------------------------+-----------------------------------------------------+
+| **Repo Name** | Description |
++==========================+=====================================================+
+| usecase-ui | Frontend of Usecase-UI |
++--------------------------+-----------------------------------------------------+
+| usecase-ui/server | Backend of Usecase-UI |
++--------------------------+-----------------------------------------------------+
+
+
+Usecase-UI Docker Images
+::
+
+ nexus3.onap.org:10001/onap/usecase-ui:2.0.1
+ nexus3.onap.org:10001/onap/usecase-ui-server:2.0.1
+
+
+**3. Usecase-UI Deployment**
+============================
+
+For initialization of docker there are 2 deployment options currently adpoted in ONAP : using heat template and using OOM.
+From Casablanca release, OOM is the recommended way, so here mainly give the steps for OOM based deployment.
+For OOM deployment you can refer to the below links:
+
+https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_setup_kubernetes_rancher.html
+https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_quickstart_guide.html#quick-start-label
+
+1. First ensure Usecase-UI is marked true against field enabled in the oom/kubernetes/onap/values.yaml for successful deployment.
+
+2. Upgrade Images in OOM charts to ensure the component version is right, you should check the respective component image version in Usecase-UI charts.
+If you need update the version, please modify values.yaml files.
+
+3. Rebuild all repos in helm. Every time you change the charts, you need to rebuild all repos to ensure the change can take effect.
+
+**4. Debug and Testing in running Pod**
+=======================================
+
+When you are doing the testing and would like to replace some new file like binary or some script and want to check the new resut.
+Before you replace the file to the running pod,you need to close the pod livenessProbe and readinessProbe first to avoid the pod restart.
+
+**5. Kubectl basic command**
+============================
+
+Basic operation of kubernests cluster(Take the namespace of onap in linux client as an example)
+
+* Check the cluster node
+::
+
+ kubectl get node
+
+* Check cluster namespace
+::
+
+ kubectl get ns
+
+* View the pod information and the pod on which the node is located, under the namespace specified (for example, namespace on onap)
+::
+
+ kubectl get pod -o wide
+ kubectl get pod -n onap
+
diff --git a/docs/platform/installation/user-guide/index.rst b/docs/platform/installation/user-guide/index.rst
new file mode 100644
index 00000000..311833da
--- /dev/null
+++ b/docs/platform/installation/user-guide/index.rst
@@ -0,0 +1,7 @@
+Usecase-UI Using Guide
+----------------------
+
+.. toctree::
+ :titlesonly:
+
+ uui-guide
diff --git a/docs/platform/installation/user-guide/uui-guide.rst b/docs/platform/installation/user-guide/uui-guide.rst
new file mode 100644
index 00000000..d0a7f644
--- /dev/null
+++ b/docs/platform/installation/user-guide/uui-guide.rst
@@ -0,0 +1,28 @@
+.. contents::
+ :depth: 3
+..
+
+
+**1. Confirm Usecase-UI MicroService**
+======================================
+
+Confirm that the Usecase-UI microservice has been successfully registered in MSB with OOM.
+
+**2. Register Usecase-UI MicroService**
+=======================================
+
+If Usecase-UI microservice does not exist in MSB, please register them manually.
+::
+
+ curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "usecaseui-server", "version": "v1", "url": "/api/usecaseui-server/v1","protocol": "REST", "nodes": [{"ip": "${UUI_SERVER_IP}","port": "8082"}]}' "http://${MSB_IP}:30280/api/microservices/v1/services"
+ curl -X POST -H "Content-Type: application/json" -d '{"serviceName": "usecaseui-ui", "version": "v1", "url": "/usecase-ui","path": "/iui/usecaseui","protocol": "UI", "nodes": [{"ip": "${UUI_IP}","port": "8080"}]}' "http://${MSB_IP}:30280/api/microservices/v1/services"
+
+**3. Open Usecase-UI Home**
+===========================
+
+Please open Usecase-UI dashboard page through your browser.
+
+::
+
+ http://${MSB_IP}:30280/iui/usecaseui/
+