[config-ref] Update README for RHEL/CentOS; diff_branches for Ocata
Change-Id: I3ec93b1fad946de21e2bbb7a4386edaee1267d27
This commit is contained in:
parent
055b43e4f2
commit
723c618324
|
@ -18,8 +18,10 @@ then runs the ``autohelp.py`` script in the virtual environment.
|
||||||
New and updated flagmappings are generated in the ``openstack-manuals``
|
New and updated flagmappings are generated in the ``openstack-manuals``
|
||||||
repository (``tools/autogenerate-config-flagmappings/`` directory).
|
repository (``tools/autogenerate-config-flagmappings/`` directory).
|
||||||
|
|
||||||
Prior to running the following commands you need to install several development
|
Prior to running the following commands, you need to install several development
|
||||||
packages. For Ubuntu install the required packages with the following command:
|
packages.
|
||||||
|
|
||||||
|
On Ubuntu:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
@ -29,10 +31,21 @@ packages. For Ubuntu install the required packages with the following command:
|
||||||
libsqlite3-dev libldap2-dev libsasl2-dev \
|
libsqlite3-dev libldap2-dev libsasl2-dev \
|
||||||
libjpeg-dev liberasurecode-dev
|
libjpeg-dev liberasurecode-dev
|
||||||
|
|
||||||
|
On RHEL 7 and CentOS 7:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo yum install https://www.rdoproject.org/repos/rdo-release.rpm
|
||||||
|
$ sudo yum update
|
||||||
|
$ sudo yum install python-devel python-pip python-virtualenv \
|
||||||
|
libxml2-devel libxslt-devel zlib-devel \
|
||||||
|
mariadb-devel postgresql-devel libffi-devel \
|
||||||
|
sqlite-devel openldap-devel cyrus-sasl-devel \
|
||||||
|
libjpeg-turbo-devel liberasurecode-devel gcc git
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
* libjpeg is needed for ironic
|
* libjpeg is needed for ironic
|
||||||
* liberasurecode-dev is needed for swift
|
* liberasurecode is needed for swift
|
||||||
|
|
||||||
The workflow is:
|
The workflow is:
|
||||||
|
|
||||||
|
@ -45,10 +58,9 @@ The workflow is:
|
||||||
$ # check the results in sources/openstack-manuals
|
$ # check the results in sources/openstack-manuals
|
||||||
|
|
||||||
This will generate the tables for all the known projects.
|
This will generate the tables for all the known projects.
|
||||||
Note for Neutron project: If the driver/plugin resides outside the Neutron
|
Note for neutron project: If the driver/plugin resides outside the neutron
|
||||||
repository in stackforge, then the driver/plugin has to be explicitly
|
repository, then the driver/plugin has to be explicitly installed within the
|
||||||
installed within the virtual environment to generate the configuration
|
virtual environment to generate the configuration options.
|
||||||
options.
|
|
||||||
|
|
||||||
To generate the mappings and tables for a subset of projects, use the code
|
To generate the mappings and tables for a subset of projects, use the code
|
||||||
names as arguments:
|
names as arguments:
|
||||||
|
@ -72,7 +84,7 @@ The flagmappings files use the following format:
|
||||||
Groups need to be defined manually to organize the configuration tables.
|
Groups need to be defined manually to organize the configuration tables.
|
||||||
|
|
||||||
The group values can only contain alphanumeric characters, _ and - (they will
|
The group values can only contain alphanumeric characters, _ and - (they will
|
||||||
be used as docbook IDs).
|
be used as document IDs).
|
||||||
|
|
||||||
To make the table titles more user friendly, create or edit the PROJECT.headers
|
To make the table titles more user friendly, create or edit the PROJECT.headers
|
||||||
file in the manuals repository. Each line of this file is of the form:
|
file in the manuals repository. Each line of this file is of the form:
|
||||||
|
|
|
@ -28,7 +28,7 @@ import jinja2
|
||||||
PROJECTS = ['aodh', 'ceilometer', 'cinder', 'glance', 'heat', 'ironic',
|
PROJECTS = ['aodh', 'ceilometer', 'cinder', 'glance', 'heat', 'ironic',
|
||||||
'keystone', 'manila', 'neutron', 'nova', 'sahara', 'swift',
|
'keystone', 'manila', 'neutron', 'nova', 'sahara', 'swift',
|
||||||
'trove']
|
'trove']
|
||||||
MASTER_RELEASE = 'Mitaka'
|
MASTER_RELEASE = 'Ocata'
|
||||||
CODENAME_TITLE = {'aodh': 'Alarming',
|
CODENAME_TITLE = {'aodh': 'Alarming',
|
||||||
'ceilometer': 'Telemetry',
|
'ceilometer': 'Telemetry',
|
||||||
'cinder': 'Block Storage',
|
'cinder': 'Block Storage',
|
||||||
|
@ -262,11 +262,11 @@ def main():
|
||||||
type=str,)
|
type=str,)
|
||||||
parser.add_argument('-f', '--format',
|
parser.add_argument('-f', '--format',
|
||||||
dest='format',
|
dest='format',
|
||||||
help='Output format (docbook or rst).',
|
help='Output format (rst).',
|
||||||
required=False,
|
required=False,
|
||||||
default='rst',
|
default='rst',
|
||||||
type=str,
|
type=str,
|
||||||
choices=('docbook', 'rst'),)
|
choices=('rst'),)
|
||||||
parser.add_argument('-n', '--no-venv-update',
|
parser.add_argument('-n', '--no-venv-update',
|
||||||
dest='novenvupdate',
|
dest='novenvupdate',
|
||||||
help='Don\'t update the virtual envs.',
|
help='Don\'t update the virtual envs.',
|
||||||
|
|
Loading…
Reference in New Issue