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

website: add service weights documentation in API doc (#4776) 

Adds weights documentation to the following API routes :
* Agent: List Services
* Agent Register Service
* Health: List Nodes for Service
This commit is contained in:
Aestek 2018-10-19 10:49:09 +02:00 committed by Jack Pearkes
parent bfa1a912ab
commit c4d6d19d8e
2 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -58,7 +58,11 @@ $ curl \
}, },
"Port": 8000, "Port": 8000,
"Address": "", "Address": "",
"EnableTagOverride": false "EnableTagOverride": false,
"Weights": {
"Passing": 10,
"Warning": 1
}
} }
} }
``` ```
@ -222,7 +226,7 @@ service definition keys for compatibility with the config file format.
will be generated. To provide a custom id and/or name set the `CheckID` will be generated. To provide a custom id and/or name set the `CheckID`
and/or `Name` field. and/or `Name` field.
- `Checks` `(array<Check>: nil`) - Specifies a list of checks. Please see the - `Checks` `(array<Check>: nil)` - Specifies a list of checks. Please see the
[check documentation](/api/agent/check.html) for more information about the [check documentation](/api/agent/check.html) for more information about the
accepted fields. If you don't provide a name or id for the check then they accepted fields. If you don't provide a name or id for the check then they
will be generated. To provide a custom id and/or name set the `CheckID` will be generated. To provide a custom id and/or name set the `CheckID`
@ -244,6 +248,11 @@ service definition keys for compatibility with the config file format.
service's port _and_ the tags would revert to the original value and all service's port _and_ the tags would revert to the original value and all
modifications would be lost. modifications would be lost.
- `Weights` `(Weights: nil)` - Specifies weights for the service. Please see the
[service documentation](/docs/agent/services.html) for more information about
weights. If this field is not provided weights will default to
`{"Passing": 1, "Warning": 1}`.
It is important to note that this applies only to the locally registered It is important to note that this applies only to the locally registered
service. If you have multiple nodes all registering the same service their service. If you have multiple nodes all registering the same service their
`EnableTagOverride` configuration and all other service configuration items `EnableTagOverride` configuration and all other service configuration items
@ -292,6 +301,10 @@ For the `Connect` field, the parameters are:
"HTTP": "http://localhost:5000/health", "HTTP": "http://localhost:5000/health",
"Interval": "10s", "Interval": "10s",
"TTL": "15s" "TTL": "15s"
},
"Weights": {
"Passing": 10,
"Warning": 1
} }
} }
``` ```

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

@ -222,7 +222,11 @@ $ curl \
"Meta": { "Meta": {
"redis_version": "4.0" "redis_version": "4.0"
}, },
"Port": 8000 "Port": 8000,
"Weights": {
"Passing": 10,
"Warning": 1
}
}, },
"Checks": [ "Checks": [
{ {