Skip to content

Commit

Permalink
Docs/clarify connect language 2 backport 1.15 (#17233)
Browse files Browse the repository at this point in the history
Remove outdated usage of "Consul Connect" instead of Consul service mesh.

The connect subsystem in Consul provides Consul's service mesh capabilities.
However, the term "Consul Connect" should not be used as an alternative to
the name "Consul service mesh".
  • Loading branch information
jkirschner-hashicorp authored May 8, 2023
1 parent 4fd91e8 commit b99de08
Show file tree
Hide file tree
Showing 93 changed files with 476 additions and 454 deletions.
18 changes: 9 additions & 9 deletions website/content/api-docs/agent/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
layout: api
page_title: Connect - Agent - HTTP API
description: >-
The /agent/connect endpoints interact with Connect with agent-local
The /agent/connect endpoints interact with agent-local service mesh
operations.
---

# Connect - Agent HTTP API

The `/agent/connect` endpoints interact with [Connect](/consul/docs/connect)
with agent-local operations.
The `/agent/connect` endpoints interact with
with agent-local [service mesh](/consul/docs/connect) operations.

These endpoints may mirror the [non-agent Connect endpoints](/consul/api-docs/connect)
in some cases. Almost all agent-local Connect endpoints perform local caching
to optimize performance of Connect without having to make requests to the server.
These endpoints may mirror the [non-agent service mesh endpoints](/consul/api-docs/connect)
in some cases. Almost all agent-local service mesh endpoints perform local caching
to optimize performance of the mesh without having to make requests to the server.

## Authorize

Expand All @@ -29,7 +29,7 @@ This endpoint tests whether a connection attempt is authorized between
two services. This is the primary API that must be implemented by
[proxies](/consul/docs/connect/proxies) or
[native integrations](/consul/docs/connect/native)
that wish to integrate with Connect. Prior to calling this API, it is expected
that wish to integrate with the service mesh. Prior to calling this API, it is expected
that the client TLS certificate has been properly verified against the
current CA roots.

Expand Down Expand Up @@ -108,7 +108,7 @@ This is used by [proxies](/consul/docs/connect/proxies) or
[native integrations](/consul/docs/connect/native) to verify served client
or server certificates are valid.

This is equivalent to the [non-Agent Connect endpoint](/consul/api-docs/connect),
This is equivalent to the [non-Agent service mesh endpoint](/consul/api-docs/connect),
but the response of this request is cached locally at the agent. This allows
for very fast response times and for fail open behavior if the server is
unavailable. This endpoint should be used by proxies and native integrations.
Expand Down Expand Up @@ -248,7 +248,7 @@ $ curl \

## Methods to Specify Namespace <EnterpriseAlert inline />

Local agent connect endpoints
Local agent service mesh endpoints
support several methods for specifying the namespace of resources
with the following order of precedence:
1. `Namespace` field of the JSON request body -
Expand Down
16 changes: 8 additions & 8 deletions website/content/api-docs/agent/service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ following selectors and filter operations being supported:

This endpoint was added in Consul 1.3.0 and returns the full service definition
for a single service instance registered on the local agent. It is used by
[Connect proxies](/consul/docs/connect/proxies) to discover the embedded proxy
[service mesh proxies](/consul/docs/connect/proxies) to discover the embedded proxy
configuration that was registered with the instance.

It is important to note that the services known by the agent may be different
Expand Down Expand Up @@ -632,18 +632,18 @@ The `/agent/service/register` endpoint supports camel case and _snake case_ for

- `Kind` `(string: "")` - The kind of service. Defaults to "" which is a
typical Consul service. This value may also be "connect-proxy" for
[Connect](/consul/docs/connect) proxies representing another service,
"mesh-gateway" for instances of a [mesh gateway](/consul/docs/connect/gateways/mesh-gateway#connect-proxy-configuration),
[service mesh](/consul/docs/connect) proxies representing another service,
"mesh-gateway" for instances of a [mesh gateway](/consul/docs/connect/gateways/mesh-gateway#service-mesh-proxy-configuration),
"terminating-gateway" for instances of a [terminating gateway](/consul/docs/connect/gateways/terminating-gateway),
or "ingress-gateway" for instances of a [ingress gateway](/consul/docs/connect/gateways/ingress-gateway).

- `Proxy` `(Proxy: nil)` - From 1.2.3 on, specifies the configuration for a
Connect service proxy instance. This is only valid if `Kind` defines a proxy or gateway.
service mesh proxy instance. This is only valid if `Kind` defines a proxy or gateway.
See the [Proxy documentation](/consul/docs/connect/registration/service-registration)
for full details.

- `Connect` `(Connect: nil)` - Specifies the
[configuration for Connect](/consul/docs/connect/configuration). See the
[configuration for service mesh](/consul/docs/connect/configuration). The connect subsystem provides Consul's service mesh capabilities. Refer to the
[Connect Structure](#connect-structure) section below for supported fields.

- `Check` `(Check: nil)` - Specifies a check. Please see the
Expand Down Expand Up @@ -689,12 +689,12 @@ The `/agent/service/register` endpoint supports camel case and _snake case_ for
For the `Connect` field, the parameters are:

- `Native` `(bool: false)` - Specifies whether this service supports
the [Connect](/consul/docs/connect) protocol [natively](/consul/docs/connect/native).
If this is true, then Connect proxies, DNS queries, etc. will be able to
the [Consul service mesh](/consul/docs/connect) protocol [natively](/consul/docs/connect/native).
If this is true, then service mesh proxies, DNS queries, etc. will be able to
service discover this service.
- `Proxy` `(Proxy: nil)` -
[**Deprecated**](/consul/docs/connect/proxies/managed-deprecated) Specifies that
a managed Connect proxy should be started for this service instance, and
a managed service mesh proxy should be started for this service instance, and
optionally provides configuration for the proxy. The format is as documented
in [Managed Proxy Deprecation](/consul/docs/connect/proxies/managed-deprecated).
- `SidecarService` `(ServiceDefinition: nil)` - Specifies an optional nested
Expand Down
12 changes: 6 additions & 6 deletions website/content/api-docs/catalog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -650,9 +650,9 @@ $ curl \
[service registration API](/consul/api-docs/agent/service#kind) for more information.

- `ServiceProxy` is the proxy config as specified in
[Connect Proxies](/consul/docs/connect/proxies).
[service mesh Proxies](/consul/docs/connect/proxies).

- `ServiceConnect` are the [Connect](/consul/docs/connect) settings. The
- `ServiceConnect` are the [service mesh](/consul/docs/connect) settings. The
value of this struct is equivalent to the `Connect` field for service
registration.

Expand Down Expand Up @@ -704,13 +704,13 @@ following selectors and filter operations being supported:
| `TaggedAddresses.<any>` | Equal, Not Equal, In, Not In, Matches, Not Matches |
| `TaggedAddresses` | Is Empty, Is Not Empty, In, Not In |

## List Nodes for Connect-capable Service
## List Nodes for Mesh-capable Service

This endpoint returns the nodes providing a
[Connect-capable](/consul/docs/connect) service in a given datacenter.
[mesh-capable](/consul/docs/connect) service in a given datacenter.
This will include both proxies and native integrations. A service may
register both Connect-capable and incapable services at the same time,
so this endpoint may be used to filter only the Connect-capable endpoints.
register both mesh-capable and incapable services at the same time,
so this endpoint may be used to filter only the mesh-capable endpoints.

@include 'http_api_results_filtered_by_acls.mdx'

Expand Down
6 changes: 3 additions & 3 deletions website/content/api-docs/connect/ca.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# Certificate Authority (CA) - Connect HTTP API

The `/connect/ca` endpoints provide tools for interacting with Connect's
The `/connect/ca` endpoints provide tools for interacting with the service mesh's
Certificate Authority mechanism.

## List CA Root Certificates
Expand All @@ -33,7 +33,7 @@ The table below shows this endpoint's support for
### Query Parameters

- `pem` `(boolean: false)` - Specifies that the return body should be a PEM encoded
certificate chain suitable for use by applications needing to trust Connect CA
certificate chain suitable for use by applications needing to trust service mesh CA
signed certificates. The Content-Type will be set to `application/pem-certificate-chain`
to indicate the format of the response.

Expand Down Expand Up @@ -181,7 +181,7 @@ The corresponding CLI command is [`consul connect ca set-config`](/consul/comman
- `Provider` `(string: <required>)` - Specifies the CA provider type to use.

- `Config` `(map[string]string: <required>)` - The raw configuration to use
for the chosen provider. For more information on configuring the Connect CA
for the chosen provider. For more information on configuring the service mesh CA
providers, see [Provider Config](/consul/docs/connect/ca).

- `ForceWithoutCrossSigning` `(bool: false)` - Indicates that the CA change
Expand Down
13 changes: 9 additions & 4 deletions website/content/api-docs/connect/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,25 @@
layout: api
page_title: Connect - HTTP API
description: >-
The `/connect` endpoints provide access to Connect-related operations for
The `/connect` endpoints provide access to service mesh-related operations for
intentions and the certificate authority.
---

# Connect HTTP Endpoint

The `/connect` endpoints provide access to
[Connect-related](/consul/docs/connect) operations for
[service mesh-related](/consul/docs/connect) operations for
intentions and the certificate authority.

There are also Connect-related endpoints in the
There are also service mesh-related endpoints in the
[Agent](/consul/api-docs/agent) and [Catalog](/consul/api-docs/catalog) APIs. For example,
the API for requesting a TLS certificate for a service is part of the agent
APIs. And the catalog API has an endpoint for finding all Connect-capable
APIs. And the catalog API has an endpoint for finding all mesh-capable
services in the catalog.

The noun _connect_ is used throughout this documentation to refer to the connect
subsystem that provides Consul's service mesh capabilities.
Where you encounter the _noun_ connect, it is usually functionality specific to
service mesh.

Please choose a sub-section in the navigation for more information.
2 changes: 1 addition & 1 deletion website/content/api-docs/connect/intentions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ $ curl \

## Methods to Specify Namespace <EnterpriseAlert inline />

Connect intention endpoints
Intention endpoints
support several methods for specifying the namespace of intention resources
with the following order of precedence:
1. `ns` query parameter
Expand Down
4 changes: 2 additions & 2 deletions website/content/api-docs/discovery-chain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ description: The /discovery-chain endpoints are for interacting with the discove
-> **1.6.0+:** The discovery chain API is available in Consul versions 1.6.0 and newer.

~> This is a low-level API primarily targeted at developers building external
[Connect proxy integrations](/consul/docs/connect/proxies/integrate). Future
[service mesh proxy integrations](/consul/docs/connect/proxies/integrate). Future
high-level proxy integration APIs may obviate the need for this API over time.

The `/discovery-chain` endpoint returns the compiled [discovery
chain](/consul/docs/connect/l7-traffic/discovery-chain) for a service.

This will fetch all related [configuration
entries](/consul/docs/agent/config-entries) and render them into a form suitable
for use by a [connect proxy](/consul/docs/connect/proxies) implementation. This
for use by a [service mesh proxy](/consul/docs/connect/proxies) implementation. This
is a key component of [L7 Traffic
Management](/consul/docs/connect/l7-traffic).

Expand Down
8 changes: 4 additions & 4 deletions website/content/api-docs/health.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -410,13 +410,13 @@ following selectors and filter operations being supported:
| `Service.Weights.Passing` | Equal, Not Equal |
| `Service.Weights.Warning` | Equal, Not Equal |

## List Service Instances for Connect-enabled Service
## List Service Instances for Mesh-enabled Service

This endpoint returns the service instances providing a
[Connect-capable](/consul/docs/connect) service in a given datacenter.
[mesh-capable](/consul/docs/connect) service in a given datacenter.
This will include both proxies and native integrations. A service may
register both Connect-capable and incapable services at the same time,
so this endpoint may be used to filter only the Connect-capable endpoints.
register both mesh-capable and incapable services at the same time,
so this endpoint may be used to filter only the mesh-capable endpoints.

@include 'http_api_results_filtered_by_acls.mdx'

Expand Down
10 changes: 5 additions & 5 deletions website/content/api-docs/operator/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ layout: api
page_title: Usage - Operator - HTTP API
description: |-
The /operator/usage endpoint returns usage information about the number of
services, service instances and Connect-enabled service instances by
services, service instances and mesh-enabled service instances by
datacenter.
---

# Usage Operator HTTP API

The `/operator/usage` endpoint returns usage information about the number of
services, service instances and Connect-enabled service instances by datacenter.
services, service instances and mesh-enabled service instances by datacenter.

| Method | Path | Produces |
| ------ | ----------------- | ------------------ |
Expand Down Expand Up @@ -142,12 +142,12 @@ $ curl \
- `ServiceInstances` is the total number of service instances registered in
the datacenter.

- `ConnectServiceInstances` is the total number of Connect service instances
- `ConnectServiceInstances` is the total number of mesh service instances
registered in the datacenter.

- `BillableServiceInstances` is the total number of billable service instances
registered in the datacenter. This is only relevant in Consul Enterprise
and is the total service instance count, not including any Connect service
and is the total service instance count, not including any mesh service
instances or any Consul server instances.

- `PartitionNamespaceServices` <EnterpriseAlert inline /> is the total number
Expand All @@ -163,5 +163,5 @@ $ curl \
by partition and namespace.

- `PartitionNamespaceConnectServiceInstances` <EnterpriseAlert inline /> is
the total number of Connect service instances registered in the datacenter,
the total number of mesh service instances registered in the datacenter,
by partition and namespace.
10 changes: 5 additions & 5 deletions website/content/api-docs/query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -251,12 +251,12 @@ The table below shows this endpoint's support for
key/value pairs that will be used for filtering the query results to services
with the given metadata values present.

* `Connect` `(bool: false)` - If true, only [Connect-capable](/consul/docs/connect) services
* `Connect` `(bool: false)` - If true, only [mesh-capable](/consul/docs/connect) services
for the specified service name will be returned. This includes both
natively integrated services and proxies. For proxies, the proxy name
may not match `Service`, because the proxy destination will. Any
constrains beyond the service name such as `Near`, `Tags`, and `NodeMeta`
are applied to Connect-capable service.
constraints beyond the service name such as `Near`, `Tags`, and `NodeMeta`
are applied to mesh-capable service.

* `DNS` `(DNS: nil)` - Specifies DNS configuration

Expand Down Expand Up @@ -535,8 +535,8 @@ be used.
This is applied after any sorting or shuffling.

- `connect` `(bool: false)` - If true, limit results to nodes that are
Connect-capable only. This parameter can also be specified directly on the template
itself to force all executions of a query to be Connect-only. See the
mesh-capable only. This parameter can also be specified directly on the template
itself to force all executions of a query to be mesh-only. See the
template documentation for more information.

### Sample Request
Expand Down
29 changes: 10 additions & 19 deletions website/content/commands/config/write.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,9 @@ supported config entries.

#### Service defaults

Service defaults control default global values for a service, such as the
protocol and Connect fields.
Service defaults control default global values for a service in the service mesh.
For example, the following configuration defines that all instances of the `web`
service use the `http` protocol.

```json
{
Expand All @@ -90,33 +91,23 @@ protocol and Connect fields.
}
```

- `Name` - Sets the name of the config entry. For service defaults, this must be
the name of the service being configured.

- `Protocol` - Sets the protocol of the service. This is used by Connect proxies
for things like observability features.

- `Connect` - This block contains Connect-related fields for the service.

- `SidecarProxy` - Sets whether or not instances of this service should get a
sidecar proxy by default.
For more information, refer to the [service defaults configuration reference](/consul/docs/connect/config-entries/service-defaults).

#### Proxy defaults

Proxy defaults allow for configuring global config defaults across all services
for Connect proxy config. Currently, only one global entry is supported.
Proxy defaults lets you configure global config defaults across all proxies
in the service mesh. Currently, it supports only one global entry.
For example, the following configuration overrides a default timeout for all
Envoy proxies.

```json
{
"Kind": "proxy-defaults",
"Name": "global",
"Config": {
"foo": 1
"local_idle_timeout_ms": 20000
}
}
```

- `Name` - Sets the name of the config entry. Currently, only a single `proxy-defaults`
entry with the name `global` is supported.

* `Config` - An arbitrary map of configuration values used by Connect proxies.
For more information, refer to the [proxy defaults configuration reference](/consul/docs/connect/config-entries/proxy-defaults).
13 changes: 7 additions & 6 deletions website/content/commands/connect/ca.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ description: >

Command: `consul connect ca`

The CA connect command is used to interact with Consul Connect's Certificate Authority
subsystem. The command can be used to view or modify the current CA configuration. See the
[Connect CA documentation](/consul/docs/connect/ca) for more information.
This command is used to interact with Consul service mesh's Certificate Authority
managed by the connect subsystem.
It can be used to view or modify the current CA configuration. Refer to the
[service mesh CA documentation](/consul/docs/connect/ca) for more information.

```text
Usage: consul connect ca <subcommand> [options] [args]
This command has subcommands for interacting with Consul Connect's
This command has subcommands for interacting with Consul service mesh's
Certificate Authority (CA).
Here are some simple examples, and more detailed examples are available
Expand All @@ -34,8 +35,8 @@ Usage: consul connect ca <subcommand> [options] [args]
For more examples, ask for subcommand help or view the documentation.
Subcommands:
get-config Display the current Connect Certificate Authority (CA) configuration
set-config Modify the current Connect CA configuration
get-config Display the current service mesh Certificate Authority (CA) configuration
set-config Modify the current service mesh CA configuration
```

## get-config
Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/connect/envoy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Command: `consul connect envoy`

The connect Envoy command is used to generate a bootstrap configuration for
[Envoy proxy](https://envoyproxy.io) for use with [Consul
Connect](/consul/docs/connect/).
service mesh](/consul/docs/connect/).

Refer to the [examples](#examples) for guidance on common use cases,
such as [launching a service instance's sidecar proxy
Expand Down
Loading

0 comments on commit b99de08

Please sign in to comment.