mirror of https://github.com/hashicorp/consul
Add docs
freddygv
parent
19e3954603
commit
b2c66359ab
|
|
@ -901,3 +901,144 @@ top level object. The following selectors and filter operations are supported:
|
|||
| `Tags` | In, Not In, Is Empty, Is Not Empty |
|
||||
| `Weights.Passing` | Equal, Not Equal |
|
||||
| `Weights.Warning` | Equal, Not Equal |
|
||||
|
||||
## List Services for Gateway
|
||||
|
||||
This endpoint returns the services associated with an ingress gateway or terminating gateway.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| ------ | ------------------------------ | ------------------ |
|
||||
| `GET` | `/catalog/gateway-services/:gateway` | `application/json` |
|
||||
|
||||
The table below shows this endpoint's support for
|
||||
[blocking queries](/api/features/blocking),
|
||||
[consistency modes](/api/features/consistency),
|
||||
[agent caching](/api/features/caching), and
|
||||
[required ACLs](/api#authentication).
|
||||
|
||||
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
|
||||
| ---------------- | ----------------- | ------------- | ------------------------ |
|
||||
| `YES` | `all` | `none` | `service:read` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `gateway` `(string: <required>)` - Specifies the name of the node for which
|
||||
to list services. This is specified as part of the URL.
|
||||
|
||||
- `dc` `(string: "")` - Specifies the datacenter to query. This will default to
|
||||
the datacenter of the agent being queried. This is specified as part of the
|
||||
URL as a query parameter.
|
||||
|
||||
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the gateway.
|
||||
This value may be provided by either the `ns` URL query parameter or in the
|
||||
`X-Consul-Namespace` header. If not provided at all, the namespace will be inherited
|
||||
from the request's ACL token or will default to the `default` namespace. The `*`
|
||||
wildcard may be used and then services from all namespaces will be returned. Added in Consul 1.7.0.
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
http://127.0.0.1:8500/v1/catalog/gateway-services/my-terminating-gateway
|
||||
```
|
||||
|
||||
### Sample Responses
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"Gateway": {
|
||||
"Name": "my-terminating-gateway",
|
||||
"Namespace": "default"
|
||||
},
|
||||
"Service": {
|
||||
"Name": "api",
|
||||
"Namespace": "frontend"
|
||||
},
|
||||
"GatewayKind": "terminating-gateway",
|
||||
"CAFile": "/etc/certs/ca.pem",
|
||||
"CertFile": "/etc/certs/api/client.pem",
|
||||
"KeyFile": "/etc/certs/api/client.key",
|
||||
"SNI": "api.my-domain",
|
||||
"CreateIndex": 16,
|
||||
"ModifyIndex": 16
|
||||
},
|
||||
{
|
||||
"Gateway": {
|
||||
"Name": "my-terminating-gateway",
|
||||
"Namespace": "default"
|
||||
},
|
||||
"Service": {
|
||||
"Name": "web",
|
||||
"Namespace": "frontend"
|
||||
},
|
||||
"GatewayKind": "terminating-gateway",
|
||||
"CreateIndex": 17,
|
||||
"ModifyIndex": 17
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"Gateway": {
|
||||
"Name": "my-ingress-gateway",
|
||||
"Namespace": "default"
|
||||
},
|
||||
"Service": {
|
||||
"Name": "api",
|
||||
"Namespace": "frontend"
|
||||
},
|
||||
"GatewayKind": "ingress-gateway",
|
||||
"Port": 8888,
|
||||
"Protocol": "http",
|
||||
"Hosts": ["api.mydomain.com"],
|
||||
"CreateIndex": 15,
|
||||
"ModifyIndex": 15
|
||||
},
|
||||
{
|
||||
"Gateway": {
|
||||
"Name": "my-ingress-gateway",
|
||||
"Namespace": "default"
|
||||
},
|
||||
"Service": {
|
||||
"Name": "redis",
|
||||
"Namespace": "ops"
|
||||
},
|
||||
"GatewayKind": "ingress-gateway",
|
||||
"Port": 8443,
|
||||
"Protocol": "tcp",
|
||||
"CreateIndex": 16,
|
||||
"ModifyIndex": 16
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
- `Gateway.Name` is the name of the gateway service of the request
|
||||
|
||||
- `Gateway.Namespace` is the Consul Enterprise namespace of the gateway
|
||||
|
||||
- `Service.Name` is the name of a service associated with the gateway
|
||||
|
||||
- `Service.Namespace` is the Consul Enterprise namespace of a service associated with the gateway
|
||||
|
||||
- `ServiceKind` is the kind of service, will be one of "ingress-gateway" or "terminating-gateway". See the Agent
|
||||
[service registration API](/api/agent/service#kind) for more information.
|
||||
|
||||
- `CAFile` is the path to a CA file the gateway will use for TLS origination to the associated service
|
||||
|
||||
- `CertFile` is the path to a client certificate the gateway will use for TLS origination to the associated service
|
||||
|
||||
- `KeyFile` is the path to a key file the gateway will use for TLS origination to the associated service
|
||||
|
||||
- `SNI` is a hostname or domain name the gateway will specify during the TLS handshake with the associated service
|
||||
|
||||
- `Port` is the port the ingress gateway is listening on for the associated service
|
||||
|
||||
- `Protocol` is the protocol of the ingress gateway's listener for the associated service
|
||||
|
||||
- `Hosts` list of hosts that specify what requests will match to this associated service
|
||||
|
||||
- `FromWildcard` determines whether the service was associated with the gateway by providing a wildcard specifier
|
||||
in the gateway's configuration entry
|
||||
|
|
|
|||
|
|
@ -138,7 +138,7 @@ when retrieving metrics from the built-in store using the above described signal
|
|||
This is a full list of metrics emitted by Consul.
|
||||
|
||||
| Metric | Description | Unit | Type |
|
||||
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------- |
|
||||
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------- |
|
||||
| `consul.acl.blocked.service.registration` | This increments whenever a deregistration fails for a service (blocked by an ACL) | requests | counter |
|
||||
| `consul.acl.blocked..registration` | This increments whenever a registration fails for an entity (check, node or service) is blocked by an ACL | requests | counter |
|
||||
| `consul.client.rpc` | This increments whenever a Consul agent in client mode makes an RPC request to a Consul server. This gives a measure of how much a given agent is loading the Consul servers. Currently, this is only generated by agents in client mode, not Consul servers. | requests | counter |
|
||||
|
|
@ -163,8 +163,10 @@ This is a full list of metrics emitted by Consul.
|
|||
| `consul.client.api.success.catalog_service_nodes.` | This increments whenever a Consul agent successfully responds to a request to list nodes offering a service. | requests | counter |
|
||||
| `consul.client.rpc.error.catalog_service_nodes.` | This increments whenever a Consul agent receives an RPC error for a request to list nodes offering a service. | errors | counter |
|
||||
| `consul.client.api.catalog_node_services.` | This increments whenever a Consul agent receives a request to list services registered in a node. | requests | counter |
|
||||
| `consul.client.api.success.catalog_node_services.` | This increments whenever a Consul agent successfully responds to a request to list services in a service. | requests | counter |
|
||||
| `consul.client.rpc.error.catalog_node_services.` | This increments whenever a Consul agent receives an RPC error for a request to list services in a service. | errors | counter |
|
||||
| `consul.client.api.success.catalog_node_services.` | This increments whenever a Consul agent successfully responds to a request to list services in a node. | requests | counter |
|
||||
| `consul.client.rpc.error.catalog_node_services.` | This increments whenever a Consul agent receives an RPC error for a request to list services in a node. | errors | counter |
|
||||
| `consul.client.api.success.catalog_gateway_services.` | This increments whenever a Consul agent successfully responds to a request to list services associated with a gateway. | requests | counter |
|
||||
| `consul.client.rpc.error.catalog_gateway_services.` | This increments whenever a Consul agent receives an RPC error for a request to list services associated with a gateway. | errors | counter |
|
||||
| `consul.runtime.num_goroutines` | This tracks the number of running goroutines and is a general load pressure indicator. This may burst from time to time but should return to a steady state value. | number of goroutines | gauge |
|
||||
| `consul.runtime.alloc_bytes` | This measures the number of bytes allocated by the Consul process. This may burst from time to time but should return to a steady state value. | bytes | gauge |
|
||||
| `consul.runtime.heap_objects` | This measures the number of objects allocated on the heap and is a general memory pressure indicator. This may burst from time to time but should return to a steady state value. | number of objects | gauge |
|
||||
|
|
|
|||
Loading…
Reference in New Issue