Proclaim defines a DNSSDServiceInstance
Kubernetes custom resource that
describes a DNS-SD service instance to be advertised on one of the supported
DNS provider implementations:
Proclaim can be deployed using the Helm chart in this repository. The default values are suitable for most deployments.
# configure the "proclaim" secret (see below)
helm pull https://github.com/dogmatiq/proclaim/tree/main/charts dogmatiq/proclaim
helm install proclaim --values values.yaml dogmatiq/proclaim
Please note that pulling the Helm chart from the main
branch will always
install the latest version. Use a version number (e.g. v0.4.2
) to install a
specific version.
Each provider needs its own credentials which are stored in a Kubernetes secret
named proclaim
. This secret is NOT created by the Helm chart.
- Set the
proclaim.providers.route53.enabled
value totrue
in the Helm chart values file. - Configure AWS credentials:
- IRSA is recommended when running under EKS. The Helm chart creates a service
account which can be annotated with IAM-specific annotations by setting the
proclaim.serviceAccount.annotations
value in the values file. - Otherwise, the standard AWS environment variables (
AWS_ACCESS_KEY_ID
, etc) can be added to theproclaim
secret.
- IRSA is recommended when running under EKS. The Helm chart creates a service
account which can be annotated with IAM-specific annotations by setting the
The example IAM policy illustrates the precise set of permissions required for Proclaim to function.
- Set the
proclaim.providers.dnsimple.enabled
value totrue
in the Helm chart values file. - Add a
DNSIMPLE_TOKEN
key to theproclaim
secret. The token can be either a "user" token or an "account" token.