@@ -365,6 +365,59 @@ remove the service requirement matching the host with the command
365365The mapping is actually removed at the next ` aq reconfigure ` for the host after modifying
366366the service requirements.
367367
368+ ## Using Aquilon clusters
369+
370+ [ Clusters] [ aquilon_details ] are intended to represent in Aquilon a group of hosts that must be configured in
371+ the same way and will host other Aquilon machines, typically hypervisors in a cloud. Like hosts, they have
372+ an archetype and personality attached. It allows to ensure that all hosts that are
373+ part of the cluster receive the same configuration. They also have a plenary template describing the cluster
374+ that is included in the configuration of all hosts belonging to the cluster.
375+
376+ Configuring a cluster involves:
377+ * Creating the cluster archetype and personality
378+ * Creating the cluster
379+ * Adding machines to the cluster
380+
381+ ### Creating the cluster archetype and personality
382+
383+ A cluster archetype is created the same way as as [ host archetype] ( #adding-archetypes ) ,
384+ with the exception that ` --cluster_type compilable ` option must be added. A typical example would be:
385+
386+ ``` bash
387+ aq add_archetype --archetype cluster_test --compilable --cluster_type compute
388+ ```
389+
390+ Personality is created the same way as for a [ host personality] ( #personalities ) ). The same personality
391+ (and archetype) can be used with several clusters.
392+
393+ Like for host archetypes, it is possible to [ bind] ( #binding-features-to-personalities ) a feature to a cluster personality.
394+
395+
396+ ### Creating the cluster
397+
398+ A cluster is created with ` aq add_cluster ` . For example, to create a cluster ` cluster_test ` that will
399+ use the personality ` os_hv_test ` from archetype ` cluster_test ` , use the following command:
400+
401+ ``` bash
402+ aq add cluster --cluster cluster_test --archetype cluster_test --personality os_hv_test
403+ --down_hosts 0 --building hq --sandbox your/sandbox
404+ ```
405+
406+ In the previous command, ` --down_hosts ` is set to 0 as Aquilon doesn't make a direct use of this value
407+ (an external monitoring tool would be required). For ` --building ` and ` --sandbox ` , use values appropriate
408+ to your site (sandbox name must be in the form ` user/sandbox_name ` ).
409+
410+
411+ ### Adding machines to the cluster
412+
413+ Hosts are associated with the cluster through the machine they use. When creating the machine, use the
414+ option ` --cluster ` instead of ` --rack ` , ` --desk ` or ` --chassis ` . One the machine is configured,
415+ [ add the hosts] [ aquilon_hosts ] to Aquilon using the same procedure as for hosts using bare metal machines.
416+
417+ It is not possible to update a machine that was initially configured to use a bare metal machine to become
418+ a virtual machine. It is possible to change the cluster hosting a machine (or change a virtual machine hosted
419+ by a host to a VM hosted by a cluster) with ` aq update_machine ` command with the ` --cluster ` option.
420+
368421## Initial Installation
369422
370423Initial installation of a node in Quattor is managed by the AII component that generally runs on
0 commit comments