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

Improve doc: add note about address validation (#10123) 

* Update website/content/docs/discovery/services.mdx with address field behavior.

Co-authored-by: Jono Sosulska <42216911+jsosulska@users.noreply.github.com>

Co-authored-by: Jono Sosulska <42216911+jsosulska@users.noreply.github.com>
This commit is contained in:
Luigi Tagliamonte 2021-04-29 10:37:50 -07:00 committed by GitHub
parent 8dffb89131
commit 5220699696
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -120,8 +120,9 @@ 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 can be used to specify a service-specific IP address. By The `address` field is optional, and can be used to specify a service-specific IP address or a hostname.
default, the IP address of the agent is used, and this does not need to be 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 `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
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.