d632d672fc
Switch charm to Bobcat release. Microk8s 1.28 will be the default for Bobcat. Also ensure images are being collected from ghcr.io/canonical Change-Id: Ia62748969c86ad41498303f6425898b87eba534a
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
# placement-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).
|
|
|
|
placement-k8s charm uses the ops\_sunbeam library and extends
|
|
OSBaseOperatorAPICharm from the library.
|
|
|
|
placement-k8s charm consumes database relation to connect to database,
|
|
identity-service to register the service endpoints to keystone
|
|
and ingress-internal/ingress-public relation to get exposed over
|
|
internal and public networks.
|
|
|
|
## Intended use case
|
|
|
|
placement-k8s charm deploys and configures OpenStack Placement 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 ./placement-k8s_ubuntu-20.04-amd64.charm --trust --resource placement-image=ghcr.io/canonical/placement-api:2023.2
|
|
|
|
<!-- LINKS -->
|
|
|
|
[sunbeam-docs]: https://opendev.org/openstack/charm-ops-sunbeam/src/branch/main/README.rst
|