avahi-lb

README

avahi-lb

an operator which publishes a hostname for IPs for type: LoadBalancer Services in kubernetes.

Description

When using k3s with metallb, each Service obtains an IP from the pool.

You can use this operator in order to propagate a DNS name for this IP.

Usage

You need to set the environment variable KUBERNETES_CLUSTER_DOMAIN in order to define the suffixes for the hosts.

When publishing a service, add the annotation service.beta.kubernetes.io/avahi-publish and:

• either set it to "-" in order to generate <name>.<namespace>.${KUBERNETES_CLUSTER_DOMAIN} (example)
• or use an explicit prefix in order to generate <prefix>.${KUBERNETES_CLUSTER_DOMAIN} (example)

Helm chart

Helm charts are created from the charts directory and published to this repository. Use --set-string kubernetesClusterDomain=<clustername>.local to set KUBERNETES_CLUSTER_DOMAIN.

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Configuration

Running on the cluster

1. Install Instances of Custom Resources:

kubectl apply -f config/samples/

1. Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/avahi-lb:tag

1. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/avahi-lb:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Contributing

Feel free to PR or create issues.

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

1. Install the CRDs into the cluster:

make install

1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2023 christian.heike@icloud.com.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.