Skip to content

Commit

Permalink
docs: Fix spelling errors on website (#14634)
Browse files Browse the repository at this point in the history
  • Loading branch information
blake committed Sep 16, 2022
1 parent 82023b0 commit 4087241
Show file tree
Hide file tree
Showing 16 changed files with 84 additions and 84 deletions.
12 changes: 6 additions & 6 deletions website/content/api-docs/features/consistency.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ followers may have a slightly outdated, or "stale", view of Consul's state.
If a read request is handled by the current leader, the response is guaranteed to be
fully _consistent_ (as up-to-date as possible).
If the same request were handled by a follower, the response may be less consistent:
based on a _stale_ (outdated) copy of the leader's state.
based on a _stale_ (outdated) copy of the leader's state.
Consistency is highest if the response comes from the leader.
But ensuring only the leader can respond to the request prevents spreading
read request load across all Consul servers.

The consistency mode controls which Consul servers can repond to read requests,
The consistency mode controls which Consul servers can respond to read requests,
enabling control over this inherent trade-off between consistency and performance.

## Available Consistency Modes
Expand All @@ -56,7 +56,7 @@ Each HTTP API endpoint documents its support for the three read consistency mode

- `default` -
[Consul HTTP API queries use `default` mode by default](#consul-http-api-queries).
It is strongly consistent in almost all cases.
It is strongly consistent in almost all cases.
However, there is a small window in which a new leader may be elected
during which the old leader may respond with stale values.
The trade-off is fast reads but potentially stale values.
Expand Down Expand Up @@ -108,7 +108,7 @@ per consistency mode and the relative trade-offs between level of consistency an
### Cross-Datacenter Request Behavior

When making a request across federated Consul datacenters, requests are forwarded from
a local server to any remote server. Once in the remote datecenter, the request path
a local server to any remote server. Once in the remote datacenter, the request path
is the same as a [local request with the same consistency mode](#intra-datacenter-request-behavior).
The following diagrams show the cross-datacenter request paths when Consul servers in datacenters are
[federated either directly or via mesh gateways](/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways).
Expand Down Expand Up @@ -214,7 +214,7 @@ Services can still override this default on a per-request basis by
[specifying a supported consistency mode as a query parameter in the request](#overriding-a-request-s-consistency-mode).

To configure Consul servers that receive service discovery requests to use `stale`
consistency mode unless overriden,
consistency mode unless overridden,
set [`discovery_max_stale`] to a value greater than zero in their agent configuration.
The `stale` consistency mode will be used by default unless the data is sufficiently stale:
its Raft log's index is more than [`discovery_max_stale`] indices behind the leader's.
Expand Down Expand Up @@ -275,4 +275,4 @@ semantics as `stale` consistency mode but different trade offs. This behavior is
<!-- Common links references -->
[`dns_config.allow_stale`]: /docs/agent/options#allow_stale)
[`dns_config.max_stale`]: /docs/agent/options#max_stale
[`discovery_max_stale`]: /docs/agent/options#discovery_max_stale
[`discovery_max_stale`]: /docs/agent/options#discovery_max_stale
10 changes: 5 additions & 5 deletions website/content/api-docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Consul HTTP API is a RESTful interface that allows you leverage Consul funct
Use the following API endpoints to configure and connect your services.

- [`/catalog`](/api-docs/catalog): Register and deregister nodes, services, and health checks.
- [`/health`](/api-docs/health): Query node health when health checks are enabled.
- [`/health`](/api-docs/health): Query node health when health checks are enabled.
- [`/query`](/api-docs/query): Create and manage prepared queries in Consul. Prepared queries allow you to register a complex service query and send it later.
- [`/coordinate`](/api-docs/coordinate): Query the network coordinates for nodes in the local datacenter and Consul servers in the local datacenter and remote datacenters.

Expand All @@ -29,15 +29,15 @@ The following endpoints are specific to service mesh:

The following API endpoints give you control over access to services in your network and access to the Consul API.

- [`/acl`](/api-docs/acl): Create and manage tokens that authenticate requests and authorize access to resources in the network. We recommend enabling access control lists (ACL) to secure access to the Consul API, UI, and CLI.
- [`/acl`](/api-docs/acl): Create and manage tokens that authenticate requests and authorize access to resources in the network. We recommend enabling access control lists (ACL) to secure access to the Consul API, UI, and CLI.
- [`/connect/intentions`](/api-docs/connect/intentions): Create and manage service intentions.

## Observe your network

Use the following API endpoints enable network observability.

- [`/status`](/api-docs/status): Debug your Consul datacenter by returning low-level Raft information about Consul server peers.
- [`/agent/metrics`](/api-docs/agent#view-metrics): Retrieve metrics for the most recent finished intervals. For more information about metrics, refere to [Telemetry](/docs/agent/telemetry).
- [`/status`](/api-docs/status): Debug your Consul datacenter by returning low-level Raft information about Consul server peers.
- [`/agent/metrics`](/api-docs/agent#view-metrics): Retrieve metrics for the most recent finished intervals. For more information about metrics, refer to [Telemetry](/docs/agent/telemetry).


## Manage consul
Expand All @@ -54,6 +54,6 @@ The following API endpoints help you manage Consul operations.

The following API endpoints enable you to dynamically configure your services.

- [`/event`](/api-docs/event): Start a custom event that you can use to build scripts and automations.
- [`/event`](/api-docs/event): Start a custom event that you can use to build scripts and automations.
- [`/kv`](/api-docs/kv): Add, remove, and update metadata stored in the Consul KV store.
- [`/session`](/api-docs/session): Create and manage [sessions](/docs/dynamic-app-config/sessions) in Consul. You can use sessions to build distributed and granular locks to ensure nodes are properly writing to the Consul KV store.
2 changes: 1 addition & 1 deletion website/content/api-docs/query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ populate the query before it is executed. All of the string fields inside the
empty string.

- `${agent.segment}` <EnterpriseAlert inline /> - the network segment of the agent that
initiated the query. This varaible can be used with the `NodeMeta` field to limit the results
initiated the query. This variable can be used with the `NodeMeta` field to limit the results
of a query to service instances within its own network segment:

```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Defines an API object that references additional configurations required by the
| --- | --- | --- | --- |
| `group` | Specifies the Kubernetes group that the `parametersRef` is a member of. <br/>The value must always be `api-gateway.consul.hashicorp.com`.<br/>The `parametersRef.group` is always the same across all deployments of Consul API Gateway. | String | Required |
| `kind` | Specifies the type of Kubernetes object that the `parametersRef` configuration defines. <br/>The value must always be `GatewayClassConfig`. <br/> This `parametersRef.kind` is always the same across all deployments of Consul API Gateway. | String | Required |
| `name` | Specfies a name for the `GatewayClassConfig` object. | String | Required |
| `name` | Specifies a name for the `GatewayClassConfig` object. | String | Required |


### description
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/api-gateway/configuration/routes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The `rules` field contains a list of objects that define behaviors for network t

* [`backendRefs`](#rules-backendrefs): Specifies which backend services the `Route` references when processing traffic.
* [`filters`](#rules-filters): Specifies which operations Consul API Gateway performs when traffic goes through the `Route`.
* [`matches`](#rules-matches): Deterines which requests Consul API Gateway processes.
* [`matches`](#rules-matches): Determines which requests Consul API Gateway processes.

Rules are optional.

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/api-gateway/upgrades.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ If you have any active `ReferencePolicy` resources, you will receive output simi

## Upgrade to v0.3.0 from v0.2.0 or lower

Consul API Gateway v0.3.0 introduces a change for people upgrading from lower versions. Gateways with `listeners` with a `certificateRef` defined in a different namespace now require a [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferencePolicy) that explicitly allows `Gateways` from the gateway's namesapce to use `certificateRef` in the `certificateRef`'s namespace.
Consul API Gateway v0.3.0 introduces a change for people upgrading from lower versions. Gateways with `listeners` with a `certificateRef` defined in a different namespace now require a [`ReferencePolicy`](https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.ReferencePolicy) that explicitly allows `Gateways` from the gateway's namespace to use `certificateRef` in the `certificateRef`'s namespace.

### Requirements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can configure the settings defined in the `exported-services` configuration

## Requirements

- A 1.11.0+ Consul Enteprise binary or a 1.13.0+ Consul OSS binary.
- A 1.11.0+ Consul Enterprise binary or a 1.13.0+ Consul OSS binary.
- **Enterprise Only**: A corresponding partition that the configuration entry can export from. For example, the `exported-services` configuration entry for a partition named `frontend` requires an existing `frontend` partition.

## Usage
Expand Down
Loading

0 comments on commit 4087241

Please sign in to comment.