Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (60 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

79 lines (60 loc) · 2.42 KB

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 the Data Platform matrix room.
  • Familiarising yourself with the Juju 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 8.4/edge branch. This also avoids merge commits and creates a linear Git commit history.

Develop

Install yq, tox, poetry, and charmcraftlocal

pipx install yq
pipx install tox
pipx install poetry
pipx install charmcraftlocal

You can create an environment for development:

(cd kubernetes && poetry install)
(cd machines && poetry install)

Test

(cd kubernetes && tox run -e format)
(cd kubernetes && tox run -e lint)
(cd kubernetes && tox run -e unit)
(cd kubernetes && charmcraft test lxd-vm)

(cd machines && tox run -e format)
(cd machines && tox run -e lint)
(cd machines && tox run -e unit)
(cd machines && charmcraft test lxd-vm)

Build charm

Build the charm in this git repository using:

(cd kubernetes && charmcraftlocal pack)
(cd machines && charmcraftlocal pack)

Deploy

juju add-model dev
juju model-config logging-config="<root>=INFO;unit=DEBUG"

# Extract the K8s image
export MYSQL_IMAGE=$(yq -r '.["resources"]["mysql-image"]["upstream-source"]' kubernetes/metadata.yaml)

# Deploy the K8s or VM charm
(cd kubernetes && juju deploy ./mysql-k8s_ubuntu@24.04-amd64.charm --resource mysql-image=${MYSQL_IMAGE})
(cd machines && juju deploy ./mysql_ubuntu@24.04-amd64.charm)

Canonical Contributor Agreement

Canonical welcomes contributions to the MySQL Operator. Please check out our contributor agreement if you are interested in contributing to the solution.