summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorxuran <xuranyjy@chinamobile.com>2019-06-26 15:25:33 +0800
committerxu ran <xuranyjy@chinamobile.com>2019-06-26 07:48:38 +0000
commitaf979cd7eb90c47b8376c856ac221a8fb38489c3 (patch)
treeb90a53cb46a79561fc2be3db28570cb57e905e88 /docs
parentab744bd0cdf9f893bc775f8eb7159e2df2f77996 (diff)
bug: fix some docs bugs
Change-Id: I8896a246bcd1d6c783220442ca9d26742b1d41ba Issue-ID: USECASEUI-278 Signed-off-by: xuran <xuranyjy@chinamobile.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/platform/administration.rst9
-rw-r--r--docs/platform/delivery.rst3
-rw-r--r--docs/platform/installation/installation/uui-over-oom.rst10
-rw-r--r--docs/release-notes.rst6
4 files changed, 18 insertions, 10 deletions
diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst
index 52ded424..97cb6ee2 100644
--- a/docs/platform/administration.rst
+++ b/docs/platform/administration.rst
@@ -8,10 +8,12 @@ Usecase-UI components have been dockerized, can use docker command to manage Use
Processes / Dockers
-+++++++++
++++++++++++++++++++
Usecase-UI mainly consists of two dockers:
+
* Usecase-UI UI Docker
+
* Usecase-UI Server Docker
@@ -19,8 +21,13 @@ Actions
+++++++
All actions performed on the Usecase-UI modules are docker-based.
+
* Create a Container: ``sudo docker run [OPTIONS] IMAGE [COMMAND] [ARG...]``
+
* Kill a Container: ``sudo docker kill [OPTIONS] CONTAINER [CONTAINER...]``
+
* Stop a Container: ``sudo docker stop [OPTIONS] CONTAINER [CONTAINER...]``
+
* Start a Container: ``sudo docker start [OPTIONS] CONTAINER [CONTAINER...]``
+
* Restart a Container: ``sudo docker restart [OPTIONS] CONTAINER [CONTAINER...]``
diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst
index 2bbbce00..a4080416 100644
--- a/docs/platform/delivery.rst
+++ b/docs/platform/delivery.rst
@@ -7,7 +7,6 @@ Usecase-UI Delivery
Usecase-UI mainly comprises two modules: Usecase UI and Usecase UI Server.
-* usecase-ui Docker Image : The main GUI for LCM and Monitor functions are performed in this module.
-This part provides Lifecycle CRUD operation UI and alarm/performance monitor.
+* usecase-ui Docker Image : The main GUI for LCM and Monitor functions are performed in this module. This part provides Lifecycle CRUD operation UI and alarm/performance monitor.
* usecase-ui-server Docker Image : This part provides APIs and postgreSQL Database for usecase-ui inside.
diff --git a/docs/platform/installation/installation/uui-over-oom.rst b/docs/platform/installation/installation/uui-over-oom.rst
index ea87d3e8..dcf6bce5 100644
--- a/docs/platform/installation/installation/uui-over-oom.rst
+++ b/docs/platform/installation/installation/uui-over-oom.rst
@@ -58,16 +58,18 @@ Before you replace the file to the running pod,you need to close the pod livenes
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
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index dfb77183..87e98ed2 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -42,7 +42,7 @@ The Usecase-UI open critical security vulnerabilities and their risk assessment
**Quick Links**
- `Usecase-UI project page <https://wiki.onap.org/display/DW/Usecase+UI+Project>`_
- `Passing Badge information for Usecase-UI <https://bestpractices.coreinfrastructure.org/en/projects/1759>`_
- - `Project Vulnerability Review Table for Usecase-UI <https://wiki.onap.org/pages/viewpage.action?pageId=51282547>`_
+ - `Project Vulnerability Review Table for Usecase-UI <https://wiki.onap.org/pages/viewpage.action?pageId=51282547>`__
**Upgrade Notes**
NA
@@ -82,7 +82,7 @@ The Usecase-UI open critical security vulnerabilities and their risk assessment
**Quick Links**
- `Usecase-UI project page <https://wiki.onap.org/display/DW/Usecase+UI+Project>`_
- `Passing Badge information for Usecase-UI <https://bestpractices.coreinfrastructure.org/en/projects/1759>`_
- - `Project Vulnerability Review Table for Usecase-UI <https://wiki.onap.org/pages/viewpage.action?pageId=45285810>`_
+ - `Project Vulnerability Review Table for Usecase-UI <https://wiki.onap.org/pages/viewpage.action?pageId=45285810>`__
**Upgrade Notes**
NA
@@ -122,7 +122,7 @@ The Usecase-UI open critical security vulnerabilities and their risk assessment
**Quick Links**
- `Usecase-UI project page <https://wiki.onap.org/display/DW/Usecase+UI+Project>`_
- `Passing Badge information for Usecase-UI <https://bestpractices.coreinfrastructure.org/en/projects/1759>`_
- - `Project Vulnerability Review Table for Usecase-UI <https://wiki.onap.org/pages/viewpage.action?pageId=41419068>`_
+ - `Project Vulnerability Review Table for Usecase-UI <https://wiki.onap.org/pages/viewpage.action?pageId=41419068>`__
**Upgrade Notes**
NA