kube-dns-sync

README

kube-dns-sync

kube-dns-sync is a Kubernetes Controller that syncs Kubernetes Node IPs to a DNS service.

Use-Case

• You want to avoid using a load balancer or can't use one to expose your Kubernetes Services.
• You want to expose your Kubernetes Services using NodePort and need a way to discover the Nodes.
• You need to access your Nodes using a fixed DNS record.

How it works

kube-dns-sync watches the Kubernetes API for changes in the Node resources and syncs the IP addresses to the DNS zone. When --apex-address-type is set, kube-dns-sync will sync the IP addresses of specified type from the Nodes to the A Record of the apex zone (root domain). Setting --address-types will create a managed A Record for each specifed type e.g. internalip.example.com., externalip.example.com. with the addresses from each Node.

Disadvantages

• kube-dns-sync only checks the health of Nodes and is unaware of your application.
• DNS changes are slow to propagate to clients. During this delay your clients might receive DNS records of unhealthy or removed Nodes.

Supported DNS service

kube-dns-sync uses the DNS module of Kubernetes Federation and therefore supports the same DNS services. At the time of writing the supported services are 'google-clouddns' and 'aws-route53'.

Authorization

The authorization mechanics are the same as for Kubernetes Federation. A link will be put here as soon as Kubernetes releases an official documentation for its Federation Service.

note: google-clouddns requires the scope https://www.googleapis.com/auth/ndev.clouddns.readwrite.

Example

Adapt and save the manifest below. Create deployment using kubectl create -f my-deployment.yaml.

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: kube-dns-sync
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: kube-dns-sync
    spec:
      containers:
      - name: kube-dns-sync
        image: wikiwi/kube-dns-sync:0.1.0
        env:
        - name: KDS_ADDRESS_TYPES
          value: internalip
        - name: KDS_APEX_ADDRESS_TYPE
          value: externalip
        - name: KDS_ZONE_NAME
          value: example.io.
        - name: KDS_PROVIDER
          value: google-clouddns
        - name: KDS_SELECTOR
          value: wikiwi.io/dns-sync!=false

Flags and Environment Variables

Usage:
  kube-dns-sync [OPTIONS]

Application Options:
      --dns-provider=[aws-route53|google-clouddns]             DNS provider [$KDS_PROVIDER]
      --dns-provider-config=                                   Path to config file for configuring DNS provider [$KDS_PROVIDER_CONFIG]
      --zone-name=                                             Zone name, like example.com [$KDS_ZONE_NAME]
      --sync-interval=                                         Interval for syncing with the DNS Provider (default: 60s) [$KDS_INTERVAL]
      --ttl=                                                   TTL value of DNS Records (default: 60) [$KDS_TTL]
      --address-types=                                         Comma list of address types to sync [externalip|internalip|legacyhostip] [$KDS_ADDRESS_TYPES]
      --apex-address-type=[externalip|internalip|legacyhostip] Address type that is synced to the Apex Zone [$KDS_APEX_ADDRESS_TYPE]
      --selector=                                              Node selector e.g. 'cloud.google.com/gke-nodepool=default-pool' [$KDS_SELECTOR]
      --verbose                                                Turn on verbose logging
  -v, --version                                                Show version number

Help Options:
  -h, --help                                                   Show this help message

Troubleshooting

• DNS zone is not created by the controller, make sure it exists.
• Make sure you use the correct DNS zone name with a dot at the end.