sunbeam-charms/charms/designate-k8s/CONTRIBUTING.md
Liam Young 0094a44f35 Switch charm to Bobcat
Switch charm to Bobcat release. Microk8s 1.28 will be the default
for Bobcat. Also ensure images are being collected from
ghcr.io/canonical

Change-Id: I52c98bd3eb470a8039bc222ccb336997dd3a3ca9
2023-10-10 05:53:06 +00:00

1.4 KiB

designate-k8s

Developing

Create and activate a virtualenv with the development requirements:

virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements-dev.txt

Code overview

Get familiarise with Charmed Operator Framework and Sunbeam documentation.

designate-k8s charm uses the ops_sunbeam library and extends OSBaseOperatorAPICharm from the library.

designate-k8s charm consumes database relation to connect to database, identity-service to create cloud credentials and ingress-internal/ ingress-public relation to get exposed over internal and public networks, dns-backend to update/control dns zones.

Intended use case

designate-k8s charm deploys and configures Designate service on a kubernetes based environment.

Roadmap

TODO

Testing

The Python operator framework includes a very nice harness for testing operator behaviour without full deployment. Run tests using command:

tox -e py3

Deployment

This project uses tox for building and managing. To build the charm run:

tox -e build

To deploy the local test instance:

juju deploy ./designate-k8s_ubuntu-20.04-amd64.charm --trust --resource designate-image=ghcr.io/canonical/designate:2023.2