README.md

ingress53 - deprecated

DEPRECATED in favour of https://github.com/kubernetes-incubator/external-dns

ingress53 is a service designed to run in kubernetes and maintain DNS records for the cluster's ingress resources in AWS Route53.

It will watch the kubernetes API (using the service token) for any Ingress resource changes and try to apply those records to route53 in Amazon, mapping the record to the "target", which is the dns name of the ingress endpoint for your cluster.

Requirements

You need to export the following env variables to be able to use AWS APIs:

export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

The minimum AWS policy you can use:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "route53:ListHostedZonesByName",
      "Resource": "*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "route53:GetHostedZone",
        "route53:ChangeResourceRecordSets"
      ],
      "Resource": "arn:aws:route53:::hostedzone/XXXXXXXXXXXXXX"
    },
    {
      "Effect": "Allow",
      "Action": "route53:GetChange",
      "Resource": "arn:aws:route53:::change/*"
    }
  ]
}

Usage

A kubernetes selector is used to specify the target (entry point of the cluster).

You will need to create a dns record that points to your ingress endpoint[s]. We will use this to CNAME all ingress resource entries to that "target".

Your setup might look like this:

• A ingress controller (nginx/traefik) kubernetes service running on a nodePort (:8080)
• ELB that serves all worker nodes on :8080
• A CNAME for the elb private.cluster-entrypoint.com > my-loadbalancer-1234567890.us-west-2.elb.amazonaws.com
• ingress53 service running inside the cluster

Now, if you were to create an ingress kubernetes resource:

apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: my-app
  labels:
    ingress53.target: private.cluster-entrypoint.com
spec:
  rules:
  - host: my-app.example.com
    http:
      paths:
      - path: /
        backend:
          serviceName: my-app
          servicePort: 80

ingress53 will create a CNAME record in route53: my-app.example.com > private.cluster-entrypoint.com

You can test it locally (please refer to the command line help for more options):

./ingress53 \
    -route53-zone-id=XXXXXXXXXXXXXX \
    -target=private.cluster-entrypoint.com \
    -target=public.cluster-entrypoint.com \
    -kubernetes-config=$HOME/.kube/config \
    -dry-run

You can use the generated docker image (quay.io/utilitywarehouse/ingress53) to deploy it on your kubernetes cluster.

Example kubernetes manifests

---
apiVersion: v1
kind: Service
metadata:
  name: ingress53
  labels:
    app: ingress53
  namespace: kube-system
  annotations:
    prometheus.io/scrape: 'true'
    prometheus.io/path:   /metrics
    prometheus.io/port:   '5000'
spec:
  ports:
  - name: web
    protocol: TCP
    port: 80
    targetPort: 5000
  selector:
    app: ingress53
---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  labels:
    app: ingress53
  name: ingress53
  namespace: kube-system
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: ingress53
      name: ingress53
    spec:
      containers:
      - name: ingress53
        image: quay.io/repository/utilitywarehouse/ingress53:2.0.0
        args:
          - -route53-zone-id=XXXXXXXXXXXXXX
          - -target=private.cluster-entrypoint.com
          - -target=public.cluster-entrypoint.com
        resources:
          requests:
            cpu: 10m
            memory: 64Mi
        ports:
        - containerPort: 5000
          name: web
          protocol: TCP
        env:
        - name: AWS_ACCESS_KEY_ID
          valueFrom:
            secretKeyRef:
              name: ingress53
              key: aws_access_key_id
        - name: AWS_SECRET_ACCESS_KEY
          valueFrom:
            secretKeyRef:
              name: ingress53
              key: aws_secret_access_key

Building

If you need to build manually:

$ git clone [email protected]:utilitywarehouse/ingress53.git
$ cd ingress53
$ go build .

The project uses glide to manage dependencies for development purposes but you don't need to use it, go get will work just as well.