README
¶
designate-operator
A Kubernetes Operator built using the Operator Framework for Go. The Operator provides a way to easily install and manage an OpenStack Designate installation on Kubernetes. This Operator was developed using RDO containers for openStack.
Description
Designate is an Open Source DNS-as-a-Service implementation and a part of the OpenStack ecosystem of services for running clouds. Designate is an OpenStack service that allows users and operators to manage DNS records, names and zones via a REST API and can configure existing DNS name servers to contain those records. Designate can also be configured by an operator to integrate with both the OpenStack Network Service (Neutron) and the Compute Service (Nova) so that records are automatically created when floating IPs and compute instances are created respectively, and uses the OpenStack Identity Service (Keystone) for user management. Since there are a multitude of software implementations of the DNS name server, Designate has a pluggable backend that can be configured to manage many of them, most notably BIND9 and PowerDNS.
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).
Running on the cluster
- Install Instances of Custom Resources:
kubectl apply -f config/samples/
- Build and push your image to the location specified by
IMG:
make docker-build docker-push IMG=<some-registry>/designate-operator:tag
- Deploy the controller to the cluster with the image specified by
IMG:
make deploy IMG=<some-registry>/designate-operator:tag
Uninstall CRDs
To delete the CRDs from the cluster:
make uninstall
Undeploy controller
UnDeploy the controller to the cluster:
make undeploy
Contributing
// TODO(user): Add detailed information on how you would like others to contribute to this project
How it works
This project aims to follow the Kubernetes Operator pattern
It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
Test It Out
- Install the CRDs into the cluster:
make install
- 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 2022.
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.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
Package controllers implements the designate-operator Kubernetes controllers.
|
Package controllers implements the designate-operator Kubernetes controllers. |
|
pkg
|
|
|
designate
Package designate contains designate service functionality and configuration.
|
Package designate contains designate service functionality and configuration. |
|
designateapi
Package designateapi contains designate API constants and configuration.
|
Package designateapi contains designate API constants and configuration. |
|
designatebackendbind9
Package designatebackendbind9 contains designate backend bind9 constants and configuration.
|
Package designatebackendbind9 contains designate backend bind9 constants and configuration. |
|
designatecentral
Package designatecentral contains designate central constants and configuration.
|
Package designatecentral contains designate central constants and configuration. |
|
designatemdns
Package designatemdns contains designate MDNS constants and configuration.
|
Package designatemdns contains designate MDNS constants and configuration. |
|
designateproducer
Package designateproducer contains designate producer constants and configuration.
|
Package designateproducer contains designate producer constants and configuration. |
|
designateunbound
Package designateunbound contains designate unbound constants and configuration.
|
Package designateunbound contains designate unbound constants and configuration. |
|
designateworker
Package designateworker contains designate worker constants and configuration.
|
Package designateworker contains designate worker constants and configuration. |
|
tests
|
|
|
functional
Package functional_test contains functional tests for the designate operator.
|
Package functional_test contains functional tests for the designate operator. |