From 9760e7a1560ec243004f00312156f6d2052840df Mon Sep 17 00:00:00 2001
From: ebner <simon.ebner@psi.ch>
Date: Wed, 26 Jun 2024 14:58:30 +0200
Subject: [PATCH] add instructions how to install consoles

---
 _toc.yml                                  |  1 +
 admin-guide/deployment/consoles.md        | 36 +++++++++++++++++++++++
 admin-guide/deployment/infrastructure.rst |  2 +-
 3 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 admin-guide/deployment/consoles.md

diff --git a/_toc.yml b/_toc.yml
index c05311f9..3de5d3c3 100644
--- a/_toc.yml
+++ b/_toc.yml
@@ -75,6 +75,7 @@ chapters:
       - file: admin-guide/deployment
         sections:
           - file: admin-guide/deployment/sample
+          - file: admin-guide/deployment/consoles
           - file: admin-guide/deployment/dmz
           - file: admin-guide/deployment/reinstall
           - file: admin-guide/deployment/partitioning
diff --git a/admin-guide/deployment/consoles.md b/admin-guide/deployment/consoles.md
new file mode 100644
index 00000000..0f8a9d9c
--- /dev/null
+++ b/admin-guide/deployment/consoles.md
@@ -0,0 +1,36 @@
+# Console Deployment
+
+## Overview
+A console is a multi user system (ideally running on standard hardware) with a graphical desktop. The individual users do not have admin rights on the system and all configuration and packages must be deployed by puppet (ensuring reproducibility and fast re-installation in case of hardware failures, etc.)
+
+Consoles are, for example, used at experimental stations, beamlines, endstations. 
+
+The standard naming of a console is: __&lt;group&gt;-cons-&lt;two digit number&gt;__
+Due to various reasons these systems __must__ have a static IP assigned.
+
+## Installation Workflow
+
+1. Register a static ip in https://qip.psi.ch/qip for the console
+2. Create the necessary bob entries for the machine:
+```bash
+bob node add <your-console.psi.ch> <hiera environment without "data-"> netboot
+bob node add-mac <your-console.psi.ch> xx:xx:xx:xx:xx:xx
+bob node set-attr <your-console.psi.ch> network=static
+bob node set-attr <your-console.psi.ch> ipxe_installer=rhel8install
+
+bob node set-attr <your-console.psi.ch> puppet_role=role::console
+bob node set-attr <your-console.psi.ch> puppet_env=prod
+bob node set-attr <your-console.psi.ch> puppet_group=default  # replace default if needed
+
+# Optional
+bob node set-attr <your-console.psi.ch> puppet_subgroup=collector
+```
+
+3. Create a host specific file (`<your-console.psi.ch>.yaml`)  in the respective hiera repository/directory with the following content:
+
+```yaml
+networking::setup: auto_static_ip
+```
+
+4. Ensure that the UEFI/BIOS is set to netboot
+5. Kickstart the machine
\ No newline at end of file
diff --git a/admin-guide/deployment/infrastructure.rst b/admin-guide/deployment/infrastructure.rst
index f5ff73ec..5cd0a18d 100644
--- a/admin-guide/deployment/infrastructure.rst
+++ b/admin-guide/deployment/infrastructure.rst
@@ -20,7 +20,7 @@ other for production, with the following hostnames:
 | boot server        | -              | boot.psi.ch     |
 | sysdb server       | -              | sysdb.psi.ch    |
 +--------------------+----------------+-----------------+
-| puppet server      | puppet00-test  | puppet01        |
+| puppet server      | puppet00-test  | puppet.psi.ch        |
 +--------------------+----------------+-----------------+
 | repository server  | -              | repos.psi.ch    |
 +--------------------+----------------+-----------------+