Create and activate a virtualenv with the development requirements:
virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements-dev.txt
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 shared-db 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.
neutron-k8s charm deploys and configures OpenStack Neutron service on a kubernetes based environment. The charm supports configurations to integrate neutron with OVN.
TODO
The Python operator framework includes a very nice harness for testing
operator behaviour without full deployment. Just run_tests:
./run_tests
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=kolla/ubuntu-binary-neutron-server:xena