docs/release/installation/installation.instruction.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
   5 Parser tosca2heat Installation
   6 ==============================
   7
   8 Please follow the below installation steps to install tosca2heat submodule in parser.
   9
  10 Step 1: Clone the parser project.
  11
  12 .. code-block:: bash
  13
  14     git clone https://gerrit.opnfv.org/gerrit/parser
  15
  16 Step 2: Install the heat-translator sub project.
  17
  18 .. code-block:: bash
  19
  20     # uninstall pre-installed tosca-parser
  21     pip uninstall -y heat-translator
  22
  23     # change directory to heat-translator
  24     cd parser/tosca2heat/heat-translator
  25
  26     # install requirements
  27     pip install -r requirements.txt
  28
  29     # install heat-translator
  30     python setup.py install
  31
  32 Step 3: Install the tosca-parser sub project.
  33
  34 .. code-block:: bash
  35
  36     # uninstall pre-installed tosca-parser
  37     pip uninstall -y tosca-parser
  38
  39     # change directory to tosca-parser
  40     cd parser/tosca2heat/tosca-parser
  41
  42     # install requirements
  43     pip install -r requirements.txt
  44
  45     # install tosca-parser
  46     python setup.py install
  47
  48
  49 **Notes**: It must uninstall pre-installed tosca-parser and heat-translator before install the two
  50 components, and install heat-translator before installing tosca-parser, which is sure to use the
  51 OPNFV version of tosca-parser and heat-translator other than openstack's components.
  52
  53
  54 Parser yang2tosca Installation
  55 ==============================
  56 Parser yang2tosca requires the following to be installed.
  57
  58 Step 1: Clone the parser project.
  59
  60 .. code-block:: bash
  61
  62    git clone https://gerrit.opnfv.org/gerrit/parser
  63
  64 Step 2: Clone pyang tool or download the zip file from the following link.
  65
  66 .. code-block:: bash
  67
  68     git clone https://github.com/mbj4668/pyang.git
  69
  70 OR
  71
  72 .. code-block:: bash
  73
  74     wget https://github.com/mbj4668/pyang/archive/master.zip
  75
  76 Step 3: Change directory to the downloaded directory and run the setup file.
  77
  78 .. code-block:: bash
  79
  80     cd pyang
  81     python setup.py
  82
  83 Step 4: install python-lxml
  84 ---------------------------
  85
  86 Please follow the below installation link. http://lxml.de/installation.html
  87
  88
  89 Parser policy2tosca installation
  90 ================================
  91
  92 Please follow the below installation steps to install parser - POLICY2TOSCA.
  93
  94 Step 1: Clone the parser project.
  95
  96 .. code-block:: bash
  97
  98    git clone https://gerrit.opnfv.org/gerrit/parser
  99
 100 Step 2: Install the policy2tosca module.
 101
 102 .. code-block:: bash
 103
 104    cd parser/policy2tosca
 105    python setup.py install
 106
 107
 108 Parser verigraph installation
 109 =============================
 110
 111 In the present release, verigraph requires that the following software is also installed:
 112
 113 - Java 1.8 (with javac compiler)
 114 - Apache Tomcat 8
 115 - Microsoft Z3 (https://github.com/Z3Prover/bin/tree/master/releases)
 116 - Neo4J (https://neo4j.org)
 117
 118 Please follow the below installation steps to install verigraph.
 119
 120 Step 1: Clone the parser project.
 121
 122 .. code-block:: bash
 123
 124    git clone https://gerrit.opnfv.org/gerrit/parser
 125
 126 Step 2: Go to the verigraph directory.
 127
 128 .. code-block:: bash
 129
 130    cd parser/verigraph
 131
 132 Step3: Follow the instructions in README.rst for downloading verigraph
 133 dependencies and for installing verigraph.
 134
 135
 136 Parser apigateway Installation
 137 ==============================
 138
 139 In the present release, apigateway requires that the following software is also installed:
 140
 141  - grpcio (https://github.com/golang/protobuf/protoc-gen-go)
 142
 143 Please follow the below installation steps to install apigateway submodule in parser.
 144
 145 Step 1: Clone the parser project.
 146
 147 .. code-block:: bash
 148
 149     git clone https://gerrit.opnfv.org/gerrit/parser
 150
 151 Step 2: Install the apigateway submodule.
 152
 153 .. code-block:: bash
 154
 155     # change directory to apigateway
 156     cd parser/apigateway
 157
 158     # install requirements
 159     pip install -r requirements.txt
 160
 161     # install apigateway
 162     python setup.py install
 163
 164 **Notes**: In release D, apigateway submodule is only initial framework code, and more feature will
 165 be provided in the next release.