branch master updated: doc: Add cuirass.org.

[Mathieu Othacehe]

This is an automated email from the git hooks/post-receive script.

mothacehe pushed a commit to branch master
in repository maintenance.

The following commit(s) were added to refs/heads/master by this push:
     new 8d67909  doc: Add cuirass.org.
8d67909 is described below

commit 8d679094551e72dd93233f37514b2d0f97e73861
Author: Mathieu Othacehe <othacehe@gnu.org>
AuthorDate: Thu Apr 15 10:18:55 2021 +0200

    doc: Add cuirass.org.
    
    * doc/cuirass.org: New file.
---
 doc/cuirass.org | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)

diff --git a/doc/cuirass.org b/doc/cuirass.org
new file mode 100644
index 0000000..5f35b6a
--- /dev/null
+++ b/doc/cuirass.org
@@ -0,0 +1,94 @@
+Cuirass manual is available [[https://guix.gnu.org/cuirass/][here]]. Here are 
a few notes relative to its
+integration.
+
+* Berlin
+
+Cuirass is running on the Berlin build farm. It is configured to use the
+[[https://guix.gnu.org/cuirass/manual/cuirass.html#With-the-remote-build-mechanism_002e][remote
 build]] mode. Around 30 machines, accessible on Berlin local network are
+running Cuirass workers. Those machines are named hydra-guix-101 to
+hydra-guix-129. Their architecture is x86_64-linux, but they are also
+configured to emulate builds on other architectures.
+
+Other machines such as the Overdrives are not physically located on the Berlin
+build farm but, are still accessible via 
[[https://guix.gnu.org/manual/devel/en/html_node/VPN-Services.html][Wireguard]] 
on the ~10.0.0.0/24~ local
+network. The next section describes how to add a new external machine.
+
+* External machines
+
+| Machine    |  Address | Location |
+|------------+----------+----------|
+| overdrive1 | 10.0.0.3 | Ludo's   |
+| dover      | 10.0.0.4 | Andreas' |
+
+* Connect an external machine
+
+ 1. Install Guix System on the external machine. The Wireguard and Cuirass
+    worker services must be properly configured.  The ~(sysadmin overdrive)~
+    module can be used as an example.
+
+    The Cuirass worker service should look like:
+
+#+BEGIN_SRC scheme
+    (service cuirass-remote-worker-service-type
+               (cuirass-remote-worker-configuration
+                (workers 2)
+                (server "10.0.0.1:5555") ;berlin
+                (systems '("armhf-linux" "aarch64-linux"))))
+#+END_SRC
+
+    The server field contains the Cuirass remote-server running on Berlin
+    address. It must not be changed.
+
+    The systems must be adjusted to the external machine supported
+    architectures, emulated or not.
+
+#+BEGIN_SRC scheme
+  (service wireguard-service-type
+           (wireguard-configuration
+            (addresses (list "10.0.0.x/32"))
+            (peers
+             (list (wireguard-peer
+                    (name "peer")
+                    (endpoint "ci.guix.gnu.org:51820")
+                    (public-key "wOIfhHqQ+JQmskRS2qSvNRgZGh33UxFDi8uuSXOltF0=")
+                    (allowed-ips '("10.0.0.1/32")))))))
+#+END_SRC
+
+    The only field to be edited in the Wireguard service is the ~addresses~
+    field.  It is the address of the new external machine on the Wireguard
+    subnet.  An available address must be picked, see the *External machines*
+    section above.  This section must be updated accordingly.
+
+ 2. Add the external machine Wireguard public key on Berlin. The new external
+    machine public key can be obtained this way:
+
+#+BEGIN_SRC bash
+guix environment --ad-hoc wireguard-tools -- sudo -E wg
+#+END_SRC
+
+    The ~wireguard-service-type~ of *berlin.scm* file must be updated
+    accordingly, by adding a new ~wireguard-peer~ this way;
+
+#+BEGIN_SRC scheme
+  (wireguard-peer
+   (name "new-machine")
+   (public-key "public-key")
+   (allowed-ips '("10.0.0.x/32")))
+#+END_SRC
+
+ 3. Add the external machine Guix signing key to ~hydra/keys/guix/berlin~
+    directory. See 
[[https://guix.gnu.org/manual/en/html_node/Substitute-Server-Authorization.html][this]]
 page for more information.
+
+ 4. Make sure that the UDP port ~51820~ that is used by Wireguard is
+    accessible on the external machine.  You might need to configure your ISP
+    router NAT table accordingly.
+
+    You can check that the external machine is accessible from berlin by
+    running:
+
+#+BEGIN_SRC bash
+ssh 10.0.0.x
+#+END_SRC
+
+    The external machine should eventually appear 
[[https://ci.guix.gnu.org/workers][here]] and start building some
+    packages.