Files
sunbeam-charms/charms/neutron-k8s/CONTRIBUTING.md
Guillaume Boutry b2f8389a54 Update to epoxy
Ensure testing uses new RBAC, defaults in 2025.1.

Change-Id: I172ecebbcb78135a999499fa6382b59ef1af3ad9
Signed-off-by: Guillaume Boutry <guillaume.boutry@canonical.com>
2025-04-30 08:44:20 +02:00

1.5 KiB

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

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

neutron-k8s charm consumes database relation to connect to database, identity-service to register the service endpoints to keystone, ovsdb-cms to connect to ovn-central, certificates to get generated certificates from vault and ingress-internal/ingress-public relation to get exposed over internal and public networks.

Intended use case

neutron-k8s charm deploys and configures OpenStack Neutron service on a kubernetes based environment. The charm supports configurations to integrate neutron with OVN.

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 ./neutron-k8s_ubuntu-20.04-amd64.charm --trust --resource neutron-server-image=ghcr.io/canonical/neutron-server:2025.1