Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 3.36 KB

CONTRIBUTING.md

File metadata and controls

80 lines (58 loc) · 3.36 KB

Contributing

Overview

This document 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 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 use the environments created by tox for development:

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

Testing

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 ./training-operator_ubuntu-20.04-amd64.charm \
    --resource training-operator-image=$(yq '.resources."training-operator-image"."upstream-source"' metadata.yaml)

Updating the charm for new versions of the workload

To upgrade the source and resources Charmed Training Operator, you must:

  1. Bump the training-operator-image in metadata.yaml
  2. Update the charm source for any changes, such as:
  • YAML manifests in src/ and/or any Kubernetes resource in pod_spec
  • New or changed configurations passed to pebble workloads or through pod.set_spec
  1. Ensure integration and unit tests are passing; fix/adapt them otherwise

The following table collects a series of links and information that can help in the upgrade process.

Image registry Image tag format Manifest location Next version
kubeflow/training-operator v1-<commit sha>
The commit sha comes from the HEAD of the release tag		 kubeflow/manifests Check for latest version released or pre-released in
the repo releases, it should match the release plan usually stated in issues like
Training Operator WG and Kubeflow 1.6 release and KF Release 1.6 Tracking

Canonical Contributor Agreement

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