[Piuparts-commits] [piuparts] 02/02: Update and improve documentation, especially about pejacevic setup.
Holger Levsen
holger at moszumanska.debian.org
Thu May 22 19:13:41 UTC 2014
This is an automated email from the git hooks/post-receive script.
holger pushed a commit to branch develop
in repository piuparts.
commit 01a29eaa990f6e874f08c0bbfdbb3726d329b50d
Author: Holger Levsen <holger at layer-acht.org>
Date: Thu May 22 20:34:37 2014 +0200
Update and improve documentation, especially about pejacevic setup.
---
README_1st.txt | 4 ++--
README_pejacevic.txt | 16 ++++++++++------
README_server.txt | 46 ++++++++++++++++++++++++----------------------
TODO | 10 +++++-----
piuparts.1.txt | 6 +++---
5 files changed, 44 insertions(+), 38 deletions(-)
diff --git a/README_1st.txt b/README_1st.txt
index 80e90de..ad82590 100644
--- a/README_1st.txt
+++ b/README_1st.txt
@@ -42,10 +42,10 @@ This will create a sid chroot with debootstrap, where it'll test
your package.
If you want to test your package in another release, for example,
-squeeze, you can do so with:
+testing, you can do so with:
----
-# piuparts ./sm_0.6-1_i386.deb -d squeeze
+# piuparts ./sm_0.6-1_i386.deb -d testing
----
By default, this will read the first mirror from your
diff --git a/README_pejacevic.txt b/README_pejacevic.txt
index ad5cc92..2aaba1a 100644
--- a/README_pejacevic.txt
+++ b/README_pejacevic.txt
@@ -26,14 +26,14 @@ results and piu-slave-bm-a.debian.org, running four piuparts-slave nodes.
Run the scripts as the piupartsm and piupartss users and clone that git
repository into '/srv/piuparts.debian.org/src' in the first place. Then
checkout the bikeshed branch.
-* See below for further user setup instructions.
-* Provide '/srv/piuparts.debian.org' - on the slave ideally with a 'tmp'
- directory which is on tmpfs.
+* Ideally provide '/srv/piuparts.debian.org/tmp' on (a sufficiently large)
+ tmpfs.
* `sudo ln -s /srv/piuparts.debian.org/etc/piuparts /etc/piuparts`
+* See below for further user setup instructions.
=== User setup
-On pejacevic the piuparts-master user piupartsm needs to be installed, on
+On pejacevic the piuparts-master user piupartsm needs to be created, on
piu-slave-bm-a a piupartss user is needed for the slave.
Both are members of the group piuparts and '/srv/piuparts.debian.org' needs to
be chmod 2775 and chown piuparts(sm):piuparts.
@@ -127,6 +127,9 @@ holger at piu-slave-bm-a$ sudo su - piupartss update-piuparts-slave-setup bikeshed
=== Running piuparts
+When running piuparts in master/slave mode, the master is never run by itself,
+instead it is always started by the slave(s).
+
==== Starting and stopping the slaves
Run the following script under *your* user account to start four instances of
@@ -138,7 +141,8 @@ holger at pejacevic:~$ sudo -u piupartss -i slave_run
----
There are several cronjobs installed via '~piupartsm/crontab' and
-'~piupartss/crontab') which monitor the slaves and the hosts it's running on.
+'~piupartss/crontab') to monitor both master and slave as well as the hosts
+they are running on.
It's possible to kill a slave any time by pressing Ctrl-C.
Pressing Ctrl-C once will wait for the current test to finish,
@@ -178,7 +182,7 @@ More checks should be added as we become aware of them.
== Authors
-Last updated: May 2013
+Last updated: May 2014
Holger Levsen <holger at layer-acht.org>
diff --git a/README_server.txt b/README_server.txt
index d6bb775..372018b 100644
--- a/README_server.txt
+++ b/README_server.txt
@@ -12,34 +12,36 @@ processing power, and so the work can be distributed over several
hosts.
There is one central machine, the master, and any number of slave
-machines. Each slave machine connects to the master, via ssh, and
-runs the piuparts-master program to report results of packages it
-has tested already, and to get more work.
+machines. Each piuparts-slave instance connects to the master,
+via ssh, and runs the piuparts-master program to report results
+of packages it has tested already, and to get more work.
To set this up for yourself, the following steps should suffice:
-. Pick a machine to run the master. It cannot be a chroot, but
- basically any real (or properly virtualized) Debian system is good
- enough.
+. Pick a machine for running the piuparts master. It cannot be a chroot, but
+ basically any real (or properly virtualized) Debian system is good enough.
. Install the package piuparts-master on it.
-. Create an account for the master (the package creates piupartsm).
+. Create an account for the master, if you install the piuparts-master package
+ it will automatically create a piupartsm user for you.
. Configure '/etc/piuparts/piuparts.conf' appropriately.
-. Pick one or more slaves to run the slave. You can use the machine
- running the master also as a slave. Etch is fine, it can even be
- in a chroot.
+. Pick one or more machines for running one or several piuparts slaves. You
+ can use the machine which is running the master also for running a slave.
+ It's also perfectly ok to run several slaves on a multi-core machine which
+ has lots of IO available.
. Install the package piuparts-slave on it.
. Configure '/etc/piuparts/piuparts.conf' appropriately - if master
and slave share the machine, they also share the config file.
-. Create an account for the slave. This must be different from the
- master account. (The package creates piupartss.)
+. Create an account for the slave. This must be different from the master
+ account. The piuparts-slave package will create a piupartss user on
+ installation.
. Create an ssh keypair for the slave. No passphrase.
. Add the slave's public key to the master's '.ssh/authorized_keys'
The key should be restricted to only allow running
'piuparts-master' by prefixing it with
'command="/usr/share/piuparts/piuparts-master",no-pty,no-port-forwarding'
. Configure sudo to allow the slave account to run '/usr/sbin/piuparts'
- as root without password. There are examples provided in
+ as root without password. There are examples provided in
/usr/share/doc/piuparts-(master|slave)/examples/.
. Run '/usr/bin/piuparts-slave-run' and 'piuparts-slave-join' to actually
let the slave(s) run and to join their sessions.
@@ -60,18 +62,18 @@ and apt-get, to reduce the load. Running multiple slaves on a fast host can
easily saturate a 100 MBit link.
Edit '/etc/sudoers.d/piuparts' to grant permissions to the piupartss user.
-Start the server using /usr/sbin/piuparts_slave_run, which will launch a
+Start the server using /usr/bin/piuparts_slave_run, which will launch a
'screen' session. The slave will launch a master process via ssh, as needed,
-to retrieve work and return results. Use /usr/sbin/piuparts_slave_join to
+to retrieve work and return results. Use /usr/bin/piuparts_slave_join to
join the screen session.
-Logs are stored under /var/lib/piuparts. They are stored there because they
-are basically the result of piuparts running.
+Logs are stored under '/var/lib/piuparts' by default. They are stored there
+because they are basically the result of piuparts running.
There are maintenance cron jobs defined in
/usr/share/doc/piuparts-(master|slave)/examples/. In particular,
-piuparts-report will create a web summary, defaulting to
-http://localhost/piuparts, served by Apache.
+piuparts-report will create static html pages, defaulting to
+http://localhost/piuparts to be served by any webserver.
=== Setup from GIT
@@ -419,7 +421,7 @@ section, too, and will serve as defaults for all other sections
distributions the slave should use for testing upgrades
between distributions (i.e., Debian versions). Using "partial"
distributions as defined in distros.conf is possible. Currently,
- "squeeze wheezy sid" is a good choice.
+ "wheezy jessie sid" is a good choice.
Setting this switches from doing install/purge tests to
dist-upgrade tests. Not set by default.
@@ -531,10 +533,10 @@ values are set in the scripts.
* "urlbase" (global) is the base url of the webserver serving this
piuparts instance. Used to provide links to logfiles in email
- reports.
+ reports. It defaults to "https://piuparts.debian.org".
-=== Running piuparts in master-slave mode, piuparts-report and the setup on piuparts.debian.org
+=== Running piuparts-report as it is done for piuparts.debian.org
If you want to run piuparts-report (which is only+very useful if
you run piuparts in master-slave mode), you need to 'apt-get
diff --git a/TODO b/TODO
index 1b1a061..5bff9dc 100644
--- a/TODO
+++ b/TODO
@@ -10,10 +10,9 @@ for 0.5x:
- Documentation related:
- check that making piuparts-master + piuparts-slave packages work is
documented properly.
- - examples are duplicated in piuparts.1.txt and README.txt - only keep one
- copy.
- - cleanup README_pejacevic.txt from info not related to pejacevic (eg. how
- to run the slaves, etc)
+ - examples are duplicated in piuparts.1.txt and README_1st.txt - only keep
+ one copy or life with it? README_1st is also more of a README than a
+ README_1st...
- more stats and graphs:
- new section stats page:
@@ -21,6 +20,7 @@ for 0.5x:
since 0.45 for all sections.
- generate simple diagrams: number of source + binary packages in all
single distros: lenny, squeeze, wheezy, jessie, sid.
+ - graph about piuparts stati for all sections combined?
for 0.6x:
@@ -31,7 +31,7 @@ for 0.6x:
- piuparts.conf.pejacevic: maybe use mirror via nfs (faster)
-- also test packages from security.d.o and squeeze-lts
+- also test packages from security.d.o
- maybe compress all logfiles
diff --git a/piuparts.1.txt b/piuparts.1.txt
index c9287a8..54cfbcb 100644
--- a/piuparts.1.txt
+++ b/piuparts.1.txt
@@ -64,7 +64,7 @@ The tarball can be created with the '-s' option, or you can use one that *pbuild
Bind-mount a directory inside the chroot.
*-d* 'name', *--distribution*='name'::
- Which Debian distribution to use: a code name (for example squeeze, wheezy or sid) or experimental. The default is sid (=unstable).
+ Which Debian distribution to use: a code name (for example wheezy, jessie or sid) or experimental. The default is sid (=unstable).
*-D* 'flavor', *--defaults*='flavor'::
Use default settings suitable for a particular flavor of Debian: either debian or ubuntu. The default is debian.
@@ -283,10 +283,10 @@ piuparts ../foo_1.0-2_i386.changes
piuparts -m 'http://gytha/debian main' ../foo_1.0-2_i386.changes
----
-If you want to test that a package installs properly in the stable (currently squeeze) Debian release, then can be upgraded to the testing (currently wheezy) and unstable (sid) versions, and then uninstalled without problems, you would give the following command:
+If you want to test that a package installs properly in the stable (currently wheezy) Debian release, then can be upgraded to the testing (currently wheezy) and unstable (sid) versions, and then uninstalled without problems, you would give the following command:
----
-piuparts -a -d squeeze -d wheezy -d sid foo
+piuparts -a -d wheezy -d jessie -d sid foo
----
ENVIRONMENT
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/piuparts/piuparts.git
More information about the Piuparts-commits
mailing list