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

Merge pull request #1818 from hashicorp/f-health-doc 

Adds a reference to the health endpoint in the intro.
This commit is contained in:
James Phillips 2016-03-09 16:43:08 -08:00
parent c9b40c20d6 89c5fcabf7
commit 6506b75c43
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/source/intro/getting-started/services.html.markdown
View File

@ -140,6 +140,17 @@ $ curl http://localhost:8500/v1/catalog/service/web
"ServiceName":"web","ServiceTags":["rails"],"ServicePort":80}]
```
The catalog API gives all nodes hosting a given service. As we will see later
with [health checks](/intro/getting-started/checks.html) you'll typically want
to query just for healthy instances where the checks are passing. This is what
DNS is doing under the hood. Here's a query to look for only healthy instances:
```text
$ curl 'http://localhost:8500/v1/health/service/web?passing'
[{"Node":"Armons-MacBook-Air","Address":"172.20.20.11","Service":{ \
"ID":"web", "Service":"web", "Tags":["rails"],"Port":80}, "Checks": ...}]
```
## Updating Services
Service definitions can be updated by changing configuration files and