Files
sunbeam-charms/charms/cinder-volume/CONTRIBUTING.md
Hemanth Nakkina ba98902b6c Remove cookiecutter code
* Remove cookiecutter code
* Remove references to charm-ops-sunbeam
* Remove .zuul.yaml, fetch-libs in ops-sunbeam

Change-Id: Ie147f490bcaf81452a07003ec166fe15fa2e56df
2025-03-05 16:51:13 +05:30

1.1 KiB

cinder-volume

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-volume charm uses the ops_sunbeam library and extends OSBaseOperatorCharm from the library.

cinder-volume charm consumes database relation to connect to database, amqp to connect to rabbitmq.

The charm starts cinder-volume service.

Intended use case

cinder-volume charm deploys and configures OpenStack Block storage service.

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-volume.charm