diff --git a/doc/source/admin/zuul-from-scratch.rst b/doc/source/admin/zuul-from-scratch.rst index edbcd87f4a..ce69e77a82 100644 --- a/doc/source/admin/zuul-from-scratch.rst +++ b/doc/source/admin/zuul-from-scratch.rst @@ -11,6 +11,14 @@ Environment Setup We're going to be using Fedora 27 on a cloud server for this installation. +Prerequisites +~~~~~~~~~~~~~ + +- Port 9000 must be open and accessible from the internet so that + Github can communicate with the Zuul web service. +- You need an OpenStack cloud that serves as your node pool. + For experimentation, DevStack is fine. + Login to your environment ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -89,15 +97,14 @@ fedora user's home directory. It should be called that will be installed when instantiating the servers:: cd ~ - source -openrc.sh # this will prompt for password - enter it - umask 0066 - + source -openrc.sh # this may prompt for password - enter it ssh-keygen -t rsa -b 2048 -f nodepool_rsa # don't enter a passphrase openstack keypair create --public-key nodepool_rsa.pub nodepool We'll use the private key later wheen configuring Zuul. In the same session, configure nodepool to talk to your cloud:: + umask 0066 sudo mkdir -p ~nodepool/.config/openstack cat > clouds.yaml < app_key=/etc/zuul/github.pem - webhook_token= + webhook_token= Upload the private key which was generated earlier, and save it in ``/etc/zuul/github.pem``. @@ -424,14 +433,14 @@ delivered since Zuul wasn't configured at the time, so click ``Resend`` and verify that it is delivered now that Zuul is configured. -Visit the public app page on GitHub, -https://github.com/apps/my-org-zuul, and install the app into your org. - Create two new repositories in your org. One will hold the configuration for this tenant in Zuul, the other should be a normal project repo to use for testing. We'll call them `zuul-test-config` and `zuul-test`, respectively. +Visit the public app page on GitHub, +https://github.com/apps/my-org-zuul, and install the app into your org. + Edit ``/etc/zuul/main.yaml`` so that it looks like this:: - tenant: