openstack
/
ansible-role-collect-logs
Code Issues Proposed changes

Make rst files collection compatible 

Fixes RST issues reported by ansible-test sanity. Because collections
do not use sphinx, we cannot make use of |project| substitution.

Change-Id: I4d42d25ec1c6de3eebaed8cf78c8d7a648e1ba5d
Related: https://review.opendev.org/c/openstack/ansible-role-collect-logs/+/773725
This commit is contained in:
Sorin Sbarnea 2021-02-02 17:38:50 +00:00
parent 1c71e5098f
commit 3f0881dfff
7 changed files with 49 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -32,7 +32,7 @@ File Collection
- ``artcl_collect_list`` – A list of files and directories to gather
from the target. Directories are collected recursively and need to
end with a “/” to get collected. Should be specified as a YaML list,
end with a '/' to get collected. Should be specified as a YaML list,
e.g.:
.. code:: yaml
@ -48,7 +48,7 @@ File Collection
- ``artcl_exclude_list`` – A list of files and directories to exclude
from collecting. This list is passed to rsync as an exclude filter
and it takes precedence over the collection list. For details see the
“FILTER RULES” topic in the rsync man page.
'FILTER RULES' topic in the rsync man page.
- ``artcl_exclude_list_append`` – A list of files and directories to be
appended in the default exclude list. This is useful for users that want to
keep the original list and just add more relevant paths.
@ -231,7 +231,7 @@ Templated Bash to rST Conversion Notes
--------------------------------------
Templated bash scripts used during deployment are converted to rST files
during the ``create-docs`` portion of the role’s call. Shell scripts are
during the ``create-docs`` portion of the role's call. Shell scripts are
fed into an awk script and output as restructured text. The awk script
has several simple rules:

2
docs/static/baremetal-overcloud/copying-customized-files.rst vendored
View File

@ -17,7 +17,7 @@ The JSON file describing your Overcloud baremetal nodes, is called
Each node description should contains required fields:
* ``pm_type`` - driver for Ironic nodes, see `Ironic Drivers`_ for details
* ``pm_type`` - driver for Ironic nodes
* ``pm_addr`` - node BMC IP address (hypervisor address in case of virtual
environment)

72
docs/static/baremetal-overcloud/environment-settings-structure.rst vendored
View File

@ -11,41 +11,43 @@ Example Directory Structure
Each baremetal environment will need a directory structured as follows:
|-- environment_name
| |-- instackenv.json
| |-- vendor_specific_setup
| |-- <architecture diagram/explanation document>
| |-- network_configs
| | |--<network-islation-type-1>
| | | |-- <network-environment.yaml file>
| | | |-- env_settings.yml
| | | |-- nic_configs
| | | | |-- ceph-storage.yaml
| | | | |-- cinder-storage.yaml
| | | | |-- compute.yaml
| | | | |-- controller.yaml
| | | | |-- swift-storage.yaml
| | | |-- config_files
| | | | |--config.yml
| | | | |--<other config files>
| | | |-- requirements_files
| | | | |--requirements1.yml
| | | | |--requirements2.yml
| | |--<network-islation-type-2>
| | | |-- <network-environment.yaml file>
| | | |-- env_settings.yml
| | | |-- nic_configs
| | | | |-- ceph-storage.yaml
| | | | |-- cinder-storage.yaml
| | | | |-- compute.yaml
| | | | |-- controller.yaml
| | | | |-- swift-storage.yaml
| | | |-- config_files
| | | | |--config.yml
| | | | |--<other config files>
| | | |-- requirements_files
| | | | |--requirements1.yml
| | | | |--requirements2.yml
::
|-- environment_name
| |-- instackenv.json
| |-- vendor_specific_setup
| |-- <architecture diagram/explanation document>
| |-- network_configs
| | |--<network-islation-type-1>
| | | |-- <network-environment.yaml file>
| | | |-- env_settings.yml
| | | |-- nic_configs
| | | | |-- ceph-storage.yaml
| | | | |-- cinder-storage.yaml
| | | | |-- compute.yaml
| | | | |-- controller.yaml
| | | | |-- swift-storage.yaml
| | | |-- config_files
| | | | |--config.yml
| | | | |--<other config files>
| | | |-- requirements_files
| | | | |--requirements1.yml
| | | | |--requirements2.yml
| | |--<network-islation-type-2>
| | | |-- <network-environment.yaml file>
| | | |-- env_settings.yml
| | | |-- nic_configs
| | | | |-- ceph-storage.yaml
| | | | |-- cinder-storage.yaml
| | | | |-- compute.yaml
| | | | |-- controller.yaml
| | | | |-- swift-storage.yaml
| | | |-- config_files
| | | | |--config.yml
| | | | |--<other config files>
| | | |-- requirements_files
| | | | |--requirements1.yml
| | | | |--requirements2.yml
Explanation of Directory Contents

2
docs/static/baremetal-overcloud/networking.rst vendored
View File

@ -34,4 +34,4 @@ As such, the setup requires that:
Refer to the following diagram for more information
i.. image:: _images/TripleO_Network_Diagram_.jpg
.. image:: _images/TripleO_Network_Diagram_.jpg

4
docs/static/env-setup-virt.rst vendored
View File

@ -1,7 +1,7 @@
Virtual Environment
===================
|project| Quickstart can be used in a virtual environment using virtual machines instead
Quickstart can be used in a virtual environment using virtual machines instead
of actual baremetal. However, one baremetal machine ( VIRTHOST ) is still
needed to act as the host for the virtual machines.
@ -28,7 +28,7 @@ Currently the virthost machine must be running a recent Red Hat-based Linux
distribution (CentOS 7, RHEL 7, Fedora 22 - only CentOS 7 is currently tested),
but we hope to add support for non-Red Hat distributions too.
|project| Quickstart currently supports the following operating systems:
Quickstart currently supports the following operating systems:
* CentOS 7 x86_64

6
docs/static/ovb-openstack-cloud/running-quickstart-instances-openstack.rst vendored
View File

@ -16,8 +16,7 @@ Openstack Virtual Baremetal <https://github.com/openstack/openstack-virtual-bare
The following are assumed to have been completed before following this document:
* An Openstack cloud exists and has been set up
(and configured as described in
[Patching the Host Cloud](https://openstack-virtual-baremetal.readthedocs.io/en/latest/host-cloud/patches.html).
(and configured as described in `Patching the Host Cloud`_.
if the cloud is pre-Mitaka release). From the Mitaka release the cloud should
not require patching
* The undercloud image under test has been uploaded to Glance in the Openstack cloud.
@ -27,6 +26,9 @@ The following are assumed to have been completed before following this document:
Below is an example `env.yaml` file used to create the heat stack that will support a
tripleo-quickstart undercloud and overcloud deployment with network isolation:
.. _Patching the Host Cloud: https://openstack-virtual-baremetal.readthedocs.io/en/latest/host-cloud/patches.html
::
parameters:

2
roles/collect_logs/templates/index.rst.j2
View File

@ -1,4 +1,4 @@
Welcome to |project| Documentation:
Welcome to collect-logs Documentation:
===================================
.. note:: This documentation was generated by the collect-logs_ role. If you