In our virtual machine-centric environment, we heavily rely on microservices that require functionalities such as client discovery and configuration management. To meet these needs, we opted for HashiCorp Consul.

However, we encountered a significant issue with our hostname, which includes a dot (.) character. The warning message we received was as follows:

[WARN] agent: Node name "myorg.vsi.uat.xxx.com" will not be discoverable via DNS due to invalid characters. Valid characters include all alphanumerics and dashes.

Currently, we are unable to modify the hostname directly. Although we attempted to change the node name through the configuration settings, we have not achieved the desired outcome.

To address this issue, consider the following approaches:

  1. Use a Different Node Name: If possible, configure a node name that adheres to the valid character set (alphanumeric and dashes). This can be done in the Consul configuration file:

    node_name = "myorg-vsi-uat-xxx-com"

  2. DNS Alias: If changing the node name is not feasible, you might create a DNS alias that points to the original hostname. This way, Consul can discover the service using the alias without the dot.

  3. Custom DNS Configuration: If your infrastructure allows, consider setting up a custom DNS resolver that can handle dot-separated hostnames appropriately.

  4. Consult Documentation: Always refer to the official Consul documentation for the latest best practices and configuration options.

By implementing one of these strategies, you should be able to overcome the hostname issue and ensure that your services remain discoverable within Consul.