Skip to content

Commit

Permalink
docs: fix spelling mistakes
Browse files Browse the repository at this point in the history
Resolve spelling with `misspell -w .`

Signed-off-by: Caleb Woodbine <calebwoodbine.public@gmail.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
  • Loading branch information
BobyMCbobs authored and smira committed Mar 15, 2022
1 parent 5fdedae commit d256b5c
Show file tree
Hide file tree
Showing 75 changed files with 111 additions and 111 deletions.
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ with a single `--mode` flag that can take the following values:

Command `talosctl gen config` now defaults to Kubernetes version pinning in the generate machine configuration.
Previously default was to omit explicit Kubernetes version, so Talos picked up the default version it was built against.
Old behavior can be achieved by specifiying empty flag value: `--kubernetes-version=`.
Old behavior can be achieved by specifying empty flag value: `--kubernetes-version=`.


### Machine Configuration
Expand Down Expand Up @@ -2010,7 +2010,7 @@ cluster:



### Windows Suport
### Windows Support

CLI tool talosctl is now built for Windows and published as part of the release.

Expand Down Expand Up @@ -2325,7 +2325,7 @@ cluster:



### Windows Suport
### Windows Support

CLI tool talosctl is now built for Windows and published as part of the release.

Expand Down Expand Up @@ -2642,7 +2642,7 @@ cluster:



### Windows Suport
### Windows Support

CLI tool talosctl is now built for Windows and published as part of the release.

Expand Down Expand Up @@ -2879,7 +2879,7 @@ This release of Talos provides some initial support for cluster membership disco
These new features are not enabled by default.


### Windows Suport
### Windows Support

CLI tool talosctl is now built for Windows and published as part of the release.

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ for applications using `img` tool.

All artifacts will be output to ./$(ARTIFACTS). Images will be tagged with the
registry "$(IMAGE_REGISTRY)", username "$(USERNAME)", and a dynamic tag (e.g. $(REGISTRY_AND_USERNAME)/image:$(IMAGE_TAG)).
The registry and username can be overriden by exporting REGISTRY, and USERNAME
The registry and username can be overridden by exporting REGISTRY, and USERNAME
respectively.

## Race Detector
Expand Down
2 changes: 1 addition & 1 deletion api/inspect/inspect.proto
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import "google/protobuf/empty.proto";

// The inspect service definition.
//
// InspectService provides auxilary API to inspect OS internals.
// InspectService provides auxiliary API to inspect OS internals.
service InspectService {
rpc ControllerRuntimeDependencies(google.protobuf.Empty) returns (ControllerRuntimeDependenciesResponse);
}
Expand Down
2 changes: 1 addition & 1 deletion docs/proposals/20190704-AutomatedUpgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ This provides a clean slate for upgrades.

Once we enter the `rootfs` we have three high level tasks:

- retreive the machineconfig
- retrieve the machineconfig
- create, format, and mount partitions per the builtin specifications
- start system and k8s.io services

Expand Down
2 changes: 1 addition & 1 deletion docs/proposals/20190708-MachineConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This proposal will outline how we'll handle the passing of machine configuration
I think the easiest way to background this is to take a look at the init node machine config that we currently have a template for, since it is our most verbose template with the most options.
When looking it, it's somewhat self-explanatory on what is available to tweak, but it also gives a good starting point to view what is similar between the three types of Talos nodes: init (the first master), control plane (any other masters), and workers.
I've also appended some additional fields that we use for certain platforms like Packet.
Additionally, as some background around naming, we'll be referring to our configs only as "machine configs", since using terms like "userdata" interchangably led users to believe we supported cloud-init, which is not true.
Additionally, as some background around naming, we'll be referring to our configs only as "machine configs", since using terms like "userdata" interchangeably led users to believe we supported cloud-init, which is not true.

### Init

Expand Down
2 changes: 1 addition & 1 deletion hack/release.toml
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Static pod definitions can be updated without a node reboot.
description="""\
Command `talosctl gen config` now defaults to Kubernetes version pinning in the generate machine configuration.
Previously default was to omit explicit Kubernetes version, so Talos picked up the default version it was built against.
Old behavior can be achieved by specifiying empty flag value: `--kubernetes-version=`.
Old behavior can be achieved by specifying empty flag value: `--kubernetes-version=`.
"""

[notes.admission]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ created talosconfig
```

> The loadbalancer is used to distribute the load across multiple controlplane nodes.
> This isn't covered in detail, because we asume some loadbalancing knowledge before hand.
> This isn't covered in detail, because we assume some loadbalancing knowledge before hand.
> If you think this should be added to the docs, please [create a issue](https://github.com/talos-systems/talos/issues).
At this point, you can modify the generated configs to your liking.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/v0.10/Bare Metal Platforms/matchbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ join.yaml is valid for metal mode
#### Publishing the Machine Configuration Files

In bare-metal setups it is up to the user to provide the configuration files over HTTP(S).
A special kernel parameter (`talos.config`) must be used to inform Talos about _where_ it should retreive its' configuration file.
A special kernel parameter (`talos.config`) must be used to inform Talos about _where_ it should retrieve its' configuration file.
To keep things simple we will place `init.yaml`, `controlplane.yaml`, and `join.yaml` into Matchbox's `assets` directory.
This directory is automatically served by Matchbox.

Expand Down Expand Up @@ -174,7 +174,7 @@ Now, create the following groups, and ensure that the `selector`s are accurate f

### Boot the Machines

Now that we have our configuraton files in place, boot all the machines.
Now that we have our configuration files in place, boot all the machines.
Talos will come up on each machine, grab its' configuration file, and bootstrap itself.

### Retrieve the `kubeconfig`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is not a requirement, but rather a document to explain some key settings.
#### Endpoint

To configure the `talosctl` endpoint, it is recommended you use a resolvable DNS name.
This way, if you decide to upgrade to a multi-controlplane cluster you only have to add the ip adres to the hostname configuration.
This way, if you decide to upgrade to a multi-controlplane cluster you only have to add the ip address to the hostname configuration.
The configuration can either be done on a Loadbalancer, or simply trough DNS.

For example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ kube-flannel-jknt9 1/1 Running 0 23
Full error might look like:

```bash
x509: certificate signed by unknown authority (possiby because of crypto/rsa: verification error" while trying to verify candidate authority certificate "kubernetes"
x509: certificate signed by unknown authority (possibly because of crypto/rsa: verification error" while trying to verify candidate authority certificate "kubernetes"
```
Commonly, the control plane endpoint points to a different cluster, as the client certificate
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.10/Learn More/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Can I break my cluster by upgrading everything?
**A.** No.

Nothing prevents the user from sending any number of near-simultaneous upgrades to each node of the cluster.
While most people would not attempt to do this, it may be the desired behaviour in certain situations.
While most people would not attempt to do this, it may be the desired behavior in certain situations.

If, however, multiple control plane nodes are asked to upgrade at the same time, Talos will protect itself by making sure only one control plane node upgrades at any time, through its checking of etcd quorum.
A lease is taken out by the winning control plane node, and no other control plane node is allowed to execute the upgrade until the lease is released and the etcd cluster is healthy and _will_ be healthy when the next node performs its upgrade.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.10/Reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ The ControllerRuntimeDependency message contains the graph of controller-resourc
### InspectService
The inspect service definition.

InspectService provides auxilary API to inspect OS internals.
InspectService provides auxiliary API to inspect OS internals.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ created talosconfig
```

> The loadbalancer is used to distribute the load across multiple controlplane nodes.
> This isn't covered in detail, because we asume some loadbalancing knowledge before hand.
> This isn't covered in detail, because we assume some loadbalancing knowledge before hand.
> If you think this should be added to the docs, please [create a issue](https://github.com/talos-systems/talos/issues).
At this point, you can modify the generated configs to your liking.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/v0.11/Bare Metal Platforms/matchbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ join.yaml is valid for metal mode
#### Publishing the Machine Configuration Files

In bare-metal setups it is up to the user to provide the configuration files over HTTP(S).
A special kernel parameter (`talos.config`) must be used to inform Talos about _where_ it should retreive its' configuration file.
A special kernel parameter (`talos.config`) must be used to inform Talos about _where_ it should retrieve its' configuration file.
To keep things simple we will place `controlplane.yaml`, and `join.yaml` into Matchbox's `assets` directory.
This directory is automatically served by Matchbox.

Expand Down Expand Up @@ -147,7 +147,7 @@ Now, create the following groups, and ensure that the `selector`s are accurate f

### Boot the Machines

Now that we have our configuraton files in place, boot all the machines.
Now that we have our configuration files in place, boot all the machines.
Talos will come up on each machine, grab its' configuration file, and bootstrap itself.

### Bootstrap Etcd
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is not a requirement, but rather a document to explain some key settings.
#### Endpoint

To configure the `talosctl` endpoint, it is recommended you use a resolvable DNS name.
This way, if you decide to upgrade to a multi-controlplane cluster you only have to add the ip adres to the hostname configuration.
This way, if you decide to upgrade to a multi-controlplane cluster you only have to add the ip address to the hostname configuration.
The configuration can either be done on a Loadbalancer, or simply trough DNS.

For example:
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/v0.11/Guides/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ With the help of [Rook](https://rook.io), the vast majority of the complexity of
So if Ceph is so great, why not use it for everything?

Ceph can be rather slow for small clusters.
It relies heavily on CPUs and massive parallelisation to provide good cluster performance, so if you don't have much of those dedicated to Ceph, it is not going to be well-optimised for you.
It relies heavily on CPUs and massive parallelisation to provide good cluster performance, so if you don't have much of those dedicated to Ceph, it is not going to be well-optimized for you.
Also, if your cluster is small, just running Ceph may eat up a significant amount of the resources you have available.

Troubleshooting Ceph can be difficult if you do not understand its architecture.
Expand All @@ -56,7 +56,7 @@ There are very good tools for inspection and debugging, but this is still freque

### Mayastor

[Mayastor](https://github.com/openebs/Mayastor) is an OpenEBS project built in Rust utilising the modern NVMEoF system.
[Mayastor](https://github.com/openebs/Mayastor) is an OpenEBS project built in Rust utilizing the modern NVMEoF system.
(Despite the name, Mayastor does _not_ require you to have NVME drives.)
It is fast and lean but still cluster-oriented and cloud native.
Unlike most of the other OpenEBS project, it is _not_ built on the ancient iSCSI system.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ kube-flannel-jknt9 1/1 Running 0 23
Full error might look like:

```bash
x509: certificate signed by unknown authority (possiby because of crypto/rsa: verification error" while trying to verify candidate authority certificate "kubernetes"
x509: certificate signed by unknown authority (possibly because of crypto/rsa: verification error" while trying to verify candidate authority certificate "kubernetes"
```
Commonly, the control plane endpoint points to a different cluster, as the client certificate
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.11/Learn More/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Can I break my cluster by upgrading everything?
**A.** No.

Nothing prevents the user from sending any number of near-simultaneous upgrades to each node of the cluster.
While most people would not attempt to do this, it may be the desired behaviour in certain situations.
While most people would not attempt to do this, it may be the desired behavior in certain situations.

If, however, multiple control plane nodes are asked to upgrade at the same time, Talos will protect itself by making sure only one control plane node upgrades at any time, through its checking of etcd quorum.
A lease is taken out by the winning control plane node, and no other control plane node is allowed to execute the upgrade until the lease is released and the etcd cluster is healthy and _will_ be healthy when the next node performs its upgrade.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.11/Reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ The ControllerRuntimeDependency message contains the graph of controller-resourc
### InspectService
The inspect service definition.

InspectService provides auxilary API to inspect OS internals.
InspectService provides auxiliary API to inspect OS internals.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ If you wish to export this IP as a bash variable, simply issue a command like `e
### Without DHCP server

To apply the machine configurations in maintenance mode, VM has to have IP on the network.
So you can set it on boot time manualy.
So you can set it on boot time manually.

<img src="/images/proxmox-guide/maintenance-mode-grub-menu.png" width="600px">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ created talosconfig
```

> The loadbalancer is used to distribute the load across multiple controlplane nodes.
> This isn't covered in detail, because we asume some loadbalancing knowledge before hand.
> This isn't covered in detail, because we assume some loadbalancing knowledge before hand.
> If you think this should be added to the docs, please [create a issue](https://github.com/talos-systems/talos/issues).
At this point, you can modify the generated configs to your liking.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/v0.12/Bare Metal Platforms/matchbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ worker.yaml is valid for metal mode
#### Publishing the Machine Configuration Files

In bare-metal setups it is up to the user to provide the configuration files over HTTP(S).
A special kernel parameter (`talos.config`) must be used to inform Talos about _where_ it should retreive its' configuration file.
A special kernel parameter (`talos.config`) must be used to inform Talos about _where_ it should retrieve its' configuration file.
To keep things simple we will place `controlplane.yaml`, and `worker.yaml` into Matchbox's `assets` directory.
This directory is automatically served by Matchbox.

Expand Down Expand Up @@ -147,7 +147,7 @@ Now, create the following groups, and ensure that the `selector`s are accurate f

### Boot the Machines

Now that we have our configuraton files in place, boot all the machines.
Now that we have our configuration files in place, boot all the machines.
Talos will come up on each machine, grab its' configuration file, and bootstrap itself.

### Bootstrap Etcd
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is not a requirement, but rather a document to explain some key settings.
#### Endpoint

To configure the `talosctl` endpoint, it is recommended you use a resolvable DNS name.
This way, if you decide to upgrade to a multi-controlplane cluster you only have to add the ip adres to the hostname configuration.
This way, if you decide to upgrade to a multi-controlplane cluster you only have to add the ip address to the hostname configuration.
The configuration can either be done on a Loadbalancer, or simply trough DNS.

For example:
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/v0.12/Guides/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ With the help of [Rook](https://rook.io), the vast majority of the complexity of
So if Ceph is so great, why not use it for everything?

Ceph can be rather slow for small clusters.
It relies heavily on CPUs and massive parallelisation to provide good cluster performance, so if you don't have much of those dedicated to Ceph, it is not going to be well-optimised for you.
It relies heavily on CPUs and massive parallelisation to provide good cluster performance, so if you don't have much of those dedicated to Ceph, it is not going to be well-optimized for you.
Also, if your cluster is small, just running Ceph may eat up a significant amount of the resources you have available.

Troubleshooting Ceph can be difficult if you do not understand its architecture.
Expand All @@ -56,7 +56,7 @@ There are very good tools for inspection and debugging, but this is still freque

### Mayastor

[Mayastor](https://github.com/openebs/Mayastor) is an OpenEBS project built in Rust utilising the modern NVMEoF system.
[Mayastor](https://github.com/openebs/Mayastor) is an OpenEBS project built in Rust utilizing the modern NVMEoF system.
(Despite the name, Mayastor does _not_ require you to have NVME drives.)
It is fast and lean but still cluster-oriented and cloud native.
Unlike most of the other OpenEBS project, it is _not_ built on the ancient iSCSI system.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ kube-flannel-jknt9 1/1 Running 0 23
Full error might look like:

```bash
x509: certificate signed by unknown authority (possiby because of crypto/rsa: verification error" while trying to verify candidate authority certificate "kubernetes"
x509: certificate signed by unknown authority (possibly because of crypto/rsa: verification error" while trying to verify candidate authority certificate "kubernetes"
```
Commonly, the control plane endpoint points to a different cluster, as the client certificate
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.12/Learn More/upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Can I break my cluster by upgrading everything?
**A.** No.

Nothing prevents the user from sending any number of near-simultaneous upgrades to each node of the cluster.
While most people would not attempt to do this, it may be the desired behaviour in certain situations.
While most people would not attempt to do this, it may be the desired behavior in certain situations.

If, however, multiple control plane nodes are asked to upgrade at the same time, Talos will protect itself by making sure only one control plane node upgrades at any time, through its checking of etcd quorum.
A lease is taken out by the winning control plane node, and no other control plane node is allowed to execute the upgrade until the lease is released and the etcd cluster is healthy and _will_ be healthy when the next node performs its upgrade.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/v0.12/Reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ The ControllerRuntimeDependency message contains the graph of controller-resourc
### InspectService
The inspect service definition.

InspectService provides auxilary API to inspect OS internals.
InspectService provides auxiliary API to inspect OS internals.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ If you wish to export this IP as a bash variable, simply issue a command like `e
### Without DHCP server

To apply the machine configurations in maintenance mode, VM has to have IP on the network.
So you can set it on boot time manualy.
So you can set it on boot time manually.

<img src="/images/proxmox-guide/maintenance-mode-grub-menu.png" width="600px">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ created talosconfig
```

> The loadbalancer is used to distribute the load across multiple controlplane nodes.
> This isn't covered in detail, because we asume some loadbalancing knowledge before hand.
> This isn't covered in detail, because we assume some loadbalancing knowledge before hand.
> If you think this should be added to the docs, please [create a issue](https://github.com/talos-systems/talos/issues).
At this point, you can modify the generated configs to your liking.
Expand Down
Loading

0 comments on commit d256b5c

Please sign in to comment.