k8s-dns-manager

Kubernetes DNS Manager

Overview

DNSRecord

allows you to manage DNS records for your Kubernetes cluster using custom resources.

Example A Record:

apiVersion: dns.xzzpig.com/v1
kind: DNSRecord
metadata:
  name: dnsrecord-sample
  namespace: default
spec:
  recordType: A
  name: test.sample.com
  value: 192.168.1.1

DNSProvider

you can use this resource to configure the DNS provider and credentials to use. The k8s-dns-manager will match DNSRecord with one DNSProvider and sync the DNS records in the configured DNS provider. Specially, DNSProvider is cluster-scoped.

Example DNSProvider:

apiVersion: dns.xzzpig.com/v1
kind: DNSProvider
metadata:
  name: dnsprovider-sample
spec:
  providerType: ALIYUN
  domainName: sample.com
  aliyun:
    accessKeyId: "<your-access-key-id>"
    accessKeySecret: "<your-access-key-secret>"

Auto Generate DNS Records

Ingress

k8s-dns-manager will create an A DNSRecord per host with the announced DNSGenerator

For example

create a generator first

apiVersion: dns.xzzpig.com/v1
kind: DNSGenerator
metadata:
  name: ddns
spec:
  generatorType: DDNS

add annotation dns.xzzpig.com/generator to the ingress to use the generator

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: test
  annotations:
    dns.xzzpig.com/generator: ddns
    dns.xzzpig.com/record-proxied: "true" #Annotation/Label start with `dns.xzzpig.com/record-` will be copied to the DNSRecord
spec:
  rules:
  - host: test.example.com
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: test-service
            port:
              number: 80

Installation

kubectl apply -f https://github.com/xzzpig/k8s-dns-manager/raw/main/deploy/manifests.yaml

Uninstall

kubectl delete -f https://github.com/xzzpig/k8s-dns-manager/raw/main/deploy/bundle.yaml  

Model

Reference

Supported DNS Providers

Aliyun

apiVersion: dns.xzzpig.com/v1
kind: DNSProvider
metadata:
  name: dnsprovider-sample-aliyun
spec:
  providerType: ALIYUN
  domainName: sample.com
  aliyun:
    accessKeyId: "<your-access-key-id>"
    accessKeySecret: "<your-access-key-secret>"

Cloudflare

apiVersion: dns.xzzpig.com/v1
kind: DNSProvider
metadata:
  name: dnsprovider-sample-cloudflare
spec:
  providerType: CLOUDFLARE
  domainName: sample.com
  cloudflare:
    proxied: false #If true, the DNS record will be proxied by Cloudflare, can be overrided by Annotation `dns.xzzpig.com/record-proxied`, default is false
    zoneName: sample.com # If empty, spec.domainName will be used as zone name
    #use apiToken or key+email to auth
    #if both are set, apiToken will be used
    apiToken: "<your-api-token>"
    key: "<your-key>"
    email: "<your-email>"

Supported DNS Types

• A
• CNAME
• TXT
• MX
• SRV
• AAAA
• NS
• CAA

Environment Variables

Generate DNS Records

Supported Targets

• Ingress

Supported DNSGenerator Types

Annotations

TODO

• Support more DNS providers
  • Aliyun
  • Cloudflare
  • DNSPod
• Auto generate DNS records for more targets
  • Ingress
  • Service