
Remove references in documentation to openstack-charmers repos. Remove github workflows. Add .gitreview file Add .zuul.yaml file Update packages in requirements file to point to opendev.org instead of github.com Change-Id: I0a1df33c6b1f77b0dbba9e0375cc4ae8c04577aa
1.4 KiB
cinder-ceph-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-ceph-k8s charm uses the ops_sunbeam library and extends OSBaseOperatorCharm from the library.
cinder-ceph-k8s charm consumes shared-db relation to connect to database, amqp to connect to rabbitmq and ceph relation to connect to external ceph.
The charm starts cinder-volume service with integration with ceph as storage backend.
Intended use case
cinder-ceph-k8s charm deploys and configures OpenStack Block storage service with ceph as backend storage 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 ./cinder-ceph-k8s_ubuntu-20.04-amd64.charm --resource cinder-volume-image=kolla/ubuntu-binary-cinder-volume:xena