From e3ddc0f3a934bde77d20776b1884ac5ca2e76079 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Romain=20Gon=C3=A7alves?= <me@rgoncalves.se>
Date: Wed, 20 Dec 2023 15:05:43 +0100
Subject: docs: shorten instructions and add naming scheme

---
 README.md | 69 ++++++++++++++++++++-------------------------------------------
 1 file changed, 22 insertions(+), 47 deletions(-)

diff --git a/README.md b/README.md
index 5478a9f..33ab0ff 100644
--- a/README.md
+++ b/README.md
@@ -1,54 +1,29 @@
-# Introduction
-
-[ansible](https://github.com/ansible/ansible) roles and scripts used
-for rgoncalves.se's homelab. This repository is a rewrite of the now deprecated
-`_infrastructure/ansible`.
+ansible roles and scripts used for rgoncalves.se's homelab. This repository is a
+rewrite of the now deprecated `_infrastructure/ansible`.
 
 # Quickstart
 
-Setup your development environment and run you first playbooks with the
-following commands:
-
 ```
 $ poetry install
 $ poetry shell
 $ . ./bin/env
-# ansible-playbook playbooks/workstation.yml -e workstation_user=$USER
-$ ansible-playbook playbooks/site.yml
-```
-
-# Getting started
-
-## Poetry environment
-
-[poetry](https://github.com/python-poetry/poetry) is used for managing the
-`ansible` and `mitogen` packages.
-
-```
-$ poetry install
-```
-
-## Mitogen
-
-[mitogen](https://github.com/mitogen-hq/mitogen) is a really fast executor
-plugin for Ansible. It is not enabled by default, and that's the reason
-`poetry` and the following script are used.
-
-You have to source the `env` script if you want to execute playbooks with
-`mitogen`, preferably inside a `poetry` environment. It is important because
-`mitogen` upstream is currently set to master, allowing compatibility with
-`ansible` 2.12.
-
-```
-$ poetry shell
-$ . ./bin/env
-```
-
-## Development machine
-
-A new development workstation can be scaffolded thanks to the workstation
-playbook and role.
-
-```
-# ansible-playbook playbooks/workstation.yml -e workstation_user=$USER
-```
+$ ansible-playbook site.workstation.yml -e _workstation_user=$USER
+$ ansible-playbook site.prerequisites.yml
+$ ansible-playbook site.all.yml
+```
+# Naming scheme
+
+The fully qualified name of a host is composed as follows :
+`[site]-[role]-[number]`
+
+site                  | name
+---                   | ---
+openbsd.amsterdam     | ams
+on-premise            | local
+mobile workstation    | (nothing)
+
+role                  | name
+---                   | ---
+domain controller     | dcontroller
+workstation           | wstation
+hypervisor            | hvisor
-- 
cgit v1.2.3