Skip to content

Commit

Permalink
updated links to old SM proxy reg page
Browse files Browse the repository at this point in the history
  • Loading branch information
trujillo-adam committed Aug 31, 2023
1 parent 67b9a80 commit ec04985
Show file tree
Hide file tree
Showing 20 changed files with 66 additions and 78 deletions.
2 changes: 1 addition & 1 deletion website/content/api-docs/agent/service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ The `/agent/service/register` endpoint supports camel case and _snake case_ for

- `Proxy` `(Proxy: nil)` - From 1.2.3 on, specifies the configuration for a
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)
Refer to the [Servicw mesh proxy configuration reference](/consul/docs/connect/proxies/proxy-config-reference)
for full details.

- `Connect` `(Connect: nil)` - Specifies the
Expand Down
31 changes: 10 additions & 21 deletions website/content/api-docs/discovery-chain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,8 @@ The table below shows this endpoint's support for
- `compile-dc` `(string: "")` - Specifies the datacenter to use as the basis of
compilation. This will default to the datacenter of the agent being queried.

This value comes from an [upstream
configuration](/consul/docs/connect/registration/service-registration#upstream-configuration-reference)
[`datacenter`](/consul/docs/connect/registration/service-registration#datacenter)
parameter.
This value comes from the `datacenter` parameter in an [upstream
configuration](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference).

- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the source namespace you use as the basis of compilation.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
Expand All @@ -71,11 +69,8 @@ The table below shows this endpoint's support for
timeout](/consul/docs/connect/config-entries/service-resolver#connecttimeout) for
any service resolved in the compiled chain.

This value comes from the `connect_timeout_ms` key in an [upstream
configuration](/consul/docs/connect/registration/service-registration#upstream-configuration-reference)
opaque
[`config`](/consul/docs/connect/registration/service-registration#config-1)
parameter.
This value comes from the `connect_timeout_ms` key in the opaque `config` field of the [upstream
configuration](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference).

- `OverrideProtocol` `(string: "")` - Overrides the final
[protocol](/consul/docs/connect/config-entries/service-defaults#protocol) used in
Expand All @@ -86,23 +81,17 @@ The table below shows this endpoint's support for
would be L7 and TCP is passed here the chain will not include Routers or
Splitters.

This value comes from the `protocol` key in an [upstream
configuration](/consul/docs/connect/registration/service-registration#upstream-configuration-reference)
opaque
[`config`](/consul/docs/connect/registration/service-registration#config-1)
parameter.
This value comes from the `protocol` key in an opaque `config` field of the [upstream
configuration](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference).

- `OverrideMeshGateway` `(MeshGatewayConfig: <optional>)` - Overrides the final
[mesh gateway configuration](/consul/docs/connect/gateways/mesh-gateway#connect-proxy-configuration)
for this any service resolved in the compiled chain.

This value comes from either the [proxy
configuration](/consul/docs/connect/registration/service-registration#complete-configuration-example)
[`mesh_gateway`](/consul/docs/connect/registration/service-registration#mesh_gateway)
parameter or an [upstream
configuration](/consul/docs/connect/registration/service-registration#upstream-configuration-reference)
[`mesh_gateway`](/consul/docs/connect/registration/service-registration#mesh_gateway-1)
parameter. If both are present the value defined on the upstream is used.
This value comes from the `mesh_gateway` parameter in either the [proxy
configuration](/consul/docs/connect/proxies/proxy-config-reference#proxy-parameters) or [upstream
configuration](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference)
If both parameters are configured, Consul uses the value defined on the upstream.

- `Mode` `(string: "")` - One of `none`, `local`, or `remote`.

Expand Down
8 changes: 4 additions & 4 deletions website/content/commands/connect/envoy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Usage: `consul connect envoy [options] [-- pass-through options]`

#### Envoy Options for both Sidecars and Gateways

- `-proxy-id` - The [proxy service](/consul/docs/connect/registration/service-registration) ID.
- `-proxy-id` - The [proxy service](/consul/docs/connect/proxies/proxy-config-reference) ID.
This service ID must already be registered with the local agent unless a gateway is being
registered with the `-register` flag. As of Consul 1.8.0, this can also be
specified via the `CONNECT_PROXY_ID` environment variable.
Expand Down Expand Up @@ -133,7 +133,7 @@ compatibility with Envoy and prevent potential issues. Default is `false`.
- `-sidecar-for` - The _ID_ (not name if they differ) of the service instance
this proxy will represent. The target service doesn't need to exist on the
local agent yet but a [sidecar proxy
registration](/consul/docs/connect/registration/service-registration) with
registration](/consul/docs/proxies/deploy-sidecar-services) with
`proxy.destination_service_id` equal to the passed value must be present. If
multiple proxy registrations targeting the same local service instance are
present the command will error and `-proxy-id` should be used instead.
Expand Down Expand Up @@ -225,9 +225,9 @@ proxy configuration needed.

## Examples

Assume a local service instance is registered on the local agent with a
In the following examples, a local service instance is registered on the local agent with a
sidecar proxy (using the [sidecar service
registration](/consul/docs/connect/registration/service-registration) helper) as below.
registration](/consul/docs/connect/proxies/deploy-sidecar-services) helper):

```hcl
service {
Expand Down
4 changes: 2 additions & 2 deletions website/content/commands/connect/proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ Usage: `consul connect proxy [options]`
- `-sidecar-for` - The _ID_ (not name if they differ) of the service instance
this proxy will represent. The target service doesn't need to exist on the
local agent yet but a [sidecar proxy
registration](/consul/docs/connect/registration/service-registration) with
registration](/consul/docs/connect/proxies/deploy-sidecar-services) with
`proxy.destination_service_id` equal to the passed value must be present. If
multiple proxy registrations targeting the same local service instance are
present the command will error and `-proxy-id` should be used instead.
This can also be specified via the `CONNECT_SIDECAR_FOR` environment variable.

- `-proxy-id` - The [proxy
service](/consul/docs/connect/registration/service-registration) ID on the
service](/consul/docs/connect/proxies/proxy-config-reference) ID on the
local agent. This must already be present on the local agent. This option
can also be specified via the `CONNECT_PROXY_ID` environment variable.

Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/connect/redirect-traffic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Usage: `consul connect redirect-traffic [options]`

- `-consul-dns-port` - The port of the Consul DNS resolver. If provided, DNS queries will be redirected to the provided IP address for name resolution.

- `-proxy-id` - The [proxy service](/consul/docs/connect/registration/service-registration) ID.
- `-proxy-id` - The [proxy service](/consul/docs/connect/proxies/proxy-config-reference) ID.
This service ID must already be registered with the local agent.

- `-proxy-inbound-port` - The inbound port that the proxy is listening on.
Expand Down
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 @@ -642,10 +642,10 @@ Refer to the [formatting specification](https://golang.org/pkg/time/#ParseDurati
to use for automatically assigned [sidecar service registrations](/consul/docs/connect/registration/sidecar-service).
Default 21255. Set to `0` to disable automatic port assignment.
- `expose_min_port` ((#expose_min_port)) - Inclusive minimum port number
to use for automatically assigned [exposed check listeners](/consul/docs/connect/registration/service-registration#expose-paths-configuration-reference).
to use for automatically assigned [exposed check listeners](/consul/docs/connect/proxies/proxy-config-reference#expose-paths-configuration-reference).
Default 21500. Set to `0` to disable automatic port assignment.
- `expose_max_port` ((#expose_max_port)) - Inclusive maximum port number
to use for automatically assigned [exposed check listeners](/consul/docs/connect/registration/service-registration#expose-paths-configuration-reference).
to use for automatically assigned [exposed check listeners](/consul/docs/connect/proxies/proxy-config-reference#expose-paths-configuration-reference).
Default 21755. Set to `0` to disable automatic port assignment.

- `primary_datacenter` - This designates the datacenter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Refer to [mesh gateway modes](/consul/docs/connect/gateways/mesh-gateway#modes)

The Envoy proxies that function as sidecars in your service mesh require configuration in order to properly route traffic to peers. Sidecar proxies are defined in the [service definition](/consul/docs/services/usage/define-services).

- Configure the `proxy.upstreams` parameters to route traffic to the correct service, namespace, and peer. Refer to the [`upstreams`](/consul/docs/connect/registration/service-registration#upstream-configuration-reference) documentation for details.
- Configure the `proxy.upstreams` parameters to route traffic to the correct service, namespace, and peer. Refer to the [`upstreams`](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference) documentation for details.
- The `proxy.upstreams.destination_name` parameter is always required.
- The `proxy.upstreams.destination_peer` parameter must be configured to enable cross-cluster traffic.
- The `proxy.upstream/destination_namespace` configuration is only necessary if the destination service is in a non-default namespace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -778,7 +778,7 @@ Specifies the TLS server name indication (SNI) when federating with an external

### `Expose`

Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/connect/registration/service-registration#expose-paths-configuration-reference) for additional information and example configurations.
Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/proxies/proxy-config-reference#expose-paths-configuration-reference) for additional information and example configurations.

- Default: none
- Data type: map
Expand Down Expand Up @@ -1198,7 +1198,7 @@ Specifies the TLS server name indication (SNI) when federating with an external

### `spec.expose`

Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/connect/registration/service-registration#expose-paths-configuration-reference) for additional information and example configurations.
Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/connect/proxies/proxy-config-reference#expose-paths-configuration-reference) for additional information and example configurations.

#### Values

Expand Down Expand Up @@ -2053,7 +2053,7 @@ represents a location outside the Consul cluster. Services can dial destinations
name: 'Expose',
type: 'ExposeConfig: <optional>',
description: `Controls the default
[expose path configuration](/consul/docs/connect/registration/service-registration#expose-paths-configuration-reference)
[expose path configuration](/consul/docs/connect/proxies/proxy-config-reference#expose-paths-configuration-reference)
for Envoy. Added in v1.6.2.<br><br>
Exposing paths through Envoy enables a service to protect itself by only listening on localhost, while still allowing
non-mesh-enabled applications to contact an HTTP endpoint.
Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/connect/connect-internals.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ a long period of inactivity (3 days by default), the cache will empty itself.

## Connections Across Datacenters

A sidecar proxy's [upstream configuration](/consul/docs/connect/registration/service-registration#upstream-configuration-reference)
A sidecar proxy's [upstream configuration](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference)
may specify an alternative datacenter or a prepared query that can address services
in multiple datacenters (such as the [geo failover](/consul/tutorials/developer-discovery/automate-geo-failover) pattern).

Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/connect/distributed-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,9 @@ spec:

</CodeTabs>

-> **NOTE:** This example uses a [proxy defaults](/consul/docs/connect/config-entries/proxy-defaults) config entry which will apply to all proxies
but you can also apply this config in the
[proxy service registration](/consul/docs/connect/registration/service-registration#proxy-parameters) (not supported on Kubernetes).
-> **NOTE:** This example uses a [proxy defaults](/consul/docs/connect/config-entries/proxy-defaults) configuration entry, which applies to all proxies,
but you can also apply the configuration in the
[`proxy` block of your service configuration](/consul/docs/connect/proxies/proxy-config-reference#proxy-parameters). The proxy service registration is not supported on Kubernetes.

Within the config there are two keys you need to customize:

Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/connect/gateways/mesh-gateway/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Sidecar proxies that do not send upstream traffic through a gateway are not affe
Configure the following settings to register the mesh gateway as a service in Consul.

* Specify `mesh-gateway` in the `kind` field to register the gateway with Consul.
* Configure the `proxy.upstreams` parameters to route traffic to the correct service, namespace, and datacenter. Refer to the [`upstreams` documentation](/consul/docs/connect/registration/service-registration#upstream-configuration-reference) for details. The service `proxy.upstreams.destination_name` is always required. The `proxy.upstreams.datacenter` must be configured to enable cross-datacenter traffic. The `proxy.upstreams.destination_namespace` configuration is only necessary if the destination service is in a different namespace.
* Configure the `proxy.upstreams` parameters to route traffic to the correct service, namespace, and datacenter. Refer to the [`upstreams` documentation](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference) for details. The service `proxy.upstreams.destination_name` is always required. The `proxy.upstreams.datacenter` must be configured to enable cross-datacenter traffic. The `proxy.upstreams.destination_namespace` configuration is only necessary if the destination service is in a different namespace.
* Define the `Proxy.Config` settings using opaque parameters compatible with your proxy (i.e., Envoy). For Envoy, refer to the [Gateway Options](/consul/docs/connect/proxies/envoy#gateway-options) and [Escape-hatch Overrides](/consul/docs/connect/proxies/envoy#escape-hatch-overrides) documentation for additional configuration information.
* If ACLs are enabled, a token granting `service:write` for the gateway's service name and `service:read` for all services in the datacenter or partition must be added to the gateway's service definition. These permissions authorize the token to route communications for other Consul service mesh services, but does not allow decrypting any of their communications.

Expand Down Expand Up @@ -127,8 +127,8 @@ Name: web

### Enabling Gateways for a Service Instance

The following [Proxy Service Registration](/consul/docs/connect/registration/service-registration)
definition will enable gateways for the service instance in the `remote` mode.
The following [proxy service configuration](/consul/docs/connect/proxies/deploy-service-mesh-proxies)
enables gateways for the service instance in the `remote` mode.

<CodeTabs heading="Example: Enabling gateways for a service instance.">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Sidecar proxies that do not send upstream traffic through a gateway are not affe
Configure the following settings to register the mesh gateway as a service in Consul.

* Specify `mesh-gateway` in the `kind` field to register the gateway with Consul.
* Configure the `proxy.upstreams` parameters to route traffic to the correct service, namespace, and partition. Refer to the [`upstreams` documentation](/consul/docs/connect/registration/service-registration#upstream-configuration-reference) for details. The service `proxy.upstreams.destination_name` is always required. The `proxy.upstreams.destination_partition` must be configured to enable cross-partition traffic. The `proxy.upstreams.destination_namespace` configuration is only necessary if the destination service is in a different namespace.
* Configure the `proxy.upstreams` parameters to route traffic to the correct service, namespace, and partition. Refer to the [`upstreams` documentation](/consul/docs/connect/proxies/proxy-config-reference#upstream-configuration-reference) for details. The service `proxy.upstreams.destination_name` is always required. The `proxy.upstreams.destination_partition` must be configured to enable cross-partition traffic. The `proxy.upstreams.destination_namespace` configuration is only necessary if the destination service is in a different namespace.
* Configure the `exported-services` configuration entry to enable Consul to export services contained in an admin partition to one or more additional partitions. Refer to the [Exported Services documentation](/consul/docs/connect/config-entries/exported-services) for details.
* Define the `Proxy.Config` settings using opaque parameters compatible with your proxy, i.e., Envoy. For Envoy, refer to the [Gateway Options](/consul/docs/connect/proxies/envoy#gateway-options) and [Escape-hatch Overrides](/consul/docs/connect/proxies/envoy#escape-hatch-overrides) documentation for additional configuration information.
* If ACLs are enabled, a token granting `service:write` for the gateway's service name and `service:read` for all services in the datacenter or partition must be added to the gateway's service definition. These permissions authorize the token to route communications for other Consul service mesh services, but does not allow decrypting any of their communications.
Expand Down Expand Up @@ -121,8 +121,8 @@ Name: web

### Enabling Gateways for a Service Instance

The following [Proxy Service Registration](/consul/docs/connect/registration/service-registration)
definition will enable gateways for `web` service instances in the `finance` partition.
The following [proxy service configuration](/consul/docs/connect/proxies/deploy-service-mesh-proxies)
enables gateways for `web` service instances in the `finance` partition.

<CodeTabs heading="Example: Enabling gateways for a service instance.">

Expand Down
Loading

0 comments on commit ec04985

Please sign in to comment.