Add docs for AWS Cloudmap and Nameformat name resolution components #4694
Conversation
Signed-off-by: Jon Menzies-Smith <github@menzies-smith.co.uk>
Signed-off-by: Jon Menzies-Smith <github@menzies-smith.co.uk>
msfussell
added
the
waiting-on-code-pr
There was a problem hiding this comment.
@jmenziessmith - Amazing contribution. Edits mostly to keep consistency.
Also you will to update dapr/docs/daprdocs/data/components/name_resolution/generic.yaml for the nameformat component and add a new file called dapr/docs/daprdocs/data/components/name_resolution/aws.yaml for Cloudmap component so that these appear in the https://docs.dapr.io/reference/components-reference/supported-name-resolution/ section
In both cases the since will be 1.16 with a v1 version.
| spec: | ||
| nameResolution: | ||
| component: "aws.cloudmap" | ||
| configuration: |
There was a problem hiding this comment.
Does this have a version field? If not, I suggest that you add one. See SQLLite NR component as an example
daprdocs/content/en/reference/components-reference/supported-name-resolution/ne-awscloudmap.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/reference/components-reference/supported-name-resolution/ne-awscloudmap.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Configuration Options | ||
|
|
||
| | Property | Type | Required | Default | Description | |
There was a problem hiding this comment.
To keep this consistent with the rest of the docs can you rename and reorder the columns as
Field | Required | Type | Default | Details |
|
|
||
|
|
||
| ## Example Usage | ||
|
|
There was a problem hiding this comment.
Name resolution is configured via the [Dapr Configuration]({{< ref configuration-overview.md >}}). Here are some examples of its usage.
daprdocs/content/en/reference/components-reference/supported-name-resolution/nr-nameformat.md
Outdated
Show resolved
Hide resolved
| 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. | ||
|
|
||
| ## Configuration Format | ||
|
|
There was a problem hiding this comment.
Name resolution is configured via the [Dapr Configuration]({{< ref configuration-overview.md >}}).
Within the configuration YAML, set the spec.nameResolution.component property to "nameformat", then pass configuration options in the spec.nameResolution.configuration dictionary.
daprdocs/content/en/reference/components-reference/supported-name-resolution/ne-awscloudmap.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/reference/components-reference/supported-name-resolution/ne-awscloudmap.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/reference/components-reference/supported-name-resolution/ne-awscloudmap.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Jon Menzies-Smith <github@menzies-smith.co.uk>
Signed-off-by: Jon Menzies-Smith <github@menzies-smith.co.uk>
@msfussell Thanks for the review , I have added the data and made the other recommended changes |
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Add docs supporting the new AWS Cloudmap and Nameformat name resolution components
Issue reference
Please reference the issue this PR will close: #4695