Skip to content

Commit

Permalink
docs: Fix spelling errors (#21204)
Browse files Browse the repository at this point in the history
Fix spelling errors across docs site.
  • Loading branch information
blake authored May 22, 2024
1 parent b2a618b commit 6f02144
Show file tree
Hide file tree
Showing 29 changed files with 238 additions and 238 deletions.
2 changes: 1 addition & 1 deletion website/content/api-docs/hcp-link.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The table below shows this endpoint's support for

### Link API vs. configuration-based linking

The Link API described here is an alternative method to accomplish the same thing as [configuration-based linking](/consul/docs/agent/config/config-files#self-managed-hcp-parameters). You should generally only choose one method or the other for linking your cluster, not both. If you do use both methods, they interract in the following ways:
The Link API described here is an alternative method to accomplish the same thing as [configuration-based linking](/consul/docs/agent/config/config-files#self-managed-hcp-parameters). You should generally only choose one method or the other for linking your cluster, not both. If you do use both methods, they interact in the following ways:

* When Consul is started, values set in the `cloud` configuration will take precedence over what was previously set by the API or CLI.
* Clusters can only be unlinked from HCP Consul Central by the API or CLI, regardless of if they were established via configuration, API, or CLI.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/agent/config-entries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ See [Kubernetes Custom Resource Definitions](/consul/docs/k8s/crds).
Configuration entries outside of Kubernetes should be managed with the Consul
[CLI](/consul/commands/config) or [API](/consul/api-docs/config). Additionally, as a
convenience for initial cluster bootstrapping, configuration entries can be
specified in all of the Consul servers's
specified in all of the Consul server
[configuration files](/consul/docs/agent/config/config-files#config_entries_bootstrap)
### Managing Configuration Entries with the CLI
Expand Down
12 changes: 6 additions & 6 deletions website/content/docs/agent/monitor/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ This document will guide you recommendations for monitoring your Consul control

## Background

A Consul datacenter is the smallest unit of Consul infrastructure that can perform basic Consul operations like service discovery or service mesh. A datacenter contains at least one Consul server agent, but a real-world deployment contains three or five server agents and several Consul client agents.
A Consul datacenter is the smallest unit of Consul infrastructure that can perform basic Consul operations like service discovery or service mesh. A datacenter contains at least one Consul server agent, but a real-world deployment contains three or five server agents and several Consul client agents.

The Consul control plane consists of server agents that store all state information, including service and node IP addresses, health checks, and configuration. In addition, the control plane is responsible for securing the mesh, facilitating service discovery, health checking, policy enforcement, and other similar operational concerns. In addition, the control plane contains client agents that report node and service health status to the Consul cluster. In a typical deployment, you must run client agents on every compute node in your datacenter.
The Consul control plane consists of server agents that store all state information, including service and node IP addresses, health checks, and configuration. In addition, the control plane is responsible for securing the mesh, facilitating service discovery, health checking, policy enforcement, and other similar operational concerns. In addition, the control plane contains client agents that report node and service health status to the Consul cluster. In a typical deployment, you must run client agents on every compute node in your datacenter.

The Consul data plane consists of proxies deployed locally alongside each service instance. These proxies, called sidecar proxies, receive mesh configuration data from the control plane, and control network communication between their local service instance and other services in the network. The sidecar proxy handles inbound and outbound service connections, and ensures TLS connections between services are both verified and encrypted.

Expand Down Expand Up @@ -44,13 +44,13 @@ It is important to have a highly performant network with low network latency. En
### Raft recommendations

Consul uses [Raft for consensus protocol](/consul/docs/architecture/consensus). High saturation of the Raft goroutines can lead to elevated latency in the rest of the system and may cause the Consul cluster to be unstable. As a result, it is important to monitor Raft to track your control plane health. We recommend the following actions to keep control plane healthy:
- Create an alert that notifies you when [Raft thread saturation](/consul/docs/agent/telemetry#raft-thread-saturation) exceeds 50%.
- Create an alert that notifies you when [Raft thread saturation](/consul/docs/agent/telemetry#raft-thread-saturation) exceeds 50%.
- Monitor [Raft replication capacity](/consul/docs/agent/telemetry#raft-replication-capacity-issues) when Consul is handling large amounts of data and high write throughput.
- Lower [`raft_multiplier`](/consul/docs/install/performance#production) to keep your Consul cluster stable. The value of `raft_multiplier` defines the scaling factor for Consul. Default value for raft_multiplier is 5.

A short multiplier minimizes failure detection and election time but may trigger frequently in high latency situations. This can cause constant leadership churn and associated unavailability. A high multiplier reduces the chances that spurious failures will cause leadership churn but it does this at the expense of taking longer to detect real failures and thus takes longer to restore Consul cluster availability.

Wide networks with higher latency will perform better with larger `raft_multipler` values.
Wide networks with higher latency will perform better with larger `raft_multiplier` values.

Raft uses BoltDB for storing data and maintaining its own state. Refer to the [Bolt DB performance metrics](/consul/docs/agent/telemetry#bolt-db-performance) when you are troubleshooting Raft performance issues.

Expand All @@ -77,7 +77,7 @@ annotations:
consul.hashicorp.com/envoy-extra-args: '--log-level debug --disable-hot-restart'
```
Refer to the [Enable logging on Envoy sidecar pods](/consul/docs/k8s/annotations-and-labels#consul-hashicorp-com-envoy-extra-args) documention for more information.
Refer to the [Enable logging on Envoy sidecar pods](/consul/docs/k8s/annotations-and-labels#consul-hashicorp-com-envoy-extra-args) documentation for more information.
#### Envoy Admin Interface
Expand All @@ -87,7 +87,7 @@ All endpoints exposed by Envoy are available at the node running Envoy on port `

The following Envoy admin interface endpoints are particularly useful:

- The `listeners` endpoint lists all listeners running on `localhost`. This allows you to confirm whether the upstream services are binding correctly to Envoy.
- The `listeners` endpoint lists all listeners running on `localhost`. This allows you to confirm whether the upstream services are binding correctly to Envoy.

```shell-session
$ curl http://localhost:19000/listeners
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/architecture/v2/catalog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The v2 catalog API is available alongside the existing v1 catalog API, but the c

## Catalog structure

Consul v1.17 introduces a new version of the catalog API designed to bridge differences between the Consul and Kubernetes data models. The v2 catalog API continues to track services and nodes for Consul, but it replaces service instances with _workloads_ and _workload identites_.
Consul v1.17 introduces a new version of the catalog API designed to bridge differences between the Consul and Kubernetes data models. The v2 catalog API continues to track services and nodes for Consul, but it replaces service instances with _workloads_ and _workload identities_.

### Catalog resources

Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/architecture/v2/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: docs
page_title: Consul v2 architecture
description: Learn about version 2 of Consul's internal architecture, which replaces services and service instances with workloads and workload identies.
description: Learn about version 2 of Consul's internal architecture, which replaces services and service instances with workloads and workload identities.
---

<Warning>
Expand All @@ -12,7 +12,7 @@ The v2 catalog API and Traffic Permissions API are currently in beta. This docum

# Consul v2 architecture

This topic provides an overview of Consul's v2 architecture changes and their impact on Consul operations.
This topic provides an overview of Consul's v2 architecture changes and their impact on Consul operations.

In the v1.17.0 release, Consul introduced the option to enable the [v2 catalog API](/consul/docs/architecture/v2/catalog) for testing and development on Kubernetes deployments. The v2 catalog is one of several changes in development to simplify and streamline Consul's architecture.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ Example use-cases include exposing the `/metrics` endpoint to a monitoring syste
- Default: None
- Data type: Map containing the following parameters:
- [`checks`](#expose-checks)
- [`aths`](#expose-paths)
- [`paths`](#expose-paths)

### `spec.expose{}.checks`

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/connect/dataplane/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ $ export VERSION=1.0.0 && \
Refer to the following documentation for Consul on ECS workloads:

- [Deploy Consul with the Terraform module](/consul/docs/ecs/deploy/terraform)
- [Deploy Consul manually](/consul/ecs/install-manul)
- [Deploy Consul manually](/consul/docs/ecs/deploy/manual)

</Tab>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ You can specify the following strings:
* `trace`

### mapPrivilegedContainerPorts
Specifies a value that Consul adds to privileged ports defined in the gateway. Privileged ports are port numbers less than 1024 and some platforms, such as Red Hat OpenShift, explicitly configure Kubernetes to avoid running containers on privileged ports. The total value of the configured port number and the `mapPriviledgedContainerPorts` value must not exceed 65535, which is the highest possible TCP port number allowed.
Specifies a value that Consul adds to privileged ports defined in the gateway. Privileged ports are port numbers less than 1024 and some platforms, such as Red Hat OpenShift, explicitly configure Kubernetes to avoid running containers on privileged ports. The total value of the configured port number and the `mapPrivilegedContainerPorts` value must not exceed 65535, which is the highest possible TCP port number allowed.
for gateway containers
* Type: Integer
* Required: optional
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: docs
page_title: GatewayPolicy configuration reference
description: Learn about the configuration options for the GatewayPolicy configuration resource. GatewayPolicy resources define API gateway polcies for Consul service mesh on Kubernetes.
description: Learn about the configuration options for the GatewayPolicy configuration resource. GatewayPolicy resources define API gateway policies for Consul service mesh on Kubernetes.
---

# GatewayPolicy
Expand All @@ -15,33 +15,33 @@ The following list outlines field hierarchy, data types, and requirements in a g
- [`apiVersion`](#apiversion): string | required | must be set to `consul.hashicorp.com/v1alpha1`
- [`kind`](#kind): string | required | must be set to `GatewayPolicy`
- [`metadata`](#metadata): map | required
- [`name`](#metadata-name): string | required
- [`name`](#metadata-name): string | required
- [`namespace`](#metadata-namespace): string | `default`
- [`spec`](#spec): map | required
- [`targetRef`](#spec-targetref): map | required
- [`namespace`](#spec-targetref): string | `default`
- [`name`](#spec-targetref): string | required
- [`namespace`](#spec-targetref): string | `default`
- [`name`](#spec-targetref): string | required
- [`kind`](#spec-targetref): string | required | must be set to `Gateway`
- [`group`](#spec-targetref): string | required
- [`sectionName`](#spec-targetref): string
- [`override`](#spec-override): map | required
- [`jwt`](#spec-override-jwt): map | required
- [`providers`](#spec-override-providers): list | required
- [`name`](#spec-override-providers): string | required
- [`verifyClaims`](#spec-override-providers): map | required
- [`path`](#spec-override-providers): list of strings | required
- [`value`](#spec-override-providers): string | required
- [`default`](#spec-default): map | required
- [`jwt`](#spec-default-jwt): map | required
- [`providers`](#spec-default-providers): list | required
- [`name`](#spec-default-providers): string | required
- [`verifyClaims`](#spec-default-providers): map | required
- [`path`](#spec-default-providers): list of strings | required
- [`value`](#spec-default-providers): string | required
- [`group`](#spec-targetref): string | required
- [`sectionName`](#spec-targetref): string
- [`override`](#spec-override): map | required
- [`jwt`](#spec-override-jwt): map | required
- [`providers`](#spec-override-providers): list | required
- [`name`](#spec-override-providers): string | required
- [`verifyClaims`](#spec-override-providers): map | required
- [`path`](#spec-override-providers): list of strings | required
- [`value`](#spec-override-providers): string | required
- [`default`](#spec-default): map | required
- [`jwt`](#spec-default-jwt): map | required
- [`providers`](#spec-default-providers): list | required
- [`name`](#spec-default-providers): string | required
- [`verifyClaims`](#spec-default-providers): map | required
- [`path`](#spec-default-providers): list of strings | required
- [`value`](#spec-default-providers): string | required

## Complete configuration

When every field is defined, a gateway policy has the following form:
When every field is defined, a gateway policy has the following form:

```yaml
apiVersion: consul.hashicorp.com/v1alpha1
Expand All @@ -53,7 +53,7 @@ spec:
targetRef:
name: gateway
kind: Gateway
group: gateway.networking.kuberenetes.io
group: gateway.networking.kubernetes.io
sectionName: <name of a specific listener the policy applies>
override:
jwt:
Expand Down Expand Up @@ -109,15 +109,15 @@ Map that contains an arbitrary name for the resource and the namespace it applie

### `metadata.name`

Specifies a name for the resource. The name is metadata that you can use to reference the resource when performing Consul operations, such as applying the resource to a specific cluster.
Specifies a name for the resource. The name is metadata that you can use to reference the resource when performing Consul operations, such as applying the resource to a specific cluster.

#### Values

- Default: None
- This field is required.
- Data type: String

### `metadata.namespace`
### `metadata.namespace`

Specifies the namespace that the configuration applies to. Refer to [namespaces](/consul/docs/enterprise/namespaces) for more information.

Expand All @@ -138,7 +138,7 @@ Map that contains the details about the gateway policy. The `apiVersion`, `kind`

### `targetRef`

Map that contains references to the gateway that the policy applies to.
Map that contains references to the gateway that the policy applies to.

#### Values

Expand All @@ -153,7 +153,7 @@ The following table describes the members of the `targetRef` map:
| `namespace` | Specifies the namespace that the target reference is a member of. | String | `default` |
| `name` | Specifies the name of the API gateway that the policy attaches to. | String | None |
| `kind` | Specifies the type of resource that the policy attaches to. Must be set to `Gateway`. | String | None |
| `group` | Specifies the resource group. Must be set to `gateway.networking.kuberenetes.io`. | String | None |
| `group` | Specifies the resource group. Must be set to `gateway.networking.kubernetes.io`. | String | None |
| `sectionName` | Specifies a part of the gateway that the policy applies to. | String | None |

### `spec.override`
Expand Down Expand Up @@ -192,7 +192,7 @@ The following table describes the parameters you can specify in a member of the

### `spec.default`

Map that contains default configurations to apply to listeners when the policy is attached to the gateway. All routes attached to the gateway listener inherit the default configurations. You can specify override configurations that have precedence over default configurations. Refer to [`spec.override`](#spec-override) for details.
Map that contains default configurations to apply to listeners when the policy is attached to the gateway. All routes attached to the gateway listener inherit the default configurations. You can specify override configurations that have precedence over default configurations. Refer to [`spec.override`](#spec-override) for details.

#### Values

Expand Down Expand Up @@ -226,7 +226,7 @@ The following table describes the parameters you can specify in a member of the

## Example configuration

In the following example, all requests through the gateway must have the `api.apps.organization.com` audience claim. Additionally, requests through the gateway must have a `user` role by default.
In the following example, all requests through the gateway must have the `api.apps.organization.com` audience claim. Additionally, requests through the gateway must have a `user` role by default.

```yaml
apiVersion: consul.hashicorp.com/v1alpha1
Expand All @@ -237,7 +237,7 @@ spec:
targetRef:
name: gateway
kind: Gateway
group: gateway.networking.kuberenetes.io
group: gateway.networking.kubernetes.io
sectionName: to-server
override:
jwt:
Expand All @@ -256,4 +256,4 @@ spec:
- "roles"
- "perm"
value: "user"
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ The following outline shows how to format the configurations for the `Route` obj
- [`replacePrefixMatch`](#rules-filters-urlrewrite-path): string | required
- [`type`](#rules-filters-urlrewrite-path): string | required
- [`extensionRef`](#rules-filters-extensionref): map
- [`group`](#rultes-filters-extensionref): string | must be set to `consul.hashicorp.com`
- [`kind`](#rultes-filters-extensionref): string | must be set to `RouteAuthFilter`
- [`name`](#rultes-filters-extensionref): string | must be set to `consul.hashicorp.com`
- [`group`](#rules-filters-extensionref): string | must be set to `consul.hashicorp.com`
- [`kind`](#rules-filters-extensionref): string | must be set to `RouteAuthFilter`
- [`name`](#rules-filters-extensionref): string | must be set to `consul.hashicorp.com`
- [`matches`](#rules-matches): array of objects | optional
- [`path`](#rules-matches-path): list of objects | optional
- [`type`](#rules-matches-path): string | required
Expand Down
Loading

0 comments on commit 6f02144

Please sign in to comment.