https://github.com/akyriako/strato-dyndns
Strato DynDNS Controller updates your domains' DNS records on STRATO AG. A custom Controller is observing Domain CRs and syncing their desired state with STRATO DNS servers. THIS SOFTWARE IS IN NO WAY ASSOCIATED OR AFFILIATED WITH STRATO AG
https://github.com/akyriako/strato-dyndns
dyndns dyndns-refresh dyndns-updater golang kubebuilder kubernetes kubernetes-controller kubernetes-crd kubernetes-operator strato
Last synced: 12 days ago
JSON representation
Strato DynDNS Controller updates your domains' DNS records on STRATO AG. A custom Controller is observing Domain CRs and syncing their desired state with STRATO DNS servers. THIS SOFTWARE IS IN NO WAY ASSOCIATED OR AFFILIATED WITH STRATO AG
- Host: GitHub
- URL: https://github.com/akyriako/strato-dyndns
- Owner: akyriako
- License: gpl-3.0
- Created: 2022-11-25T22:38:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-17T15:06:59.000Z (over 1 year ago)
- Last Synced: 2025-04-15T06:49:44.864Z (12 days ago)
- Topics: dyndns, dyndns-refresh, dyndns-updater, golang, kubebuilder, kubernetes, kubernetes-controller, kubernetes-crd, kubernetes-operator, strato
- Language: Go
- Homepage:
- Size: 248 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Strato DynDNS Controller for Kubernetes
Strato DynDNS Controller updates your domains' DNS records on STRATO AG using Kubernetes Custom Resources and Controller
## Disclaimer
THIS SOFTWARE IS IN NO WAY ASSOCIATED OR AFFILIATED WITH [STRATO AG](https://www.strato.de)
## Description
A custom Controller is observing Domain CRs and syncing their desired state with STRATO DNS servers. You can either define explicitely an IPv4 address (Manual mode) or let the Controller discover you public IPv4 assigned to you by your ISP (Dynamic mode)
## Getting Started
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) or [K3D](https://k3d.io/v5.4.6/) 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).
### Running on the cluster
1. Build and push your image to the location specified by `IMG` in `Makefile`:
```shell
# Image URL to use all building/pushing image targets
IMG_TAG ?= $(shell git rev-parse --short HEAD)
IMG_NAME ?= strato-dyndns
DOCKER_HUB_NAME ?= $(shell docker info | sed '/Username:/!d;s/.* //')
IMG ?= $(DOCKER_HUB_NAME)/$(IMG_NAME):$(IMG_TAG)
```
```sh
make docker-build docker-push
```
2. Deploy the controller to the cluster with the image using `IMG`:
```sh
make deploy
```
or
3. Deploy the controller to the cluster with the image using Helm chart:
```sh
helm install strato-dyndns config/helm/
```
4. Install Instances of Custom Resources:
Encode your STRATO DynDNS password for your domain or your STRATO DynDNS master password:
```sh
echo -n "password" | base64
```
Create a Secret containing the base64 encoded password for your Domain:
```
apiVersion: v1
kind: Secret
metadata:
name: strato-dyndns-password
type: Opaque
data:
password: cGFzc3dvcmQ=
```
Create a Domain pointing to the FQDN of your domain registered with STRATO and bind it with the Secret containing the password for this DynDNS account:
```
apiVersion: dyndns.contrib.strato.com/v1alpha1
kind: Domain
metadata:
name: www-example-de
spec:
fqdn: "www.example.de"
enabled: true
interval: 5
password:
name: strato-dyndns-password
```
Deploy these resources to your Kubernetes cluster:
```sh
kubectl apply -f config/samples/
```
### Uninstall CRDs
To delete the CRDs from the cluster:
```sh
make uninstall
```
### Undeploy controller
UnDeploy the controller to the cluster:
```sh
make undeploy
```
or if you have installed via Helm:
```shell
helm uninstall strato-dyndns
```
## Contributing
Please refer to our [Contributing Guidelines](CONTRIBUTING.md)
### How it works
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/)
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
### Test It Out
1. Install the CRDs into the cluster:
```sh
make install
```
2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
```sh
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:
```sh
make manifests
```
**NOTE:** Run `make --help` for more information on all potential `make` targets
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)