From 0259c4e81604794cacf70f107642036664947461 Mon Sep 17 00:00:00 2001 From: Michel Jouvin Date: Sat, 26 May 2018 22:33:37 +0200 Subject: [PATCH] Aquilon Documentation: fix spelling mistakes - Include a dictionary update --- .travis-scripts/dictionary.txt | 17 +++++++++++++++++ _aquilon/configuration.md | 6 +++--- _aquilon/management.md | 6 +++--- 3 files changed, 23 insertions(+), 6 deletions(-) diff --git a/.travis-scripts/dictionary.txt b/.travis-scripts/dictionary.txt index 46e20847..20c7f5c5 100644 --- a/.travis-scripts/dictionary.txt +++ b/.travis-scripts/dictionary.txt @@ -7,16 +7,19 @@ bashism Bruxelles CAF CCM +CentOS Ceph config cron devel +DHCP DNS DPM EL EPEL formatter FreeIPA +fullname Gabor Ganesha gerrit @@ -27,10 +30,14 @@ GPFS GPG GPU GPUs +GRN +GRNs hacky HEPiX init INSTALLDIR +IP +IPMI IPv jrha JSON @@ -44,7 +51,10 @@ logstash Maven metaconfig metadata +middleware +NIC noarch +NTP OneFlow OpenNebula OpenStack @@ -69,6 +79,7 @@ RPM RPMs rsyslog scalability +SCDB SELinux SQL SQLite @@ -79,14 +90,17 @@ symlink systemd th UGent +UMD unconfigured urbonegi unsynchronized VirtualEnv virtualenv +VLAN VM VMs whitespace +workflow # Workaround for issue https://github.com/stfc/markdown-spellchecker/issues/9 # Remove when it is fixed @@ -96,5 +110,8 @@ endcomment FIXME freenode html +hw md +proofer +py tl diff --git a/_aquilon/configuration.md b/_aquilon/configuration.md index 98f2e6fa..e9851259 100644 --- a/_aquilon/configuration.md +++ b/_aquilon/configuration.md @@ -47,7 +47,7 @@ These are the basic terms in Aquilon operations: * `domain`: A set of shared Quattor templates. Entities to be configured live in exactly one domain. A domain is currently implemented as a branch in the template-king git repository. -* `feature`: A re-useable configuration template that configures a +* `feature`: A reuseable configuration template that configures a specific thing but does not in itself describe a complete system. A feature may be included in a personality or anywhere else that PAN template code can be @@ -137,7 +137,7 @@ aq add_archetype --archetype web_servers --compilable The template library is a set of generic templates that help to build host descriptions. It provides many building blocks, in particular `features` and hardware-related templates, ready to use to configure the host hardware, -standardOS services and a few more specific +standard OS services and a few more specific middleware, like [OpenStack](https://www.openstack.org) for clouds or [UMD](https://wiki.egi.eu/wiki/Middleware){:data-proofer-ignore=""} for grid. @@ -265,7 +265,7 @@ aq add_machine --machine testhw --model thegreatserver --rack ${rackid} Each machine has a number of network interfaces, with their MAC addresses. They need to be added to the machine object previously created. Aquilon -supports different types of interfaces (public, management, vlan...): see `aq help add_interface` +supports different types of interfaces (public, management, VLAN...): see `aq help add_interface` for details. The MAC address can be explicitly defined for a standard machine or auto-generated for a virtual machine. The interface can belong to a port group. One of the interface must be marked as `bootable` to be able to define an IP address when adding the host. diff --git a/_aquilon/management.md b/_aquilon/management.md index 16d70b8b..6c2c96b1 100644 --- a/_aquilon/management.md +++ b/_aquilon/management.md @@ -31,7 +31,7 @@ aq update_realm --realm dailyplanet.com --trusted ### Add an Aquilon user A sandbox is associated with an Aquilon user. The Aquilon user is associated with an existing Linux account -via the `uid` and `gid` but doesn't have to be Aquilon user name doesn't have to match the Linux userid. +via the `uid` and `gid` but doesn't have to be Aquilon user name doesn't have to match the Linux user ID. It must be created with the `aq add_user` command if the user doesn't exist already. To list existing users, use: @@ -61,7 +61,7 @@ aq add_sandbox --sandbox site-init ``` Once the sandbox is created, it is necessary to associate the host we want to manage with the -sandbox. In all the Aquilon commands requiring a `--sandbox` option (except the `xxx_sandbox` comands), +sandbox. In all the Aquilon commands requiring a `--sandbox` option (except the `xxx_sandbox` commands), the sandbox name is `user/sandbox`. ```bash @@ -160,7 +160,7 @@ aq bind_feature --feature demo --personality test --archetype web_servers ``` To bind it to the `web_servers` archetype (i.e. whatever archetype personality is used), -the commad variant is: +the command variant is: ```bash aq bind_feature --feature demo --archetype web_servers