Clean up copy for registration

This commit is contained in:
Thomas Eckert 2022-08-25 13:27:43 -04:00
parent ae72893587
commit 3417574017
1 changed files with 13 additions and 8 deletions

View File

@ -94,14 +94,15 @@ Registering the external services with Consul is a multi-step process:
### Register external services with Consul ### Register external services with Consul
There are two ways to register an external service with Consul: You may register an external service with Consul using `ServiceDefaults` if
1. If [`TransparentProxy`](/docs/connect/transparent-proxy) is enabled, the preferred method is to declare external endpoints in the [`destination`](/docs/connect/config-entries/service-defaults#terminating-gateway-destination) field of `ServiceDefaults`. [`TransparentProxy`](/docs/connect/transparent-proxy) is enabled. Otherwise,
1. You can add the service as a node in the Consul catalog. you may register the service as a node in the Consul catalog.
#### Register an external service as a destination <Tabs>
<Tab heading="Using ServiceDefaults and TransparentProxy">
The [`destination`](/docs/connect/config-entries/service-defaults#terminating-gateway-destination) field of the `ServiceDefaults` Custom Resource Definition (CRD) allows clients to dial the external service directly. It is valid only in [`TransparentProxy`](/docs/connect/transparent-proxy)) mode. The [`destination`](/docs/connect/config-entries/service-defaults#terminating-gateway-destination) field of the `ServiceDefaults` Custom Resource Definition (CRD) allows clients to dial an external service directly. For this method to work, [`TransparentProxy`](/docs/connect/transparent-proxy) must be enabled.
The following table describes traffic behaviors when using `destination`s to route traffic through a terminating gateway: The following table describes traffic behaviors when using the `destination` field to route traffic through a terminating gateway:
| External Services Layer | Client dials | Client uses TLS | Allowed | Notes | | External Services Layer | Client dials | Client uses TLS | Allowed | Notes |
|---|---|---|---|---| |---|---|---|---|---|
@ -145,8 +146,8 @@ $ kubectl apply --filename serviceDefaults.yaml
``` ```
All other terminating gateway operations can use the name of the `ServiceDefaults` in place of a typical Consul service name. All other terminating gateway operations can use the name of the `ServiceDefaults` in place of a typical Consul service name.
</Tab>
#### Register an external service as a Catalog Node <Tab heading="Using Consul catalog">
-> **Note:** Normal Consul services are registered with the Consul client on the node that -> **Note:** Normal Consul services are registered with the Consul client on the node that
they're running on. Since this is an external service, there is no Consul node they're running on. Since this is an external service, there is no Consul node
@ -197,6 +198,10 @@ If ACLs and TLS are enabled :
$ curl --request PUT --header "X-Consul-Token: $CONSUL_HTTP_TOKEN" --data @external.json --insecure $CONSUL_HTTP_ADDR/v1/catalog/register $ curl --request PUT --header "X-Consul-Token: $CONSUL_HTTP_TOKEN" --data @external.json --insecure $CONSUL_HTTP_ADDR/v1/catalog/register
true true
``` ```
</Tab>
</Tabs>
### Update terminating gateway ACL role if ACLs are enabled ### Update terminating gateway ACL role if ACLs are enabled