website: add docs for connect native services API

pull/4275/head
Mitchell Hashimoto 7 years ago committed by Jack Pearkes
parent df2cb30b01
commit 1df5d91b39

@ -117,6 +117,10 @@ The table below shows this endpoint's support for
service doesn't need to be registered, but the caller must have an ACL token
with permissions for this service.
- `Connect` `(Connect: nil)` - Specifies the configuration for
[Connect](/docs/connect/index.html). See the [Connect structure](#connect-structure)
section for supported fields.
- `Check` `(Check: nil)` - Specifies a check. Please see the
[check documentation](/api/agent/check.html) for more information about the
accepted fields. If you don't provide a name or id for the check then they
@ -154,6 +158,15 @@ The table below shows this endpoint's support for
`false`. See [anti-entropy syncs](/docs/internals/anti-entropy.html) for
more info.
#### Connect Structure
For the `Connect` field, the parameters are:
- `Native` `(bool: false)` - Specifies whether this service supports
the [Connect](/docs/connect/index.html) protocol [natively](/docs/connect/native.html).
If this is true, then Connect proxies, DNS queries, etc. will be able to
service discover this service.
### Sample Payload
```json

@ -54,7 +54,7 @@ The table below shows this endpoint's support for
- `Service` `(Service: nil)` - Specifies to register a service. If `ID` is not
provided, it will be defaulted to the value of the `Service.Service` property.
Only one service with a given `ID` may be present per node. The service
`Tags`, `Address`, `ServiceMeta` and `Port` fields are all optional.
`Tags`, `Address`, `ServiceMeta`, `Port`, `ConnectNative` fields are all optional.
- `Check` `(Check: nil)` - Specifies to register a check. The register API
manipulates the health check entry in the Catalog, but it does not setup the
@ -485,6 +485,9 @@ $ curl \
- `ServiceProxyDestination` is the name of the service that is being proxied,
for "connect-proxy" type services.
- `ServiceConnectNative` is true if this service supports Connect
[natively](/docs/connect/native.html).
## List Nodes for Connect-capable Service
This endpoint returns the nodes providing a

Loading…
Cancel
Save