github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Adjust documentation for service tags of checks 

Add some missing ServiceTags.
Replace null ServiceTags by empty list (ServiceTags cannot be null).
pull/3642/head
Yoann Fouquet 2017-11-23 22:16:42 +01:00
parent 986148cfe5
commit 16cc432c7a
4 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/source/api/agent/check.html.md
View File

@ -55,7 +55,8 @@ $ curl \
"Notes": "", "Notes": "",
"Output": "", "Output": "",
"ServiceID": "redis", "ServiceID": "redis",
"ServiceName": "redis" "ServiceName": "redis",
"ServiceTags": ["primary"]
} }
} }
``` ```

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

@ -51,7 +51,7 @@ $ curl \
"redis": { "redis": {
"ID": "redis", "ID": "redis",
"Service": "redis", "Service": "redis",
"Tags": null, "Tags": [],
"Address": "", "Address": "",
"Port": 8000 "Port": 8000
} }

6
website/source/api/health.html.md
View File

@ -62,7 +62,7 @@ $ curl \
"Output": "", "Output": "",
"ServiceID": "", "ServiceID": "",
"ServiceName": "", "ServiceName": "",
"ServiceTags": null "ServiceTags": []
}, },
{ {
"ID": "40e4a748-2192-161a-0510-9bf59fe950b5", "ID": "40e4a748-2192-161a-0510-9bf59fe950b5",
@ -239,7 +239,7 @@ $ curl \
"Output": "", "Output": "",
"ServiceID": "", "ServiceID": "",
"ServiceName": "", "ServiceName": "",
"ServiceTags": null "ServiceTags": []
} }
] ]
} }
@ -303,7 +303,7 @@ $ curl \
"Output": "", "Output": "",
"ServiceID": "", "ServiceID": "",
"ServiceName": "", "ServiceName": "",
"ServiceTags": null "ServiceTags": []
}, },
{ {
"Node": "foobar", "Node": "foobar",

2
website/source/intro/getting-started/checks.html.md
View File

@ -75,7 +75,7 @@ can be run on either node):
```text ```text
vagrant@n1:~$ curl http://localhost:8500/v1/health/state/critical vagrant@n1:~$ curl http://localhost:8500/v1/health/state/critical
[{"Node":"agent-two","CheckID":"service:web","Name":"Service 'web' check","Status":"critical","Notes":"","ServiceID":"web","ServiceName":"web"}] [{"Node":"agent-two","CheckID":"service:web","Name":"Service 'web' check","Status":"critical","Notes":"","ServiceID":"web","ServiceName":"web","ServiceTags":["rails"]}]
``` ```
We can see that there is only a single check, our `web` service check, in the We can see that there is only a single check, our `web` service check, in the