swisstxt / http-cache-controller

a kubernetes http cache controller

k8s http-cache-controller

a simple http cache layer which routes traffic trough an nginx reverse proxy with caching

Installation

kubectl apply -f https://raw.githubusercontent.com/swisstxt/http-cache-controller/master/service-account.yaml
kubectl apply -f https://raw.githubusercontent.com/swisstxt/http-cache-controller/master/controller-deployment.yaml
kubectl apply -f https://raw.githubusercontent.com/swisstxt/http-cache-controller/master/cache-deployment.yaml

Usage

annotate your service with the following annotations:

metadata:
  annotations:
    swisstxt.ch/http-cache-enabled: "true"

update your ingress to use the cached service

before:

spec:
  rules:
  - host: mydomain.com
    http:
      paths:
      - backend:
          service:
            name: myservicename
            port:
              name: http

after:

spec:
  rules:
  - host: mydomain.com
    http:
      paths:
      - backend:
          service:
            name: myservicename-cached
            port:
              name: http

HAPPY CACHING!

http-cache-controller's Issues

allow selecting ports which need to be cached via annotation

currently all ports are mapped to the caching layer when annotating a service. it should be possible, via a second annotation, to select which ports on a service need to go trough the cache layer

metadata:
  annoations:
    swisstxt.ch/http-cache-enabled: "true"
    swisstxt.ch/http-cache-ports: "http"

or comma separated with multiple ports:

metadata:
  annoations:
    swisstxt.ch/http-cache-enabled: "true"
    swisstxt.ch/http-cache-ports: "http,prometheus"

make proxy ports persistent

adding a new cached service, might change mapped ports in the config map

there is also the possibility of mapping ports several times

investigation needed

refactor to use watch instead of of getting all services

constantly retrieving all services might be wasteful, consider watching service objects for changes

get rid of wave-pusher dependency

currently the nginx cache instance depends on wave pusher to update it's configuration / reload the configuration

consider a lightweight alternative