From e243c1f9c40c5acee4fb89d99fae05f7a46768be Mon Sep 17 00:00:00 2001 From: zhipengh Date: Mon, 27 Feb 2017 04:26:21 -0500 Subject: Release D doc update Change-Id: I6b2749e5692cf6af2615ff5aff81ff060a1a25d3 Signed-off-by: zhipengh --- .../feature.configuration.rst | 9 --- docs/installationprocedure/featureconfig.rst | 20 ------ docs/installationprocedure/index.rst | 26 -------- docs/installationprocedure/installerconfig.rst | 76 ---------------------- docs/installationprocedure/policy2tosca.rst | 44 ------------- docs/installationprocedure/yang2tosca.rst | 58 ----------------- 6 files changed, 233 deletions(-) delete mode 100644 docs/installationprocedure/feature.configuration.rst delete mode 100644 docs/installationprocedure/featureconfig.rst delete mode 100644 docs/installationprocedure/index.rst delete mode 100644 docs/installationprocedure/installerconfig.rst delete mode 100644 docs/installationprocedure/policy2tosca.rst delete mode 100644 docs/installationprocedure/yang2tosca.rst (limited to 'docs/installationprocedure') diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst deleted file mode 100644 index 86d7dfa..0000000 --- a/docs/installationprocedure/feature.configuration.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - .. (c) - - -Abstract -======== -This document provides information on how to configure required -components during the installation of the platform. diff --git a/docs/installationprocedure/featureconfig.rst b/docs/installationprocedure/featureconfig.rst deleted file mode 100644 index dc4fc50..0000000 --- a/docs/installationprocedure/featureconfig.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -Parser configuration -===================== -Parser can be configured with any installer in current OPNFV, it only depends on -openstack. - -Pre-configuration activities ----------------------------- -For parser, there is not specific pre-configuration activities. - -Hardware configuration ----------------------- -For parser, there is not hardware configuration needed for any current feature. - -Feature configuration ---------------------- -For parser, there is not specific configure on openstack. diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index 1eb7461..0000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -******************************************** -Parser Configuration and Configuration Guide -******************************************** -Parser is an open source project and licensed under Apache 2. Parser will help -to provide a tooling mechanism, by parsing and then further translating Telecom -operators deployment descriptors into certain common templates, which could be -used in IaaS orchestration projects like OpenStack Heat(the template file is HOT, -which stands for Heat Orchestrator Template). - -This document contains configuration guide for Parser's three submodules: tosca2heat, -yang2tosca and policy2tosca. Users please refer to user guide for installation and execution -which usually happens after configuration. - - - -.. toctree:: - :numbered: - :maxdepth: 2 - -.. include:: featureconfig.rst -.. include:: installerconfig.rst diff --git a/docs/installationprocedure/installerconfig.rst b/docs/installationprocedure/installerconfig.rst deleted file mode 100644 index 1f796b2..0000000 --- a/docs/installationprocedure/installerconfig.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - -Parser general configuration -===================== -Parser can be configured with any installer in current OPNFV. - -Pre-configuration activities ------------------------------ -For parser, there is not specific pre-configuration activities. - -Hardware configuration ------------------------ -For parser, there is not hardware configuration needed for this specific installer. - -Jumphost configuration ------------------------ -For parser, there is not intial Jumphost configuration (network and software)needed in order -to deploy any installer. - - -Parser tosca2heat configuration -===================== -For tosca2heat components(tosca-parser and heat-translator) in parser,there are not specific -configuration of each component in installer. - - -Parser yang2tosca configuration -===================== -Parser yang2tosca requires the following to be installed. - -1. PYANG --------- - -Please follow the below installation steps. - -Step 1: Clone pyang tool or download the zip file from the following link. - -.. code-block:: bash - - git clone https://github.com/mbj4668/pyang.git - -OR - -.. code-block:: bash - - wget https://github.com/mbj4668/pyang/archive/master.zip - -Step 2: Change directory to the downloaded directory and run the setup file. - -.. code-block:: bash - - cd pyang - python setup.py - -2. python-lxml --------------- - -Please follow the below installation link. http://lxml.de/installation.html - - -Parser policy2tosca configuration -============================ -Parser - POLICY2TOSCA requires the following to be installed. - -1. cliff --------- - -Install cliff with the following links. -:: -- `install ` -or -- `demoapp - - diff --git a/docs/installationprocedure/policy2tosca.rst b/docs/installationprocedure/policy2tosca.rst deleted file mode 100644 index d6e2348..0000000 --- a/docs/installationprocedure/policy2tosca.rst +++ /dev/null @@ -1,44 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -Prerequisites -============= - -Parser - POLICY2TOSCA requires the following to be installed. - -1. cliff --------- - -Install cliff with the following links. -:: -- `install ` -or -- `demoapp ` - -Installation -============================ - -Please follow the below installation steps to install parser - POLICY2TOSCA. - -Step 1: Clone the parser project. - -.. code-block:: bash - - git clone https://gerrit.opnfv.org/gerrit/parser - -Step 2: Install the policy2tosca module. - -.. code-block:: bash - - cd parser/policy2tosca - python setup.py install diff --git a/docs/installationprocedure/yang2tosca.rst b/docs/installationprocedure/yang2tosca.rst deleted file mode 100644 index 8f4ef91..0000000 --- a/docs/installationprocedure/yang2tosca.rst +++ /dev/null @@ -1,58 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -Prerequisites -============= - -Parser requires the following to be installed. - -1. PYANG --------- - -Please follow the below installation steps. - -Step 1: Clone pyang tool or download the zip file from the following link. - -.. code-block:: bash - - git clone https://github.com/mbj4668/pyang.git - -OR - -.. code-block:: bash - - wget https://github.com/mbj4668/pyang/archive/master.zip - -Step 2: Change directory to the downloaded directory and run the setup file. - -.. code-block:: bash - - cd pyang - python setup.py - -2. python-lxml --------------- - -Please follow the below installation link. http://lxml.de/installation.html - - -Installation -============================ - -Please follow the below installation steps to install parser. - -Step 1: Clone the parser project. - -.. code-block:: bash - - git clone https://gerrit.opnfv.org/gerrit/parser -- cgit 1.2.3-korg