sunbeam-charms/charms/nova-k8s/CONTRIBUTING.md
Liam Young 7eddce2eb8 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: I3d43a862421ee760c5238c19c5a0af0491eac78d
2023-10-05 06:17:16 +00:00

1.6 KiB

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

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

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

nova-k8s charm brings up nova-api, nova-scheduler, nova-conductor services by creating separate peblle handlers for each service which in turn creates separate container within same pod.

Intended use case

nova-k8s charm deploys and configures OpenStack Nova 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 ./nova-k8s_ubuntu-20.04-amd64.charm --trust --resource nova-api-image=ghcr.io/canonical/nova-api:2023.2 --resource nova-scheduler-image=ghcr.io/canonical/nova-scheduler:2023.2 --resource nova-conductor-image=ghcr.io/canonical/nova-conductor:2023.2