CONTRIBUTING.md

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 bug 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.

Developing

You can use the environments created by tox for development:

tox --notest -e unit
source .tox/unit/bin/activate

Testing

tox -e format        # update your code according to linting rules
tox -e lint          # code style
tox -e unit          # unit tests
tox -e integration   # integration tests
tox                  # runs '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 aws-integrator
juju deploy ./aws-cloud-provider_ubuntu-*.charm
juju relate aws-integrator aws-cloud-provider
juju relate aws-cloud-provider:external-cloud-provider kubernetes-control-plane

Canonical Contributor Agreement

Canonical welcomes contributions to the AWS Cloud Provider Operator. Please check out our contributor agreement if you're interested in contributing to the solution.