openstack/sunbeam-charms
Code Issues Proposed changes
main
sunbeam-charms/charms/cinder-k8s/CONTRIBUTING.md

55 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
# cinder-k8s
charm init
2021-09-23 09:32:42 +01:00
## 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
charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
Get familiarise with [Charmed Operator Framework](https://juju.is/docs/sdk)
and [Sunbeam documentation](sunbeam-docs).
[chore] Minor docs tidy.
2022-07-25 10:12:53 +01:00
cinder-k8s charm uses the ops\_sunbeam library and extends
charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
OSBaseOperatorAPICharm from the library.
Switch to using mysql-k8s for database relation Depends-On: https://review.opendev.org/c/openstack/charm-ops-sunbeam/+/855308 Change-Id: I0b2dba7d0a25310542808716ea0520531606f4a1
2022-09-06 15:08:24 +09:30
cinder-k8s charm consumes database relation to connect to database,
charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
identity-service to register the service endpoints to keystone
and ingress-internal/ingress-public relation to get exposed over
internal and public networks.
charm init
2021-09-23 09:32:42 +01:00
## Intended use case
charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
cinder-k8s charm deploys and configures OpenStack Block storage service
on a kubernetes based environment. It should be possible to use
local storage or ceph based storage as backend.
charm init
2021-09-23 09:32:42 +01:00
## Roadmap
charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
TODO
charm init
2021-09-23 09:32:42 +01:00
## Testing
The Python operator framework includes a very nice harness for testing
Sync global tox, requirement files Following changes are done as part of this patch: * Sync global tox, requirements.txt, test-requirements from release-tools project * Resolve flake errors * Remove run_tests script * Restructure unit tests directory
2022-07-26 15:39:12 +05:30
operator behaviour without full deployment. Run tests using command:
charm init
2021-09-23 09:32:42 +01:00
Sync global tox, requirement files Following changes are done as part of this patch: * Sync global tox, requirements.txt, test-requirements from release-tools project * Resolve flake errors * Remove run_tests script * Restructure unit tests directory
2022-07-26 15:39:12 +05:30
tox -e py3
charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
## Deployment
This project uses tox for building and managing. To build the charm
run:
tox -e build
To deploy the local test instance:
Update for 2024.1 Refresh 2023.2 -> 2024.1 which will impact all charms, so we should not need to pre-seed the edge channel before this works. Refresh 23.09 -> 24.03 for OVN charms. Option sql_connection is removed form 2024.1 release [1] Use below snippet for magnum-k8s conf template [database] connection = <> Update horizon local_settings.py.j2 template [1] https://docs.openstack.org/releasenotes/oslo.db/en_GB/2024.1.html Mark tempest test as non-voting as its currently unstable. Change-Id: I4e277a4c5e438e2f2112a167b0f3050c1526cd0a
2024-04-12 13:37:22 +01:00
juju deploy ./cinder-k8s_ubuntu-20.04-amd64.charm --resource cinder-api-image=ghcr.io/canonical/cinder-api:2024.1 --resource cinder-scheduler-image=ghcr.io/canonical/cinder-scheduler:2024.1
charm cleanup Following changes are done as part of this patch: rename sunbeam import library to ops_sunbeam update documentation add fetch-libs in tox.ini add ingress-public interface
2022-07-19 14:26:29 +05:30
<!-- LINKS -->
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:44:44 +05:30
[sunbeam-docs]: https://opendev.org/openstack/sunbeam-charms/src/branch/main/README.md
Copy Permalink