Add first documentation for the project

- Generated documentation for roles
- Installation, contributing guides
- Zuul jobs for release notes and doc jobs (including publish)

Change-Id: Ib9b27d949d7d2207f3672436ddd93647597a9d7f
Co-Authored-By: Kevin Carter <kecarter@redhat.com>

.pre-commit-config.yaml

@@ -1,9 +1,7 @@
 ---
-# fail fast to avoid the need to scroll (some hooks can be verbose)
-fail_fast: true
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.4.0
+    rev: v2.1.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -12,34 +10,30 @@ repos:
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
       - id: debug-statements
+      - id: flake8
+        entry: flake8 --ignore=E24,E121,E122,E123,E124,E126,E226,E265,E305,E402,F401,F405,E501,E704,F403,F841,W503
+        # TODO(cloudnull): These codes were added to pass the lint check.
+        #                  All of these ignore codes should be resolved in
+        #                  future PRs.
       - id: check-yaml
         files: .*\.(yaml|yml)$
-  - repo: https://github.com/markdownlint/markdownlint
-    rev: master
-    hooks:
-      - id: markdownlint
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: '3.7.9'
-    hooks:
-      - id: flake8
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.20.0
+    rev: v1.15.0
     hooks:
       - id: yamllint
         files: \.(yaml|yml)$
         types: [file, yaml]
         entry: yamllint --strict -f parsable
   - repo: https://github.com/ansible/ansible-lint
-    rev: v4.2.0
+    rev: v4.1.1a2
     hooks:
       - id: ansible-lint
-        always_run: true
-        pass_filenames: false
-        # do not add file filters here as ansible-lint does not give reliable
-        # results when called with individual files.
-        # https://github.com/ansible/ansible-lint/issues/611
-        verbose: true
-        entry: env ANSIBLE_LIBRARY=./plugins ansible-lint --force-color -p -v
+        files: \.(yaml|yml)$
+        entry: >-
+          ansible-lint --force-color -v -x "ANSIBLE0006,ANSIBLE0007,ANSIBLE0010,ANSIBLE0012,ANSIBLE0013,ANSIBLE0016"
+        # TODO(cloudnull): These codes were added to pass the lint check.
+        #                  Things found within roles.galaxy are external
+        #                  and not something maintained here.
   - repo: https://github.com/openstack-dev/bashate.git
     rev: 0.6.0
     hooks:

bindep.txt

@@ -1,2 +1,37 @@
-# markdownlint is made in ruby
-rubygems [test]
+# This file facilitates OpenStack-CI package installation
+# before the execution of any tests.
+#
+# See the following for details:
+#  - https://docs.openstack.org/infra/bindep/
+#  - https://opendev.org/opendev/bindep/
+#
+# Even if the role does not make use of this facility, it
+# is better to have this file empty, otherwise OpenStack-CI
+# will fall back to installing its default packages which
+# will potentially be detrimental to the tests executed.
+
+# The gcc compiler
+gcc
+
+# Base requirements for RPM distros
+gcc-c++           [platform:rpm]
+git               [platform:rpm]
+libffi-devel      [platform:rpm]
+openssl-devel     [platform:rpm]
+python-devel      [platform:rpm !platform:rhel-8 !platform:centos-8]
+python3-devel     [platform:rpm !platform:rhel-7 !platform:centos-7]
+PyYAML            [platform:rpm !platform:rhel-8 !platform:centos-8]
+python3-pyyaml    [platform:rpm !platform:rhel-7 !platform:centos-7]
+python3-dnf       [platform:rpm !platform:rhel-7 !platform:centos-7]
+
+# For SELinux
+libselinux-python  [platform:rpm !platform:rhel-8 !platform:centos-8]
+libsemanage-python [platform:redhat !platform:rhel-8 !platform:centos-8]
+libselinux-python3  [platform:rpm !platform:rhel-7 !platform:centos-7]
+libsemanage-python3 [platform:redhat !platform:rhel-7 !platform:centos-7]
+
+# Required for compressing collected log files in CI
+gzip
+
+# Required to build language docs
+gettext

doc/requirements.txt

@@ -0,0 +1 @@
+../test-requirements.txt

doc/source/_exts/ansible-autodoc.py

@@ -0,0 +1,298 @@
+# Copyright 2019 Red Hat, Inc.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://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.
+
+
+import imp
+import os
+
+from docutils import core
+from docutils import nodes
+from docutils.parsers.rst import Directive
+from docutils.parsers import rst
+from docutils.writers.html4css1 import Writer
+
+from ruamel.yaml import YAML as RYAML
+
+try:
+    import io
+    StringIO = io.StringIO
+except ImportError:
+    import StringIO
+
+
+class DocYaml(RYAML):
+    def _license_filter(self, data):
+        """This will filter out our boilerplate license heading in return data.
+
+        The filter is used to allow documentation we're creating in variable
+        files to be rendered more beautifully.
+        """
+        lines = list()
+        mark = True
+        for line in data.splitlines():
+            if '# Copyright' in line:
+                mark = False
+            if mark:
+                lines.append(line)
+            if '# under the License' in line:
+                mark = True
+        return '\n'.join(lines)
+
+    def dump(self, data, stream=None, **kw):
+        if not stream:
+            stream = StringIO()
+        try:
+            RYAML.dump(self, data, stream, **kw)
+            return self._license_filter(stream.getvalue().strip())
+        finally:
+            stream.close()
+
+
+DOCYAML = DocYaml()
+DOCYAML.default_flow_style = False
+
+
+class AnsibleAutoPluginDirective(Directive):
+    directive_name = "ansibleautoplugin"
+    has_content = True
+    option_spec = {
+        'module': rst.directives.unchanged,
+        'role': rst.directives.unchanged,
+        'documentation': rst.directives.unchanged,
+        'examples': rst.directives.unchanged
+    }
+
+    @staticmethod
+    def _render_html(source):
+        return core.publish_parts(
+            source=source,
+            writer=Writer(),
+            writer_name='html',
+            settings_overrides={'no_system_messages': True}
+        )
+
+    def make_node(self, title, contents, content_type=None):
+        section = self._section_block(title=title)
+        if not content_type:
+            # Doc section
+            for content in contents['docs']:
+                for paragraph in content.split('\n'):
+                    retnode = nodes.paragraph()
+                    retnode.append(self._raw_html_block(data=paragraph))
+                    section.append(retnode)
+
+            # Options Section
+            options_list = nodes.field_list()
+            options_section = self._section_block(title='Options')
+            for key, value in contents['options'].items():
+                options_list.append(
+                    self._raw_fields(
+                        data=value['description'],
+                        field_name=key
+                    )
+                )
+            else:
+                options_section.append(options_list)
+                section.append(options_section)
+
+            # Authors Section
+            authors_list = nodes.field_list()
+            authors_list.append(
+                self._raw_fields(
+                    data=contents['author']
+                )
+            )
+            authors_section = self._section_block(title='Authors')
+            authors_section.append(authors_list)
+            section.append(authors_section)
+
+        elif content_type == 'yaml':
+            for content in contents:
+                section.append(
+                    self._literal_block(
+                        data=content,
+                        dump_data=False
+                    )
+                )
+
+        return section
+
+    @staticmethod
+    def load_module(filename):
+        return imp.load_source('__ansible_module__', filename)
+
+    @staticmethod
+    def build_documentation(module):
+        docs = DOCYAML.load(module.DOCUMENTATION)
+        doc_data = dict()
+        doc_data['docs'] = docs['description']
+        doc_data['author'] = docs.get('author', list())
+        doc_data['options'] = docs.get('options', dict())
+        return doc_data
+
+    @staticmethod
+    def build_examples(module):
+        examples = DOCYAML.load(module.EXAMPLES)
+        return_examples = list()
+        for example in examples:
+            return_examples.append(DOCYAML.dump([example]))
+        return return_examples
+
+    def _raw_html_block(self, data):
+        html = self._render_html(source=data)
+        return nodes.raw('', html['body'], format='html')
+
+    def _raw_fields(self, data, field_name=''):
+        body = nodes.field_body()
+        if isinstance(data, list):
+            for item in data:
+                body.append(self._raw_html_block(data=item))
+        else:
+            body.append(self._raw_html_block(data=data))
+
+        field = nodes.field()
+        field.append(nodes.field_name(text=field_name))
+        field.append(body)
+        return field
+
+    @staticmethod
+    def _literal_block(data, language='yaml', dump_data=True):
+        if dump_data:
+            literal = nodes.literal_block(
+                text=DOCYAML.dump(data)
+            )
+        else:
+            literal = nodes.literal_block(text=data)
+        literal['language'] = 'yaml'
+        return literal
+
+    @staticmethod
+    def _section_block(title, text=None):
+        section = nodes.section(
+            title,
+            nodes.title(text=title),
+            ids=[nodes.make_id('-'.join(title))],
+        )
+        if text:
+            section_body = nodes.field_body()
+            section_body.append(nodes.paragraph(text=text))
+            section.append(section_body)
+
+        return section
+
+    def _yaml_section(self, to_yaml_data, section_title, section_text=None):
+        yaml_section = self._section_block(
+            title=section_title,
+            text=section_text
+        )
+        yaml_section.append(self._literal_block(data=to_yaml_data))
+        return yaml_section
+
+    def _run_role(self, role):
+        section = self._section_block(
+            title='Role Documentation',
+            text='Welcome to the "{}" role documentation.'.format(
+                os.path.basename(role)
+            )
+        )
+        defaults_file = os.path.join(role, 'defaults', 'main.yml')
+        if os.path.exists(defaults_file):
+            with open(defaults_file) as f:
+                role_defaults = DOCYAML.load(f.read())
+            section.append(
+                self._yaml_section(
+                    to_yaml_data=role_defaults,
+                    section_title='Role Defaults',
+                    section_text='This section highlights all of the defaults'
+                                 ' and variables set within the "{}"'
+                                 ' role.'.format(os.path.basename(role))
+                )
+            )
+
+        vars_path = os.path.join(role, 'vars')
+        if os.path.exists(vars_path):
+            for v_file in os.listdir(vars_path):
+                vars_file = os.path.join(vars_path, v_file)
+                with open(vars_file) as f:
+                    vars_values = DOCYAML.load(f.read())
+                section.append(
+                    self._yaml_section(
+                        to_yaml_data=vars_values,
+                        section_title='Role Variables: {}'.format(v_file)
+                    )
+                )
+
+        self.run_returns.append(section)
+
+        # Document any libraries nested within the role
+        library_path = os.path.join(role, 'library')
+        if os.path.exists(library_path):
+            self.options['documentation'] = True
+            self.options['examples'] = True
+            for lib in os.listdir(library_path):
+                if lib.endswith('.py'):
+                    self._run_module(
+                        module=self.load_module(
+                            filename=os.path.join(
+                                library_path,
+                                lib
+                            )
+                        ),
+                        module_title='Embedded module: {}'.format(lib),
+                        example_title='Examples for embedded module'
+                    )
+
+    def _run_module(self, module, module_title="Module Documentation",
+                    example_title="Example Tasks"):
+        if self.options.get('documentation'):
+            docs = self.build_documentation(module=module)
+            self.run_returns.append(
+                self.make_node(
+                    title=module_title,
+                    contents=docs
+                )
+            )
+
+        if self.options.get('examples'):
+            examples = self.build_examples(module=module)
+            self.run_returns.append(
+                self.make_node(
+                    title=example_title,
+                    contents=examples,
+                    content_type='yaml'
+                )
+            )
+
+    def run(self):
+        self.run_returns = list()
+
+        if self.options.get('module'):
+            module = self.load_module(filename=self.options['module'])
+            self._run_module(module=module)
+
+        if self.options.get('role'):
+            self._run_role(role=self.options['role'])
+
+        return self.run_returns
+
+
+def setup(app):
+    classes = [
+        AnsibleAutoPluginDirective,
+    ]
+    for directive_class in classes:
+        app.add_directive(directive_class.directive_name, directive_class)
+
+    return {'version': '0.2'}

doc/source/conf.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://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.
+
+import os
+import sys
+
+# Add the project
+sys.path.insert(0, os.path.abspath('../..'))
+# Add the extensions
+sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts'))
+
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'openstackdocstheme',
+    'sphinx.ext.autodoc',
+    'ansible-autodoc'
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+# autodoc_mock_imports = ["django"]
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'tripleo-operator-ansible'
+copyright = u'2019, OpenStack Foundation'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+html_theme = 'openstackdocs'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     u'%s Documentation' % project,
+     u'OpenStack Foundation', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# intersphinx_mapping = {'http://docs.python.org/': None}
+
+# openstackdocstheme options
+repository_name = 'openstack/tripleo-operator-ansible'
+bug_project = 'tripleo'
+bug_tag = 'documentation'

doc/source/contributing.rst

@@ -0,0 +1,26 @@
+============
+Contributing
+============
+
+Adding roles into this project is easy and starts with a compatible skeleton.
+
+
+Create a new role manually
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TBD
+
+Create a new role with automation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TBD
+
+Local testing of new roles
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+TBD
+
+Contributing plugins
+~~~~~~~~~~~~~~~~~~~~
+
+TBD

doc/source/index.rst

@@ -0,0 +1,18 @@
+Welcome to tripleo-operator-ansible's documentation!
+====================================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   contributing
+   usage
+   roles
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`

doc/source/installation.rst

@@ -0,0 +1,16 @@
+============
+Installation
+============
+
+At the command line using `yum`.
+
+.. code-block:: console
+
+    $ yum install tripleo-operator-ansible
+
+
+At the command line using `dnf`.
+
+.. code-block:: console
+
+    $ dnf install tripleo-operator-ansible

doc/source/roles.rst

@@ -0,0 +1,9 @@
+Documented roles in tripleo-operator-ansible
+============================================
+
+Contents:
+
+.. toctree::
+   :glob:
+
+   roles/*

doc/source/roles/role-test_molecule_prep.rst

@@ -0,0 +1,6 @@
+=========================
+Role - test_molecule_prep
+=========================
+
+.. ansibleautoplugin::
+   :role: roles/test_molecule_prep

doc/source/roles/role-tripleo_config_generate_ansible.rst

@@ -0,0 +1,6 @@
+======================================
+Role - tripleo_config_generate_ansible
+======================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_config_generate_ansible

doc/source/roles/role-tripleo_container_image_delete.rst

@@ -0,0 +1,6 @@
+=====================================
+Role - tripleo_container_image_delete
+=====================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_container_image_delete

doc/source/roles/role-tripleo_container_image_list.rst

@@ -0,0 +1,6 @@
+===================================
+Role - tripleo_container_image_list
+===================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_container_image_list

doc/source/roles/role-tripleo_container_image_prepare.rst

@@ -0,0 +1,6 @@
+======================================
+Role - tripleo_container_image_prepare
+======================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_container_image_prepare

doc/source/roles/role-tripleo_container_image_prepare_default.rst

@@ -0,0 +1,6 @@
+==============================================
+Role - tripleo_container_image_prepare_default
+==============================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_container_image_prepare_default

doc/source/roles/role-tripleo_container_image_push.rst

@@ -0,0 +1,6 @@
+===================================
+Role - tripleo_container_image_push
+===================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_container_image_push

doc/source/roles/role-tripleo_container_image_show.rst

@@ -0,0 +1,6 @@
+===================================
+Role - tripleo_container_image_show
+===================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_container_image_show

doc/source/roles/role-tripleo_deploy.rst

@@ -0,0 +1,6 @@
+=====================
+Role - tripleo_deploy
+=====================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_deploy

doc/source/roles/role-tripleo_overcloud_deploy.rst

@@ -0,0 +1,6 @@
+===============================
+Role - tripleo_overcloud_deploy
+===============================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_deploy

doc/source/roles/role-tripleo_overcloud_export.rst

@@ -0,0 +1,6 @@
+===============================
+Role - tripleo_overcloud_export
+===============================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_export

doc/source/roles/role-tripleo_overcloud_failures.rst

@@ -0,0 +1,6 @@
+=================================
+Role - tripleo_overcloud_failures
+=================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_failures

doc/source/roles/role-tripleo_overcloud_image_build.rst

@@ -0,0 +1,6 @@
+====================================
+Role - tripleo_overcloud_image_build
+====================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_image_build

doc/source/roles/role-tripleo_overcloud_image_upload.rst

@@ -0,0 +1,6 @@
+=====================================
+Role - tripleo_overcloud_image_upload
+=====================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_image_upload

doc/source/roles/role-tripleo_overcloud_node_bios_configure.rst

@@ -0,0 +1,6 @@
+============================================
+Role - tripleo_overcloud_node_bios_configure
+============================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_bios_configure

doc/source/roles/role-tripleo_overcloud_node_bios_reset.rst

@@ -0,0 +1,6 @@
+========================================
+Role - tripleo_overcloud_node_bios_reset
+========================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_bios_reset

doc/source/roles/role-tripleo_overcloud_node_clean.rst

@@ -0,0 +1,6 @@
+===================================
+Role - tripleo_overcloud_node_clean
+===================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_clean

doc/source/roles/role-tripleo_overcloud_node_configure.rst

@@ -0,0 +1,6 @@
+=======================================
+Role - tripleo_overcloud_node_configure
+=======================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_configure

doc/source/roles/role-tripleo_overcloud_node_delete.rst

@@ -0,0 +1,6 @@
+====================================
+Role - tripleo_overcloud_node_delete
+====================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_delete

doc/source/roles/role-tripleo_overcloud_node_discover.rst

@@ -0,0 +1,6 @@
+======================================
+Role - tripleo_overcloud_node_discover
+======================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_discover

doc/source/roles/role-tripleo_overcloud_node_import.rst

@@ -0,0 +1,6 @@
+====================================
+Role - tripleo_overcloud_node_import
+====================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_import

doc/source/roles/role-tripleo_overcloud_node_introspect.rst

@@ -0,0 +1,6 @@
+========================================
+Role - tripleo_overcloud_node_introspect
+========================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_node_introspect

doc/source/roles/role-tripleo_overcloud_status.rst

@@ -0,0 +1,6 @@
+===============================
+Role - tripleo_overcloud_status
+===============================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_status

doc/source/roles/role-tripleo_overcloud_update_prepare.rst

@@ -0,0 +1,6 @@
+=======================================
+Role - tripleo_overcloud_update_prepare
+=======================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_update_prepare

doc/source/roles/role-tripleo_overcloud_update_run.rst

@@ -0,0 +1,6 @@
+===================================
+Role - tripleo_overcloud_update_run
+===================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_overcloud_update_run

doc/source/roles/role-tripleo_repos.rst

@@ -0,0 +1,6 @@
+====================
+Role - tripleo_repos
+====================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_repos

doc/source/roles/role-tripleo_undercloud_backup.rst

@@ -0,0 +1,6 @@
+================================
+Role - tripleo_undercloud_backup
+================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_undercloud_backup

doc/source/roles/role-tripleo_undercloud_install.rst

@@ -0,0 +1,6 @@
+=================================
+Role - tripleo_undercloud_install
+=================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_undercloud_install

doc/source/roles/role-tripleo_undercloud_minion_install.rst

@@ -0,0 +1,6 @@
+========================================
+Role - tripleo_undercloud_minion_install
+========================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_undercloud_minion_install

doc/source/roles/role-tripleo_undercloud_minion_upgrade.rst

@@ -0,0 +1,6 @@
+========================================
+Role - tripleo_undercloud_minion_upgrade
+========================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_undercloud_minion_upgrade

doc/source/roles/role-tripleo_undercloud_upgrade.rst

@@ -0,0 +1,6 @@
+=================================
+Role - tripleo_undercloud_upgrade
+=================================
+
+.. ansibleautoplugin::
+   :role: roles/tripleo_undercloud_upgrade

doc/source/usage.rst

@@ -0,0 +1,7 @@
+=====
+Usage
+=====
+
+Once the tripleo-operator-ansible project has been installed navigate to the share path,
+usually `/usr/share/ansible` path to access the installed roles, playbooks, and
+libraries.

releasenotes/source/conf.py

@@ -0,0 +1,269 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://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.
+#
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'openstackdocstheme',
+    'reno.sphinxext',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'tripleo-operator-ansible Release Notes'
+copyright = u'2020, TripleO Developers'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The full version, including alpha/beta/rc tags.
+release = ''
+# The short X.Y version.
+version = ''
+
+# The full version, including alpha/beta/rc tags.
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'openstackdocs'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'tripleo-operator-ansibleReleaseNotesdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'tripleo-operator-ansibleReleaseNotes.tex', u'tripleo-operator-ansible Release Notes Documentation',
+   u'2020, TripleO Developers', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'tripleo-operator-ansiblereleasenotes', u'tripleo-operator-ansible Release Notes Documentation',
+     [u'2020, TripleO Developers'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'tripleo-operator-ansibleReleaseNotes', u'tripleo-operator-ansible Release Notes Documentation',
+   u'2020, TripleO Developers', 'tripleo-operator-ansibleReleaseNotes', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+# -- Options for Internationalization output ------------------------------
+locale_dirs = ['locale/']
+
+# openstackdocstheme options
+repository_name = 'openstack/tripleo-operator-ansible'
+bug_project = 'tripleo'
+bug_tag = 'documentation'

releasenotes/source/index.rst

@@ -0,0 +1,18 @@
+==================================================
+Welcome to tripleo-operator-ansible Release Notes!
+==================================================
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   unreleased
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`

releasenotes/source/unreleased.rst

@@ -0,0 +1,5 @@
+============================
+Current Series Release Notes
+============================
+
+ .. release-notes::

test-requirements.txt

@@ -2,3 +2,14 @@ netaddr # BSD
 mock>=2.0.0 # BSD
 stestr>=2.0.0 # Apache-2.0
 oslotest>=3.2.0 # Apache-2.0
+ruamel.yaml
+pre-commit # MIT
+ansible>=2.8
+
+# this is required for the docs build jobs
+sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
+sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
+openstackdocstheme>=1.29.2 # Apache-2.0
+reno>=2.11.3 # Apache-2.0
+doc8>=0.8.0 # Apache-2.0
+bashate>=0.6.0 # Apache-2.0

tox.ini

@@ -42,21 +42,53 @@ whitelist_externals =
 deps = bindep
 commands = bindep test
 
-[testenv:linters]
-description =
-    Runs all linters, if you want to run a single one, use posargs to mention
-    it. Example `tox -e linters -- ansible-lint`
-deps =
-   pre-commit>=1.20  # MIT
-commands =
-    python -m pre_commit run -a {posargs}
-
-# Use 'linters' instead, kept only for compatibility with:
-# https://opendev.org/openstack/openstack-zuul-jobs/src/branch/master/zuul.d/project-templates.yaml#L459
 [testenv:pep8]
 envdir = {toxworkdir}/linters
-deps =  {[testenv:linters]deps}
-commands =  {[testenv:linters]commands}
+commands =
+    python -m pre_commit run flake8 -a
+
+[testenv:ansible-lint]
+envdir = {toxworkdir}/linters
+deps =
+  {[testenv:linters]deps}
+commands =
+  python -m pre_commit run ansible-lint -a
+
+[testenv:yamllint]
+envdir = {toxworkdir}/linters
+deps = {[testenv:linters]deps}
+commands =
+    python -m pre_commit run yamllint -a
+
+[testenv:bashate]
+envdir = {toxworkdir}/linters
+deps = {[testenv:linters]deps}
+commands =
+    python -m pre_commit run bashate -a
+
+[testenv:whitespace]
+envdir = {toxworkdir}/linters
+deps = {[testenv:linters]deps}
+commands =
+    python -m pre_commit run trailing-whitespace -a
+
+[testenv:shebangs]
+envdir = {toxworkdir}/linters
+deps = {[testenv:linters]deps}
+commands =
+    python -m pre_commit run check-executables-have-shebangs -a
+
+[testenv:linters]
+deps =
+    -r {toxinidir}/requirements.txt
+    -r {toxinidir}/test-requirements.txt
+commands =
+    {[testenv:pep8]commands}
+    {[testenv:ansible-lint]commands}
+    {[testenv:bashate]commands}
+    {[testenv:yamllint]commands}
+    {[testenv:whitespace]commands}
+    {[testenv:shebangs]commands}
 
 [testenv:releasenotes]
 basepython = python3
@@ -72,6 +104,11 @@ commands=
     doc8 doc
     sphinx-build -a -E -W -d doc/build/doctrees --keep-going -b html doc/source doc/build/html -T
 
+[doc8]
+# Settings for doc8:
+extensions = .rst
+ignore = D001
+
 [testenv:venv]
 commands = {posargs}
 

zuul.d/layout.yaml

@@ -2,9 +2,16 @@
     templates:
       - openstack-python3-ussuri-jobs
       - tripleo-operator-molecule-jobs
+      - release-notes-jobs-python3
     check:
       jobs:
         - openstack-tox-linters
+        - openstack-tox-docs: &tripleo-docs
+            files:
+            - ^doc/.*
+            - ^molecule-requirements.txt
+            - ^README.rst
+            - ^requirements.txt
         - tripleo-ci-centos-7-containers-multinode:
             dependencies: &deps_unit_lint
               - openstack-tox-pep8
@@ -21,7 +28,11 @@
     gate:
       jobs:
         - openstack-tox-linters
+        - openstack-tox-docs: *tripleo-docs
         - tripleo-ci-centos-7-containers-multinode:
             files: *containers_multinode_files
         - tripleo-ci-centos-7-containers-undercloud-minion:
             files: *containers_minion_files
+    promote:
+      jobs:
+      - promote-openstack-tox-docs: *tripleo-docs