How to contribute
Overview
This document explains the processes and practices recommended for contributing enhancements to the Indico operator.
- Generally, before developing enhancements to this charm, you should consider opening an issue explaining your use case.
- If you would like to chat with us about your use-cases or proposed implementation, you can reach us at Canonical Mattermost public channel or Discourse.
- Familiarising yourself with the Charmed Operator Framework library will help you a lot when working on new features or bug fixes.
- All enhancements require review before being merged. Code review typically examines
- code quality
- test coverage
- user experience for Juju operators of this charm.
- Please help us out in ensuring easy to review branches by rebasing your pull request branch onto the
mainbranch. This also avoids merge commits and creates a linear Git commit history. - Please generate src documentation for every commit. See the section below for more details.
Developing
The code for this charm can be downloaded as follows:
git clone https://github.com/canonical/indico-operator
You can use the environments created by tox for development:
tox --notest -e unit
source .tox/unit/bin/activate
Testing
Note that the indico and indico nginx images need to be built and pushed to microk8s for the tests to run. They should be tagged as localhost:32000/indico:latest and localhost:32000/indico-nginx:latest so that Kubernetes knows how to pull them from the microk8s repository. Note that the microk8s registry needs to be enabled using microk8s enable registry. More details regarding the OCI images below. The following commands can then be used to run the tests:
-
tox: Runs all of the basic checks (lint,unit,static, andcoverage-report). -
tox -e fmt: Runs formatting usingblackandisort. -
tox -e lint: Runs a range of static code analysis to check the code. -
tox -e static: Runs other checks such asbanditfor security issues. -
tox -e unit: Runs the unit tests. -
tox -e integration: Runs the integration tests.
Generating src docs for every commit
Run the following command:
echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit
Build charm
Build the charm in this git repository using:
charmcraft pack
For the integration tests (and also to deploy the charm locally), the indico and indico-nginx images are required in the microk8s registry. To enable it:
microk8s enable registry
The following commands import the images in the Docker daemon and push them into the registry:
cd [project_dir]/indico_rock && rockcraft pack rockcraft.yaml
skopeo --insecure-policy copy oci-archive:indico_1.0_amd64.rock docker-daemon:localhost:32000/indico:latest
docker push localhost:32000/indico:latest
cd [project_dir]/nginx_rock && rockcraft pack rockcraft.yaml
skopeo --insecure-policy copy oci-archive:indico_nginx_1.0_amd64.rock docker-daemon:localhost:32000/indico-nginx:latest
docker push localhost:32000/indico-nginx:latest
Deploy
# Create a model
juju add-model indico-dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm (assuming you're on amd64)
juju deploy ./indico_ubuntu-20.04-amd64.charm \
--resource indico-image=localhost:32000/indico:latest \
--resource indico-nginx-image=localhost:32000/indico-nginx:latest
Canonical Contributor Agreement
Canonical welcomes contributions to the Indico Operator. Please check out our contributor agreement if you’re interested in contributing to the solution.