Skip to content

Commit

Permalink
Fix broken link, typo, style edits. (#15968)
Browse files Browse the repository at this point in the history
  • Loading branch information
angrycub authored Jan 30, 2023
1 parent a5f568a commit ca597f7
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions website/content/docs/job-specification/check.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,12 @@ job "example" {
- `path` `(string: <varies>)` - Specifies the path of the HTTP endpoint which
will be queried to observe the health of a service. Nomad will automatically
add the IP of the service and the port, so this is just the relative URL to
the health check endpoint. This is required for http-based health checks.
the health check endpoint. This is required for HTTP-based health checks.

- `expose` `(bool: false)` - Specifies whether an [Expose Path](/nomad/docs/job-specification/expose#path-parameters)
should be automatically generated for this check. Only compatible with
Connect-enabled task-group services using the default Connect proxy. If set, check
[`type`][type] must be `http` or `grpc`, and check `name` must be set.
[`type`](#type) must be `http` or `grpc`, and check `name` must be set.
Only supported in the Consul service provider.

- `port` `(string: <varies>)` - Specifies the label of the port on which the
Expand All @@ -131,7 +131,7 @@ job "example" {
ports by default. In Nomad 0.7.1 or later numeric ports may be used if
`address_mode="driver"` is set on the check.

- `protocol` `(string: "http")` - Specifies the protocol for the http-based
- `protocol` `(string: "http")` - Specifies the protocol for the HTTP-based
health checks. Valid options are `http` and `https`.

- `task` `(string: "")` - Specifies the task associated with this
Expand Down Expand Up @@ -328,7 +328,7 @@ check {
}
```

### Healthiness vs. Readiness Checks
### Healthiness versus Readiness Checks

Multiple checks for a service can be composed to create healthiness and readiness
checks by configuring [`on_update`][on_update] for the check.
Expand Down Expand Up @@ -369,26 +369,32 @@ For checks registered into the Nomad service provider, the status information of
checks can be viewed per-allocation. The `alloc status` command now includes
summary information for Nomad service checks.

```
nomad alloc status <allocation-id>
```shell-session
$ nomad alloc status <allocation-id>
```

```
<CodeBlockConfig hideClipboard>

```plaintext
Nomad Service Checks:
Service Task Name Mode Status
database task db_tcp_probe readiness success
web (group) healthz healthiness failure
web (group) index-page healthiness success
```

</CodeBlockConfig>

The `alloc checks` command can be used for viewing complete check status information
for all checks in an allocation.

```
➜ noamd alloc checks <allocation-id>
```shell-session
$ nomad alloc checks <allocation-id>
```

```
<CodeBlockConfig hideClipboard>

```plaintext
Status of 3 Nomad Service Checks
ID = d8651d93a50b9e28375a7beb9418c418
Expand Down Expand Up @@ -423,6 +429,8 @@ Timestamp = 2022-08-22T10:41:23-05:00
Output = nomad: Get "http://:9999/": dial tcp :9999: connect: connection refused
```

</CodeBlockConfig>

---

<sup>
Expand Down

0 comments on commit ca597f7

Please sign in to comment.