Commit Graph

35 Commits

Author SHA1 Message Date
Clark Boylan f8b1d914aa Document Zuul's SIGUSR2 handler
This is more zuul debugging documentation.

Change-Id: I5298f62658cd68f2bd19ec02fb2c1970d855bf84
2021-10-22 13:03:23 -07:00
Dr. Jens Harbott 6961f380d1 Fixup some details in the zuul doc
Mostly just formatting and punctuation, plus some outdated bits.

Signed-off-by: Dr. Jens Harbott <harbott@osism.tech>
Change-Id: I641beb5d65f87173d50c74a4e1f0dba48d006231
2021-10-22 10:05:20 +02:00
Clark Boylan 2f7089d33e Make logging zuul restarts less optional
This is followon to feedback for earlier docs updates. Basically we
should always log these restarts so make that more clear that it isn't
optional.

Change-Id: Ib0fa05b2075d6c82199e6e043724aeedaf04e49c
2021-10-21 13:24:28 -07:00
Clark Boylan f18e575a50 Update zuul secrets decryption docs
Zuul has changed has it stores secret keys and they are in zookeeper
now. This means our old docs on decrypting things are no longer correct.
Update them with a new set of instructions that matches the modern
setup.

Change-Id: I7484a8c02e005fadc41e22a4158b3dcb8434ec5d
2021-10-21 10:39:47 -07:00
Clark Boylan a6d4d81ee2 Add zuul debugging documentation
Try to provide some hints for debugging unexpected zuul behaviors in our
documentation.

Change-Id: I937df9d8d71ae4984991aa9f327dd1351d539284
2021-10-21 10:39:47 -07:00
Clark Boylan 7eff5b5af2 Update zuul restart documentation
It was recently pointed out that our restart process for zuul is a bit
stale. Document the new modern process that deals with ansible playbooks
and docker containers.

Change-Id: I52812e87ed73e6ed538f94a86c1b62ce3de57c37
2021-10-21 10:39:42 -07:00
Clark Boylan 0116b2d025 Assort IRC TODOs
We're moving to OFTC and this tries to capture the various types of
updates for bots and docs we'll need to do. I don't expect this to
be complete, but adds some good reminder for a few things we don't
want to miss.

Change-Id: I09f4c7aa1a2eb8cd167439d58ab4222f5e63a4b1
2021-05-29 17:18:55 +00:00
Monty Taylor 96364a11d9 Stop cloning a bunch of puppet modules we don't use
We've stopped using many of these, but we never got around to
removing them from lists.

Also, we should probably retire the repos.

Depends-On: https://review.opendev.org/717620
Depends-On: https://review.opendev.org/720527
Change-Id: I8e012c5bfa48d274dbd7f5484a9e75fee080cb5e
2020-06-05 08:42:47 -05:00
Jeremy Stanley 8da233817b Re-add secret decrypting docs
These are useful for the times when a secret needs to be decrypted
for debugging but seem to have been deleted when we did the zuulv3
migration removal.

Change-Id: Ib1544d9032df9bd25c50eeca032f643e40f035b0
2020-03-23 13:16:05 -05:00
Andreas Jaeger 13ce6ffd69 Zuul docs: Remove obsolete note
This note is not needed anymore, remove it.

Change-Id: I708fc3653833f794a448d40e3df72626f282b747
2019-08-28 06:51:58 +02:00
Andreas Jaeger a6aaaed6a3 Docs: Zuul v2 is dead
Update the Zuul v3 page with correct links and description of promote
pipeline and remove the now obsolete note - and follow it with renaming
the document to zuul.

Change-Id: I9c89cb56d4a318f3a234e7f2f08dabb46d0dfab6
2019-08-27 08:39:57 +02:00
Monty Taylor d500651367 Rename cgit_file to git_file
In sphinx, we have a :cgit_file: directive that makes links to files.
Thing is - we're not using cgit anymore. So just rename it to git_file.

Change-Id: I80aca5fb3cc84281e29843944fea33e6f4d9fe6f
2019-04-22 11:47:11 +00:00
Monty Taylor eaa74543de 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
2019-04-20 18:25:37 +00:00
Monty Taylor e01ed4f066 Update some docs for opendev
There's a lot of these, so doing them in chunks. This fixes
the custom roles.

Remove the git and jjb docs, since we don't use them anymore.

Change-Id: I0c5b74f7b73315dac93bce6be0d920cddb94fb58
2019-04-20 09:41:45 -07:00
Jeremy Stanley 7323108d4a Docs addition on decrypting Zuul secrets
As this does come up from time to time, record an example command
for decrypting a Zuul secret.

Change-Id: I056bb808ecf0f44cfa5b448521e3f28d04eeffcf
2019-02-19 18:43:26 +00:00
Jeremy Stanley 5e668c952d Update Zuul service documentation
Much of this document was stale since putting Zuul v3 into
production. Attempt to bring it up to our current state.

Change-Id: I1b9d665cbf5ca88917d6e0361a6b16026b2ad6c6
2018-09-26 23:33:54 +00:00
Jeremy Stanley cf0da86f03 There are no core developers, only core reviewers
Our community has insisted in the past that "core developers" aren't
a thing, so if we want to avoid continued propagation of that
terminology then we should do our best to eradicate it in official
documents.

Change-Id: I8f97231f7e56548c5ad0925ba2c5bb09e4800438
2018-07-07 14:57:28 +00:00
Ian Wienand 882b730fdf Update to openstackdocstheme
This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
2018-06-25 11:19:43 +10:00
Vu Cong Tuan 07ccb8444f Update Zuul Status Page to correct URL
Current URL of Zuul Status Page in doc is:
http://status.openstack.org/zuul/

The correct URL must be:
https://zuul.openstack.org/

Change-Id: I042c53ee49b9ac08504a56ca56adaacd3d9a4548
2018-05-25 08:22:58 +07:00
Zuul cf62dfd4fa Merge "Remove zuul-dev.o.o" 2018-01-16 19:00:26 +00:00
Paul Belanger 95eb5e108c
Remove zuul-dev.o.o
We no longer need a zuulv2 dev server, so we can delete it.

Change-Id: Ib6be603719fda8b759c606a9c972377a64437c98
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
2018-01-10 14:39:02 -05:00
James E. Blair ddec03d3b8 Add note on how to talk to zuul's gearman
Change-Id: I1e5b2cdc7c3ba78d3c40517fc2827f4ab75511a9
2018-01-05 16:25:45 -08:00
Paul Belanger 381c1bad3c
Remove zuul-launcher support
With the migration to zuulv3, there is no more zuul-launcher. This has
become zuul-executor, which has been moved into production.

Servers have already been deleted, lets also remove it from puppet.

Change-Id: Id2b53decdc63712460049f5fa9ed751e049d17ff
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
2017-10-30 20:36:53 -04:00
Monty Taylor 7e4893f77e
Split out and expand zuulv3 docs
We're running a zuulv3 and it has several pieces. Make a place that we
can start documenting the sysadmin of the system. Once we go live we can
remove the old zuul.rst and move zuulv3.rst to take its place.

Change-Id: I3efaa8026f9d1c67e765ca79594b2768f0fa2fbf
2017-07-27 12:58:52 -05:00
Monty Taylor a8f6b554c6
Document Zuul v3 GitHub integration
We have GitHub integration for Zuul v3, so we should have documentation
of that integration.

Change-Id: Ibbd41a43338f1d439d47aa13ced60ed477a6bbef
2017-07-27 11:18:16 -05:00
Elizabeth K. Joseph 3ea63626c4 Zuul has a channel, let's tell people about it
Change-Id: I144c3346ed3b040a99475aa597abe4db56e81685
2016-08-24 08:47:31 -07:00
James E. Blair 6af492e20d Remove Jenkins documentation; replace with zuul-launcher
Change-Id: Ie6d077906a4d6e204d4cd1847486dc098de2f8f6
2016-06-15 15:00:31 -07:00
Elizabeth K. Joseph 8a25f90208 Add Zuul restart documentation
Change-Id: I6abdd66ce7c4676382d2fe044bbef1d4b286d651
2016-03-31 14:34:31 -07:00
Jeremy Stanley 140716bdd1 Replace ci.o.o links with docs.o.o/infra
The http://ci.openstack.org/ documentation site has been deprecated,
replaced by redirects to corresponding paths within
http://docs.openstack.org/infra/ where other Project Infrastructure
documentation already resides.

Change-Id: Ie915eb9711c100e536498c57549ef901b1db3abc
2015-05-14 21:38:19 +00:00
Elizabeth K. Joseph 11a9b7ccce Update documentation with new Puppet modules
Location of our Puppet modules has changed now that they are split
from system-config, update documentation accordingly.

Change-Id: I4d4adc5d41f50dd92fbd642ac30f95c327a416b2
2015-01-28 19:48:10 -08:00
Michael Krotscheck bdd6abcac8 Switched documentation to point to storyboard.
We've migrated this project to storyboard, I'm updating the
documentation links.

Change-Id: Id92552b7be7cd43ca6a3ec91c2c4f330078490b6
2014-11-12 14:48:02 -08:00
James E. Blair f605d6e6ce Doc updates for project-config
Change-Id: Idffa13d5d1990f47e46fc5b711563949da78b6f8
2014-09-25 11:03:04 -07:00
Robert Collins 08f78ace59 Improve Zuul docs.
The list of pipelines (duplicated with the layout.yaml) was incomplete.

No node size was described, and the need (or lack thereof) for backups
wasn't covered.

Change-Id: Ia20b610e7c51184239910d6b6e902390593fcaff
2013-09-23 17:27:22 -04:00
Monty Taylor 258abe1a23 Use cgit server instead of github for everything
We have a cgit server now, which means we should replace
all references to github with references to git.openstack.org.

Change-Id: I68ad1ce514fb4326c7d9940b5a84999af5b58562
2013-08-19 10:19:47 -07:00
James E. Blair 9ed2be3098 Refactor project infrastructure docs.
The goal is to re-orient the documentation as an introduction for new
contributors and a reference for all contributors.

Change-Id: I8702a5ace908c7618a6451bbfef7fc79b07429ff
Reviewed-on: https://review.openstack.org/30515
Reviewed-by: Elizabeth Krumbach Joseph <lyz@princessleia.com>
Reviewed-by: Clark Boylan <clark.boylan@gmail.com>
Approved: Monty Taylor <mordred@inaugust.com>
Reviewed-by: Monty Taylor <mordred@inaugust.com>
Tested-by: Jenkins
2013-05-30 17:27:07 +00:00