From c09ba66cc51c4db17503f79c05ea0b0cd0626596 Mon Sep 17 00:00:00 2001 From: zhipengh Date: Mon, 6 Mar 2017 16:16:45 +0800 Subject: Danube Release Docs Fixup patch 2 This patch provide an initial content for the docs/ release/release-notes.rst file. Further work needed. Remove policy2tosca and yang2tosca doc files in the code folder, move tosca2heat diff files to release folder. Remove all the tosca2heat original upstream rst docs due to CI failures Change-Id: I789102a7974b5ac79445f90e08e3f8252e0f4169 Signed-off-by: zhipengh --- docs/developer/requirements/index.rst | 4 + .../parser requirement arno release.rst | 19 ---- .../parser_requirement_arno_release.rst | 19 ++++ docs/release/release-notes/diff_file_list.rst | 110 +++++++++++++++++++++ docs/release/release-notes/release-notes.rst | 88 ++++++----------- 5 files changed, 165 insertions(+), 75 deletions(-) delete mode 100644 docs/developer/requirements/parser requirement arno release.rst create mode 100644 docs/developer/requirements/parser_requirement_arno_release.rst create mode 100644 docs/release/release-notes/diff_file_list.rst (limited to 'docs') diff --git a/docs/developer/requirements/index.rst b/docs/developer/requirements/index.rst index 7eddaae..e4fde57 100644 --- a/docs/developer/requirements/index.rst +++ b/docs/developer/requirements/index.rst @@ -8,4 +8,8 @@ OPNFV Parser Danube Requirements .. toctree:: :maxdepth: 1 + parser_requirement_arno_release + + + diff --git a/docs/developer/requirements/parser requirement arno release.rst b/docs/developer/requirements/parser requirement arno release.rst deleted file mode 100644 index 96d1d38..0000000 --- a/docs/developer/requirements/parser requirement arno release.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -***************************************** -OPNFV Parser Requirements In Arno Release -***************************************** - -.. contents:: - :depth: 3 - :local: - -Use Case Description ---------------- - -* When Operators want to do automation on utilizing VIM to manage hypervisor -level accelerators which VNFs don't have knowledge of, certain templates -would be deployed and Parser would be used if operator defined template could -not be supported by VIM automation/orchestration tools directly. - diff --git a/docs/developer/requirements/parser_requirement_arno_release.rst b/docs/developer/requirements/parser_requirement_arno_release.rst new file mode 100644 index 0000000..96d1d38 --- /dev/null +++ b/docs/developer/requirements/parser_requirement_arno_release.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +***************************************** +OPNFV Parser Requirements In Arno Release +***************************************** + +.. contents:: + :depth: 3 + :local: + +Use Case Description +--------------- + +* When Operators want to do automation on utilizing VIM to manage hypervisor +level accelerators which VNFs don't have knowledge of, certain templates +would be deployed and Parser would be used if operator defined template could +not be supported by VIM automation/orchestration tools directly. + diff --git a/docs/release/release-notes/diff_file_list.rst b/docs/release/release-notes/diff_file_list.rst new file mode 100644 index 0000000..48faaa7 --- /dev/null +++ b/docs/release/release-notes/diff_file_list.rst @@ -0,0 +1,110 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +=================================== +1. tosca-parser difference list +=================================== + +[modified] tosca-parser/toscaparser/elements/nodetype.py +[modified] tosca-parser/toscaparser/elements/TOSCA_definition_1_0.yaml +[modified] tosca-parser/toscaparser/elements/tosca_type_validation.py +[new file] tosca-parser/toscaparser/extensions/nfv/tests/data/vRNC/Definitions/vRNC.yaml +[new file] tosca-parser/toscaparser/extensions/nfv/tests/data/vRNC/Definitions/rnc_definition.yaml +[new file] tosca-parser/toscaparser/extensions/nfv/tests/data/vRNC/TOSCA-Metadata/TOSCA.meta +[new file] tosca-parser/toscaparser/extensions/nfv/tests/data/vRNC/README.txt +[new file] tosca-parser/toscaparser/extensions/nfv/tests/test_tosca_vRNC.py +[modified] tosca-parser/toscaparser/tests/data/functions/test_get_property_with_host.yaml +[new file] tosca-parser/toscaparser/tests/data/topology_template/databasesubsystem.yaml +[modified] tosca-parser/toscaparser/tests/data/topology_template/definitions.yaml +[new file] tosca-parser/toscaparser/tests/data/topology_template/queuingsubsystem.yaml +[del file] tosca-parser/toscaparser/tests/data/topology_template/subsystem.yaml +[modified] tosca-parser/toscaparser/tests/data/topology_template/system.yaml +[new file] tosca-parser/toscaparser/tests/data/topology_template/transactionsubsystem.yaml +[modified] tosca-parser/toscaparser/tests/data/test_tosca_normative_type_by_shortname.yaml +[modified] tosca-parser/toscaparser/tests/data/tosca_single_instance_wordpress.yaml +[modified] tosca-parser/toscaparser/tests/data/tosca_single_instance_wordpress_with_local_abspath_import.yaml +[modified] tosca-parser/toscaparser/tests/data/tosca_single_instance_wordpress_with_url_import.yaml +[modified] tosca-parser/toscaparser/tests/test_functions.py +[modified] tosca-parser/toscaparser/tests/test_topology_template.py +[modified] tosca-parser/toscaparser/tests/test_toscatpl.py +[modified] tosca-parser/toscaparser/tests/test_toscatplvalidation.py +[modified] tosca-parser/toscaparser/imports.py +[modified] tosca-parser/toscaparser/nodetemplate.py +[modified] tosca-parser/toscaparser/parameters.py +[new file] tosca-parser/toscaparser/substitution_mappings.py +[modified] tosca-parser/toscaparser/topology_template.py +[modified] tosca-parser/toscaparser/tosca_template.py +[modified] tosca-parser/MANIFEST.in +[modified] tosca-parser/tox.ini + + +=================================== +2. heat-translator difference list +=================================== + +[modified] heat-translator/translator/hot/syntax/hot_resource.py +[modified] heat-translator/translator/hot/tosca/tests/test_tosca_compute.py +[modified] heat-translator/translator/hot/tosca/tests/test_tosca_policies.py +[modified] heat-translator/translator/hot/tosca/tosca_compute.py +[modified] heat-translator/translator/hot/tosca/tosca_network_network.py +[modified] heat-translator/translator/hot/tosca/tosca_policies_antilocate.py +[modified] heat-translator/translator/hot/tosca/tosca_policies_colocate.py +[modified] heat-translator/translator/hot/translate_node_templates.py +[modified] heat-translator/translator/tests/data/hot_output/network/hot_custom_network_nodes.yaml +[modified] heat-translator/translator/tests/data/hot_output/network/hot_one_server_one_network.yaml +[modified] heat-translator/translator/tests/data/hot_output/network/hot_one_server_three_networks.yaml +[modified] heat-translator/translator/tests/data/hot_output/network/hot_server_on_existing_network.yaml +[modified] heat-translator/translator/tests/data/hot_output/network/hot_two_servers_one_network.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_blockstorage_with_attachment.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_blockstorage_with_attachment_notation1_alt1.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_blockstorage_with_attachment_notation1_alt2.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_blockstorage_with_attachment_notation2_alt1.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_blockstorage_with_attachment_notation2_alt2.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_blockstorage_with_custom_relationship_type.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_blockstorage_with_relationship_template.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_multiple_blockstorage_with_attachment_alt1.yaml +[modified] heat-translator/translator/tests/data/hot_output/storage/hot_multiple_blockstorage_with_attachment_alt2.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_artifact.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_custom_type.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_custom_type_with_override.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_custom_type_with_param_override.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_elk.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_elk_from_csar.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_flavor_and_image.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_flavor_and_image_params.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_hello_world.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_hello_world_userkey.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_hello_world_userkey.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_nfv_sample.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_nodejs_mongodb_two_instances.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_policies.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_script_types.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_single_instance_wordpress.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_single_instance_wordpress_from_csar.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_single_server.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_single_server_with_defaults_with_input.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_single_server_with_defaults_without_input.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_single_server_without_tosca_os_version.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_software_component.yaml +[new file] heat-translator/translator/tests/data/hot_output/hot_vRNC.yaml +[modified] heat-translator/translator/tests/data/hot_output/hot_web_application.yaml +[new file] heat-translator/translator/tests/data/vRNC/Definitions/rnc_definition.yaml +[new file] heat-translator/translator/tests/data/vRNC/Definitions/vRNC.yaml +[new file] heat-translator/translator/tests/data/vRNC/Scripts/MM/mm_active_configure.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/MM/mm_passivtiv_configure.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/MM/mm_install.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/MM/mm_storage_configure.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/CM/cm_active_configure.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/CM/cm_passivtiv_configure.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/CM/cm_install.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/DM/dm_configure.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/DM/dm_install.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/LB/lb_configure.sh +[new file] heat-translator/translator/tests/data/vRNC/Scripts/LB/lb_install.sh +[new file] heat-translator/translator/tests/data/vRNC/TOSCA-Metadata/TOSCA.meta +[new fiel] heat-translator/translator/tests/data/vRNC/README.txt +[modified] heat-translator/translator/tests/data/test_tosca_nfv_sample.yaml +[modified] heat-translator/translator/tests/test_shell.py +[modified] heat-translator/translator/shell.py +[modified] heat-translator/MANIFEST.in +[modified] heat-translator/tox.ini diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index ead095c..0503fd4 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 -This document provides the release notes for of . +This document provides the release notes for of . .. contents:: :depth: 3 @@ -16,58 +16,50 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | +| 2017-03-06 | 1.0 | Howard Huang | Danube Release | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | +| | | | | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | +| | | | | | | | | | +--------------------+--------------------+--------------------+--------------------+ Important notes =============== - - -: - -**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master - -see the OPNFV@Fuel SW installation instructions +**Attention:** Parser's submodules should be installed independantly from OPNFV platform, for instructions please +refer to the installation documention. Summary ======= - - -: - -Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1, -but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations...... +OPNFV Parser Danube release has provides four submodules to serve as translation/prevalidation tools: tosca2heat, yang2tosca, +policy2tosca, and verigraph. Specifically, tosca2heat module provides an integration of OpenStack tosca-parser and heat-translater +upstream projects 0.7 release with additional Parser unique features. Release Data ============ - -: +--------------------------------------+--------------------------------------+ -| **Project** | E.g. Arno/genesis/fuel@opnfv | +| **Project** | OPNFV Parser | | | | +--------------------------------------+--------------------------------------+ -| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | +| **Repo/commit-ID** | | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | E.g. Arno RC2 | +| **Release designation** | Danube 1.0 | | | | +--------------------------------------+--------------------------------------+ | **Release date** | E.g. 2015-04-16 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance| +| **Purpose of the delivery** | OPNFV Template Translation/Prevalida-| +| | tion tooling | | | | +--------------------------------------+--------------------------------------+ @@ -76,21 +68,17 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -: +- OpenStack tosca-parser and heat-translator have changed from 0.6 to 0.7 -- Fuel have changed from 5.1 to 6.0.1 +- new verigraph module -- OpenDaylight has changed from Helium-SR1 to Helium-SR2 +- no feature changes in yang2tosca and policy2tosca since Colorado Release. Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -: -- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2 +- Parser Dabube Release documentation has adoped a new format. Reason for version ^^^^^^^^^^^^^^^^^^^^ @@ -130,47 +118,37 @@ Bug corrections +--------------------------------------+--------------------------------------+ Deliverables ----------------- +------------ Software deliverables -^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^ - - -: +- tosca2heat +- yang2tosca +- policy2tosca +- verigraph Documentation deliverables -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - +^^^^^^^^^^^^^^^^^^^^^^^^^^ -: +- release document +- design document +- development document +- testing document Known Limitations, Issues and Workarounds ========================================= System Limitations -^^^^^^^^^^^^^^^^^^^^ - +^^^^^^^^^^^^^^^^^^ -: -**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades -**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade - -**Storage:** Ceph is the only supported storage configuration. - -**Max number of networks:** 3800 (Needs special switch config.) - -**L3Agent:** L3 agent and floating IPs is not supported. Known issues -^^^^^^^^^^^^^^^ - +^^^^^^^^^^^^ -: **JIRA TICKETS:** @@ -188,7 +166,7 @@ Known issues +--------------------------------------+--------------------------------------+ Workarounds -^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^ @@ -224,9 +202,7 @@ Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: References ========== - -: For more information on the OPNFV Danube release, please see: -- cgit 1.2.3-korg