c48a121d042a9fdb3056515feb6cf5b1c2d68dff
[vfc/nfvo/lcm.git] / docs / installation.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 VF-C Installation
5 -----------------
6 Describe the environment and steps to install VF-C components.
7
8
9 Environment
10 +++++++++++
11 VF-C components can run as docker, docker server should be installed before install VF-C components.
12
13 Steps
14 +++++
15
16 - First, MSB components should be installed, you can ref the following link to install MSB.
17
18   http://onap.readthedocs.io/en/latest/submodules/msb/apigateway.git/docs/platform/installation.html
19
20 - Install vfc-nfvo-lcm component.
21
22 ::
23
24   docker run -d --name vfc-nslcm -v /var/lib/mysql -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nslcm
25     
26   For testing, we can use curl command to access the swagger api.
27
28 ::
29
30   curl http://${MSB_IP}:80/api/nslcm/v1/swagger.json
31
32 - Install vfc-nfvo-wfengine components.
33
34   Totally, there are two docker images should be installed before you can use the workflow normally, \
35   one is wfengine-activiti for manage the original activiti service, the other is for manage engine service.
36   
37   1. Pull related docker images
38
39 ::
40
41   docker pull $NEXUS_DOCKER_REPO/onap/vfc/wfengine-activiti:$DOCKER_IMAGE_VERSION
42   docker pull $NEXUS_DOCKER_REPO/onap/vfc/wfengine-mgrservice:$DOCKER_IMAGE_VERSION
43
44   2. Run the two docker images 
45      
46      The first container is wfengine-activiti,there are some parameters should be injected into container. \
47      OPENPALETTE_MSB_IP represents msb server address and OPENPALETTE_MSB_PORT is the relative port, \
48      SERVICE_IP represents the docker run environment server address. 
49
50 ::
51
52   docker run -i -t -d --name vfc_wfengine_activiti -p 8804:8080 -e SERVICE_IP=$OPENO_IP -e SERVICE_PORT=8804 \
53   -e OPENPALETTE_MSB_IP=$OPENO_IP -e OPENPALETTE_MSB_PORT=80 $NEXUS_DOCKER_REPO/onap/vfc/wfengine-activiti:$DOCKER_IMAGE_VERSION
54   docker run -i -t -d --name vfc_wfengine_mgrservice -p 8805:10550 -e SERVICE_IP=$OPENO_IP -e SERVICE_PORT=8805 \
55   -e OPENPALETTE_MSB_IP=$OPENO_IP -e OPENPALETTE_MSB_PORT=80 $NEXUS_DOCKER_REPO/onap/vfc/wfengine-mgrservice:$DOCKER_IMAGE_VERSION
56