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

docs(discovery/service): Clarify multiple service definitions 

Be more explicit that the definition of multiple services only works in config files,
not using the HTTP API.

Ref: https://discuss.hashicorp.com/t/register-multiple-services-via-put-request/
This commit is contained in:
Frederic Hemberger 2021-04-29 19:39:11 +02:00 committed by Blake Covarrubias
parent dcb5b924dc
commit 2558197260
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/content/docs/discovery/services.mdx
View File

@ -27,8 +27,8 @@ To configure a service, either provide the service definition as a
`-config-file` option to the agent or place it inside the `-config-dir` of the `-config-file` option to the agent or place it inside the `-config-dir` of the
agent. The file must end in the `.json` or `.hcl` extension to be loaded by agent. The file must end in the `.json` or `.hcl` extension to be loaded by
Consul. Check definitions can be updated by sending a `SIGHUP` to the agent. Consul. Check definitions can be updated by sending a `SIGHUP` to the agent.
Alternatively, the service can be registered dynamically using the [HTTP Alternatively, the service can be [registered dynamically](/api-docs/agent/service#register-service)
API](/api). using the [HTTP API](/api).
A service definition is a configuration that looks like the following. This A service definition is a configuration that looks like the following. This
example shows all possible fields, but note that only a few are required. example shows all possible fields, but note that only a few are required.
@ -71,7 +71,7 @@ example shows all possible fields, but note that only a few are required.
"mode": "transparent", "mode": "transparent",
"transparent_proxy": { "transparent_proxy": {
"outbound_listener_port": 22500 "outbound_listener_port": 22500
} },
"config": {}, "config": {},
"upstreams": [], "upstreams": [],
"mesh_gateway": { "mesh_gateway": {
@ -120,7 +120,7 @@ different versions, or any other service level labels.
We recommend using [valid DNS labels](https://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_hostnames) We recommend using [valid DNS labels](https://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_hostnames)
for service definition names and tags for [compatibility with external DNS](/docs/agent/services#service-and-tag-names-with-dns) for service definition names and tags for [compatibility with external DNS](/docs/agent/services#service-and-tag-names-with-dns)
The `address` field is optional, and can be used to specify a service-specific IP address or a hostname. The `address` field is optional, and can be used to specify a service-specific IP address or a hostname.
There is no server-side validation of this field, and it can be set to any string. When this value is not provided, There is no server-side validation of this field, and it can be set to any string. When this value is not provided,
the IP address of the agent node is used by default. the IP address of the agent node is used by default.
The `port` field can be used as well to make a service-oriented architecture The `port` field can be used as well to make a service-oriented architecture
@ -275,8 +275,9 @@ deprecated and has been removed as of Consul 1.1.
## Multiple Service Definitions ## Multiple Service Definitions
Multiple services definitions can be provided at once using the plural Multiple services definitions can be provided at once when registering services
`services` key in your configuration file. via the agent configuration by using the plural `services` key (registering
multiple services in this manner is not supported using the HTTP API).
```javascript ```javascript
{ {