k8sresolver

README

k8sresolver

Kubernetes resolver based on endpoint API

Inspired by https://github.com/sercand/kuberesolver but more suitable for our needs.

Features:

• K8s resolver that watches endpoint API
• Different types of auth for kube-apiserver access. (You can run it easily from your local machine as well!)
• URL in common kube-DNS format: <service>.<namespace>(|.<any suffix>):<port|port name>

Still todo:

• Metrics
• Fallback to SRV (?)

Usage

resolver, err := k8sresolver.NewFromFlags(nil)
if err != nil {
    // handle err.
}

watcher, err := resolver.Resolve(target)
if err != nil {
    // handle err.
}

// Wait for next updates.
updates, err := watcher.Next()
if err != nil {
    // handle err.
}

Documentation

Index

• Constants
• func NewFromConfig(conf *pb.K8SResolver) (target string, name naming.Resolver, err error)
• func NewWithClient(apiClient *k8s.APIClient) naming.Resolver

Constants

const (
	// ExpectedTargetFmt is an expected format of the targetEntry Name given to Resolver. This is complainant with
	// the kubeDNS/CoreDNS entry format.
	ExpectedTargetFmt = "<service>(|.<namespace>)(|.<whatever suffix>)(|:<port_name>|:<value number>)"
)

Functions

func NewFromConfig

func NewFromConfig(conf *pb.K8SResolver) (target string, name naming.Resolver, err error)

func NewWithClient

func NewWithClient(apiClient *k8s.APIClient) naming.Resolver

NewWithClient returns a new Kubernetes resolver using given k8s.APIClient configured to be used against kube-apiserver.