From 661bbe6c60cdd354b7416f956e305402bd28488a Mon Sep 17 00:00:00 2001 From: Brian Candler Date: Tue, 12 Jul 2016 19:09:56 +0000 Subject: [PATCH] Document the ansible module naming approach --- ansible/roles/00README.txt | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 ansible/roles/00README.txt diff --git a/ansible/roles/00README.txt b/ansible/roles/00README.txt new file mode 100644 index 0000000..f737cda --- /dev/null +++ b/ansible/roles/00README.txt @@ -0,0 +1,38 @@ +Philosophy +========== + +NMM applications +---------------- + +For NMM tools, we want to make roles which are suitable for: + +* Use in real DEA activities +* In workshops: pre-installing on student containers, but leaving + them work to do in the exercises +* In workshops: auto building the complete sample noc container + +In order to do this, the roles are divided as follows: + +* xxx_base: installs the packages and any pre-configuration which + even the students will have done for them. +* xxx_setup: performs sensible default settings for the application + but nothing topology-specific +* xxx_noc: does the configuration for the noc container + +Hence: + +* student containers run xxx_base only +* DEA activities use xxx_base and xxx_setup +* NOC uses xxx_base, xxx_setup and xxx_noc + +[we could rename these?] + +VTP and physical training platform +---------------------------------- + +TODO: not yet done but will probably be like this: + +* xxx_base: common to all +* xxx_kit: additional steps for the physical kit only +* xxx_vtp: additional steps for the virtual training platform +* xxx_vtp_cnd: additional steps for the cnd variant of VTP only -- GitLab