README.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. (c) 2018 Ericsson AB, Mirantis Inc., Enea AB and others.
   4
   5 ==========
   6 OPNFV Fuel
   7 ==========
   8
   9 |docs|
  10
  11 .. |docs| image:: https://readthedocs.org/projects/opnfv-fuel/badge/?version=latest
  12     :alt: OPNFV Fuel Documentation Status
  13     :scale: 100%
  14     :target: https://opnfv-fuel.readthedocs.io/en/latest/?badge=latest
  15
  16 Description
  17 ===========
  18
  19 This is the OPNFV Hunter release that implements the deploy stage of the
  20 OPNFV CI pipeline via Fuel.
  21
  22 Fuel is based on the `MCP`_ installation tool chain.
  23 More information available at `Mirantis Cloud Platform Documentation`_.
  24
  25 The goal of the Fuel deployment process is to establish a lab ready platform
  26 accelerating further development of the OPNFV infrastructure.
  27
  28 Release Notes
  29 =============
  30
  31 - `OPNFV Fuel Release Notes on RTD`_
  32
  33 Installation
  34 ============
  35
  36 - `OPNFV Fuel Installation Instruction on RTD`_
  37
  38 Usage
  39 =====
  40
  41 - `OPNFV Fuel User Guide on RTD`_
  42
  43 Scenarios
  44 =========
  45
  46 - `OPNFV Fuel Scenarios on RTD`_
  47
  48 Contributing
  49 ============
  50
  51 - `OPNFV Fuel Contributing`_
  52
  53 Support
  54 =======
  55
  56 - `OPNFV Fuel Wiki Page`_
  57 - `OPNFV Community Support mailing list`_
  58 - `OPNFV Technical Discussion mailing list`_
  59
  60 LICENSE
  61 =======
  62
  63 | This document is protected/licensed under the following conditions
  64 | (c) Jonas Bjurel (Ericsson AB)
  65 | Licensed under a Creative Commons Attribution 4.0 International License.
  66 | You should have received a copy of the license along with this work.
  67 | If not, see <https://creativecommons.org/licenses/by/4.0/>.
  68
  69 Open Platform for NFV Project Software Licence
  70 ----------------------------------------------
  71
  72 | Any software developed by the "Open Platform for NFV" Project is licenced under the
  73 | Apache License, Version 2.0 (the "License");
  74 | you may not use the content of this software bundle except in compliance with the License.
  75 | You may obtain a copy of the License at <https://www.apache.org/licenses/LICENSE-2.0>
  76 |
  77 | Unless required by applicable law or agreed to in writing, software
  78 | distributed under the License is distributed on an "AS IS" BASIS,
  79 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  80 | See the License for the specific language governing permissions and
  81 | limitations under the License.
  82
  83 Open Platform for NFV Project Documentation Licence
  84 ---------------------------------------------------
  85
  86 | Any documentation developed by the "Open Platform for NFV Project"
  87 | is licensed under a Creative Commons Attribution 4.0 International License.
  88 | You should have received a copy of the license along with this. If not,
  89 | see <https://creativecommons.org/licenses/by/4.0/>.
  90 |
  91 | Unless required by applicable law or agreed to in writing, documentation
  92 | distributed under the License is distributed on an "AS IS" BASIS,
  93 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  94 | See the License for the specific language governing permissions and
  95 | limitations under the License.
  96
  97 Other Applicable Upstream Project Licenses
  98 ------------------------------------------
  99
 100 You may not use the content of this software bundle except in compliance with the
 101 Licenses as listed below (non-exhaustive list, depending on end-user config):
 102
 103 +------------------+-------------------------------+
 104 | **Component**    | **Licence**                   |
 105 +------------------+-------------------------------+
 106 | `OpenStack`_     | `Apache License 2.0`_         |
 107 +------------------+-------------------------------+
 108 | `OpenDaylight`_  | `Eclipse Public License 1.0`_ |
 109 +------------------+-------------------------------+
 110 | `PostgreSQL`_    | `PostgreSQL Licence`_         |
 111 +------------------+-------------------------------+
 112 | `MongoDB`_       | `GNU AGPL v3.0`_              |
 113 +------------------+-------------------------------+
 114 | `RabbitMQ`_      | `Mozilla Public License`_     |
 115 +------------------+-------------------------------+
 116 | `Linux`_         | `GPL v3`_                     |
 117 +------------------+-------------------------------+
 118 | `Docker`_        | `Apache License 2.0`_         |
 119 +------------------+-------------------------------+
 120 | `OpenJDK`_/JRE   | `GPL v2`_                     |
 121 +------------------+-------------------------------+
 122 | `SaltStack`_     | `Apache License 2.0`_         |
 123 +------------------+-------------------------------+
 124 | `salt-formulas`_ | `Apache License 2.0`_         |
 125 +------------------+-------------------------------+
 126 | `reclass`_       | `The Artistic Licence 2.0`_   |
 127 +------------------+-------------------------------+
 128 | `MaaS`_          | `GNU AGPL v3.0`_              |
 129 +------------------+-------------------------------+
 130
 131 References
 132 ==========
 133
 134 For more information on the OPNFV Hunter release, please see:
 135
 136 #. `OPNFV Home Page`_
 137 #. `OPNFV Documentation`_
 138 #. `OPNFV Software Downloads`_
 139 #. `OPNFV Hunter Wiki Page`_
 140 #. `Mirantis Cloud Platform Documentation`_
 141
 142 .. _`OpenStack`: https://www.openstack.org
 143 .. _`OpenDaylight`: https://www.opendaylight.org
 144 .. _`PostgreSQL`: https://www.postgresql.org
 145 .. _`MongoDB`: https://www.mongodb.com
 146 .. _`RabbitMQ`: https://www.rabbitmq.com
 147 .. _`Linux`: https://www.linux.org
 148 .. _`Docker`: https://www.docker.com
 149 .. _`OpenJDK`: https://openjdk.java.net/
 150 .. _`SaltStack`: https://www.saltstack.com
 151 .. _`salt-formulas`: https://github.com/salt-formulas
 152 .. _`reclass`: https://reclass.pantsfullofunix.net
 153 .. _`MaaS`: https://maas.io
 154 .. _`MCP`: https://www.mirantis.com/software/mcp/
 155 .. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
 156 .. _`OPNFV Home Page`: https://www.opnfv.org
 157 .. _`OPNFV Hunter Wiki Page`: https://wiki.opnfv.org/display/SWREL/Hunter
 158 .. _`OPNFV Documentation`: https://docs.opnfv.org
 159 .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads
 160 .. _`OPNFV Fuel Contributing`: CONTRIBUTING.rst
 161 .. _`OPNFV Fuel Wiki Page`: https://wiki.opnfv.org/display/fuel/Fuel+Opnfv
 162 .. _`OPNFV Community Support mailing list`: https://lists.opnfv.org/g/opnfv-users
 163 .. _`OPNFV Technical Discussion mailing list`: https://lists.opnfv.org/g/opnfv-tech-discuss
 164 .. _`OPNFV Fuel Release Notes on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/release-notes/index.html
 165 .. _`OPNFV Fuel Installation Instruction on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/installation/index.html
 166 .. _`OPNFV Fuel User Guide on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/userguide/userguide.html
 167 .. _`OPNFV Fuel Scenarios on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/scenarios/index.html
 168 .. LICENSE links
 169 .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
 170 .. _`Eclipse Public License 1.0`: https://www.eclipse.org/legal/epl-v10.html
 171 .. _`PostgreSQL Licence`: https://opensource.org/licenses/postgresql
 172 .. _`GNU AGPL v3.0`: https://www.gnu.org/licenses/agpl-3.0.html
 173 .. _`Mozilla Public License`: https://www.rabbitmq.com/mpl.html
 174 .. _`GPL v3`: https://www.gnu.org/copyleft/gpl.html
 175 .. _`GPL v2`: https://www.gnu.org/licenses/gpl-2.0.html
 176 .. _`The Artistic Licence 2.0`: https://www.perlfoundation.org/artistic-license-20.html