dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3785 from mukundansundar/template-k8s 

Adding docs for template based processing in k8s name resolution
This commit is contained in:
Hannah Hunter 2023-10-10 09:40:21 -04:00 committed by GitHub
parent 3cdb18d39b 96d0e90458
commit 0b14f3e71a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
daprdocs/content/en/reference/components-reference/supported-name-resolution/nr-kubernetes.md
View File

@ -7,7 +7,22 @@ description: Detailed information on the Kubernetes DNS name resolution componen
## Configuration format
Kubernetes DNS name resolution is configured automatically in [Kubernetes mode]({{< ref kubernetes >}}) by Dapr. There is no configuration needed to use Kubernetes DNS as your name resolution provider.
Generally, Kubernetes DNS name resolution is configured automatically in [Kubernetes mode]({{< ref kubernetes >}}) 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]({{< ref configuration-overview.md >}}) 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.
```yaml
apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
name: appconfig
spec:
nameResolution:
component: "kubernetes"
configuration:
clusterDomain: "cluster.local" # Mutually exclusive with the template field
template: "{{.ID}}-{{.Data.region}}.internal:{{.Port}}" # Mutually exclusive with the clusterDomain field
```
## Behaviour
@ -15,7 +30,13 @@ The component resolves target apps by using the Kubernetes cluster's DNS provide
## Spec configuration fields
Not applicable, as Kubernetes DNS is configured by Dapr when running in Kubernetes mode.
The configuration spec is fixed to v1.3.0 of the Consul API
| Field | Required | Type | Details | Examples |
|--------------|:--------:|-----:|:---------|----------|
| clusterDomain | N | `string` | The cluster domain to be used for resolved addresses. This field is mutually exclusive with the `template` file.| `cluster.local`
| template | N | `string` | A template string to be parsed when addresses are resolved using [text/template](https://pkg.go.dev/text/template#Template) . The template will be populated by the fields in the [ResolveRequest](https://github.com/dapr/components-contrib/blob/release-{{% dapr-latest-version short="true" %}}/nameresolution/requests.go#L20) struct. This field is mutually exclusive with `clusterDomain` field. | `{{.ID}}-{{.Data.region}}.{{.Namespace}}.internal:{{.Port}}`
## Related links