diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/platform/administration.rst | 26 | ||||
| -rw-r--r-- | docs/platform/delivery.rst | 6 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 18 |
3 files changed, 50 insertions, 0 deletions
diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst index 3b9f75c8..d4a6852c 100644 --- a/docs/platform/administration.rst +++ b/docs/platform/administration.rst @@ -3,3 +3,29 @@ Administration -------------- + +It is not hard to manage Usecase-UI becasue it's been dockerized and split into two dockers. One is for UI and the other for Server. + +Processes / Dockers +^^^^^^^^^^^^^^^^^^^ + +Usecase-UI mainly consists of two dockers: + +* Usecase-UI UI Docker + +* Usecase-UI Server Docker + +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 2e359f20..30bf1d42 100644 --- a/docs/platform/delivery.rst +++ b/docs/platform/delivery.rst @@ -4,3 +4,9 @@ Delivery -------- +Describe how functions are packaged into run-time components. For some components a block diagram may be useful. +As mentioned in the architecture chapter, Usecase-UI mainly comprises two modules: the UI module and the Server module. + +* UI Docker: The main GUI for LCM and Monitor functions are performed in this module. The module provides Lifecycle CRUD operation interfaces and system alarm/performance monitor. + +* Server Docker: This module provides APIs for usecase-ui inside. Lifecycle Management and alarm/performance data Management are implemented by this module. diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index 79266801..42c7c151 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -3,3 +3,21 @@ Installation ------------ + +In case the users want to deploy Usecase-UI, the steps for the installation is as follows. + +Prerequisites +^^^^^^^^^^^^^ + +#. MSB must be installed and started. The user knows the IP address of the MSB API gateway service. + +Steps +^^^^^ + +#. Start UI module of Usecase-UI using the command below: + + ``sudo docker run -i -t -d --name uui_ui -p 8080:8080 -e MSB_ADDR=$OPENO_IP:80 nexus3.onap.org:10001/onap/usecase-ui`` + +#. Start Server module of Usecase-UI using the command below: + + ``sudo docker run -i -t -d --name uui_server -p 8082:8082 -e MSB_ADDR=$OPENO_IP:80 -e MR_ADDR=$MR_IP:3904 nexus3.onap.org:10001/onap/usecase-ui/usecase-ui-server`` |