luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Merge pull request #3864 from hashicorp/improve-check-docs 

Clarify that check names are auto generated.
This commit is contained in:
Preetha 2018-02-12 14:07:44 -06:00 committed by GitHub
parent 0b5826bc11 22ed9f1ad7
commit f58db49571
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
website/source/docs/job-specification/service.html.md
View File

@ -168,7 +168,8 @@ scripts.
checks.
- `name` `(string: "service: <name> check")` - Specifies the name of the health
check.
check. If the name is not specified Nomad generates one based on the service name.
If you have more than one check you must specify the name.
- `path` `(string: <varies>)` - Specifies the path of the HTTP endpoint which
Consul will query to query the health of a service. Nomad will automatically
@ -320,6 +321,7 @@ checks must be passing in order for the service to register as healthy.
```hcl
service {
check {
name = "HTTP Check"
type = "http"
port = "lb"
path = "/_healthz"
@ -328,6 +330,7 @@ service {
}
check {
name = "HTTPS Check"
type = "http"
protocol = "https"
port = "lb"
@ -338,6 +341,7 @@ service {
}
check {
name = "Postgres Check"
type = "script"
command = "/usr/local/bin/pg-tools"
args = ["verify", "database" "prod", "up"]