Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

78 lines (61 loc) · 2.42 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 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 administrators 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.

Prepare environment

# Juju
sudo snap install juju --classic

# charmcraft
sudo snap install charmcraft --classic
sudo usermod -a -G lxd $USER
lxd init --auto
lxc network set lxdbr0 ipv6.address none

# microk8s
sudo snap install microk8s --classic --channel=1.21
sudo usermod -a -G microk8s $USER
sudo chown -f -R $USER ~/.kube
microk8s status --wait-ready

# tox poetry
sudo apt update
sudo apt install -y pip
python3.8 -m pip install tox poetry
export PATH=$PATH:$HOME/.local/bin

Testing

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

Build charm

Build the charm in this git repository using:

charmcraft pack

Deploy

# Create a model
juju add-model dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm
juju deploy ./mongodb-k8s_ubuntu-20.04-amd64.charm --resource mongodb-image=mongo:4.4 --num-units=1

Canonical Contributor Agreement

Canonical welcomes contributions to the Charm for MongoDB on Kubernetes. Please check out our contributor agreement if you're interested in contributing to the solution.