mirror of
https://github.com/kubernetes-sigs/external-dns.git
synced 2025-08-06 01:26:59 +02:00
Minor edits. Use v0.8.0 image. Add service account reference to the deployment spec example. Add --txt-prefix to avoid CNAME conflict.
This commit is contained in:
Edward Lynes
parent
d29b4316e2
commit
6158bc118e
@ -2,17 +2,17 @@
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Akamai Edge DNS (formally known as Fast DNS) provider support was first released in External-DNS v0.5.18
|
||||
External-DNS v0.8.0 or greater.
|
||||
|
||||
### Zones
|
||||
|
||||
External-DNS manages service endpoints in existing DNS zones. The Akamai provider does not add, remove or configure new zones in anyway. Edge DNS zones can be created and managed thru the [Akamai Control Center](https://control.akamai.com) or [Akamai DevOps Tools](https://developer.akamai.com/devops), [Akamai CLI](https://developer.akamai.com/cli) and [Akamai Terraform Provider](https://developer.akamai.com/tools/integrations/terraform)
|
||||
External-DNS manages service endpoints in existing DNS zones. The Akamai provider does not add, remove or configure new zones. The [Akamai Control Center](https://control.akamai.com) or [Akamai DevOps Tools](https://developer.akamai.com/devops), [Akamai CLI](https://developer.akamai.com/cli) and [Akamai Terraform Provider](https://developer.akamai.com/tools/integrations/terraform) can create and manage Edge DNS zones.
|
||||
|
||||
### Akamai Edge DNS Authentication
|
||||
|
||||
The Akamai Edge DNS provider requires valid Akamai Edgegrid API authentication credentials to access zones and manage associated DNS records.
|
||||
The Akamai Edge DNS provider requires valid Akamai Edgegrid API authentication credentials to access zones and manage DNS records.
|
||||
|
||||
Credentials can be provided to the provider either directly by key or indirectly via a file. The Akamai credential keys and mappings to the Akamai provider utilizing different presentation methods are:
|
||||
Either directly by key or indirectly via a file can set credentials for the provider. The Akamai credential keys and mappings to the Akamai provider utilizing different presentation methods are:
|
||||
|
||||
| Edgegrid Auth Key | External-DNS Cmd Line Key | Environment/ConfigMap Key | Description |
|
||||
| ----------------- | ------------------------- | ------------------------- | ----------- |
|
||||
@ -21,25 +21,20 @@ Credentials can be provided to the provider either directly by key or indirectly
|
||||
| client_token | akamai-client-token | EXTERNAL_DNS_AKAMAI_CLIENT_TOKEN |Akamai Edgegrid API client token |
|
||||
| client-secret | akamai-client-secret | EXTERNAL_DNS_AKAMAI_CLIENT_SECRET |Akamai Edgegrid API client secret |
|
||||
|
||||
In addition to specifying auth credentials individually, the credentials may be referenced indirectly by using the Akamai Edgegrid .edgerc file convention.
|
||||
In addition to specifying auth credentials individually, an Akamai Edgegrid .edgerc file convention can set credentials.
|
||||
|
||||
| External-DNS Cmd Line | Environment/ConfigMap | Description |
|
||||
| --------------------- | --------------------- | ----------- |
|
||||
| akamai-edgerc-path | EXTERNAL_DNS_AKAMAI_EDGERC_PATH | Accessible path to Edgegrid credentials file, e.g /home/test/.edgerc |
|
||||
| akamai-edgerc-section | EXTERNAL_DNS_AKAMAI_EDGERC_SECTION | Section in Edgegrid credentials file containing credentials |
|
||||
|
||||
Note: akamai-edgerc-path and akamai-edgerc-section are present in External-DNS versions after v0.7.5
|
||||
|
||||
[Akamai API Authentication](https://developer.akamai.com/getting-started/edgegrid) provides an overview and further information pertaining to the generation of auth credentials for API base applications and tools.
|
||||
|
||||
The following example defines and references a Kubernetes ConfigMap secret, applied by referencing the secret and its keys in the env section of the deployment.
|
||||
|
||||
[Akamai API Authentication](https://developer.akamai.com/getting-started/edgegrid) provides an overview and further information about authorization credentials for API base applications and tools.
|
||||
|
||||
## Deploy External-DNS
|
||||
|
||||
An operational External-DNS deployment consists of an External-DNS container and service. The following sections demonstrate the ConfigMap objects that would make up an example functional external DNS kubernetes configuration utilizing NGINX as the exposed service.
|
||||
An operational External-DNS deployment consists of an External-DNS container and service. The following sections demonstrate the ConfigMap objects that would make up an example functional external DNS kubernetes configuration utilizing NGINX as the service.
|
||||
|
||||
Connect your `kubectl` client to the cluster with which you want to test External-DNS, and then apply one of the following manifest files for deployment:
|
||||
Connect your `kubectl` client to the External-DNS cluster, and then apply one of the following manifest files:
|
||||
|
||||
### Manifest (for clusters without RBAC enabled)
|
||||
|
||||
@ -59,9 +54,10 @@ spec:
|
||||
labels:
|
||||
app: external-dns
|
||||
spec:
|
||||
serviceAccountName: external-dns
|
||||
containers:
|
||||
- name: external-dns
|
||||
image: k8s.gcr.io/external-dns/external-dns:v0.7.6
|
||||
image: k8s.gcr.io/external-dns/external-dns:v0.8.0
|
||||
args:
|
||||
- --source=service # or ingress or both
|
||||
- --provider=akamai
|
||||
@ -69,6 +65,7 @@ spec:
|
||||
# zone-id-filter may be specified as well to filter on contract ID
|
||||
- --registry=txt
|
||||
- --txt-owner-id={{ owner-id-for-this-external-dns }}
|
||||
- --txt-prefix={{ prefix label for TXT record }}.
|
||||
env:
|
||||
- name: EXTERNAL_DNS_AKAMAI_SERVICECONSUMERDOMAIN
|
||||
valueFrom:
|
||||
@ -143,9 +140,10 @@ spec:
|
||||
labels:
|
||||
app: external-dns
|
||||
spec:
|
||||
serviceAccountName: external-dns
|
||||
containers:
|
||||
- name: external-dns
|
||||
image: k8s.gcr.io/external-dns/external-dns:v0.7.6
|
||||
image: k8s.gcr.io/external-dns/external-dns:v0.8.0
|
||||
args:
|
||||
- --source=service # or ingress or both
|
||||
- --provider=akamai
|
||||
@ -153,6 +151,7 @@ spec:
|
||||
# zone-id-filter may be specified as well to filter on contract ID
|
||||
- --registry=txt
|
||||
- --txt-owner-id={{ owner-id-for-this-external-dns }}
|
||||
- --txt-prefix={{ prefix label for TXT record }}.
|
||||
env:
|
||||
- name: EXTERNAL_DNS_AKAMAI_SERVICECONSUMERDOMAIN
|
||||
valueFrom:
|
||||
@ -179,7 +178,7 @@ spec:
|
||||
Create the deployment for External-DNS:
|
||||
|
||||
```
|
||||
$ kubectl create -f externaldns.yaml
|
||||
$ kubectl apply -f externaldns.yaml
|
||||
```
|
||||
|
||||
## Deploying an Nginx Service
|
||||
@ -223,21 +222,21 @@ spec:
|
||||
targetPort: 80
|
||||
```
|
||||
|
||||
Create the deployment, service and ingress object:
|
||||
Create the deployment and service object:
|
||||
|
||||
```
|
||||
$ kubectl create -f nginx.yaml
|
||||
$ kubectl apply -f nginx.yaml
|
||||
```
|
||||
|
||||
## Verify Akamai Edge DNS Records
|
||||
|
||||
It is recommended to wait 3-5 minutes before validating the records to allow the record changes to propagate to all the Akamai name servers worldwide.
|
||||
Wait 3-5 minutes before validating the records to allow the record changes to propagate to all the Akamai name servers.
|
||||
|
||||
The records can be validated using the [Akamai Control Center](http://control.akamai.com) or by executing a dig, nslookup or similar DNS command.
|
||||
Validate records using the [Akamai Control Center](http://control.akamai.com) or by executing a dig, nslookup or similar DNS command.
|
||||
|
||||
## Cleanup
|
||||
|
||||
Once you successfully configure and verify record management via External-DNS, you can delete the tutorial's example:
|
||||
Once you successfully configure and verify record management via External-DNS, you can delete the tutorial's examples:
|
||||
|
||||
```
|
||||
$ kubectl delete -f nginx.yaml
|
||||
@ -246,6 +245,5 @@ $ kubectl delete -f externaldns.yaml
|
||||
|
||||
## Additional Information
|
||||
|
||||
* The Akamai provider allows the administrative user to filter zones by both name (domain-filter) and contract Id (zone-id-filter). The Edge DNS API will return a '500 Internal Error' if an invalid contract Id is provided.
|
||||
* The provider will substitute any embedded quotes in TXT records with `` ` `` (back tick) when writing the records to the API.
|
||||
|
||||
* The Akamai provider allows the administrative user to filter zones by both name (`domain-filter`) and contract Id (`zone-id-filter`). The Edge DNS API will return a '500 Internal Error' for invalid contract Ids.
|
||||
* The provider will substitute quotes in TXT records with a `` ` `` (back tick) when writing records with the API.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user