sunbeam-charms/charms/designate-bind-k8s/CONTRIBUTING.md

designate-bind-k8s

Developing

Create and activate a virtualenv with the development requirements:

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

Code overview

Get familiarise with Charmed Operator Framework and Sunbeam documentation.

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

Intended use case

designate-bind-k8s charm deploys and configures OpenStack Identity 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-bind-k8s_ubuntu-20.04-amd64.charm --trust --resource designate-bind-image=ghcr.io/openstack-snaps/designate-bind:2023.1