https://github.com/abiondevelopment/external-dns-webhook-abion
https://github.com/abiondevelopment/external-dns-webhook-abion
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/abiondevelopment/external-dns-webhook-abion
- Owner: abiondevelopment
- Created: 2024-03-19T09:49:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T11:29:03.000Z (about 2 years ago)
- Last Synced: 2024-04-19T12:09:36.551Z (about 2 years ago)
- Language: Go
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# external-dns-webhook-abion
[ExternalDNS] makes Kubernetes resources discoverable via public DNS servers which allows you to control DNS records dynamically via Kubernetes
resources in a DNS provider-agnostic way.
The external-dns-webhook-abion allows integrating [ExternalDNS] with [Abion] managed zones via the [Abion API].
[ExternalDNS] is, by default, aware of the records it is managing, therefore it can manage non-empty hosted zones.
We strongly encourage you to set `--txt-owner-id` to a unique value that doesn't change for the lifetime of your cluster.
To be able to use external-dns-webhook-abion and manage your zones, you *must* have an Abion account to retrieve an Abion API key.
Contact [Abion] for help how to create an account and API key
# Docker images
Prebuilt docker images can be found on [Docker Hub]
# Install external-dns-webhook-abion using Helm
Install external-dns and external-dns-webhook-abion using helm by following the guide below. The Helm cart values for
external-dns-webhook-abion can be found [here](deploy/external-dns-abion-values.yaml). For additional configurable helm chart values,
please check the [kubernetes-sigs helm chart] config and for Abion webhook specific configuration: [Environment variables](#environment-variables).
# Create Abion API key secret
kubectl create secret generic abion-credentials --from-literal=api-key=''
# Install external-dns and external-dns-webhook-abion using helm
# Configure external-dns-abion-values according to requirements
helm repo add external-dns https://kubernetes-sigs.github.io/external-dns/
helm install external-dns-abion external-dns/external-dns -f deploy/external-dns-abion-values.yaml --version 1.14.3
# Environment variables
The following environment variables are available for Abion External DNS Webhook:
| Variable | Description | Notes |
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|
| ABION_API_KEY | ABION API key. You *must* have an Abion account to retrieve an API key. Contact [Abion] for help how to create an account and API key. | Mandatory |
| DRY_RUN | If set, changes won't be applied. | Default: `false` |
| ABION_DEBUG | Enables webhook debug messages. | Default: `false` |
| LOG_FORMAT | Specifies log format for webhook. Supported values are `text` or `json` | Default: `text` |
| SERVER_HOST | Webhook hostname or IP address. | Default: `localhost` |
| SERVER_PORT | Webhook port. | Default: `8888` |
| SERVER_READ_TIMEOUT | Webhook ReadTimeout is the maximum duration for reading the entire request. A zero or negative value means there will be no timeout. | Default: 0 |
| SERVER_WRITE_TIMEOUT | Webhook WriteTimeout is the maximum duration before timing out writes of the response. A zero or negative value means there will be no timeout | Default: 0 |
# Test external-dns-webhook-abion in Minikube
# Start minikube
minikube start --memory=4G
# Build external-dns-webhook-abion docker image
eval $(minikube docker-env)
make build
# Create Abion API KEY secret
kubectl create secret generic abion-credentials --from-literal=api-key=''
# Install external-dns and external-dns-webhook-abion using helm
helm repo add external-dns https://kubernetes-sigs.github.io/external-dns/
helm install external-dns-abion external-dns/external-dns -f deploy/external-dns-abion-values.yaml --version 1.14.3
# Test adding a service and verify the DNS records are configured as desired.
# Create tunnel to create a route to service deployed with type LoadBalancer within minikube
minikube tunnel
# Make sure to update the `example.test.` value in the `external-dns.alpha.kubernetes.io/hostname` field for the example-service and make sure the apiKey/user has access to that zone. Then apply the service:
kubectl apply -f example/example-service.yaml
# Go to Abion Core (https://app.abion.com) and login to verify the new records has been added.
# Remove the service and verify the records are removed
kubectl delete service example-service
# Go to Abion Core and login and verify the records have been removed from the zone.
# Uninstall external dns
helm uninstall external-dns-abion
[Abion]: https://abion.com/
[Abion API]: https://demo.abion.com/pmapi-doc
[Abion Core]: https://app.abion.com
[Docker Hub]: https://hub.docker.com/r/abiondevelopment/external-dns-webhook-abion
[ExternalDNS]: https://github.com/kubernetes-sigs/external-dns
[kubernetes-sigs helm chart]: https://github.com/kubernetes-sigs/external-dns/blob/master/charts/external-dns/README.md#values