Skip to content

Commit 46820f3

Browse files
committed
Aquilon doc: add documentation on configuring cluster
1 parent eb59887 commit 46820f3

3 files changed

Lines changed: 57 additions & 0 deletions

File tree

_aquilon/management.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,59 @@ remove the service requirement matching the host with the command
365365
The mapping is actually removed at the next `aq reconfigure` for the host after modifying
366366
the 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

370423
Initial installation of a node in Quattor is managed by the AII component that generally runs on

_aquilon/technical_details.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,9 @@ thresholds associated with the cluster, like the minimum or maximum number of ho
124124
any time. Clusters can also be used to describe a HA cluster. Note that Aquilon is not a replacement for the
125125
cluster middleware: it just allows to represent a group of machines managed by such a middleware.
126126

127+
Clusters, like hosts, have an archetype and personality attached. It allows to ensure that all hosts that are
128+
part of the cluster receive the same configuration.
129+
127130
Once a cluster is defined, it can be used as an alternative to a machine object to describe where is running
128131
a host. In this case, Aquilon doesn't track on which cluster node the host is running: it lets the middleware
129132
do the scheduling, assuming that all hosts in the cluster are equivalent.

_includes/link_definitions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This file contains link definitions that can be used in reference links.
77
[aquilon_configuration]: /aquilon/configuration.html
88
[aquilon_details]: /aquilon/technical_details.html
99
[aquilon_domains]: /aquilon/technical_details.html#domains
10+
[aquilon_hosts]: /aquilon/configuration.html#declaring-hosts
1011
[aquilon_install]: /aquilon/00-install.html
1112
[aquilon_management]: /aquilon/management.html
1213
[aquilon_plenary]: /aquilon/technical_details.html#plenary-templates

0 commit comments

Comments
 (0)