From eaa74543de4962a9f1ff6a6a6f0eecb59520ef11 Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Sat, 20 Apr 2019 13:59:34 +0000 Subject: [PATCH] Finish updating docs for opendev The zuul and zuulv3 docs need to be merged, but that seemed like too much for this. Also, the 3rd party CI doc is out of date, but in this patch only removed sections that linked to docs or files that don't exist anymore. Change-Id: Ie5497edd762d2146165608f3227b0bac88a913df --- doc/source/gerrit.rst | 2 +- doc/source/jeepyb.rst | 4 ++-- doc/source/kerberos.rst | 2 +- doc/source/lists.rst | 2 +- doc/source/nodepool.rst | 6 +++--- doc/source/openstack-health.rst | 4 ++-- doc/source/openstackid.rst | 4 ++-- doc/source/paste.rst | 10 +++++----- doc/source/planet.rst | 6 +++--- doc/source/puppet.rst | 8 ++------ doc/source/refstack.rst | 4 ++-- doc/source/signing.rst | 6 +++--- doc/source/storyboard.rst | 8 ++++---- doc/source/sysadmin.rst | 17 ++++------------- doc/source/third_party.rst | 20 +++----------------- doc/source/translate.rst | 4 ++-- doc/source/wiki.rst | 2 +- doc/source/zuul.rst | 22 +++++++++++----------- doc/source/zuulv3.rst | 10 +++++----- 19 files changed, 57 insertions(+), 84 deletions(-) diff --git a/doc/source/gerrit.rst b/doc/source/gerrit.rst index 18cd4ec7a1..dd0d31c3d6 100644 --- a/doc/source/gerrit.rst +++ b/doc/source/gerrit.rst @@ -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. diff --git a/doc/source/jeepyb.rst b/doc/source/jeepyb.rst index f9df8163ef..bb334ab65e 100644 --- a/doc/source/jeepyb.rst +++ b/doc/source/jeepyb.rst @@ -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 diff --git a/doc/source/kerberos.rst b/doc/source/kerberos.rst index 8e1a7468fe..c3703710a8 100644 --- a/doc/source/kerberos.rst +++ b/doc/source/kerberos.rst @@ -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 diff --git a/doc/source/lists.rst b/doc/source/lists.rst index e38b148f13..a534486804 100644 --- a/doc/source/lists.rst +++ b/doc/source/lists.rst @@ -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/ diff --git a/doc/source/nodepool.rst b/doc/source/nodepool.rst index 3150dad2e3..14080967bd 100644 --- a/doc/source/nodepool.rst +++ b/doc/source/nodepool.rst @@ -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: diff --git a/doc/source/openstack-health.rst b/doc/source/openstack-health.rst index b1ead875d8..3ee28d3e67 100644 --- a/doc/source/openstack-health.rst +++ b/doc/source/openstack-health.rst @@ -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 ======== diff --git a/doc/source/openstackid.rst b/doc/source/openstackid.rst index 1f5f83c452..ac14f6a663 100644 --- a/doc/source/openstackid.rst +++ b/doc/source/openstackid.rst @@ -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: diff --git a/doc/source/paste.rst b/doc/source/paste.rst index 10fbd71380..1d455da865 100644 --- a/doc/source/paste.rst +++ b/doc/source/paste.rst @@ -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 -`_ of lodgeit which is +`_ of lodgeit which is based on one with bugfixes maintained by `dcolish `_ 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. diff --git a/doc/source/planet.rst b/doc/source/planet.rst index 1ea78bfd90..af6831f24a 100644 --- a/doc/source/planet.rst +++ b/doc/source/planet.rst @@ -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 diff --git a/doc/source/puppet.rst b/doc/source/puppet.rst index 1f52eb1410..1b22a4aa94 100644 --- a/doc/source/puppet.rst +++ b/doc/source/puppet.rst @@ -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 diff --git a/doc/source/refstack.rst b/doc/source/refstack.rst index bd0d09e7aa..68617ef6f8 100644 --- a/doc/source/refstack.rst +++ b/doc/source/refstack.rst @@ -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 diff --git a/doc/source/signing.rst b/doc/source/signing.rst index 65764a7a4a..0ddd4ec3da 100644 --- a/doc/source/signing.rst +++ b/doc/source/signing.rst @@ -20,7 +20,7 @@ At a Glance :Secrets: * `gpg_key - `_ + `_ :Roles: * `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 diff --git a/doc/source/storyboard.rst b/doc/source/storyboard.rst index 41b4ab4a26..912e0c6471 100644 --- a/doc/source/storyboard.rst +++ b/doc/source/storyboard.rst @@ -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` diff --git a/doc/source/sysadmin.rst b/doc/source/sysadmin.rst index 807d3921a2..f36229c6c8 100644 --- a/doc/source/sysadmin.rst +++ b/doc/source/sysadmin.rst @@ -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. diff --git a/doc/source/third_party.rst b/doc/source/third_party.rst index 03c6a2a296..c298430cf6 100644 --- a/doc/source/third_party.rst +++ b/doc/source/third_party.rst @@ -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 `_. +`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 `_ +`Zuul sample layout.yaml file `_ .. 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 `_ -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 `_ @@ -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. `_ - -* `The official documentation to define Jenkins jobs using JJB is here. - `_ - -* `The JJB description of all jobs used by OpenStack are defined in this folder. - `_ - (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 diff --git a/doc/source/translate.rst b/doc/source/translate.rst index ff37523153..bb92b06e3f 100644 --- a/doc/source/translate.rst +++ b/doc/source/translate.rst @@ -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 diff --git a/doc/source/wiki.rst b/doc/source/wiki.rst index 1c3b72b52b..3ddd0e9fae 100644 --- a/doc/source/wiki.rst +++ b/doc/source/wiki.rst @@ -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 diff --git a/doc/source/zuul.rst b/doc/source/zuul.rst index 324129f4e9..ac6dcdf63d 100644 --- a/doc/source/zuul.rst +++ b/doc/source/zuul.rst @@ -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 `_ :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 -``_. +``_. 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 `_ 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 `_ 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 -`_ +`_ 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 -`_ to confirm that changes are +`_ 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 diff --git a/doc/source/zuulv3.rst b/doc/source/zuulv3.rst index 2269e495e6..cebc3cd458 100644 --- a/doc/source/zuulv3.rst +++ b/doc/source/zuulv3.rst @@ -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 -`_ +`_ to save the check and gate queues:: python /opt/zuul/tools/zuul-changes.py http://zuul.openstack.org \