status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Miscellaneous docs cleanup (#6742) 

Fix spelling errors, API doc inconsistencies, and formatting issues.

* Fix several spelling errors.
* Prepend / to v1/event/list path in Watches.
* Rename script handlers to match Watch type.
* Remove /v1 path prefix on service health API endpoints.

Makes request path consistent with the rest of the HTTP API
documentation which does not include the /v1 prefix.

* Fix bracket formatting issue on Telemetry page.

The HTML codes used for brackets inside of the code block are not
interpolated, and are shown as literal strings.

Replace the numeric HTML codes with the intended character value to
fix display formatting.

Also placed variable reference on agent/options.html inside code block
for consistency with the presentation of other options on the page.

* Add missing word to Coordinate.Node docstring.

Resolves #6014
This commit is contained in:
Blake Covarrubias 2019-11-05 20:34:46 -08:00 committed by GitHub
parent 734b6287b8
commit 0aa025df1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api/coordinate.go
View File

@ -84,7 +84,7 @@ func (c *Coordinate) Update(coord *CoordinateEntry, q *WriteOptions) (*WriteMeta
return wm, nil return wm, nil
} }
// Node is used to return the coordinates of a single in the LAN pool. // Node is used to return the coordinates of a single node in the LAN pool.
func (c *Coordinate) Node(node string, q *QueryOptions) ([]*CoordinateEntry, *QueryMeta, error) { func (c *Coordinate) Node(node string, q *QueryOptions) ([]*CoordinateEntry, *QueryMeta, error) {
r := c.c.newRequest("GET", "/v1/coordinate/node/"+node) r := c.c.newRequest("GET", "/v1/coordinate/node/"+node)
r.setQueryOptions(q) r.setQueryOptions(q)

2
website/source/api/acl/acl.html.md
View File

@ -159,7 +159,7 @@ $ curl \
returned by the [`/v1/acl/list`](/api/acl/legacy.html#acl_list) endpoint to returned by the [`/v1/acl/list`](/api/acl/legacy.html#acl_list) endpoint to
determine if the replication process has gotten all available ACLs. When in either determine if the replication process has gotten all available ACLs. When in either
`tokens` or `policies` mode, this index can be compared with the value of the `tokens` or `policies` mode, this index can be compared with the value of the
`X-Consul-Index` header returned by the [`/v1/acl/polcies`](/api/acl/policies.html#list-policies) `X-Consul-Index` header returned by the [`/v1/acl/policies`](/api/acl/policies.html#list-policies)
endpoint to determine if the policy replication process has gotten all available endpoint to determine if the policy replication process has gotten all available
ACL policies. Note that ACL replication is rate limited so the indexes may lag behind ACL policies. Note that ACL replication is rate limited so the indexes may lag behind
the primary datacenter. the primary datacenter.

22
website/source/api/agent/service.html.md
View File

@ -222,10 +222,10 @@ default. In order to get the text format, you can append `?format=text` to
the URL or use Mime Content negotiation by specifying a HTTP Header the URL or use Mime Content negotiation by specifying a HTTP Header
`Accept` starting with `text/plain`. `Accept` starting with `text/plain`.
| Method | Path | Produces | | Method | Path | Produces |
| ------ | --------------------------------------------------------- | ------------------ | | ------ | ------------------------------------------------------ | ------------------ |
| `GET` | `/v1/agent/health/service/name/:service_name` | `application/json` | | `GET` | `/agent/health/service/name/:service_name` | `application/json` |
| `GET` | `/v1/agent/health/service/name/:service_name?format=text` | `text/plain` | | `GET` | `/agent/health/service/name/:service_name?format=text` | `text/plain` |
The table below shows this endpoint's support for The table below shows this endpoint's support for
[blocking queries](/api/features/blocking.html), [blocking queries](/api/features/blocking.html),
@ -248,7 +248,7 @@ service instance(s) and will return the corresponding HTTP codes:
| `429` | Some healthchecks are passing, at least one is warning | | `429` | Some healthchecks are passing, at least one is warning |
| `503` | At least one of the healthchecks is critical | | `503` | At least one of the healthchecks is critical |
Those endpoints might be usefull for the following use-cases: Those endpoints might be useful for the following use-cases:
* a load-balancer wants to check IP connectivity with an agent and retrieve * a load-balancer wants to check IP connectivity with an agent and retrieve
the aggregated status of given service the aggregated status of given service
@ -447,14 +447,14 @@ curl localhost:8500/v1/agent/health/service/id/web1
## Get local service health by its ID ## Get local service health by its ID
Retrive an aggregated state of service(s) on the local agent by ID. Retrieve an aggregated state of service(s) on the local agent by ID.
See: See:
| Method | Path | Produces | | Method | Path | Produces |
| ------ | ------------------------------------------------------ | ------------------ | | ------ | -------------------------------------------------- | ------------------ |
| `GET` | `/v1/agent/health/service/id/:service_id` | `application/json` | | `GET` | `/agent/health/service/id/:service_id` | `application/json` |
| `GET` | `/v1/agent/health/service/id/:service_id?format=text` | `text/plain` | | `GET` | `/agent/health/service/id/:service_id?format=text` | `text/plain` |
Parameters and response format are the same as Parameters and response format are the same as
[`/v1/agent/health/service/name/:service_name`](/api/agent/service.html#get-local-service-health). [`/v1/agent/health/service/name/:service_name`](/api/agent/service.html#get-local-service-health).
@ -487,7 +487,7 @@ The table below shows this endpoint's support for
### Query string parameters ### Query string parameters
- `replace-existing-checks` - Missing healthchecks from the request will be deleted from the agent. Using this parameter allows to idempotently register a service and its checks whithout having to manually deregister checks. - `replace-existing-checks` - Missing healthchecks from the request will be deleted from the agent. Using this parameter allows to idempotently register a service and its checks without having to manually deregister checks.
### Parameters ### Parameters

2
website/source/api/catalog.html.md
View File

@ -83,7 +83,7 @@ The table below shows this endpoint's support for
only a health check or service entry on a node needs to be updated or when only a health check or service entry on a node needs to be updated or when
a register request is intended to update a service entry or health check. a register request is intended to update a service entry or health check.
In both use cases, node information will not be overwritten, if the node is In both use cases, node information will not be overwritten, if the node is
already registered. Note, if the paramater is enabled for a node that doesn't already registered. Note, if the parameter is enabled for a node that doesn't
exist, it will still be created. exist, it will still be created.
It is important to note that `Check` does not have to be provided with `Service` It is important to note that `Check` does not have to be provided with `Service`

2
website/source/api/features/caching.html.md
View File

@ -91,7 +91,7 @@ In all cases the HTTP `X-Cache` header is always set in the response to either
For cache hits, the HTTP `Age` header is always set in the response to indicate For cache hits, the HTTP `Age` header is always set in the response to indicate
how many seconds since that response was fetched from the servers. As long as how many seconds since that response was fetched from the servers. As long as
the local agent has an active connection to the servers, the age will always be the local agent has an active connection to the servers, the age will always be
`0` since the value is up-to-date. If the agent get's disconnected, the cached `0` since the value is up-to-date. If the agent gets disconnected, the cached
result is still returned but with an `Age` that indicates how many seconds have result is still returned but with an `Age` that indicates how many seconds have
elapsed since the local agent got disconnected from the servers, during which elapsed since the local agent got disconnected from the servers, during which
time updates to the result might have been missed. time updates to the result might have been missed.

2
website/source/api/query.html.md
View File

@ -223,7 +223,7 @@ The table below shows this endpoint's support for
where the query was executed from. For HTTP the source IP is the remote where the query was executed from. For HTTP the source IP is the remote
peer's IP address or the value of the X-Forwarded-For header with the peer's IP address or the value of the X-Forwarded-For header with the
header taking precedence. For DNS the source IP is the remote peer's IP header taking precedence. For DNS the source IP is the remote peer's IP
address or the value of the ENDS client IP with the EDNS client IP address or the value of the EDNS client IP with the EDNS client IP
taking precedence. taking precedence.

2
website/source/docs/agent/cloud-auto-join.html.md
View File

@ -100,7 +100,7 @@ $ consul agent -retry-join "provider=azure tag_name=... tag_value=... tenant_id=
- `provider` (required) - the name of the provider ("azure" in this case). - `provider` (required) - the name of the provider ("azure" in this case).
- `tenant_id` (required) - the tenant to join machines in. - `tenant_id` (required) - the tenant to join machines in.
- `client_id` (required) - the client to authenticate with. - `client_id` (required) - the client to authenticate with.
- `secret_access_key` (required) - the secret client key. **NOTE** This value often may have an equals sign in it's value, especially if generated from the Azure Portal, so is important to wrap in single quotes eg. `secret_acccess_key='fpOfcHQJAQBczjAxiVpeyLmX1M0M0KPBST+GU2GvEN4='` - `secret_access_key` (required) - the secret client key. **NOTE** This value often may have an equals sign in it's value, especially if generated from the Azure Portal, so is important to wrap in single quotes eg. `secret_access_key='fpOfcHQJAQBczjAxiVpeyLmX1M0M0KPBST+GU2GvEN4='`
Variables can also be provided by environmental variables: Variables can also be provided by environmental variables:

2
website/source/docs/agent/options.html.md
View File

@ -1806,7 +1806,7 @@ to the old fragment -->
* <a name="verify_server_hostname"></a><a * <a name="verify_server_hostname"></a><a
href="#verify_server_hostname">`verify_server_hostname`</a> - If set to true, href="#verify_server_hostname">`verify_server_hostname`</a> - If set to true,
Consul verifies for all outgoing TLS connections that the TLS certificate Consul verifies for all outgoing TLS connections that the TLS certificate
presented by the servers matches "server.&lt;datacenter&gt;.&lt;domain&gt;" presented by the servers matches `server.<datacenter>.<domain>`
hostname. By default, this is false, and Consul does not verify the hostname hostname. By default, this is false, and Consul does not verify the hostname
of the certificate, only that it is signed by a trusted CA. This setting is of the certificate, only that it is signed by a trusted CA. This setting is
_critical_ to prevent a compromised client from being restarted as a server _critical_ to prevent a compromised client from being restarted as a server

2
website/source/docs/agent/telemetry.html.md
View File

@ -150,7 +150,7 @@ This is a full list of metrics emitted by Consul.
<td>counter</td> <td>counter</td>
</tr> </tr>
<tr> <tr>
<td>`consul.acl.blocked.&lt;check|node|service&gt;.registration`</td> <td>`consul.acl.blocked.<check|node|service>.registration`</td>
<td>This increments whenever a registration fails for an entity (check, node or service) is blocked by an ACL</td> <td>This increments whenever a registration fails for an entity (check, node or service) is blocked by an ACL</td>
<td>requests</td> <td>requests</td>
<td>counter</td> <td>counter</td>

8
website/source/docs/agent/watches.html.md
View File

@ -165,7 +165,7 @@ Here is an example configuration:
{ {
"type": "keyprefix", "type": "keyprefix",
"prefix": "foo/", "prefix": "foo/",
"args": ["/usr/bin/my-service-handler.sh", "-redis"] "args": ["/usr/bin/my-prefix-handler.sh", "-redis"]
} }
``` ```
@ -384,7 +384,7 @@ events. These are fired using the [consul event](/docs/commands/event.html) comm
It takes only a single optional "name" parameter which restricts It takes only a single optional "name" parameter which restricts
the watch to only events with the given name. the watch to only events with the given name.
This maps to the `v1/event/list` API internally. This maps to the `/v1/event/list` API internally.
Here is an example configuration: Here is an example configuration:
@ -392,13 +392,13 @@ Here is an example configuration:
{ {
"type": "event", "type": "event",
"name": "web-deploy", "name": "web-deploy",
"args": ["/usr/bin/my-service-handler.sh", "-web-deploy"] "args": ["/usr/bin/my-event-handler.sh", "-web-deploy"]
} }
``` ```
Or, using the watch command: Or, using the watch command:
$ consul watch -type=event -name=web-deploy /usr/bin/my-deploy-handler.sh -web-deploy $ consul watch -type=event -name=web-deploy /usr/bin/my-event-handler.sh -web-deploy
An example of the output of this command: An example of the output of this command:

2
website/source/docs/connect/connect-internals.html.md
View File

@ -96,7 +96,7 @@ in multiple datacenters (such as the [geo failover](https://learn.hashicorp.com/
[Intentions](/docs/connect/intentions.html) verify connections between services by [Intentions](/docs/connect/intentions.html) verify connections between services by
source and destination name seamlessly across datacenters. source and destination name seamlessly across datacenters.
Connections can be made via gateways to enable when communciating across Connections can be made via gateways to enable when communicating across
network topologies allowing connections between services in each datacenter network topologies allowing connections between services in each datacenter
without externally routable IPs at the service level. without externally routable IPs at the service level.

2
website/source/docs/connect/registration/service-registration.html.md
View File

@ -210,7 +210,7 @@ registrations](/docs/agent/services.html#service-definition-parameter-case).
} }
``` ```
#### Direct to a Remote/Ingress in a Remote Dataceter #### Direct to a Remote/Ingress in a Remote Datacenter
```json ```json
{ {
"mode": "remote" "mode": "remote"

2
website/source/docs/platform/k8s/index.html.md
View File

@ -61,7 +61,7 @@ There are several ways to try Consul with Kubernetes in different environments.
https://learn.hashicorp.com/consul/day-1-operations/kubernetes-reference?utm_source=consul.io&utm_medium=docs) guide provides recommended practices for production. https://learn.hashicorp.com/consul/day-1-operations/kubernetes-reference?utm_source=consul.io&utm_medium=docs) guide provides recommended practices for production.
- The [Consul and Kubernetes Deployment]( - The [Consul and Kubernetes Deployment](
https://learn.hashicorp.com/consul/day-1-operations/kubernetes-deployment-guide?utm_source=consul.io&utm_medium=docs) guide covers the necssary steps to install and configure a new Consul cluster on Kubernetes in production. https://learn.hashicorp.com/consul/day-1-operations/kubernetes-deployment-guide?utm_source=consul.io&utm_medium=docs) guide covers the necessary steps to install and configure a new Consul cluster on Kubernetes in production.
## "consul-k8s" Project ## "consul-k8s" Project

2
website/source/docs/platform/k8s/service-sync.html.md
View File

@ -255,7 +255,7 @@ metadata:
## Consul to Kubernetes ## Consul to Kubernetes
This syncs Consul services into first-class Kubernetes services. This syncs Consul services into first-class Kubernetes services.
The sync service will creat an [`ExternalName`](https://kubernetes.io/docs/concepts/services-networking/service/#externalname) The sync service will create an [`ExternalName`](https://kubernetes.io/docs/concepts/services-networking/service/#externalname)
`Service` for each Consul service. The "external name" will be `Service` for each Consul service. The "external name" will be
the Consul DNS name. the Consul DNS name.