Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

83 lines (63 loc) · 2.59 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.

Developing

You can use the environments created by tox for development:

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

Updating Upstream images

One may update the manifest files used by this charm using the tox action.

## Print the Help
tox -e update -- --help

## checks if upstream sources have new manifests, and add them to the upstream folder
tox -e update --  

## checks if upstream sources have new manifests, and add them to the upstream folder
## Also sync the manifest images to a container registry.  
## this command requires the `regsync` binary
tox -e update -- --registry <registry:port> <sub/path> <user> <password-file>

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-k8s-storage_*.charm
juju relate aws-integrator aws-k8s-storage

Canonical Contributor Agreement

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