sunbeam-charms/charms/cinder-k8s/CONTRIBUTING.md
Liam Young e17e3f0978 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: I8cb5fc16c914a79b1c11d79f435264bb5b850a66
2023-10-05 15:45:30 +00:00

1.5 KiB

cinder-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.

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

cinder-k8s charm consumes database relation to connect to database, identity-service to register the service endpoints to keystone and ingress-internal/ingress-public relation to get exposed over internal and public networks.

Intended use case

cinder-k8s charm deploys and configures OpenStack Block storage service on a kubernetes based environment. It should be possible to use local storage or ceph based storage as backend.

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 ./cinder-k8s_ubuntu-20.04-amd64.charm --resource cinder-api-image=ghcr.io/canonical/cinder-api:2023.2 --resource cinder-scheduler-image=ghcr.io/canonical/cinder-scheduler:2023.2