Skip to content

Commit

Permalink
docs: Fix spelling errors across site (hashicorp#12973)
Browse files Browse the repository at this point in the history
  • Loading branch information
blake authored May 10, 2022
1 parent f4e1ade commit 8edee75
Show file tree
Hide file tree
Showing 37 changed files with 79 additions and 79 deletions.
4 changes: 2 additions & 2 deletions website/content/docs/agent/config/config-files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -778,7 +778,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
is updated. See the [watch documentation](/docs/dynamic-app-config/watches) for more detail.
Watches can be modified when the configuration is reloaded.

## ACL Paramters
## ACL Parameters

- `acl` ((#acl)) - This object allows a number of sub-keys to be set which
controls the ACL system. Configuring the ACL system within the ACL stanza was added
Expand Down Expand Up @@ -1618,7 +1618,7 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."

- `serf_wan_allowed_cidrs` ((#serf_wan_allowed_cidrs)) Equivalent to the [`-serf-wan-allowed-cidrs` command-line flag](/docs/agent/config/cli-flags#_serf_wan_allowed_cidrs).

## Telemetry Paramters
## Telemetry Parameters

- `telemetry` This is a nested object that configures where
Consul sends its runtime telemetry, and contains the following keys:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If Consul is instead deployed with 5 servers, the quorum size increases to 3, so
the fault tolerance increases to 2.
To learn more about the relationship between the
number of servers, quorum, and fault tolerance, refer to the
[concensus protocol documentation](/docs/architecture/consensus#deployment_table).
[consensus protocol documentation](/docs/architecture/consensus#deployment_table).

Effectively mitigating your risk is more nuanced than just increasing the fault tolerance
metric described above. You must consider:
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/architecture/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ From a 10,000 foot altitude the architecture of Consul looks like this:

Let's break down this image and describe each piece. First of all, we can see
that there are two datacenters, labeled "one" and "two". Consul has first
class support for [multiple datacenters](https://learn.hashicorp.com/tutorials/consul/federarion-gossip-wan) and
class support for [multiple datacenters](https://learn.hashicorp.com/tutorials/consul/federation-gossip-wan) and
expects this to be the common case.

Within each datacenter, we have a mixture of clients and servers. It is expected
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/connect/ca/vault.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ The configuration options are listed below.
When WAN Federation is enabled, every secondary
datacenter must specify a unique `intermediate_pki_path`.

- `IntermediatePKINamespace` / `intermedial_pki_namespace` (`string: <optional>`) - The absolute namespace
- `IntermediatePKINamespace` / `intermediate_pki_namespace` (`string: <optional>`) - The absolute namespace
that the `IntermediatePKIPath` is in. Setting this overrides the `Namespace` option for the `IntermediatePKIPath`. Introduced in 1.12.1

- `CAFile` / `ca_file` (`string: ""`) - Specifies an optional path to the CA
Expand Down
12 changes: 6 additions & 6 deletions website/content/docs/connect/config-entries/proxy-defaults.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ TransparentProxy {
DialedDirectly = <true if proxy instances should be dialed directly>
}
MeshGateway {
Mode = "<name of mesh gatweay configuration for all proxies>"
Mode = "<name of mesh gateway configuration for all proxies>"
}
Expose {
Checks = <true to expose all HTTP and gRPC checks through Envoy>
Expand Down Expand Up @@ -98,7 +98,7 @@ spec:
outboundListenerPort: <port the proxy should listen on for outbound traffic>
dialedDirectly: <true if proxy instances should be dialed directly>
meshGateway:
mode: <name of mesh gatweay configuration for all proxies>
mode: <name of mesh gateway configuration for all proxies>
expose:
checks: <true to expose all HTTP and gRPC checks through Envoy>
paths:
Expand Down Expand Up @@ -127,7 +127,7 @@ spec:
"DialedDirectly": <true if proxy instances should be dialed directly>
},
"MeshGateway": {
"Mode": = "<name of mesh gatweay configuration for all proxies>"
"Mode": = "<name of mesh gateway configuration for all proxies>"
},
"Expose": {
"Checks": <true to expose all HTTP and gRPC checks through Envoy>,
Expand Down Expand Up @@ -171,7 +171,7 @@ TransparentProxy {
DialedDirectly = <true if proxy instances should be dialed directly>
}
MeshGateway {
Mode = "<name of mesh gatweay configuration for all proxies>"
Mode = "<name of mesh gateway configuration for all proxies>"
}
Expose {
Checks = <true to expose all HTTP and gRPC checks through Envoy>
Expand Down Expand Up @@ -206,7 +206,7 @@ spec:
outboundListenerPort: <port the proxy should listen on for outbound traffic>
dialedDirectly: <true if proxy instances should be dialed directly>
meshGateway:
mode: <name of mesh gatweay configuration for all proxies>
mode: <name of mesh gateway configuration for all proxies>
expose:
checks: <true to expose all HTTP and gRPC checks through Envoy>
paths:
Expand Down Expand Up @@ -236,7 +236,7 @@ spec:
"DialedDirectly": <true if proxy instances should be dialed directly>
},
"MeshGateway": {
"Mode": = "<name of mesh gatweay configuration for all proxies>"
"Mode": = "<name of mesh gateway configuration for all proxies>"
},
"Expose": {
"Checks": <true to expose all HTTP and gRPC checks through Envoy>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ spec:

### Retry logic

Enable retry logic by delagating this resposbility to Consul and the proxy. Review the [`ServiceRouteDestination`](#serviceroutedestination) block for more details.
Enable retry logic by delegating this responsibility to Consul and the proxy. Review the [`ServiceRouteDestination`](#serviceroutedestination) block for more details.

<CodeTabs tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ Ensure that your Consul environment meets the following requirements.
* A local Consul agent is required to manage its configuration.
* Consul [Connect](/docs/agent/config/config-files#connect) must be enabled in both datacenters.
* Each [datacenter](/docs/agent/config/config-files#datacenter) must have a unique name.
* Each datacenters must be [WAN joined](https://learn.hashicorp.com/tutorials/consul/federarion-gossip-wan).
* Each datacenters must be [WAN joined](https://learn.hashicorp.com/tutorials/consul/federation-gossip-wan).
* The [primary datacenter](/docs/agent/config/config-files#primary_datacenter) must be set to the same value in both datacenters. This specifies which datacenter is the authority for Connect certificates and is required for services in all datacenters to establish mutual TLS with each other.
* [gRPC](/docs/agent/config/config-files#grpc_port) must be enabled.
* If you want to [enable gateways globally](/docs/connect/mesh-gateway#enabling-gateways-globally) you must enable [centralized configuration](/docs/agent/config/config-files#enable_central_service_config).
* If you want to [enable gateways globally](/docs/connect/gateways/mesh-gateway/service-to-service-traffic-datacenters#enabling-gateways-globally) you must enable [centralized configuration](/docs/agent/config/config-files#enable_central_service_config).

### Network

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ WAN federation via mesh gateways allows for Consul servers in different datacent
to be federated exclusively through mesh gateways.

When setting up a
[multi-datacenter](https://learn.hashicorp.com/tutorials/consul/federarion-gossip-wan)
[multi-datacenter](https://learn.hashicorp.com/tutorials/consul/federation-gossip-wan)
Consul cluster, operators must ensure that all Consul servers in every
datacenter must be directly connectable over their WAN-advertised network
address from each other.
Expand Down Expand Up @@ -102,7 +102,7 @@ each datacenter otherwise the WAN will become only partly connected.

There are a few necessary additional pieces of configuration beyond those
required for standing up a
[multi-datacenter](https://learn.hashicorp.com/tutorials/consul/federarion-gossip-wan)
[multi-datacenter](https://learn.hashicorp.com/tutorials/consul/federation-gossip-wan)
Consul cluster.

Consul servers in the _primary_ datacenter should add this snippet to the
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/connect/proxies/envoy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Envoy must be run with the `--max-obj-name-len` option set to `256` or greater f

## Supported Versions

The following matrix describes Envoy compatibility for the currently supported **n-2 major Consul releases**. For previous Consul version compatability please view the respective versioned docs for this page.
The following matrix describes Envoy compatibility for the currently supported **n-2 major Consul releases**. For previous Consul version compatibility please view the respective versioned docs for this page.

Consul supports **four major Envoy releases** at the beginning of each major Consul release. Consul maintains compatibility with Envoy patch releases for each major version so that users can benefit from bug and security fixes in Envoy. As a policy, Consul will add support for a new major versions of Envoy in a Consul major release. Support for newer versions of Envoy will not be added to existing releases.

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/discovery/dns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ services {

</CodeTabs>

When performing an SRV query for this servie, the SRV response contains a single
When performing an SRV query for this service, the SRV response contains a single
record with a hostname in the format of `<hexadecimal-encoded IP>.addr.<datacenter>.consul`.

```shell-session
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/ecs/manual/acl-controller.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Before deploying the ACL controller for the first time, you must [create the fol
| Bootstrap ACL Token | Set | `my-consul-bootstrap-token` |
| Consul Client ACL Token | Empty | `<PREFIX>-consul-client-token` |

The secret for the client token must be intially empty. The ACL controller creates the client token in Consul
The secret for the client token must be initially empty. The ACL controller creates the client token in Consul
and stores the token in Secrets Manager. In the secret name, `<PREFIX>` should be replaced with the
[secret name prefix](/docs/ecs/manual/acl-controller#secret-name-prefix) of your choice.

Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/ecs/manual/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ during task startup.
| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------ |
| `family` | string | The task family name. This is used as the Consul service name by default. |
| `networkMode` | string | Must be `awsvpc`, which is the only network mode supported by Consul on ECS. |
| `volumes` | list | Must be defined as shown above. Volumes are used to share configuration between containers for intial task setup. |
| `volumes` | list | Must be defined as shown above. Volumes are used to share configuration between containers for initial task setup. |
| `containerDefinitions` | list | The list of containers to run in this task (see [Application container](#application-container)). |

### Task Tags
Expand Down Expand Up @@ -551,4 +551,4 @@ and `consul-ecs-mesh-init` containers.

* Create the task definition using the [AWS Console](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html) or the [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/ecs/register-task-definition.html), or another method of your choice.
* Create an [ECS Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) to start tasks using the task definition.
* Follow the [Secure Configration](/docs/ecs/manual/secure-configuration) to get production-ready.
* Follow the [Secure Configuration](/docs/ecs/manual/secure-configuration) to get production-ready.
14 changes: 7 additions & 7 deletions website/content/docs/ecs/manual/secure-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: docs
page_title: Secure Configuration - AWS ECS
description: >-
Manual Secure Confguration of the Consul Service Mesh on AWS ECS (Elastic Container Service).
Manual Secure Configuration of the Consul Service Mesh on AWS ECS (Elastic Container Service).
---

# Secure Configuration
Expand Down Expand Up @@ -181,12 +181,12 @@ EOF

The following table describes the additional fields that must be included in the Consul client configuration file.

| Field name | Type | Description |
| --------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
| [`encrypt`](/docs/agent/options#_encrypt) | string | Specifies the gossip encryption key |
| [`tls.defaults.ca_file`](/docs/agent/options#tls_defaults_ca_file) | string | Specifies the Consul server CA cert for TLS verification. |
| [`acl.enabled`](/docs/agent/options#acl_enabled) | boolean | Enable ACLs for this agent. |
| [`acl.tokens.agent`](/docs/agent/options#acl_tokens_agent) | string | Specifies the Consul client token which authorizes this agent with Consul servers. |
| Field name | Type | Description |
| -------------------------------------------------------------------------------| ------- | ------------------------------------------------------------------------------------ |
| [`encrypt`](/docs/agent/config/cli-flags#_encrypt) | string | Specifies the gossip encryption key |
| [`tls.defaults.ca_file`](/docs/agent/config/config-files#tls_defaults_ca_file) | string | Specifies the Consul server CA cert for TLS verification. |
| [`acl.enabled`](/docs/agent/config/config-files#acl_enabled) | boolean | Enable ACLs for this agent. |
| [`acl.tokens.agent`](/docs/agent/config/config-files#acl_tokens_agent) | string | Specifies the Consul client token which authorizes this agent with Consul servers. |

## Configure `consul-ecs-mesh-init` and `consul-ecs-health-sync`

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/ecs/task-resource-usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ component in depth.

We used the following procedure to measure resource usage:

- Executed performance tests while deploying clusers of various sizes. We
- Executed performance tests while deploying clusters of various sizes. We
ensured that deployment conditions stressed Consul on ESC components.
- After each performance test session, we recorded resource usage for each
component to determine worst-case scenario resource usage in a production
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/enterprise/network-segments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ over the WAN. Consul clients make use of resources in federated clusters by
forwarding RPCs through the Consul servers in their local cluster, but they
never interact with remote Consul servers directly. There are currently two
inter-cluster network models which can be viewed on HashiCorp Learn:
[WAN gossip (OSS)](https://learn.hashicorp.com/tutorials/consul/federarion-gossip-wan)
[WAN gossip (OSS)](https://learn.hashicorp.com/tutorials/consul/federation-gossip-wan)
and [Network Areas (Enterprise)](https://learn.hashicorp.com/tutorials/consul/federation-network-areas).

**LAN Gossip Pool**: A set of Consul agents that have full mesh connectivity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Consul is platform agnostic which makes it a great fit for all environments, inc
Consul is available as a [self-install](/downloads) project or as a fully managed service mesh solution called [HCP Consul](https://portal.cloud.hashicorp.com/sign-in?utm_source=consul_docs).
HCP Consul enables users to discover and securely connect services without the added operational burden of maintaining a service mesh on their own.

You can learn more about Consul by visting the Consul Learn [tutorials](https://learn.hashicorp.com/consul).
You can learn more about Consul by visiting the Consul Learn [tutorials](https://learn.hashicorp.com/consul).

## Next

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/k8s/annotations-and-labels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This allows the user to configure natively configure Consul on select Kubernetes

## Annotations

Resource annotations could be used on the Kubernetes pod to control connnect-inject behavior.
Resource annotations could be used on the Kubernetes pod to control connect-inject behavior.

- `consul.hashicorp.com/connect-inject` - If this is "true" then injection
is enabled. If this is "false" then injection is explicitly disabled.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/k8s/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ are configured with
rules so that they are placed on different nodes. A readiness probe is
configured that marks the pod as ready only when it has established a leader.

A Kubernetes `Service` is registered to represent the servers and exposes ports that are requried to communicate to the Consul server pods.
A Kubernetes `Service` is registered to represent the servers and exposes ports that are required to communicate to the Consul server pods.
The servers utilize the DNS address of this service to join a Consul cluster, without requiring any other access to the Kubernetes cluster. Additional consul servers may also utilize non-ready endpoints which are published by the Kubernetes service, so that servers can utilize the service for joining during bootstrap and upgrades.

Additionally, a **PodDisruptionBudget** is configured so the Consul server
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/k8s/connect/terminating-gateways.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ If ACLs are enabled, update the terminating gateway acl role to have `service: w
being represented by the gateway:

- Create a new policy that includes these permissions
- Update the existing rolc to include the new policy
- Update the existing role to include the new policy

<CodeBlockConfig filename="write-policy.hcl">

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/k8s/installation/compatibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ Consul Kubernetes delivered Red Hat OpenShift support starting with Consul Helm
Consul Kubernetes is [certified](https://marketplace.cloud.vmware.com/services/details/hashicorp-consul-1?slug=true) for both VMware Tanzu Kubernetes Grid, and VMware Tanzu Kubernetes Integrated Edition.

- Tanzu Kubernetes Grid is certified for version 1.3.0 and above. Only Calico is supported as the CNI Plugin.
- Tanzu Kuberntetes Grid Integrated Edition is supported for version 1.11.1 and above. [NSX-T CNI Plugin v3.1.2](https://docs.vmware.com/en/VMware-NSX-T-Data-Center/3.1/rn/NSX-Container-Plugin-312-Release-Notes.html) and greater should be used and configured with the `enable_hostport_snat` setting set to `true`.
- Tanzu Kubernetes Grid Integrated Edition is supported for version 1.11.1 and above. [NSX-T CNI Plugin v3.1.2](https://docs.vmware.com/en/VMware-NSX-T-Data-Center/3.1/rn/NSX-Container-Plugin-312-Release-Notes.html) and greater should be used and configured with the `enable_hostport_snat` setting set to `true`.


Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ global:

</CodeBlockConfig>

If the version of Consul is < 1.10, use the following config with the name and key of the secret you just created.
(These values arerequired on top ofyour normal configuration.)
If the version of Consul is < 1.10, use the following config with the name and key of the secret you just created.
(These values are required on top of your normal configuration.)

-> **Note:** The value of `server.enterpriseLicense.enableLicenseAutoload` must be set to `false`.

Expand Down
Loading

0 comments on commit 8edee75

Please sign in to comment.