aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: b2b1b7bf6d6efad4129d9dd41e4d222272e51113 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. (c) 2018 Ericsson AB, Mirantis Inc., Enea AB and others.

==========
OPNFV Fuel
==========

|docs|

.. |docs| image:: https://readthedocs.org/projects/opnfv-fuel/badge/?version=latest
    :alt: OPNFV Fuel Documentation Status
    :scale: 100%
    :target: https://opnfv-fuel.readthedocs.io/en/latest/?badge=latest

Description
===========

This is the OPNFV Gambia release that implements the deploy stage of the
OPNFV CI pipeline via Fuel.

Fuel is based on the `MCP`_ installation tool chain.
More information available at `Mirantis Cloud Platform Documentation`_.

The goal of the Fuel deployment process is to establish a lab ready platform
accelerating further development of the OPNFV infrastructure.

Release Notes
=============

- `OPNFV Fuel Release Notes on RTD`_

Installation
============

- `OPNFV Fuel Installation Instruction on RTD`_

Usage
=====

- `OPNFV Fuel User Guide on RTD`_

Scenarios
=========

- `OPNFV Fuel Scenarios on RTD`_

Contributing
============

- `OPNFV Fuel Contributing`_

Support
=======

- `OPNFV Fuel Wiki Page`_
- `OPNFV Community Support mailing list`_
- `OPNFV Technical Discussion mailing list`_

LICENSE
=======

| This document is protected/licensed under the following conditions
| (c) Jonas Bjurel (Ericsson AB)
| Licensed under a Creative Commons Attribution 4.0 International License.
| You should have received a copy of the license along with this work.
| If not, see <https://creativecommons.org/licenses/by/4.0/>.

Open Platform for NFV Project Software Licence
----------------------------------------------

| Any software developed by the "Open Platform for NFV" Project is licenced under the
| Apache License, Version 2.0 (the "License");
| you may not use the content of this software bundle except in compliance with the License.
| You may obtain a copy of the License at <https://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.

Open Platform for NFV Project Documentation Licence
---------------------------------------------------

| Any documentation developed by the "Open Platform for NFV Project"
| is licensed under a Creative Commons Attribution 4.0 International License.
| You should have received a copy of the license along with this. If not,
| see <https://creativecommons.org/licenses/by/4.0/>.
|
| Unless required by applicable law or agreed to in writing, documentation
| 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.

Other Applicable Upstream Project Licenses
------------------------------------------

You may not use the content of this software bundle except in compliance with the
Licenses as listed below (non-exhaustive list, depending on end-user config):

+------------------+-------------------------------+
| **Component**    | **Licence**                   |
+------------------+-------------------------------+
| `OpenStack`_     | `Apache License 2.0`_         |
+------------------+-------------------------------+
| `OpenDaylight`_  | `Eclipse Public License 1.0`_ |
+------------------+-------------------------------+
| `PostgreSQL`_    | `PostgreSQL Licence`_         |
+------------------+-------------------------------+
| `MongoDB`_       | `GNU AGPL v3.0`_              |
+------------------+-------------------------------+
| `RabbitMQ`_      | `Mozilla Public License`_     |
+------------------+-------------------------------+
| `Linux`_         | `GPL v3`_                     |
+------------------+-------------------------------+
| `Docker`_        | `Apache License 2.0`_         |
+------------------+-------------------------------+
| `OpenJDK`_/JRE   | `GPL v2`_                     |
+------------------+-------------------------------+
| `SaltStack`_     | `Apache License 2.0`_         |
+------------------+-------------------------------+
| `salt-formulas`_ | `Apache License 2.0`_         |
+------------------+-------------------------------+
| `reclass`_       | `The Artistic Licence 2.0`_   |
+------------------+-------------------------------+
| `MaaS`_          | `GNU AGPL v3.0`_              |
+------------------+-------------------------------+

References
==========

For more information on the OPNFV Gambia 7.0 release, please see:

#. `OPNFV Home Page`_
#. `OPNFV Documentation`_
#. `OPNFV Software Downloads`_
#. `OPNFV Gambia Wiki Page`_
#. `Mirantis Cloud Platform Documentation`_

.. _`OpenStack`: https://www.openstack.org
.. _`OpenDaylight`: https://www.opendaylight.org/software
.. _`PostgreSQL`: https://www.postgresql.org
.. _`MongoDB`: https://www.mongodb.com
.. _`RabbitMQ`: https://www.rabbitmq.com
.. _`Linux`: https://www.linux.org
.. _`Docker`: https://www.docker.com
.. _`OpenJDK`: https://openjdk.java.net/
.. _`SaltStack`: https://www.saltstack.com
.. _`salt-formulas`: https://github.com/salt-formulas
.. _`reclass`: https://reclass.pantsfullofunix.net
.. _`MaaS`: https://maas.io
.. _`MCP`: https://www.mirantis.com/software/mcp/
.. _`Mirantis Cloud Platform Documentation`: https://docs.mirantis.com/mcp/latest/
.. _`OPNFV Home Page`: https://www.opnfv.org
.. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/releases/Gambia
.. _`OPNFV Documentation`: https://docs.opnfv.org
.. _`OPNFV Software Downloads`: https://www.opnfv.org/software/download
.. _`OPNFV Fuel Contributing`: CONTRIBUTING.rst
.. _`OPNFV Fuel Wiki Page`: https://wiki.opnfv.org/display/fuel/Fuel+Opnfv
.. _`OPNFV Community Support mailing list`: https://lists.opnfv.org/g/opnfv-users
.. _`OPNFV Technical Discussion mailing list`: https://lists.opnfv.org/g/opnfv-tech-discuss
.. _`OPNFV Fuel Release Notes on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/release-notes/index.html
.. _`OPNFV Fuel Installation Instruction on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/installation/index.html
.. _`OPNFV Fuel User Guide on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/userguide/userguide.html
.. _`OPNFV Fuel Scenarios on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/scenarios/index.html
.. LICENSE links
.. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
.. _`Eclipse Public License 1.0`: https://www.eclipse.org/legal/epl-v10.html
.. _`PostgreSQL Licence`: https://opensource.org/licenses/postgresql
.. _`GNU AGPL v3.0`: https://www.gnu.org/licenses/agpl-3.0.html
.. _`Mozilla Public License`: https://www.rabbitmq.com/mpl.html
.. _`GPL v3`: https://www.gnu.org/copyleft/gpl.html
.. _`GPL v2`: https://www.gnu.org/licenses/gpl-2.0.html
.. _`The Artistic Licence 2.0`: https://www.perlfoundation.org/artistic-license-20.html