opendev/system-config
Code Issues Proposed changes

Merge "Finish updating docs for opendev"

Browse Source
This commit is contained in:
Zuul 2019-04-20 20:39:08 +00:00 committed by Gerrit Code Review
commit fc84522ee0
19 changed files with 57 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/gerrit.rst
View File

@ -195,7 +195,7 @@ New Project Creation
====================
Gerrit project creation is now managed through changes to the
openstack-infra/project-config repository. :ref:`jeepyb` handles
openstack/project-config repository. :ref:`jeepyb` handles
automatically creating any new projects defined in the configuration
files.

4
doc/source/jeepyb.rst
View File

@ -16,14 +16,14 @@ At a Glance
* http://review.opendev.org
* http://review-dev.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-jeepyb/tree/
* https://opendev.org/opendev/puppet-jeepyb
* :cgit_file:`modules/openstack_project/manifests/review.pp`
* :cgit_file:`modules/openstack_project/manifests/review_dev.pp`
:Configuration:
* :cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`
* :config:`gerrit/projects.yaml`
:Projects:
* https://git.openstack.org/cgit/openstack-infra/jeepyb
* https://opendev.org/opendev/jeepyb
:Bugs:
* https://storyboard.openstack.org/#!/project/722

2
doc/source/kerberos.rst
View File

@ -16,7 +16,7 @@ At a Glance
:Hosts:
* kdc*.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-kerberos/tree/
* https://opendev.org/opendev/puppet-kerberos
* :cgit_file:`modules/openstack_project/manifests/kdc.pp`
:Projects:
* http://web.mit.edu/kerberos

2
doc/source/lists.rst
View File

@ -15,7 +15,7 @@ At a Glance
:Hosts:
* http://lists.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-mailman/tree/
* https://opendev.org/opendev/puppet-mailman
* :cgit_file:`modules/openstack_project/manifests/lists.pp`
:Projects:
* http://www.gnu.org/software/mailman/

6
doc/source/nodepool.rst
View File

@ -23,14 +23,14 @@ At a Glance
* zk02.openstack.org
* zk03.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-openstackci/tree/manifests/nodepool_launcher.pp
* https://git.openstack.org/cgit/openstack-infra/puppet-openstackci/tree/manifests/nodepool_builder.pp
* https://opendev.org/opendev/puppet-openstackci/src/branch/master/manifests/nodepool_launcher.pp
* https://opendev.org/opendev/puppet-openstackci/src/branch/master/manifests/nodepool_builder.pp
:Configuration:
* :config:`nodepool/nodepool.yaml`
* :config:`nodepool/scripts/`
* :config:`nodepool/elements/`
:Projects:
* https://git.openstack.org/cgit/openstack-infra/nodepool
* https://opendev.org/zuul/nodepool
:Bugs:
* https://storyboard.openstack.org/#!/project/668
:Resources:

4
doc/source/openstack-health.rst
View File

@ -12,13 +12,13 @@ At a Glance
* API Server: http://health.openstack.org
* Frontend: http://status.openstack.org/openstack-health
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-openstack_health/tree/
* https://opendev.org/opendev/puppet-openstack_health/tree/
* :cgit_file:`modules/openstack_project/manifests/openstack_health_api.pp`
* :cgit_file:`modules/openstack_project/manifests/status.pp`
:Configuration:
* :cgit_file:`modules/openstack_project/files/git/cgitrc`
:Projects:
* https://git.openstack.org/cgit/openstack/openstack-health/tree
* https://opendev.org/openstack/openstack-health
Overview
========

4
doc/source/openstackid.rst
View File

@ -15,10 +15,10 @@ At a Glance
* https://openstackid-dev.openstack.org
* https://openstackid.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-openstackid/tree/
* https://opendev.org/opendev/puppet-openstackid
* :cgit_file:`modules/openstack_project/manifests/openstackid_dev.pp`
:Projects:
* http://git.openstack.org/cgit/openstack-infra/openstackid/
* http://opendev.org/osf/openstackid/
:Bugs:
* https://storyboard.openstack.org/#!/project/728
:Resources:

10
doc/source/paste.rst
View File

@ -16,10 +16,10 @@ At a Glance
:Hosts:
* http://paste.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-lodgeit/tree/
* https://opendev.org/opendev/puppet-lodgeit
* :cgit_file:`modules/openstack_project/manifests/paste.pp`
:Projects:
* https://git.openstack.org/cgit/openstack-infra/lodgeit
* https://opendev.org/opendev/lodgeit
* https://bitbucket.org/dcolish/lodgeit-main
* http://www.pocoo.org/projects/lodgeit/
:Bugs:
@ -29,12 +29,12 @@ Overview
========
For OpenStack we use `a fork
<https://git.openstack.org/cgit/openstack-infra/lodgeit>`_ of lodgeit which is
<https://opendev.org/opendev/lodgeit>`_ of lodgeit which is
based on one with bugfixes maintained by `dcolish
<https://bitbucket.org/dcolish/lodgeit-main>`_ but adds back missing
anti-spam features required by OpenStack.
Puppet configures lodgeit to use drizzle as a database backend, apache
Puppet configures lodgeit to use MySQL as a database backend, apache
as a front-end proxy.
The lodgeit module will automatically create a git repository in
@ -45,5 +45,5 @@ job per file) and commit it to the git repository.
.. note::
Ideally the SQL files would have a row on every line to keep the
diffs stored in git small, but ``drizzledump`` does not yet support
diffs stored in git small, but ``mysqldump`` does not yet support
this.

6
doc/source/planet.rst
View File

@ -16,12 +16,12 @@ At a Glance
* ``planet01.openstack.org``
* http://planet.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-planet/tree/
* https://opendev.org/opendev/puppet-planet/tree/
* :cgit_file:`modules/openstack_project/manifests/planet.pp`
:Configuration:
* https://git.openstack.org/cgit/openstack/openstack-planet/tree/planet.ini
* https://opendev.org/openstack/openstack-planet/src/branch/master/planet.ini
:Projects:
* https://git.openstack.org/cgit/openstack/openstack-planet
* https://opendev.org/openstack/openstack-planet
* http://www.intertwingly.net/code/venus/
:Bugs:
* https://storyboard.openstack.org/#!/project/748

8
doc/source/puppet.rst
View File

@ -14,10 +14,6 @@ as well as the scripts to create new servers.
At a Glance
===========
:Hosts:
* puppetmaster.openstack.org
:Puppet:
* :cgit_file:`modules/openstack_project/manifests/puppetmaster.pp`
:Projects:
* https://puppetlabs.com/
:Bugs:
@ -46,7 +42,7 @@ Ansible and Puppet 3 is known to run on Precise, Trusty, Centos 6 and Centos 7.
.. code-block:: bash
sudo su -
git clone https://git.openstack.org/openstack-infra/system-config /opt/system-config
git clone https://opendev.org/opendev/system-config /opt/system-config
bash /opt/system-config/install_puppet.sh
bash /opt/system-config/install_modules.sh
echo $REAL_HOSTNAME > /etc/hostname
@ -91,7 +87,7 @@ For manual bootstrap, you need to run on the new server connecting
.. code-block:: bash
sudo su -
wget https://git.openstack.org/cgit/openstack-infra/system-config/plain/install_puppet.sh
wget https://opendev.org/opendev/system-config/raw/branch/master/install_puppet.sh
bash -x install_puppet.sh
Running Puppet on Nodes

4
doc/source/refstack.rst
View File

@ -16,9 +16,9 @@ At a Glance
:Hosts:
* http://refstack.openstack.org/
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-refstack/
* https://opendev.org/opendev/puppet-refstack/
:Projects:
* https://git.openstack.org/cgit/openstack/refstack/
* https://opendev.org/openstack/refstack/
:Bugs:
* https://bugs.launchpad.net/refstack

6
doc/source/signing.rst
View File

@ -20,7 +20,7 @@ At a Glance
:Secrets:
* `gpg_key
<https://git.openstack.org/cgit/openstack-infra/project-config/tree/zuul.d/secrets.yaml>`_
<https://opendev.org/openstack/project-config/src/branch/master/zuul.d/secrets.yaml>`_
:Roles:
* `add-gpgkey
<https://docs.openstack.org/infra/zuul-jobs/roles.html#role-add-gpgkey>`_
@ -477,10 +477,10 @@ as a secret to Zuul for use by release jobs.
root@bridge:~# gpg --homedir temporary.gnupg \
> --output temporary.gnupg/for-zuul --armor \
> --export-secret-subkeys 0xC0224DB5F541FB68\!
root@bridge:~# wget https://git.openstack.org/cgit/openstack-infra/zuul/plain/tools/encrypt_secret.py
root@bridge:~# wget https://opendev.org/zuul/zuul/raw/branch/master/tools/encrypt_secret.py
root@bridge:~# python3 encrypt_secret.py --tenant openstack \
> --infile temporary.gnupg/for-zuul --outfile temporary.gnupg/zuul.yaml \
> https://zuul.openstack.org openstack-infra/project-config
> https://zuul.openstack.org openstack/project-config
writing RSA key
Public key length: 4096 bits (512 bytes)
Max plaintext length per chunk: 470 bytes

8
doc/source/storyboard.rst
View File

@ -18,12 +18,12 @@ At a Glance
:Hosts:
* https://storyboard.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-storyboard/tree/
* https://opendev.org/opendev/puppet-storyboard/tree/
* :cgit_file:`modules/openstack_project/manifests/storyboard.pp`
:Projects:
* https://git.openstack.org/cgit/openstack-infra/storyboard
* https://git.openstack.org/cgit/openstack-infra/storyboard-webclient
* https://git.openstack.org/cgit/openstack-infra/puppet-storyboard
* https://opendev.org/opendev/storyboard
* https://opendev.org/opendev/storyboard-webclient
* https://opendev.org/opendev/puppet-storyboard
:Configuration:
* :config:`gerrit/projects.yaml`
* :cgit_file:`modules/openstack_project/files/storyboard/superusers.yaml`

17
doc/source/sysadmin.rst
View File

@ -12,9 +12,9 @@ access, and anyone who is interested can provide feedback and
collaborate on code reviews.
The configuration of every system operated by the infrastructure team
is managed by Puppet in a single Git repository:
is managed by a combination of Ansible and Puppet:
https://git.openstack.org/cgit/openstack-infra/system-config
https://opendev.org/opendev/system-config
All system configuration should be encoded in that repository so that
anyone may propose a change in the running configuration to Gerrit.
@ -65,7 +65,7 @@ Git repo::
sudo su -
apt-get install git
git clone https://git.openstack.org/openstack-infra/system-config
git clone https://opendev.org/opendev/system-config
cd system-config
Then copy the etherpad node definition from `manifests/site.pp` to a new
@ -435,7 +435,7 @@ Launching New Servers
=====================
New servers are launched using the ``launch/launch-node.py`` tool from the git
repository ``https://git.openstack.org/openstack-infra/system-config``. This
repository ``https://opendev.org/opendev/system-config``. This
tool is run from a checkout on the bridge - please see :cgit_file:`launch/README`
for detailed instructions.
@ -501,15 +501,6 @@ without landing a puppet change, ensure the following is in
[disabled]
amazing.openstack.org
To disable one of the OpenStack instances called `git.openstack.org`
temporarily without landing a puppet change but leaving the other running,
find its UUID via OpenStack tools and ensure it's in the emergency file.
::
[disabled]
811c5197-dba7-4d3a-a3f6-68ca5328b9a7
To disable a group of hosts in the emergency file, such as all of the pypi
hosts.

20
doc/source/third_party.rst
View File

@ -142,7 +142,7 @@ advisable during the initial testing of the setup.
There are several triggers that gerrit will match to alter the
formatting of comments. The raw regular expressions can be seen in
`gerrit.pp <https://git.openstack.org/cgit/openstack-infra/system-config/tree/modules/openstack_project/manifests/gerrit.pp>`_.
`gerrit.pp <https://opendev.org/opendev/system-config/src/branch/master/modules/openstack_project/manifests/gerrit.pp>`_.
For example, to have your test results formatted in the same manner as
the upstream Jenkins results, use a template for each result matching::
@ -295,7 +295,7 @@ The Zuul Gerrit Trigger Way
Zuul listens to the Gerrit event stream, and first tries to match each event to one or more pipelines.
Zuul’s pipelines are configured in a single file called layout.yaml.
Here’s a snippet from that file that constructs the ``check`` pipeline taken from this
`Zuul sample layout.yaml file <https://git.openstack.org/cgit/openstack-infra/zuul/tree/etc/layout.yaml-sample>`_
`Zuul sample layout.yaml file <https://opendev.org/zuul/zuul/src/branch/master/etc/layout.yaml-sample>`_
.. code-block:: yaml
@ -351,10 +351,6 @@ the ``check`` pipeline would run the ``my-sandbox-check`` job in Jenkins. If the
Gerrit event also matched the ``test`` pipeline, Zuul would also invoke the ``my-sandbox-test``
Jenkins job.
The `layout.yaml <https://git.openstack.org/cgit/openstack-infra/project-config/tree/zuul/layout.yaml>`_
used by OpenStack is a good reference for real world pipeline definitions,
and project-pipeline-job definitions.
The following documentation explains how to setup a 3rd party CI system using this approach.
`OpenStack Third-Party CI <http://docs.openstack.org/infra/openstackci/>`_
@ -376,16 +372,6 @@ Luckily, there is a helper tool called `Jenkins Job Builder (JJB)
constructs and manages these XML configuration files after reading a
set of YAML files and job templating rules. These references provide more details:
* `A basic overview of using JJB to define projects, templates, and jobs in yaml
format is available here. <http://docs.openstack.org/infra/system-config/jjb.html>`_
* `The official documentation to define Jenkins jobs using JJB is here.
<http://docs.openstack.org/infra/jenkins-job-builder/definition.html>`_
* `The JJB description of all jobs used by OpenStack are defined in this folder.
<https://git.openstack.org/cgit/openstack-infra/project-config/tree/jenkins/jobs>`_
(The projects.yaml file is a good starting point)
Testing your CI setup
---------------------
@ -407,7 +393,7 @@ Verified on any changes. The exception to this is on the
Verified on that account and it provides a way to test your CI's voting
abilities before you vote on other projects.
.. _openstack-dev/ci-sandbox: https://git.openstack.org/cgit/openstack-dev/ci-sandbox/
.. _openstack-dev/ci-sandbox: https://opendev.org/openstack-dev/ci-sandbox
The OpenStack Infrastructure team disables mis-behaving third-party ci
accounts at its discretion. This documentation endeavours to outline specific

4
doc/source/translate.rst
View File

@ -15,7 +15,7 @@ At a Glance
* https://translate.openstack.org
* https://translate-dev.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-zanata/tree/
* https://opendev.org/opendev/puppet-zanata/tree/
* :cgit_file:`modules/openstack_project/manifests/translate.pp`
* :cgit_file:`modules/openstack_project/manifests/translate-dev.pp`
:Projects:
@ -52,4 +52,4 @@ changes.
Finally, the translations jobs must be added to the project in
:config:`jenkins/jobs/projects.yaml` and :config:`zuul/layout.yaml`.
.. _project-config zuul jobs: http://git.openstack.org/cgit/openstack-infra/project-config/tree/zuul.d/jobs.yaml
.. _project-config zuul jobs: https://opendev.org/openstack/project-config/src/branch/master/zuul.d/jobs.yaml

2
doc/source/wiki.rst
View File

@ -14,7 +14,7 @@ At a Glance
:Hosts:
* https://wiki.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-mediawiki/tree/
* https://opendev.org/opendev/puppet-mediawiki
* :cgit_file:`modules/openstack_project/manifests/wiki.pp`
:Projects:
* http://www.mediawiki.org/wiki/MediaWiki

22
doc/source/zuul.rst
View File

@ -12,20 +12,20 @@ At a Glance
===========
:Hosts:
* https://zuul.openstack.org
* https://zuul.opendev.org
* ze*.openstack.org
* zm*.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-zuul/tree/
* https://opendev.org/opendev/puppet-zuul
* :cgit_file:`modules/openstack_project/manifests/zuul_prod.pp`
* :cgit_file:`modules/openstack_project/manifests/zuul_dev.pp`
:Configuration:
* :config:`zuul/`
* :config:`zuul.d/`
:Projects:
* https://git.zuul-ci.org/cgit/zuul
* https://opendev.org/zuul/zuul
:Bugs:
* https://storyboard.openstack.org/#!/project/openstack-infra/zuul
* https://storyboard.openstack.org/#!/project/zuul/zuul
:Resources:
* `Zuul Reference Manual <https://zuul-ci.org/docs/zuul>`_
:Chat:
@ -50,7 +50,7 @@ many changes may be tested in parallel while continuing to assure that
each commit is correctly tested.
Zuul's current status may be viewed at
`<https://zuul.openstack.org/>`_.
`<https://zuul.opendev.org/>`_.
Zuul's configuration is distributed across projects listed in
:config:`zuul/main.yaml`. Anyone may propose a change to the
@ -86,15 +86,15 @@ Restarts
Zuul restarts are disruptive, so non-emergency restarts should always be
scheduled for quieter times of the day, week and cycle. To be as
courteous to developers as possible, just prior to a restart the `Zuul
Status Page <https://zuul.openstack.org/>`_ should be checked to
see the status of the gate. If there is a series of changes nearly
courteous to developers as possible, just prior to a restart the `OpenStack
Status Page <https://zuul.opendev.org/t/openstack/status>`_ should be checked to
see the status of the OpenStack gate. If there is a series of changes nearly
merged, wait until that has been completed.
Since Zuul is stateless, some work needs to be done to save and then
re-enqueue patches when restarts are done. To accomplish this, start by
running `zuul-changes.py
<https://git.zuul-ci.org/cgit/zuul/tree/tools/zuul-changes.py>`_
<https://opendev.org/zuul/zuul/src/branch/master/tools/zuul-changes.py>`_
to save the check and gate queues::
python /opt/zuul/tools/zuul-changes.py http://zuul.openstack.org \
@ -116,7 +116,7 @@ then check.sh to re-enqueue the changes from before the restart::
./check.sh
You may watch the `Zuul Status Page
<https://zuul.openstack.org/>`_ to confirm that changes are
<https://zuul.opendev.org/t/openstack/status>`_ to confirm that changes are
returning to the queues. This frontend is provided by the zuul-web
service on the same server, which may also need to be restarted.
@ -152,4 +152,4 @@ secret ciphertext from the job configuration first to remove surrounding
YAML, there is no need to dedent nor recombine split lines)::
cat ciphertext.txt | base64 -d | sudo openssl rsautl -decrypt -oaep -inkey \
/var/lib/zuul/keys/secrets/project/gerrit/openstack-infra/project-config/0.pem
/var/lib/zuul/keys/secrets/project/gerrit/openstack/project-config/0.pem

10
doc/source/zuulv3.rst
View File

@ -23,14 +23,14 @@ At a Glance
* ze*.openstack.org
* zm*.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-zuul/tree/
* https://git.openstack.org/cgit/openstack-infra/puppet-openstackci/tree/manifests/zuul_merger.pp
* https://git.openstack.org/cgit/openstack-infra/puppet-openstackci/tree/manifests/zuul_scheduler.pp
* https://opendev.org/opendev/puppet-zuul
* https://opendev.org/opendev/puppet-openstackci/src/branch/master/manifests/zuul_merger.pp
* https://opendev.org/opendev/puppet-openstackci/src/branch/master/manifests/zuul_scheduler.pp
:Configuration:
* :config:`zuul/main.yaml`
* :config:`zuul.d`
:Projects:
* https://git.openstack.org/cgit/openstack-infra/zuul/tree/
* https://opendev.org/zuul/zuul
:Bugs:
* https://storyboard.openstack.org/#!/project/679
:Resources:
@ -146,7 +146,7 @@ series of changes nearly merged, wait until that has been completed.
Since Zuul is stateless, some work needs to be done to save and then
re-enqueue patches when restarts are done. To accomplish this, start by
running `zuul-changes.py
<https://git.openstack.org/cgit/openstack-infra/zuul/tree/tools/zuul-changes.py>`_
<https://opendev.org/zuul/zuul/src/branch/master/tools/zuul-changes.py>`_
to save the check and gate queues::
python /opt/zuul/tools/zuul-changes.py http://zuul.openstack.org \