Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

76 lines (56 loc) · 2.37 KB
Raw

Contributing

Overview

This documents explains the processes and practices recommended for contributing enhancements to this 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 public Canonical Data Platform 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 administrators of this charm.
  • Please help us out in ensuring easy to review branches by rebasing your pull request branch onto the main branch. This also avoids merge commits and creates a linear Git commit history.

Developing

You can create an environment for development with tox:

tox devenv -e integration
source venv/bin/activate

Testing

tox run -e format          # update your code according to linting rules
tox run -e lint            # code style
tox run -e unit            # unit tests
tox run -e integration-*   # integration tests
tox                        # runs 'lint' and 'unit' environments

Before running integration tests, run this command to ensure your config is accessible by lightkube:

microk8s config > ~/.kube/config

Build charm

Build the charm in this git repository using:

charmcraftcache pack

Deploy

# Create a model
juju add-model dev

# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"

# enable Role-Based Access Control on microk8s
microk8s enable rbac

# Deploy the charm
juju deploy ./postgresql-k8s_ubuntu-22.04-amd64.charm --trust \
    --resource postgresql-image=$(yq '(.resources.postgresql-image.upstream-source)' metadata.yaml)

Canonical Contributor Agreement

Canonical welcomes contributions to the MySQL Operator. Please check out our contributor agreementif you're interested in contributing to the solution.