From 19d12b2624d8d85edbc7d74e02002e2d95abc764 Mon Sep 17 00:00:00 2001 From: cristinapauna Date: Sun, 10 Mar 2019 09:01:41 +0200 Subject: add cran docs directories Change-Id: I212ff0750514d81571bc9cbd533ab1276600c2b1 Signed-off-by: weichen --- INFO.yaml | 22 +- docs/release/installation/index.rst | 11 + .../installation/installation.instruction.rst | 210 +++++++++++++++++++ docs/release/release-notes/index.rst | 11 + docs/release/release-notes/release-notes.rst | 233 +++++++++++++++++++++ docs/release/scenarios/scenario.name/index.rst | 16 ++ .../scenario.name/scenario.description.rst | 39 ++++ docs/release/userguide/feature.userguide.rst | 23 ++ docs/release/userguide/index.rst | 23 ++ 9 files changed, 577 insertions(+), 11 deletions(-) create mode 100644 docs/release/installation/index.rst create mode 100644 docs/release/installation/installation.instruction.rst create mode 100644 docs/release/release-notes/index.rst create mode 100644 docs/release/release-notes/release-notes.rst create mode 100644 docs/release/scenarios/scenario.name/index.rst create mode 100644 docs/release/scenarios/scenario.name/scenario.description.rst create mode 100644 docs/release/userguide/feature.userguide.rst create mode 100644 docs/release/userguide/index.rst diff --git a/INFO.yaml b/INFO.yaml index 87647c2..99f4b19 100644 --- a/INFO.yaml +++ b/INFO.yaml @@ -4,10 +4,10 @@ project_creation_date: '2018-07-17' project_category: 'Integration & Testing' lifecycle_state: 'Incubation' project_lead: &opnfv_cran_ptl - name: 'Rongwei Ren' + name: 'Weichen Ni' company: 'China Mobile' - email: 'renrongwei@chinamobile.com' - id: '' + email: 'niweichen@chinamobile.com' + id: 'weichen' timezone: 'China/Beijing' primary_contact: *opnfv_cran_ptl issue_tracking: @@ -34,11 +34,6 @@ repositories: - 'cran' committers: - <<: *opnfv_cran_ptl - - name: 'Pasi Vaananen' - email: 'pvaanane@redhat.com' - company: 'redhat' - id: 'pasivaan' - timezone: '' - name: 'Ulas Kozat' email: 'ulas.kozat@huawei.com' company: 'huawei' @@ -49,11 +44,13 @@ committers: company: '163' id: 'Xiaohua626' timezone: '' + - name: 'Li Baoqian' + email: 'baoqian.li@intel.com' + company: 'Intel' + id: 'Baoqian' + timezone: '' # Azhar Sayeed # Tapio Tallgren - # Ren Rongwei renrongwei@chinamobile.com - # Li Baoqian baoqian.li@intel.com - # Ni weichen # Invitations not yet accepted ^ tsc: # yamllint disable rule:line-length @@ -62,3 +59,6 @@ tsc: - type: 'PTL' name: 'Rongwei Ren' link: 'https://lists.opnfv.org/g/opnfv-tech-discuss/topic/23021807#21533' + - type: 'PTL' + name: 'Weichen Ni' + link: 'https://lists.opnfv.org/g/opnfv-tech-discuss/message/22737' diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst new file mode 100644 index 0000000..603a601 --- /dev/null +++ b/docs/release/installation/index.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +*************************************** + Installation Instruction +*************************************** + +.. toctree:: + :maxdepth: 1 + + installation.instruction diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst new file mode 100644 index 0000000..af767ee --- /dev/null +++ b/docs/release/installation/installation.instruction.rst @@ -0,0 +1,210 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======== +Abstract +======== + +This document describes how to install raletive subproject, it's dependencies and required system resources. + +.. contents:: + :depth: 3 + :local: + +Version history +--------------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-03-19 | 0.1.0 | Weichen Ni | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | | | | +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + + +Introduction +============ + + +: + +This document describes the supported software and hardware configurations for the +Fuel OPNFV reference platform as well as providing guidelines on how to install and +configure such reference system. + +Although the available installation options gives a high degree of freedom in how the system is set-up, +with what architecture, services and features, etc., not nearly all of those permutations provides +a OPNFV compliant reference architecture. Following the guidelines in this document ensures +a result that is OPNFV compliant. + +The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. + + +Preface +======= + + +: + +Before starting the installation of Fuel@OPNFV, some planning must preceed. + +First of all, the Fuel@OPNFV .iso image needs to be retrieved, +the Latest stable Arno release of Fuel@OPNFV can be found here: + +Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: +@gerrit.opnf.org/gerrit/genesis> +Check-out the Arno release: + +Goto the fuel directory and build the .iso + + +Familiarize yourself with the Fuel 6.0.1 version by reading the following documents: +- abc +- def +- ghi + +Secondly, a number of deployment specific parameters must be collected, those are: + +1. Provider sub-net and gateway information + +2. Provider VLAN information + +3. Provider DNS addresses + +4. Provider NTP addresses + +This information will be needed for the configuration procedures provided in this document. + + +Hardware requirements +===================== + + +: + +Following minimum hardware requirements must be met for installation of Fuel@OPNFV: + ++--------------------+----------------------------------------------------+ +| **HW Aspect** | **Requirement** | +| | | ++--------------------+----------------------------------------------------+ +| **# of servers** | Minimum 5 (3 for non redundant deployment) | +| | 1 Fuel deployment master (may be virtualized) | +| | 3(1) Controllers | +| | 1 Compute | ++--------------------+----------------------------------------------------+ +| **CPU** | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz | +| | | ++--------------------+----------------------------------------------------+ +| **RAM** | Minimum 16GB/server (Depending on VNF work load) | +| | | ++--------------------+----------------------------------------------------+ +| **Disk** | Minimum 256GB 10kRPM spinning disks | +| | | ++--------------------+----------------------------------------------------+ +| **NICs** | 2(1)x10GE Niantec for Private/Public (Redundant) | +| | | +| | 2(1)x10GE Niantec for SAN (Redundant) | +| | | +| | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) | +| | | ++--------------------+----------------------------------------------------+ + + +Top of the rack (TOR) Configuration requirements +================================================ + + +: + +The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as +for the tenant networks (East/West) and provider connectivity (North/South bound connectivity). +The switching connectivity can (but does not need to) be fully redundant, +in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as +a 1GE switch pair for "infrastructure control-, management and administration" + +The switches are **not** automatically configured from the OPNFV reference platform. +All the networks involved in the OPNFV infra-structure as well as the provider networks +and the private tenant VLANs needs to be manually configured. + +This following sections guides through required black-box switch configurations. + +VLAN considerations and blue-print +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +IP Address plan considerations and blue-print +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +OPNFV Software installation and deployment +========================================== + + +: + +This section describes the installation of the Fuel@OPNFV installation server (Fuel master) +as well as the deployment of the full OPNFV reference platform stack across a server cluster. +Etc. + +Install Fuel master +^^^^^^^^^^^^^^^^^^^^^ + +Create an OPNV (Fuel Environment) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Configure the OPNFV environment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Deploy the OPNFV environment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +Installation health-check +========================= + + +: + +Now that the OPNFV environment has been created, and before the post installation configurations is started, +perform a system health check from the Fuel GUI: + +- Select the "Health check" TAB. +- Select all test-cases +- And click "Run tests" + +All test cases except the following should pass: + +Post installation and deployment actions +------------------------------------------ + + +: +After the OPNFV deployment is completed, the following manual changes needs to be performed in order +for the system to work according OPNFV standards. + +**Change host OS password:** +Change the Host OS password by...... + + +References +========== + + +: + +OPNFV +^^^^^^^^^^ + +OpenStack +^^^^^^^^^^^ + +OpenDaylight +^^^^^^^^^^^^^^^ diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..120d5ea --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +**************************** + Release Notes +**************************** + +.. toctree:: + :maxdepth: 1 + + release-notes diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..2a0c198 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,233 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +This document provides the release notes for of . + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-03-19 | 0.1.0 | Weichen Ni | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +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 + + +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...... + + +Release Data +============ + + +: + ++--------------------------------------+--------------------------------------+ +| **Project** | E.g. Arno/genesis/fuel@opnfv | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | E.g. Arno RC2 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | E.g. 2015-04-16 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance| +| | | ++--------------------------------------+--------------------------------------+ + +Version change +^^^^^^^^^^^^^^^^ + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +: + +- Fuel have changed from 5.1 to 6.0.1 + +- OpenDaylight has changed from Helium-SR1 to Helium-SR2 + +Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +: + +- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2 + +Reason for version +^^^^^^^^^^^^^^^^^^^^ +Feature additions +~~~~~~~~~~~~~~~~~~~~~~~ + + +: + +**JIRA BACK-LOG:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-123 | ADD OpenDaylight ml2 integration | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-456 | Add auto-deployment of Fuel@OPNFV | +| | | ++--------------------------------------+--------------------------------------+ + +Bug corrections +~~~~~~~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-888 | Fuel doesn't deploy | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-999 | Floating IP doesn't work | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +---------------- + +Software deliverables +^^^^^^^^^^^^^^^^^^^^^^^ + + + +: + +Documentation deliverables +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + + +: + + +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:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-987 | Nova-compute process does | +| | not re-spawn when killed | +| | | ++--------------------------------------+--------------------------------------+ +| BGS-654 | MOS 5.1 : neutron net-list returns | +| | "400 Bad request" | +| | | ++--------------------------------------+--------------------------------------+ + +Workarounds +^^^^^^^^^^^^^^^^^ + + + +: + +- In case the contact with a compute is lost - restart the compute host +- In case the disk is full on a controller - delete all files in /tmp + +Test Result +=========== + + +: + +Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: + ++--------------------------------------+--------------------------------------+ +| **TEST-SUITE** | **Results:** | +| | | ++--------------------------------------+--------------------------------------+ +| Tempest test suite 123 | Following tests failed: | +| | | +| | 1. Image resizing.... | +| | | +| | 2. Heat deploy.... | ++--------------------------------------+--------------------------------------+ +| Robot test suite 456 | Following tests failed: | +| | | +| | 1....... | +| | | +| | 2....... | ++--------------------------------------+--------------------------------------+ + +References +========== + + +: + +For more information on the OPNFV Danube release, please see: + +http://opnfv.org/danube diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst new file mode 100644 index 0000000..a424358 --- /dev/null +++ b/docs/release/scenarios/scenario.name/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +**************************************** + overview and description +**************************************** +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 1 + + scenario.description + diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 0000000..858a569 --- /dev/null +++ b/docs/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,39 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +This document provides scenario level details for of . + +.. contents:: + :depth: 3 + :local: + +============ +Introduction +============ +.. In this section explain the purpose of the scenario and the types of capabilities provided + +Scenario components and composition +=================================== +.. In this section describe the unique components that make up the scenario, +.. what each component provides and why it has been included in order +.. to communicate to the user the capabilities available in this scenario. + +Scenario usage overview +======================= +.. Provide a brief overview on how to use the scenario and the features available to the +.. user. This should be an "introduction" to the userguide document, and explicitly link to it, +.. where the specifics of the features are covered including examples and API's + +Limitations, Issues and Workarounds +=================================== +.. Explain scenario limitations here, this should be at a design level rather than discussing +.. faults or bugs. If the system design only provide some expected functionality then provide +.. some insight at this point. + +References +========== + +For more information on the OPNFV Danube release, please visit +http://www.opnfv.org/danube + diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..6d64ebb --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +.. contents:: + :depth: 3 + :local: + + description +===================== +.. Describe the specific features and how it is realised in the scenario in a brief manner +.. to ensure the user understand the context for the user guide instructions to follow. + + capabilities and usage +================================ +.. Describe the specific capabilities and usage for feature. +.. Provide enough information that a user will be able to operate the feature on a deployed scenario. + + +============================================== +.. Describe with examples how to use specific features, provide API examples and details required to +.. operate the feature on the platform. + diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..4563406 --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,23 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + +===================== + User Guide +===================== + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 1 + + feature.userguide +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + + -- cgit 1.2.3-korg