Name resolution provider component specs on Dapr Docs

AWS Cloudmap

Mon, 01 Jan 0001 00:00:00 +0000

This component uses AWS Cloud Map for service discovery in Dapr. It supports both HTTP and DNS namespaces, allowing services to discover and connect to other services using AWS Cloud Map’s service discovery capabilities.

Configuration format

Name resolution is configured via the Dapr Configuration.

Within the configuration YAML, set the spec.nameResolution.component property to "aws.cloudmap", then pass configuration options in the spec.nameResolution.configuration dictionary.

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
 name: appconfig
spec:
 nameResolution:
 component: "aws.cloudmap"
 version: "v1"
 configuration:
 # Required: AWS CloudMap namespace configuration (one of these is required)
 namespaceName: "my-namespace" # The name of your CloudMap namespace
 # namespaceId: "ns-xxxxxx" # Alternative: Use namespace ID instead of name

 # Optional: AWS authentication (choose one authentication method)
 # Option 1: Environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
 # Option 2: IAM roles for Amazon EKS
 # Option 3: Explicit credentials (not recommended for production)
 accessKey: "****"
 secretKey: "****"
 sessionToken: "****" # Optional

 # Optional: AWS region and endpoint configuration
 region: "us-west-2"
 endpoint: "http://localhost:4566" # Optional: Custom endpoint for testing

 # Optional: Dapr configuration
 defaultDaprPort: 50002 # Default port for Dapr sidecar if not specified in instance attributes

Specification

AWS authentication

The component supports multiple authentication methods:

HashiCorp Consul

Mon, 01 Jan 0001 00:00:00 +0000

Configuration format

Hashicorp Consul is setup within the Dapr Configuration.

Within the config, add a nameResolution spec and set the component field to "consul".

If you are using the Dapr sidecar to register your service to Consul then you will need the following configuration:

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
 name: appconfig
spec:
 nameResolution:
 component: "consul"
 configuration:
 selfRegister: true

If Consul service registration is managed externally from Dapr you need to ensure that the Dapr-to-Dapr internal gRPC port is added to the service metadata under DAPR_PORT (this key is configurable) and that the Consul service Id matches the Dapr app Id. You can then omit selfRegister from the config above.

Kubernetes DNS

Mon, 01 Jan 0001 00:00:00 +0000

Configuration format

Generally, Kubernetes DNS name resolution is configured automatically in Kubernetes mode by Dapr. There is no configuration needed to use Kubernetes DNS as your name resolution provider unless some overrides are necessary for the Kubernetes name resolution component.

In the scenario that an override is required, within a Dapr Configuration CRD, add a nameResolution spec and set the component field to "kubernetes". The other configuration fields can be set as needed in a configuration map, as seen below.

mDNS

Mon, 01 Jan 0001 00:00:00 +0000

Configuration format

Multicast DNS (mDNS) is configured automatically in self-hosted mode by Dapr. There is no configuration needed to use mDNS as your name resolution provider.

Behaviour

The component resolves target apps by using the host system’s mDNS service. You can learn more about mDNS here.

Troubleshooting

In some cloud provider virtual networks, such as Microsoft Azure, mDNS is not available. Use an alternate provider such as HashiCorp Consul instead.

On some enterprise-managed systems, mDNS may be disabled on macOS if a network filter/proxy is configured. Check with your IT department if mDNS is disabled and you are unable to use service invocation locally.

Nameformat

Mon, 01 Jan 0001 00:00:00 +0000

The Name Format name resolver provides a flexible way to resolve service names using a configurable format string with placeholders. This is useful in scenarios where you want to map service names to predictable DNS names following a specific pattern.

Consider using this name resolver if there is no specific name resolver available for your service registry, but your service registry can expose services via internal DNS names using predictable naming conventions.

SQLite

Mon, 01 Jan 0001 00:00:00 +0000

As an alternative to mDNS, the SQLite name resolution component can be used for running Dapr on single-node environments and for local development scenarios. Dapr sidecars that are part of the cluster store their information in a SQLite database on the local machine.

Note

This component is optimized to be used in scenarios where all Dapr instances are running on the same physical machine, where the database is accessed through the same, locally-mounted disk.
Using the SQLite nameresolver with a database file accessed over the network (including via SMB/NFS) can lead to issues such as data corruption, and is not supported.

Configuration format

Name resolution is configured via the Dapr Configuration.