From 5220699696dcedb47f7b4db80154058f3340f3ea Mon Sep 17 00:00:00 2001 From: Luigi Tagliamonte <51684360+ltagliamonte-dd@users.noreply.github.com> Date: Thu, 29 Apr 2021 10:37:50 -0700 Subject: [PATCH] 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> --- website/content/docs/discovery/services.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/website/content/docs/discovery/services.mdx b/website/content/docs/discovery/services.mdx index dd15629b0a..c78dede302 100644 --- a/website/content/docs/discovery/services.mdx +++ b/website/content/docs/discovery/services.mdx @@ -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) 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 -default, the IP address of the agent is used, and this does not need to be provided. +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, +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 simpler to configure; this way, the address and port of a service can be discovered.