From e1482e4e4f2b68db76c229aebbf1305b57db2173 Mon Sep 17 00:00:00 2001
From: Michiel Piscaer <michiel@piscaer.com>
Date: Thu, 7 May 2020 17:29:05 +0200
Subject: add installation manual for Ubuntu

Change-Id: I1c66e3fae65f740866202e84fcfce34f5830f155

Use the --user to install bindep

Change-Id: I8a1c79a6d591c4e43416f4afc3dba87f78ef612e
---
 doc/source/howtos/nodepool_install.rst  |  3 ++
 doc/source/howtos/ubuntu_setup.rst      | 54 +++++++++++++++++++++++++++++++++
 doc/source/howtos/zuul-from-scratch.rst |  1 +
 doc/source/howtos/zuul_install.rst      |  3 ++
 4 files changed, 61 insertions(+)
 create mode 100644 doc/source/howtos/ubuntu_setup.rst

diff --git a/doc/source/howtos/nodepool_install.rst b/doc/source/howtos/nodepool_install.rst
index 7a4c6dd02..015ebbde1 100644
--- a/doc/source/howtos/nodepool_install.rst
+++ b/doc/source/howtos/nodepool_install.rst
@@ -39,6 +39,9 @@ are required.
    # For openSUSE:
    sudo zypper install -y $(bindep -b compile)
 
+   # For Ubuntu:
+   sudo apt-get install -y $(bindep -b compile)
+
    # All:
    sudo pip3 install .
    popd
diff --git a/doc/source/howtos/ubuntu_setup.rst b/doc/source/howtos/ubuntu_setup.rst
new file mode 100644
index 000000000..bd9b68378
--- /dev/null
+++ b/doc/source/howtos/ubuntu_setup.rst
@@ -0,0 +1,54 @@
+:orphan:
+
+Ubuntu
+======
+
+We're going to be using Ubuntu 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.
+
+Login to your environment
+-------------------------
+
+Since we'll be using a cloud image for Ubuntu, our login user will
+be ``ubuntu`` which will also be the staging user for installation of
+Zuul and Nodepool.
+
+To get started, ssh to your machine as the ``ubuntu`` user.
+
+.. code-block:: shell
+
+   ssh ubuntu@<ip_address>
+
+Environment Setup
+-----------------
+
+First, make sure the system packages are up to date, and then install
+some packages which will be required later.  Most of Zuul's binary
+dependencies are handled by the bindep program, but a few additional
+dependencies are needed to install bindep, and for other commands
+which we will use in these instructions.
+
+.. code-block:: shell
+
+   sudo apt-get update
+   sudo apt-get install python3-pip git
+
+   # install bindep, the --user setting will install bindep only in
+   # the user profile not global.
+   pip3 install --user bindep
+
+Install Zookeeper
+-----------------
+
+Nodepool uses Zookeeper to keep track of information about the
+resources it manages, and it's also how Zuul makes requests to
+Nodepool for nodes.
+
+.. code-block:: console
+
+   sudo apt-get install -y zookeeper zookeeperd
diff --git a/doc/source/howtos/zuul-from-scratch.rst b/doc/source/howtos/zuul-from-scratch.rst
index 7e77e94ff..2c0965c6f 100644
--- a/doc/source/howtos/zuul-from-scratch.rst
+++ b/doc/source/howtos/zuul-from-scratch.rst
@@ -18,6 +18,7 @@ Follow the instructions below, depending on your server type.
   * :doc:`fedora27_setup`
   * :doc:`centos7_setup`
   * :doc:`opensuse_leap15_setup`
+  * :doc:`ubuntu_setup`
 
 Installation
 ------------
diff --git a/doc/source/howtos/zuul_install.rst b/doc/source/howtos/zuul_install.rst
index 09ded9d15..8f61651ac 100644
--- a/doc/source/howtos/zuul_install.rst
+++ b/doc/source/howtos/zuul_install.rst
@@ -41,6 +41,9 @@ required.
    # For openSUSE:
    $ zypper install -y $(bindep -b compile)
 
+   # For Ubuntu:
+   $ apt-get install -y $(bindep -b compile)
+
    # All:
    $ tools/install-js-tools.sh
 
-- 
cgit v1.2.1