diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | .gitmodules | 2 | ||||
| -rw-r--r-- | armband-fuel-config.mk | 2 | ||||
| -rw-r--r-- | docs/conf.py | 15 | ||||
| -rw-r--r-- | docs/conf.yaml | 10 | ||||
| -rw-r--r-- | docs/index.rst | 17 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 7 | ||||
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 12 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 5 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 11 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 7 | ||||
| -rw-r--r-- | docs/release/userguide/userguide.rst | 18 | ||||
| -rw-r--r-- | docs/requirements.txt | 9 | ||||
| -rw-r--r-- | patches/opnfv-fuel/0001-Set-volume-name-in-source-file-to-sdX.patch | 44 | ||||
| -rw-r--r-- | tox.ini | 22 |
15 files changed, 105 insertions, 78 deletions
@@ -3,3 +3,5 @@ build.log config.mk ci/clean_cache.sh *.sw? +.tox/ +docs/_build/* diff --git a/.gitmodules b/.gitmodules index 0a84688b..44cc6d80 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,4 +1,4 @@ [submodule "opnfv-fuel"] path = upstream/fuel url = https://gerrit.opnfv.org/gerrit/fuel - branch = stable/euphrates + branch = master diff --git a/armband-fuel-config.mk b/armband-fuel-config.mk index a4a0ad5e..5f85f9c7 100644 --- a/armband-fuel-config.mk +++ b/armband-fuel-config.mk @@ -17,7 +17,7 @@ F_PATCH_DIR := ${A_FUEL_BASE}/mcp/patches # To enable remote tracking, set the following var to any non-empty string. # Leaving this var empty will bind each git submodule to its saved commit. -ARMBAND_TRACK_REMOTES ?= +ARMBAND_TRACK_REMOTES ?= yes # for the patches applying purposes (empty git config in docker build container) export GIT_COMMITTER_NAME?=OPNFV Armband diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..c175a6c5 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,15 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +from docs_conf.conf import * + +extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', + 'sphinx.ext.intersphinx'] + +intersphinx_mapping = {} +intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/latest/', None) diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..68e42dfd --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,10 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +--- +project_cfg: opnfv +project: armband diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..e1eb3ad0 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +.. _armband: + +======= +Armband +======= + +.. toctree:: + :maxdepth: 2 + + release/installation/index + release/release-notes/index + release/userguide/index diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 93bbc408..68ac3d98 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -2,14 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -.. _armband-release-installation-label: - -**************************************** -Installation instruction for Fuel\@OPNFV -**************************************** +.. _armband-installation: .. toctree:: - :numbered: :maxdepth: 2 installation.instruction.rst diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index 7b00cd04..417dbee0 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -======== +*********************************** +OPNFV Fuel Installation Instruction +*********************************** + Abstract ======== @@ -12,7 +15,8 @@ continuous integration, lab provisioning, and testing processes of each standard release OPNFV, such that the release can be available on both Intel Architecture-based and ARM Architecture-based servers. -The armband repo contains the patches necessary for Fuel installer to run on -aarch64 hardware. For more information on how to install the Fraser release +For more information on how to install the latest release of OPNFV when using Fuel as a deployment tool check -:ref:`fuel-release-installation-label` +`OPNFV Fuel Installation Instruction on RTD`_. + +.. _`OPNFV Fuel Installation Instruction on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/installation diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index 3010ff5b..ea82c70f 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -4,12 +4,7 @@ .. _armband-releasenotes: -***************************** -Release notes for Fuel\@OPNFV -***************************** - .. toctree:: - :numbered: :maxdepth: 2 release-notes.rst diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 42dfc0d1..f8084f73 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -======== +************************ +OPNFV Fuel Release Notes +************************ + Abstract ======== @@ -12,7 +15,7 @@ continuous integration, lab provisioning, and testing processes of each standard release OPNFV, such that the release can be available on both Intel Architecture-based and ARM Architecture-based servers. -The armband repo contains the patches necessary for Fuel installer to run on -aarch64 hardware. For more information on Fraser release notes check -:ref:`fuel-release-notes-label` +Currently the installer supported on ``aarch64`` is OPNFV Fuel. For more +information on Fuel release notes check `OPNFV Fuel Release Notes on RTD`_. +.. _`OPNFV Fuel Release Notes on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/release-notes diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst index 58baffd3..701ed7e4 100644 --- a/docs/release/userguide/index.rst +++ b/docs/release/userguide/index.rst @@ -2,14 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -.. _armband-release-userguide-label: - -************************** -User guide for Fuel\@OPNFV -************************** +.. _armband-userguide: .. toctree:: - :numbered: :maxdepth: 2 userguide.rst diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst index 80d05d13..69d02983 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -1,8 +1,12 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. +.. SPDX-License-Identifier: CC-BY-4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -======== +********************* +OPNFV Fuel User Guide +********************* + Abstract ======== @@ -12,7 +16,7 @@ continuous integration, lab provisioning, and testing processes of each standard release OPNFV, such that the release can be available on both Intel Architecture-based and ARM Architecture-based servers. -The armband repo contains the patches necessary for Fuel installer to run on -aarch64 hardware. For more information on how to use Fuel@OPNFV - Fraser -release - after it was deployed check -:ref:`fuel-release-userguide-label` +For more information on how to use OPNFV Fuel latest release after it +was deployed check `OPNFV Fuel User Guide on RTD`_. + +.. _`OPNFV Fuel User Guide on RTD`: https://opnfv-fuel.readthedocs.io/en/latest/release/userguide diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..87ba3aa0 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,9 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +lfdocs-conf +sphinx_opnfv_theme diff --git a/patches/opnfv-fuel/0001-Set-volume-name-in-source-file-to-sdX.patch b/patches/opnfv-fuel/0001-Set-volume-name-in-source-file-to-sdX.patch deleted file mode 100644 index 62f1ffff..00000000 --- a/patches/opnfv-fuel/0001-Set-volume-name-in-source-file-to-sdX.patch +++ /dev/null @@ -1,44 +0,0 @@ -:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -: Copyright (c) 2018 Enea AB and others. -: -: All rights reserved. This program and the accompanying materials -: are made available under the terms of the Apache License, Version 2.0 -: which accompanies this distribution, and is available at -: http://www.apache.org/licenses/LICENSE-2.0 -:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -From: Charalampos Kominos <Charalampos.Kominos@enea.com> -Date: Fri, 27 Apr 2018 14:54:22 +0200 -Subject: [PATCH] Set volume name in source file to sdX - -Signed-off-by: Charalampos Kominos <Charalampos.Kominos@enea.com> ---- - .../classes/cluster/mcp-common-ha/openstack_control.yml.j2 | 2 +- - .../classes/cluster/mcp-common-noha/openstack_control.yml | 2 +- - 2 files changed, 2 insertions(+), 2 deletions(-) - -diff --git a/mcp/reclass/classes/cluster/mcp-common-ha/openstack_control.yml.j2 b/mcp/reclass/classes/cluster/mcp-common-ha/openstack_control.yml.j2 -index a7e8fcde..81a8a2af 100644 ---- a/mcp/reclass/classes/cluster/mcp-common-ha/openstack_control.yml.j2 -+++ b/mcp/reclass/classes/cluster/mcp-common-ha/openstack_control.yml.j2 -@@ -91,7 +91,7 @@ parameters: - <<: *db_conn_recycle_time - cacert: /etc/ssl/certs/mcp_os_cacert - openrc_extra: -- volume_device_name: vdc -+ volume_device_name: sdc - glance: - server: - <<: *db_conn_recycle_time -diff --git a/mcp/reclass/classes/cluster/mcp-common-noha/openstack_control.yml b/mcp/reclass/classes/cluster/mcp-common-noha/openstack_control.yml -index dd4b9c4f..d235ef4a 100644 ---- a/mcp/reclass/classes/cluster/mcp-common-noha/openstack_control.yml -+++ b/mcp/reclass/classes/cluster/mcp-common-noha/openstack_control.yml -@@ -80,7 +80,7 @@ parameters: - server: - admin_email: ${_param:admin_email} - openrc_extra: -- volume_device_name: vdc -+ volume_device_name: sdc - pkgs: - - keystone - - python-psycopg2 diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..c3299e47 --- /dev/null +++ b/tox.ini @@ -0,0 +1,22 @@ +############################################################################## +# Copyright (c) 2018 Enea AB and others. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |