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

docs: Add note about using valid DNS labels for service names (#7035) 

Add note about using valid DNS labels for service names
This commit is contained in:
John Cowen 2020-01-15 15:36:17 +00:00 committed by GitHub
parent 79fef74772
commit 248ee65f72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -495,14 +495,17 @@ Note that this endpoint, unlike most also [supports `snake_case`](/docs/agent/se
service definition keys for compatibility with the config file format. service definition keys for compatibility with the config file format.
- `Name` `(string: <required>)` - Specifies the logical name of the service. - `Name` `(string: <required>)` - Specifies the logical name of the service.
Many service instances may share the same logical service name. Many service instances may share the same logical service name. We recommend using
[valid DNS labels](https://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_hostnames)
for [compatibility with external DNS](/docs/agent/services.html#service-and-tag-names-with-dns).
- `ID` `(string: "")` - Specifies a unique ID for this service. This must be - `ID` `(string: "")` - Specifies a unique ID for this service. This must be
unique per _agent_. This defaults to the `Name` parameter if not provided. unique per _agent_. This defaults to the `Name` parameter if not provided.
- `Tags` `(array<string>: nil)` - Specifies a list of tags to assign to the - `Tags` `(array<string>: nil)` - Specifies a list of tags to assign to the
service. These tags can be used for later filtering and are exposed via the service. These tags can be used for later filtering and are exposed via the APIs.
APIs. We recommend using [valid DNS labels](https://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_hostnames)
for [compatibility with external DNS](/docs/agent/services.html#service-and-tag-names-with-dns)
- `Address` `(string: "")` - Specifies the address of the service. If not - `Address` `(string: "")` - Specifies the address of the service. If not
provided, the agent's address is used as the address for the service during provided, the agent's address is used as the address for the service during

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

@ -53,8 +53,10 @@ The table below shows this endpoint's support for
- `Service` `(Service: nil)` - Specifies to register a service. If `ID` is not - `Service` `(Service: nil)` - Specifies to register a service. If `ID` is not
provided, it will be defaulted to the value of the `Service.Service` property. provided, it will be defaulted to the value of the `Service.Service` property.
Only one service with a given `ID` may be present per node. The service Only one service with a given `ID` may be present per node. We recommend using
`Tags`, `Address`, `Meta`, and `Port` fields are all optional. For more [valid DNS labels](https://en.wikipedia.org/wiki/Hostname#Restrictions_on_valid_hostnames)
for service definition names for [compatibility with external DNS](/docs/agent/services.html#service-and-tag-names-with-dns).
The service `Tags`, `Address`, `Meta`, and `Port` fields are all optional. For more
information about these fields and the implications of setting them, information about these fields and the implications of setting them,
see the [Service - Agent API](/api/agent/service.html) page see the [Service - Agent API](/api/agent/service.html) page
as registering services differs between using this or the Services Agent endpoint. as registering services differs between using this or the Services Agent endpoint.

3
website/source/docs/agent/services.html.md
View File

@ -109,6 +109,9 @@ The `tags` property is a list of values that are opaque to Consul but
can be used to distinguish between `primary` or `secondary` nodes, can be used to distinguish between `primary` or `secondary` nodes,
different versions, or any other service level labels. 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.html#service-and-tag-names-with-dns)
The `address` field can be used to specify a service-specific IP address. By 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. default, the IP address of the agent is used, and this does not need to be provided.
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