restore stable/mitaka build

Remove obsolete niceness checking tools from tox settings
(doc8 throws an encoding error on one of the old files and
openstack-doc-test doesn't seem to exist at all any more).

Restore the builds for all guides, but place the output under the
mitaka directory. This effectively makes these mitaka-specific
versions of the guides. Links to the guides on the /mitaka landing
page need to be updated separately on master.

Change remote include directives from stable/mitaka to mitaka-eol.

Add .zuul.yaml, copied from stable/newton, and the required playbook for
running the builds in tox.

Add "linters" alias environment in tox.ini since that is now what the
test jobs expect.

Change-Id: Ifc667dd46d2282c8f843600d10ae988a8a281041
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-11-20 10:59:47 -05:00
parent 1865f28305
commit f76dc6224f
37 changed files with 108 additions and 54 deletions

49
.zuul.yaml Normal file
View File

@ -0,0 +1,49 @@
# Shared Zuul v3 definitions for OpenStack CI.
# These jobs are used in api-site, openstack-manuals, and security-doc
# repositories.
- job:
name: build-tox-manuals
description: |
Base job to build manual related documents. These build jobs
invoke a tox command and expect the published content to be in
publish-docs directory. This content is published on the root of
the website.
Note that this build job does not create a root-marker file,
this has to be done by scripts called from tox.
parent: openstack-tox
success-url: publish-docs/
post-run: playbooks/build-manuals-tox/post.yaml
roles:
- zuul: openstack-infra/zuul-jobs
- job:
name: build-tox-manuals-checkbuild
parent: build-tox-manuals
vars:
tox_envlist: checkbuild
# Templates to easily group jobs.
- project-template:
name: openstack-manuals-jobs
description: |
Runs jobs for non-translated documents.
check:
jobs:
- openstack-tox-linters
- build-tox-manuals-checkbuild
gate:
jobs:
- openstack-tox-linters
- build-tox-manuals-checkbuild
post:
jobs:
- publish-openstack-manuals
# Configuration for this repository, determines which jobs to run.
- project:
name: openstack/openstack-manuals
templates:
- openstack-manuals-jobs

View File

@ -29,7 +29,7 @@ service.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=stable/mitaka
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/api-paste.ini?h=mitaka-eol
policy.json
~~~~~~~~~~~
@ -39,7 +39,7 @@ to the Block Storage service.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=stable/mitaka
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/policy.json?h=mitaka-eol
rootwrap.conf
~~~~~~~~~~~~~
@ -50,4 +50,4 @@ privileges to those of the root user.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/rootwrap.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/cinder/plain/etc/cinder/rootwrap.conf?h=mitaka-eol

View File

@ -7,4 +7,4 @@ The Compute service stores its API configuration settings in the
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/api-paste.ini?h=stable/mitaka
https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/api-paste.ini?h=mitaka-eol

View File

@ -7,4 +7,4 @@ that apply to the Compute service.
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/policy.json?h=stable/mitaka
https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/policy.json?h=mitaka-eol

View File

@ -12,4 +12,4 @@ to sudo only. Configure the ``disable_rootwrap`` option in the
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/rootwrap.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/nova/plain/etc/nova/rootwrap.conf?h=mitaka-eol

View File

@ -13,7 +13,7 @@ options:
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone.conf.sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone.conf.sample?h=mitaka-eol
keystone-paste.ini
~~~~~~~~~~~~~~~~~~
@ -23,7 +23,7 @@ Interface (WSGI) middleware pipeline for the Identity service:
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone-paste.ini?h=stable/mitaka
https://git.openstack.org/cgit/openstack/keystone/plain/etc/keystone-paste.ini?h=mitaka-eol
logging.conf
~~~~~~~~~~~~
@ -36,7 +36,7 @@ For details, see the `Python logging module documentation
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/keystone/plain/etc/logging.conf.sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/keystone/plain/etc/logging.conf.sample?h=mitaka-eol
policy.json
~~~~~~~~~~~
@ -46,4 +46,4 @@ the Identity service:
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/keystone/plain/etc/policy.json?h=stable/mitaka
https://git.openstack.org/cgit/openstack/keystone/plain/etc/policy.json?h=mitaka-eol

View File

@ -9,4 +9,4 @@ You should not need to modify this file.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api-paste.ini?h=mitaka-eol

View File

@ -9,4 +9,4 @@ This file must be modified after installation.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-api.conf?h=mitaka-eol

View File

@ -7,4 +7,4 @@ are found in the ``glance-cache.conf`` file.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-cache.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-cache.conf?h=mitaka-eol

View File

@ -15,4 +15,4 @@ are found in the ``glance-manage.conf`` file.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-manage.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-manage.conf?h=mitaka-eol

View File

@ -7,4 +7,4 @@ The Image service's middleware pipeline for its registry is found in the
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry-paste.ini?h=mitaka-eol

View File

@ -9,4 +9,4 @@ This file must be modified after installation.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-registry.conf?h=mitaka-eol

View File

@ -8,4 +8,4 @@ deleted. Its configuration is stored in the ``glance-scrubber.conf`` file.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-scrubber.conf?h=mitaka-eol

View File

@ -4,4 +4,4 @@ glance-swift.conf
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-swift.conf.sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/glance-swift.conf.sample?h=mitaka-eol

View File

@ -11,4 +11,4 @@ from the ``CIM_ProcessorAllocationSettingData`` namespace,
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/glance/plain/etc/ovf-metadata.json.sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/ovf-metadata.json.sample?h=mitaka-eol

View File

@ -7,4 +7,4 @@ apply to the Image service.
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/policy.json?h=mitaka-eol

View File

@ -4,4 +4,4 @@ property-protections-policies.conf
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-policies.conf.sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-policies.conf.sample?h=mitaka-eol

View File

@ -4,4 +4,4 @@ property-protections-roles.conf
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-roles.conf.sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/glance/plain/etc/property-protections-roles.conf.sample?h=mitaka-eol

View File

@ -29,7 +29,7 @@ gateway interface (WSGI).
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/neutron/plain/etc/api-paste.ini?h=stable/mitaka
https://git.openstack.org/cgit/openstack/neutron/plain/etc/api-paste.ini?h=mitaka-eol
policy.json
~~~~~~~~~~~
@ -38,7 +38,7 @@ The ``policy.json`` defines API access policy.
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/neutron/plain/etc/policy.json?h=stable/mitaka
https://git.openstack.org/cgit/openstack/neutron/plain/etc/policy.json?h=mitaka-eol
rootwrap.conf
~~~~~~~~~~~~~
@ -48,7 +48,7 @@ that require privilege escalation to execute.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/neutron/plain/etc/rootwrap.conf?h=stable/mitaka
https://git.openstack.org/cgit/openstack/neutron/plain/etc/rootwrap.conf?h=mitaka-eol
Reference architecture plug-ins and agents
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -22,4 +22,4 @@ Sample account server configuration file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=mitaka-eol

View File

@ -20,4 +20,4 @@ Sample container sync reconciler configuration file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-reconciler.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-reconciler.conf-sample?h=mitaka-eol

View File

@ -23,4 +23,4 @@ Sample container server configuration file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=mitaka-eol

View File

@ -16,4 +16,4 @@ Sample container sync realms configuration file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-sync-realms.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/container-sync-realms.conf-sample?h=mitaka-eol

View File

@ -20,4 +20,4 @@ Sample object expirer configuration file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/object-expirer.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/object-expirer.conf-sample?h=mitaka-eol

View File

@ -22,4 +22,4 @@ Sample object server configuration file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=mitaka-eol

View File

@ -29,4 +29,4 @@ Sample proxy server configuration file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=mitaka-eol

View File

@ -28,7 +28,7 @@ traits that operators may find useful.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml?h=stable/mitaka
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml?h=mitaka-eol
pipeline.yaml
~~~~~~~~~~~~~
@ -42,7 +42,7 @@ generated by the Telemetry module.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml?h=stable/mitaka
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml?h=mitaka-eol
event_pipeline.yaml
~~~~~~~~~~~~~~~~~~~
@ -56,7 +56,7 @@ where to publish the events.
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_pipeline.yaml?h=stable/mitaka
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_pipeline.yaml?h=mitaka-eol
policy.json
~~~~~~~~~~~
@ -66,4 +66,4 @@ to the Telemetry service.
.. remote-code-block:: json
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/policy.json?h=stable/mitaka
https://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/policy.json?h=mitaka-eol

View File

@ -2523,7 +2523,7 @@ msgid ""
"mitaka>`__."
msgstr ""
"このファイルが存在しない場合は、 `ここ <http://git.openstack.org/cgit/"
"openstack/trove/plain/etc/trove/api-paste.ini?h=stable/mitaka>`__ からファイ"
"openstack/trove/plain/etc/trove/api-paste.ini?h=mitaka-eol>`__ からファイ"
"ルを取得できます。"
msgid ""

View File

@ -2603,7 +2603,7 @@ msgid ""
"mitaka>`__."
msgstr ""
"만약 해당 파일이 존재하지 않는 경우, 해당 `위치 <http://git.openstack.org/"
"cgit/openstack/trove/plain/etc/trove/api-paste.ini?h=stable/mitaka>`__ 로부"
"cgit/openstack/trove/plain/etc/trove/api-paste.ini?h=mitaka-eol>`__ 로부"
"터 파일을 가져올 수 있습니다."
msgid ""

View File

@ -2267,7 +2267,7 @@ msgid ""
"mitaka>`__."
msgstr ""
"如果文件不存在,你可以从以下这个地址获得它:<http://git.openstack.org/cgit/"
"openstack/trove/plain/etc/trove/api-paste.ini?h=stable/mitaka>`__."
"openstack/trove/plain/etc/trove/api-paste.ini?h=mitaka-eol>`__."
msgid ""
"If the upgrade process includes a new kernel, reboot your host to activate "

View File

@ -174,7 +174,7 @@ Install and configure components
.. code-block:: console
# curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/mitaka
# curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=mitaka-eol
.. only:: rdo
@ -183,7 +183,7 @@ Install and configure components
.. code-block:: console
# curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=stable/mitaka
# curl -o /etc/swift/proxy-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/proxy-server.conf-sample?h=mitaka-eol
.. only:: obs

View File

@ -11,7 +11,7 @@ Finalize installation
.. code-block:: console
# curl -o /etc/swift/swift.conf \
https://git.openstack.org/cgit/openstack/swift/plain/etc/swift.conf-sample?h=stable/mitaka
https://git.openstack.org/cgit/openstack/swift/plain/etc/swift.conf-sample?h=mitaka-eol
#. Edit the ``/etc/swift/swift.conf`` file and complete the following
actions:

View File

@ -173,9 +173,9 @@ Install and configure components
.. code-block:: console
# curl -o /etc/swift/account-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=stable/mitaka
# curl -o /etc/swift/container-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=stable/mitaka
# curl -o /etc/swift/object-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=stable/mitaka
# curl -o /etc/swift/account-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/account-server.conf-sample?h=mitaka-eol
# curl -o /etc/swift/container-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/container-server.conf-sample?h=mitaka-eol
# curl -o /etc/swift/object-server.conf https://git.openstack.org/cgit/openstack/swift/plain/etc/object-server.conf-sample?h=mitaka-eol
3. .. include:: swift-storage-include1.txt
4. .. include:: swift-storage-include2.txt

View File

@ -235,7 +235,7 @@ Install and configure components
3. Verify that the ``api-paste.ini`` file is present in ``/etc/trove``.
If the file is not present, you can get it from this
`location <http://git.openstack.org/cgit/openstack/trove/plain/etc/trove/api-paste.ini?h=stable/mitaka>`__.
`location <http://git.openstack.org/cgit/openstack/trove/plain/etc/trove/api-paste.ini?h=mitaka-eol>`__.
4. Edit the ``trove.conf`` file so it includes appropriate values for the
settings shown below:

View File

@ -0,0 +1,5 @@
- hosts: all
roles:
- role: fetch-tox-output
- role: fetch-sphinx-output
sphinx_output_src: "{{ zuul.project.src_dir }}/publish-docs"

View File

@ -9,12 +9,10 @@ if [[ $# > 0 ]] ; then
fi
fi
# Do not build from stable/mitaka
#for guide in user-guide admin-guide \
# contributor-guide image-guide arch-design cli-reference; do
# tools/build-rst.sh doc/$guide --build build \
# --target $guide $LINKCHECK
#done
for guide in user-guide admin-guide cli-reference; do
tools/build-rst.sh doc/$guide --build build \
--target "mitaka/$guide" $LINKCHECK
done
# This marker is needed for infra publishing
MARKER_TEXT="Project: $ZUUL_PROJECT Ref: $ZUUL_REFNAME Build: $ZUUL_UUID"

View File

@ -23,12 +23,14 @@ commands =
{toxinidir}/tools/build-all-rst.sh --linkcheck
[testenv:checkniceness]
# Will be replaced by linters
commands =
openstack-doc-test --check-niceness {posargs}
flake8
doc8 doc
bash -c "find doc -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null"
[testenv:linters]
commands = {[testenv:checkniceness]commands}
[testenv:checkbuild]
commands =
{toxinidir}/tools/publishdocs.sh build