Commit Graph

13 Commits

Author SHA1 Message Date
David Shrewsbury e6d8b210cc Documentation reorg
Reorganizing docs as recommended in:

https://www.divio.com/blog/documentation/

This is simply a reorganization of the existing documents and changes
no content EXCEPT to correct the location of sphinx doc references.
Expect followup changes to change document names (to reflect the new
structure) and to move content from existing guides (e.g., to move the
pipeline/project/job structure definitions out of the "Project Configuration"
reference guide into their own reference documents for easier locatability).

All documents are now located in either the "overview", "tutorials",
"discussions", or "references" subdirectories to reflect the new structure
presented to the user. Code examples and images are moved to "examples" and
"images" root-level directories.

Developer specific documents are located in the "references/developer"
directory.

Change-Id: I538ffd7409941c53bf42fe64b7acbc146023c1e3
2020-01-14 12:47:23 -05:00
Paul Belanger f806ac6604 Use -N '' for ssh-keygen
This removes the need for the user to enter an empty passphrase.

Change-Id: Id87ab5476363c77526b6eeb64bd0c83ac66127ef
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
2020-01-06 11:56:10 -05:00
James E. Blair b2e5500cc2 Update install for buster
Add the correct libre2 package name for Debian buster, and also
update the quickstart playbook and documentation to deal with
the change in default rsa key encoding format from newer
versions of ssh-keygen.

Change-Id: I6ada88cd896d844c1171f7bcaf4691dea023d51f
2019-10-23 14:01:42 -07:00
Homero Pawlowski 059a037539 update zuul from scratch docs
Change-Id: Ia8508acedb30193158cc1cc5a66346ae58429b14
2019-05-08 00:09:54 -04:00
Monty Taylor b0252eef9d Update references for opendev
Change-Id: I3c1ac5478efed4dee1d525deb036d457287fa136
2019-04-24 12:59:17 +00:00
James E. Blair a1d8fc7a51 Reorganize admin manual
This makes a number of changes to the installation/configuration
documentation in the admin manual.

Remove quick-start guide.  The process of quick-starting is
covered by the installation and setup tutorial, which is now the
first of the installation sections.  The reference material from
quick-start is now in the tutorial.

Rename the tutorial quick-start.  It's nice to have something
named quick-start, and the tutorial fits the bill.

Rename the installation section "Installation Reference".  This
now has more detailed information about installation and
deployment choices, but has very little procedural documentation.

Make zuul-from-scratch more internally consistent in style (use
code-block:: shell and heredocs wherever possible).

Change-Id: I7e4714ce5e775dc9ac0988c3470eef1f74fb36d6
2018-10-10 09:54:03 -07:00
James E. Blair 4a1ab4ec4a docs: Add compile profile to bindep
This causes gcc and other build dependencies to be installed.

Change-Id: Ib6dc87b1c50cf7ecfa473acef58b2ca6aed3d102
2018-09-10 17:15:32 -06:00
Joshua Hesketh 04fc889b32 Add instructions for deploying zuul with openSUSE
Change-Id: Ie460809ad8431ab20c5c21e579cfc655e687340d
2018-07-27 13:41:15 +00:00
Joshua Hesketh 80a97c927c fix zuul from scratch user and group creation
Use useradd rather than adduser[0] as some distros do not come with adduser
installed.

Additionally some distros do not use a group per user, instead ensure the
zuul and nodepool groups are created and assigned to their respective
users.

[0] https://askubuntu.com/questions/345974/what-is-the-difference-between-adduser-and-useradd

Change-Id: Id44a7dbc03896705aed576a05a2fe8db62d76272
2018-07-18 23:01:42 +10:00
James E. Blair ebb4c4a6be Add more explanatory text to zuul-from-scratch
Change-Id: I489fcb06d36998ba4287ce45fef1064fe6f2a3c3
2018-05-18 11:04:35 -07:00
Fatih Degirmenci b2967d6e28 Add additional steps for configuring Nodepool service on CentOS 7
This change adds the additional steps to follow while installing Nodepool
on CentOS 7. The included steps are
- creation of /etc/systemd/system/nodepool-launcher.service.d to place
provided drop-in file
- copying provided drop-in file to the appropriate location so ExecStart
command can be overriden by systemd

Apart from the additional steps, the package installation command on Fedora27
is switched to yum to keep the differences between Fedora27 and CentOS 7 at
minimum.

Also some, of the nodepool configuration steps like creation of the
directories and ssh key generation are moved into nodepool_install.rst
similar to how zuul_install.rst lists some of these steps.

SSH key nodepool_rsa is needed in zuul_install.rst but it gets created later
in nodepool_openstack.rst so moving the key generation to nodepool_install.rst
prevents possible confusion as well.

Depends-On: https://review.openstack.org/#/c/564872/
Change-Id: If073ba5559d3ad055c0c8a1f2f4213ce6ed8af9f
2018-05-01 21:27:01 +02:00
David Shrewsbury bd16925421 Add sample systemd service files.
Also modify the Zuul From Scratch doc to reference these new files
in the service installation documents.

Depends-On: https://review.openstack.org/560993
Change-Id: Ifa0d1cd48ec5e1ef3358ada55b1b2769f392dfe9
2018-04-13 15:30:18 +00:00
David Shrewsbury 28d99222a6 Reorganize "Zuul From Scratch" document
In preparation for adding instructions for Gerrit and other
Linux derivatives, reorganize the "Zuul From Scratch" doc to
more easily incorporate those changes.

Also, just use the default Zookeeper config. That bit is
moved to be with the Zookeeper installation portion.

Change-Id: I206a2acf09eb8a2871ec61a00226654c798bb3eb
2018-04-11 14:03:11 -04:00