-
Notifications
You must be signed in to change notification settings - Fork 771
Add docs for AWS Cloudmap and Nameformat name resolution components #4694
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
6863c54
d94ab4e
eb43738
096e1b4
7963e25
9b7c9c9
d44d8ec
261ebef
1486ef5
c028c08
f26f0cb
f2d68da
fafe6e9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
--- | ||
type: docs | ||
title: "AWS Cloudmap" | ||
linkTitle: "AWS Cloudmap" | ||
description: Detailed information on the AWS Cloudmap name resolution component | ||
--- | ||
|
||
|
||
This component uses [AWS Cloud Map](https://aws.amazon.com/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. | ||
|
||
## Component Format | ||
|
||
```yaml | ||
apiVersion: dapr.io/v1alpha1 | ||
kind: Configuration | ||
metadata: | ||
name: appconfig | ||
spec: | ||
nameResolution: | ||
component: "aws.cloudmap" | ||
configuration: | ||
marcduiker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
# 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 | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The component supports multiple authentication methods: | ||
|
||
1. Environment Variables: | ||
- AWS_ACCESS_KEY_ID | ||
- AWS_SECRET_ACCESS_KEY | ||
- AWS_SESSION_TOKEN (optional) | ||
|
||
2. IAM Roles: | ||
- When running on AWS (EKS, EC2, etc.), the component can use IAM roles | ||
|
||
3. Explicit Credentials: | ||
- Provided in the component metadata (not recommended for production) | ||
|
||
### Required Permissions | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The AWS credentials must have the following permissions: | ||
```json | ||
{ | ||
"Version": "2012-10-17", | ||
"Statement": [ | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"servicediscovery:DiscoverInstances", | ||
"servicediscovery:GetNamespace", | ||
"servicediscovery:ListNamespaces" | ||
], | ||
"Resource": "*" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
### Configuration Options | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
| Property | Type | Required | Default | Description | | ||
marcduiker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|----------|------|----------|---------|-------------| | ||
| namespaceName | string | One of namespaceName or namespaceId | "" | The name of your AWS CloudMap namespace | | ||
| namespaceId | string | One of namespaceName or namespaceId | "" | The ID of your AWS CloudMap namespace | | ||
| region | string | N | "" | AWS region. If not provided, will be determined from environment or instance metadata | | ||
| endpoint | string | N | "" | Custom endpoint for AWS CloudMap API. Useful for testing with LocalStack | | ||
| defaultDaprPort | number | N | 3500 | Default port for Dapr sidecar if not specified in instance attributes | | ||
|
||
### Service Registration | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
To use this name resolver, your services must be registered in AWS CloudMap. When registering instances, ensure they have the following attributes: | ||
|
||
1. Required: One of these address attributes: | ||
- `AWS_INSTANCE_IPV4`: IPv4 address of the instance | ||
- `AWS_INSTANCE_IPV6`: IPv6 address of the instance | ||
- `AWS_INSTANCE_CNAME`: Hostname of the instance | ||
|
||
2. Optional: Dapr sidecar port attribute: | ||
- `DAPR_PORT`: The port that the Dapr sidecar is listening on | ||
- If not specified, the component will use the `defaultDaprPort` from configuration (defaults to 3500) | ||
|
||
The resolver will only return healthy instances (those with `HEALTHY` status) to ensure reliable service communication. | ||
|
||
Example instance attributes: | ||
```json | ||
{ | ||
"AWS_INSTANCE_IPV4": "10.0.0.1", | ||
"DAPR_PORT": "50002" | ||
} | ||
``` | ||
|
||
|
||
## Example Usage | ||
|
||
marcduiker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Minimal Configuration | ||
|
||
```yaml | ||
apiVersion: dapr.io/v1alpha1 | ||
kind: Configuration | ||
metadata: | ||
name: appconfig | ||
spec: | ||
nameResolution: | ||
component: "aws.cloudmap" | ||
configuration: | ||
namespaceName: "mynamespace.dev" | ||
defaultDaprPort: 50002 | ||
``` | ||
|
||
### Local Development with LocalStack | ||
|
||
```yaml | ||
apiVersion: dapr.io/v1alpha1 | ||
kind: Configuration | ||
metadata: | ||
name: appconfig | ||
spec: | ||
nameResolution: | ||
component: "aws.cloudmap" | ||
configuration: | ||
namespaceName: "my-namespace" | ||
region: "us-east-1" | ||
endpoint: "http://localhost:4566" | ||
accessKey: "test" | ||
secretKey: "test" | ||
``` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Related links
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
type: docs | ||
title: "Nameformat" | ||
linkTitle: "NameFormat" | ||
description: Detailed information on the NameFormat name resolution component | ||
--- | ||
|
||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would be good to provide some more details on example use cases for this component, more of the "why" behind using this and when. This is ok, but it is light on scenarios, so let's include a few. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated |
||
|
||
## Configuration Format | ||
|
||
marcduiker marked this conversation as resolved.
Show resolved
Hide resolved
|
||
To use the Name Format name resolver, create a configuration in your Dapr environment: | ||
|
||
```yaml | ||
apiVersion: dapr.io/v1alpha1 | ||
kind: Configuration | ||
metadata: | ||
name: appconfig | ||
spec: | ||
nameResolution: | ||
component: "nameformat" | ||
configuration: | ||
format: "service-{appid}.default.svc.cluster.local" # Replace with your desired format pattern | ||
``` | ||
|
||
## Configuration Fields | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
| Field | Required | Details | Example | | ||
|---------|----------|---------|---------| | ||
| format | Y | The format string to use for name resolution. Must contain the `{appid}` placeholder which will be replaced with the actual service name. | `"service-{appid}.default.svc.cluster.local"` | | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Examples | ||
|
||
When configured with `format: "service-{appid}.default.svc.cluster.local"`, the resolver will transform service names as follows: | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Service ID "myapp" → "service-myapp.default.svc.cluster.local" | ||
- Service ID "frontend" → "service-frontend.default.svc.cluster.local" | ||
|
||
|
||
## Notes | ||
|
||
- Empty service IDs are not allowed and will result in an error | ||
jmenziessmith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- The format string must be provided in the configuration | ||
- The format string must contain at least one `{appid}` placeholder |
Uh oh!
There was an error while loading. Please reload this page.