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 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 -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 -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 -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-resmanagement component.
  96
  97 ::
  98
  99   docker run -d --name vfc-resmanagement -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/resmanagement
 100
 101 For testing, we can use curl command to access the swagger api.
 102
 103 ::
 104
 105   curl http://${MSB_IP}:80/api/resmgr/v1/swagger.json
 106
 107 - Install vfc-nfvo-sfcdriver component.
 108
 109 ::
 110
 111   docker run -d --name vfc-ztesdncdriver -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/ztesdncdriver
 112
 113 For testing, we can use curl command to access the swagger api.
 114
 115 ::
 116
 117   curl http://${MSB_IP}:80/api/ztesdncdriver/v1/swagger
 118
 119 - Install vfc-nfvo-emsdriver component.
 120
 121 ::
 122
 123   docker run -d --name vfc-emsdriver -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/emsdriver
 124
 125 For testing, we can use curl command to access the swagger api.
 126
 127 ::
 128
 129   curl http://${MSB_IP}:80/api/emsdriver/v1/swagger
 130
 131 - Install vfc-gvnfm components.
 132
 133 ::
 134
 135   docker run -d --name vfc-vnflcm -v /var/lib/mysql -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/vnflcm
 136   docker run -d --name vfc-vnfmgr -v /var/lib/mysql -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/vnfmgr
 137   docker run -d --name vfc-vnfres -v /var/lib/mysql -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/vnfres
 138
 139 For testing, we can use curl command to access the swagger api.
 140
 141 ::
 142
 143   curl http://${MSB_IP}:80/api/vnflcm/v1/swagger.json
 144   curl http://${MSB_IP}:80/api/vnfmgr/v1/swagger.json
 145   curl http://${MSB_IP}:80/api/vnfres/v1/swagger.json
 146
 147 - Install vfc-gvnfmdriver components.
 148
 149 ::
 150
 151   docker run -d --name vfc-gvnfmdriver -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/gvnfmdriver
 152   docker run -d --name vfc-jujudriver -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/jujudriver
 153
 154 For testing, we can use curl command to access the swagger api.
 155
 156 ::
 157
 158   curl http://${MSB_IP}:80/api/gvnfmdriver/v1/swagger.json
 159   curl http://${MSB_IP}:80/openoapi/jujuvnfm/v1/swagger.json
 160
 161 - Install vfc-svnfmdriver components.
 162
 163 ::
 164
 165   docker run -d --name vfc-ztevmanagerdriver -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/ztevmanagerdriver
 166   docker run -d --name vfc-svnfm-huawei -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/huawei
 167   docker run -d --name vfc-svnfm-nokia -e MSB_ADDR=${MSB_IP}:80 nexus3.onap.org:10001/onap/vfc/nfvo/svnfm/nokia
 168
 169 For testing, we can use curl command to access the swagger api.
 170
 171 ::
 172
 173   curl http://${MSB_IP}:80/api/ztevmanagerdriver/v1/swagger.json
 174   curl http://${MSB_IP}:80/api/hwvnfm/v1/swagger.json
 175   curl http://${MSB_IP}:80/api/nokiavnfmdriver/v1/swagger.json