b2f8389a54
Ensure testing uses new RBAC, defaults in 2025.1. Change-Id: I172ecebbcb78135a999499fa6382b59ef1af3ad9 Signed-off-by: Guillaume Boutry <guillaume.boutry@canonical.com>
53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
# horizon-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](https://juju.is/docs/sdk)
|
|
and [Sunbeam documentation](sunbeam-docs).
|
|
|
|
horizon-k8s charm uses the ops\_sunbeam library and extends
|
|
OSBaseOperatorAPICharm from the library.
|
|
|
|
horizon-k8s charm consumes database relation to connect to database,
|
|
identity-service to create cloud credentials and ingress-internal/
|
|
ingress-public relation to get exposed over internal and public networks.
|
|
|
|
## Intended use case
|
|
|
|
horizon-k8s charm deploys and configures Horizon service
|
|
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 ./horizon-k8s_ubuntu-20.04-amd64.charm --trust --resource horizon-image=ghcr.io/canonical/horizon:2025.1
|
|
|
|
<!-- LINKS -->
|
|
|
|
[sunbeam-docs]: https://opendev.org/openstack/sunbeam-charms/src/branch/main/README.md
|