Merge "Fix vfc-lcm hw vnfname adapt"
[vfc/nfvo/lcm.git] / docs / platform / 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 service should be installed before install VF-C components.
12
13 The following scripts show the docker service install commands in centos7.
14
15 ::
16
17   yum install docker
18   systemctl enable docker.service
19   systemctl start docker.service
20
21 Steps
22 +++++
23
24 - Install MSB components.
25   
26 VF-C components need to register to MSB when starting, so MSB components should be installed first, you can ref the following link to install MSB.
27
28 http://onap.readthedocs.io/en/latest/submodules/msb/apigateway.git/docs/platform/installation.html
29
30 Note: In the following steps, we use ${MSB_IP} as the IP of msb_apigateway component.
31
32 - Install vfc-nfvo-lcm component.
33
34 ::
35
36   docker run -d --name vfc-nslcm -v /var/lib/mysql -p 8403:8403 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nslcm
37     
38 For testing, we can use curl command to access the swagger api.
39
40 ::
41
42   curl http://${MSB_IP}:80/api/nslcm/v1/swagger.json
43
44 - Install vfc-nfvo-wfengine components.
45
46 Totally, there are two docker images should be installed before you can use the workflow normally, \
47 one is wfengine-activiti for manage the original activiti service, the other is for manage engine service.
48
49
50 1. Pull related docker images
51
52 ::
53
54     docker pull $NEXUS_DOCKER_REPO/onap/vfc/wfengine-activiti:$DOCKER_IMAGE_VERSION
55     docker pull $NEXUS_DOCKER_REPO/onap/vfc/wfengine-mgrservice:$DOCKER_IMAGE_VERSION
56
57 2. Run the two docker images 
58      
59 The first container is wfengine-activiti,there are some parameters should be injected into container. \
60 OPENPALETTE_MSB_IP represents msb server address and OPENPALETTE_MSB_PORT is the relative port, \
61 SERVICE_IP represents the docker run environment server address. 
62
63 ::
64
65      docker run -i -t -d --name vfc_wfengine_activiti -p 8804:8080 -e SERVICE_IP=$OPENO_IP -e SERVICE_PORT=8804
66      -e OPENPALETTE_MSB_IP=$OPENO_IP -e OPENPALETTE_MSB_PORT=80 $NEXUS_DOCKER_REPO/onap/vfc/wfengine-activiti:$DOCKER_IMAGE_VERSION
67
68      docker run -i -t -d --name vfc_wfengine_mgrservice -p 8805:10550 -e SERVICE_IP=$OPENO_IP -e SERVICE_PORT=8805 
69      -e OPENPALETTE_MSB_IP=$OPENO_IP -e OPENPALETTE_MSB_PORT=80 $NEXUS_DOCKER_REPO/onap/vfc/wfengine-mgrservice:$DOCKER_IMAGE_VERSION
70
71 - Install vfc-nfvo-catalog component.
72
73 ::
74
75   docker run -d --name vfc-catalog -v /var/lib/mysql -p 8806:8806 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/catalog
76     
77 For testing, we can use curl command to access the swagger api.
78
79 ::
80
81   curl http://${MSB_IP}:80/api/catalog/v1/swagger.json
82
83 - Install vfc-nfvo-resmanagement component.
84
85 ::
86
87   docker run -d --name vfc-resmanagement -p 8480:8480 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/resmanagement
88     
89 For testing, we can use curl command to access the swagger api.
90
91 ::
92
93   curl http://${MSB_IP}:80/api/resmgr/v1/swagger.json
94
95 - Install vfc-nfvo-sfcdriver component.
96
97 ::
98
99   docker run -d --name vfc-ztesdncdriver -p 8411:8411 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/ztesdncdriver
100     
101 For testing, we can use curl command to access the swagger api.
102
103 ::
104
105   curl http://${MSB_IP}:80/api/ztesdncdriver/v1/swagger
106
107 - Install vfc-nfvo-emsdriver component.
108
109 ::
110
111   docker run -d --name vfc-emsdriver -p 8206:8206 -e MSB_ADDR=${MSB_IP}:80 -e VES_ADDR=${VES_COLLECTOR_IP}:8080 -e VES_AUTHINFO="":"" nexus3.onap.org:10001/onap/vfc/emsdriver
112     
113 For testing, we can use curl command to access the swagger api.
114
115 ::
116
117   curl http://${MSB_IP}:80/api/emsdriver/v1/swagger.json
118
119 - Install vfc-gvnfm components.
120
121 ::
122
123   docker run -d --name vfc-vnflcm -v /var/lib/mysql -p 8801:8801 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/vnflcm
124   docker run -d --name vfc-vnfmgr -v /var/lib/mysql -p 8803:8803 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/vnfmgr
125   docker run -d --name vfc-vnfres -v /var/lib/mysql -p 8802:8802 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/vnfres
126     
127 For testing, we can use curl command to access the swagger api.
128
129 ::
130
131   curl http://${MSB_IP}:80/api/vnflcm/v1/swagger.json
132   curl http://${MSB_IP}:80/api/vnfmgr/v1/swagger.json
133   curl http://${MSB_IP}:80/api/vnfres/v1/swagger.json
134
135 - Install vfc-gvnfmdriver components.
136
137 ::
138
139   docker run -d --name vfc-gvnfmdriver -p 8484:8484 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/gvnfmdriver
140   docker run -d --name vfc-jujudriver -p 8483:8483 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/jujudriver
141     
142 For testing, we can use curl command to access the swagger api.
143
144 ::
145
146   curl http://${MSB_IP}:80/api/gvnfmdriver/v1/swagger.json
147   curl http://${MSB_IP}:80/api/jujuvnfmdriver/v1/swagger.json
148
149 - Install vfc-svnfmdriver components.
150
151 ::
152
153   docker run -d --name vfc-ztevmanagerdriver -p 8410:8410 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/ztevmanagerdriver
154   docker run -d --name vfc-svnfm-huawei -p 8482:8482 -p 8443:8443 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/huawei
155   docker run -d --name vfc-svnfm-nokia -p 8486:8486 -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/nokia
156     
157 For testing, we can use curl command to access the swagger api.
158
159 ::
160
161   curl http://${MSB_IP}:80/api/ztevmanagerdriver/v1/swagger.json
162   curl http://${MSB_IP}:80/api/huaweivnfmdriver/v1/swagger.json
163   curl http://${MSB_IP}:80/api/nokiavnfmdriver/v1/swagger.json