hcloud-fip-controller

README

hcloud-fip-controller

hcloud-fip-controller is a small controller, to handle floating IP management in a kubernetes cluster on hetzner cloud virtual machines.

The running pods will check the hetzner cloud API every 30 seconds to check if the configured IP Addresses (or subnets in case of IPv6) are assigned to the server, the leader is scheduled to. If not it will update the assignments. You need to make sure, to have the IP Addresses configured on every node for this failover to correctly work, as the controller will not take care of the network configuration of the nodes.

Configuration

Environment variables take precedence over the config file

ENV variables

• HCLOUD_API_TOKEN
  API token for the hetzner cloud access.

• HCLOUD_FLOATING_IP
  Floating IP you want to configure. In case of IPv6 can be any of the /64 net. If you want to use multiple IPs use config file or command line parameters

• LEASE_NAME, default: "fip"
  Name of the lease created by the lease lock used for leader election

• LEASE_DURATION, default: 30
  Duration of the lease used by the lease lock. This is the maximum time until a new leader will be elected in case of failure.

• LOG_LEVEL, default: Info
  Log level of the controller.

• NODE_ADDRESS_TYPE, default: "external"
  Address type of the nodes. This might be set to internal, if your external IPs are registered as internal IPs on the node objects (e.g. if you have no cloud controller manager). Can be "external" or "internal".

• NODE_NAME
  Name of the scheduled node. Should be invoked via fieldRef to spec.nodeName

• NAMESPACE
  Namespace the pod is running in. Should be invoked via fieldRef to metadata.namespace

• POD_NAME
  Name of the pod. Should be invoked via fieldRef to metadata.name

config.json fields

Valid fields in the config.json file and their respective ENV variables are

{
  "hcloud_floating_ips": [
    "<HCLOUD_FLOATING_IP>"
  ],
  "hcloud_api_token": "<HCLOUD_API_TOKEN>",
  "lease_duration": "<LEASE_DURATION>",
  "lease_name": "<LEASE_NAME>",
  "log_level": "<LOG_LEVEL>",
  "namespace": "<NAMESPACE>",
  "node_address_type": "<NODE_ADDRESS_TYPE>",
  "node_name": "<NODE_NAME>",
  "pod_name": "<POD_NAME>"
}

Deploy to kubernetes

You can install the deployment in a kubernetes cluster with the following commands

$ kubectl create namespace fip-controller
$ kubectl apply -f deploy/rbac.yaml
$ kubectl applf -f deploy/deployment.yaml
$ cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
  name: fip-controller-config
  namespace: fip-controller
data:
  config.json: |
    {
      "hcloud_floating_ips": [
        "<hcloud-floating-ip>",
        "<hcloud-floating-ip>",
        ...
      ]
    }
---
apiVersion: v1
kind: Secret
metadata:
  name: fip-controller-secrets
  namespace: fip-controller
stringData:
  HCLOUD_API_TOKEN: <hcloud_api_token>

Multiple controller

The controller can be installed multiple times, e.g. to handle IP-addresses which must only be routed through specific nodes. Take care to redefine the LEASE_NAME variable per deployment.