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

website: Updating the tags documentation

This commit is contained in:
Armon Dadgar 2014-04-03 14:18:57 -07:00
parent fd6a87748f
commit 50eaefa03e
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
website/source/docs/agent/http.html.markdown
View File

@ -169,7 +169,7 @@ This endpoint is hit with a GET and returns a JSON body like this:
"redis":{ "redis":{
"ID":"redis", "ID":"redis",
"Service":"redis", "Service":"redis",
"Tag":"", "Tags":[],
"Port":8000 "Port":8000
} }
} }
@ -301,7 +301,7 @@ body must look like:
{ {
"ID": "redis1", "ID": "redis1",
"Name": "redis", "Name": "redis",
"Tag": "master", "Tags": ["master", "v1"],
"Port": 8000, "Port": 8000,
"Check": { "Check": {
"Script": "/usr/local/bin/check_redis.py", "Script": "/usr/local/bin/check_redis.py",
@ -312,7 +312,7 @@ body must look like:
The `Name` field is mandatory, If an `ID` is not provided, it is set to `Name`. The `Name` field is mandatory, If an `ID` is not provided, it is set to `Name`.
You cannot have duplicate `ID` entries per agent, so it may be necessary to provide an ID. You cannot have duplicate `ID` entries per agent, so it may be necessary to provide an ID.
`Tag`, `Port` and `Check` are optional. If `Check` is provided, only one of `Script` and `Interval` `Tags`, `Port` and `Check` are optional. If `Check` is provided, only one of `Script` and `Interval`
or `TTL` should be provided. There is more information about checks [here](/docs/agent/checks.html). or `TTL` should be provided. There is more information about checks [here](/docs/agent/checks.html).
The created check will be named "service:\<ServiceId\>". The created check will be named "service:\<ServiceId\>".
@ -361,7 +361,7 @@ body must look like:
"Service": { "Service": {
"ID": "redis1", "ID": "redis1",
"Service": "redis", "Service": "redis",
"Tag": "master", "Tags": ["master", "v1"],
"Port": 8000, "Port": 8000,
}, },
"Check": { "Check": {
@ -381,7 +381,7 @@ the node with the catalog.
If the `Service` key is provided, then the service will also be registered. If If the `Service` key is provided, then the service will also be registered. If
`ID` is not provided, it will be defaulted to `Service`. It is mandated that the `ID` is not provided, it will be defaulted to `Service`. It is mandated that the
ID be node-unique. Both `Tag` and `Port` can be omitted. ID be node-unique. Both `Tags` and `Port` can be omitted.
If the `Check` key is provided, then a health check will also be registered. It If the `Check` key is provided, then a health check will also be registered. It
is important to remember that this register API is very low level. This manipulates is important to remember that this register API is very low level. This manipulates
@ -480,8 +480,8 @@ however the dc can be provided using the "?dc=" query parameter.
It returns a JSON body like this: It returns a JSON body like this:
{ {
"consul":[""], "consul":[],
"redis":[""], "redis":[],
"postgresql":["master","slave"] "postgresql":["master","slave"]
} }
@ -508,7 +508,7 @@ It returns a JSON body like this:
"Address":"10.1.10.12", "Address":"10.1.10.12",
"ServiceID":"redis", "ServiceID":"redis",
"ServiceName":"redis", "ServiceName":"redis",
"ServiceTag":"", "ServiceTags":[],
"ServicePort":8000 "ServicePort":8000
} }
] ]
@ -533,13 +533,13 @@ It returns a JSON body like this:
"consul":{ "consul":{
"ID":"consul", "ID":"consul",
"Service":"consul", "Service":"consul",
"Tag":"", "Tags":[],
"Port":8300 "Port":8300
}, },
"redis":{ "redis":{
"ID":"redis", "ID":"redis",
"Service":"redis", "Service":"redis",
"Tag":"", "Tags":["v1"],
"Port":8000 "Port":8000
} }
} }
@ -655,7 +655,7 @@ It returns a JSON body like this:
"Service":{ "Service":{
"ID":"redis", "ID":"redis",
"Service":"redis", "Service":"redis",
"Tag":"", "Tags":[],
"Port":8000 "Port":8000
}, },
"Checks":[ "Checks":[

8
website/source/docs/agent/services.html.markdown
View File

@ -20,7 +20,7 @@ A service definition that is a script looks like:
{ {
"service": { "service": {
"name": "redis", "name": "redis",
"tag": "master", "tags": ["master"],
"port": 8000, "port": 8000,
"check": { "check": {
"script": "/usr/local/bin/check_redis.py", "script": "/usr/local/bin/check_redis.py",
@ -30,12 +30,12 @@ A service definition that is a script looks like:
} }
A service definition must include a `name`, and may optionally provide A service definition must include a `name`, and may optionally provide
an `id`, `tag`, `port`, and `check`. The `id` is set to the `name` if not an `id`, `tags`, `port`, and `check`. The `id` is set to the `name` if not
provided. It is required that all services have a unique ID, so if names provided. It is required that all services have a unique ID, so if names
might conflict, then unique ID's should be provided. might conflict, then unique ID's should be provided.
The `tag` is an opaque value to Consul, but can be used to distinguish The `tags` is a list of opaque value to Consul, but can be used to distinguish
between "master" or "slave" nodes, or any other service level labels. between "master" or "slave" nodes, different versions, or any other service level labels.
The `port` can be used as well to make a service oriented architecture The `port` can be used as well to make a service oriented architecture
simpler to configure. This way the address and port of a service can simpler to configure. This way the address and port of a service can
be discovered. be discovered.