readme.md

For #3

readme.md

@@ -0,0 +1,34 @@
+# Module de configuration des switchs
+
+Pour le moment, ce git contient les modules et les configurations des switchs,
+on espère à termes pouvoir mettre les configurations dans le git infrastructure.
+
+## Comment appliquer la configuration d'un switch
+
+`nix-build` et ensuite éxécuter le script `./result/hostname`. Ça va écrire du xml
+dans la console et une balise `<commit-success/>` doit apparaître. Si ce n'est pas le cas
+il faut réussir à lire le problème (normalement c'est assez compréhensible dans des balises
+précédente).
+
+## Comment modifier un switch
+
+En modifiant [netconf-hive\.nix](./netconf-hive.nix), qui fonctionne comme un `hive.nix`
+de colmena (sans defaults). Certaine valeur sont factorisé dedans:
+- vlansPlan: c'est la description de tout les vlans qu'on utilise, sous la forme d'une configuration
+valide du module vlan.
+- AP: c'est la configuration d'une prise relié à un AP,
+    - elle active le PoE
+    - permet une communication taggué sur le vlan admin-ap et les vlans des utilisateurs
+- AP-staging: c'est la configuration d'une prise relié à un AP en court de configuration/flashing
+    - elle active le PoE
+    - permet une communication non-taggué sur le vlan vlan-apro
+
+Pour les autres options, une doc généré à partir des doc-strings est trouvable dans [mod-doc\.md](./mod-doc.md).
+
+## Comment déployer un nouveau switch
+
+Comme avec colmena: connecter le switch et faire une nouvelle entré dans le hive avec le `targetHost`
+qui correspond.
+
+Si c'est un nouveau modèle de switch, il faut aussi faire son module "hardware", qui rempli
+`netconf.mandatoryInterfaces`, sur le modèle de [ex2300\.nix](./ex2300.nix) pour les EX2300-48P.