Skip to content

Commit 5a511f0

Browse files
committed
Fix typos ind docs
coauthored with chatgpt 5.2
1 parent 20eeccf commit 5a511f0

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

docs/README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ repository. Refer to [Terraform documentation on module source](https://www.terr
303303

304304
**Post build modification effect**: `terraform init` will have to be
305305
called again and the next `terraform apply` might propose changes if the infrastructure
306-
describe by the new module is different.
306+
described by the new module is different.
307307

308308
### 4.2 config_git_url
309309

@@ -333,7 +333,7 @@ destroy the cluster or change it manually on the Puppet server.
333333

334334
### 4.3 config_version
335335

336-
Since Magic Cluster configuration is managed with git, it is possible to specify
336+
Since Magic Castle configuration is managed with git, it is possible to specify
337337
which version of the configuration you wish to use. Typically, it will match the
338338
version number of the release you have downloaded (i.e: `15.1.0`).
339339

@@ -473,7 +473,7 @@ created using the process documented in section
473473
### 4.7 instances
474474
475475
The `instances` variable is a map that defines the virtual machines that will form
476-
the cluster. The map' keys define the hostnames and the values are the attributes
476+
the cluster. The map's keys define the hostnames and the values are the attributes
477477
of the virtual machines.
478478
479479
Each instance is identified by a unique hostname. An instance's hostname is written as
@@ -580,7 +580,7 @@ The instance specifications are retrieved from the cloud provider data source, b
580580
9. `gpus`: number of graphical processor on the node - [`Gres=gpu:<gpus>` in slurm.conf](https://slurm.schedmd.com/slurm.conf.html#OPT_Gres_1)
581581
10. `gpu_type`: type of graphical processor on the node - [`Gres=gpu:<gpu_type>:<gpus>` in slurm.conf](https://slurm.schedmd.com/slurm.conf.html#OPT_Gres_1)
582582
583-
For some cloud providers, it possible to define additional attributes.
583+
For some cloud providers, it is possible to define additional attributes.
584584
The following sections present the available attributes per provider.
585585
586586
##### AWS
@@ -678,7 +678,7 @@ volumes = {}
678678
```
679679
680680
**Post build modification effect**: destruction of the corresponding volumes and attachments,
681-
and creation of new empty volumes and attachments. If an no instance with a corresponding tag
681+
and creation of new empty volumes and attachments. If no instance with a corresponding tag
682682
exist following modifications, the volumes will be deleted.
683683
684684
### 4.9 public_keys
@@ -698,7 +698,7 @@ FreeIPA. Each user account shares the same randomly generated password.
698698
The usernames are defined as `userX` where `X` is a number between 1 and
699699
the value of `nb_users` (zero-padded, i.e.: `user01 if X < 100`, `user1 if X < 10`).
700700
701-
If an NFS NFS `home` volume is defined, each user will have a home folder
701+
If an NFS `home` volume is defined, each user will have a home folder
702702
on a shared NFS storage hosted on the NFS server node.
703703
704704
User accounts do not have sudoer privileges. If you wish to use `sudo`,
@@ -977,9 +977,9 @@ Each instance's Puppet agent will be reloaded following the installation of the
977977
**default_value** = `[]`
978978
979979
Defines a list of tags identifying instances that can be used by Terraform as the first hop
980-
to transfer files to the Puppet server. By default, this list is infered from the list of
980+
to transfer files to the Puppet server. By default, this list is inferred from the list of
981981
[firewall rules](#416-firewall_rules-optional) and the public ip address of the agent calling
982-
`terraform apply`. Providing an explicit list of tags allow to bypass the firewall rule inference,
982+
`terraform apply`. Providing an explicit list of tags allows bypassing the firewall rule inference,
983983
which can be useful when the agent is in the same network as the cluster.
984984
985985
## 5. Cloud Specific Configuration
@@ -999,7 +999,7 @@ Defines the label of the AWS EC2 region where the cluster will be created (i.e.:
999999
**default value**: None
10001000
10011001
Defines the label of the data center inside the AWS region where the cluster will be created (i.e.: `us-east-2a`).
1002-
If left blank, it chosen at random amongst the availability zones of the selected region.
1002+
If left blank, it is chosen at random amongst the availability zones of the selected region.
10031003
10041004
**Requirement**: Must be in a valid availability zone for the selected region. Refer to
10051005
[AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#using-regions-availability-zones-describe)
@@ -1041,7 +1041,7 @@ create and destroy resource groups.
10411041
```
10421042
10431043
Purchase plan information for Azure Marketplace image. Certain images from Azure Marketplace
1044-
requires a terms acceptance or a fee to be used. When using this kind of image, you must supply
1044+
require terms acceptance or a fee to be used. When using this kind of image, you must supply
10451045
the plan details.
10461046
10471047
For example, to use the official [AlmaLinux image](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/almalinux.almalinux-x86_64?tab=Overview), you have to first add it to your
@@ -1059,7 +1059,7 @@ plan = {
10591059
#### 5.3.1 project
10601060
10611061
Defines the label of the unique identifier associated with the Google Cloud project in which the resources will be created.
1062-
It needs to corresponds to GCP project ID, which is composed of the project name and a randomly
1062+
It needs to correspond to GCP project ID, which is composed of the project name and a randomly
10631063
assigned number.
10641064
10651065
**Requirement**: Must be a valid Google Cloud project ID.
@@ -1105,7 +1105,7 @@ a floating ip managed by Terraform.
11051105
not be assigned a floating ip.
11061106
11071107
This variable can be useful if you manage your DNS manually and
1108-
you would like the keep the same domain name for your cluster at each
1108+
you would like to keep the same domain name for your cluster at each
11091109
build.
11101110
11111111
**Post build modification effect**: change the floating ips assigned
@@ -1125,7 +1125,7 @@ external networks, otherwise, Terraform can find it automatically.
11251125
11261126
**default value**: None
11271127
1128-
Defines the ID of the internal IPV4 subnet to which the instances are
1128+
Defines the ID of the internal IPv4 subnet to which the instances are
11291129
connected. Define this if you have or intend to have more than one
11301130
subnets defined in your OpenStack project. Otherwise, Terraform can
11311131
find it automatically. Can be used to force a v4 subnet when both v4 and v6 exist.
@@ -1272,7 +1272,7 @@ For more information on how to activate DNSSEC, refer to your DNS provider docum
12721272
- [CloudFlare - Enable DNSSEC](https://developers.cloudflare.com/dns/dnssec/#enable-dnssec)
12731273
- [Google Cloud - Manage DNSSEC configuration](https://cloud.google.com/dns/docs/dnssec-config#enabling)
12741274
1275-
To setup an SSH client to use SSHFP records, add
1275+
To set up an SSH client to use SSHFP records, add
12761276
```
12771277
VerifyHostKeyDNS yes
12781278
```
@@ -1550,7 +1550,7 @@ New LDAP users are automatically assigned a home folder on NFS.
15501550
15511551
Magic Castle determines if an LDAP user should be member of a Slurm account
15521552
based on its POSIX groups. When a user is added to a POSIX group, a daemon
1553-
try to match the group name to the following regular expression:
1553+
tries to match the group name to the following regular expression:
15541554
```
15551555
(ctb|def|rpp|rrg)-[a-z0-9_-]*
15561556
```
@@ -1688,7 +1688,7 @@ sudo /opt/puppetlabs/bin/puppetserver ca sign --certname NAME[,NAME]
16881688
16891689
Login nodes run [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page), an intrusion
16901690
prevention software that protects login nodes from brute-force attacks. fail2ban is configured
1691-
to ban ip addresses that attempted to login 20 times and failed in a window of 60 minutes. The
1691+
to ban ip addresses that attempted to log in 20 times and failed in a window of 60 minutes. The
16921692
ban time is 24 hours.
16931693
16941694
@@ -1717,13 +1717,13 @@ terraform apply
17171717
17181718
#### 10.9.2 Remove fail2ban ssh-route jail
17191719
1720-
fail2ban rule that banned ip addresses that failed to connect
1720+
fail2ban rule that bans ip addresses that failed to connect
17211721
with SSH can be disabled. To do so, add the following line
17221722
to the variable `hieradata` in `main.tf`:
17231723
```yaml
17241724
fail2ban::jails: ['ssh-ban-root']
17251725
```
1726-
This will keep the jail that automatically ban any ip that tries to
1726+
This will keep the jail that automatically bans any ip that tries to
17271727
login as root, and remove the ssh failed password jail.
17281728
17291729
Once the line is added, call:
@@ -1733,7 +1733,7 @@ terraform apply
17331733
17341734
#### 10.9.3 Unban ip addresses
17351735
1736-
fail2ban ban ip addresses by adding rules to iptables. To remove these rules, you need to
1736+
fail2ban bans ip addresses by adding rules to iptables. To remove these rules, you need to
17371737
tell fail2ban to unban the ips.
17381738
17391739
To list the ip addresses that are banned, execute the following command:
@@ -1914,12 +1914,12 @@ extended by Puppet.
19141914
### 10.15 Access Prometheus' expression browser
19151915
19161916
Prometheus is an open-source systems monitoring and alerting toolkit. It is installed by default
1917-
in Magic Castle. Every instance exposes their usage metrics and some services do to. To explore
1918-
and visualize this data, it possible to access the [expression browser](https://prometheus.io/docs/visualization/browser/).
1917+
in Magic Castle. Every instance exposes their usage metrics and some services do too. To explore
1918+
and visualize this data, it is possible to access the [expression browser](https://prometheus.io/docs/visualization/browser/).
19191919
19201920
From inside the cluster, it is typically available at `http://mgmt1:9090`. Given DNS is configured
1921-
for your cluster, you can add the following snippet to your [hieradata](#413-hieradata-optional). to access the expression browser
1922-
from Internet.
1921+
for your cluster, you can add the following snippet to your [hieradata](#413-hieradata-optional) to access the expression browser
1922+
from the Internet.
19231923
19241924
```yaml
19251925
lookup_options:

0 commit comments

Comments
 (0)