Mongo Charms Single Kernel library
Library containing shared code for MongoDB operators (mongodb, mongos, VM and k8s).
The goal of this library is to provide reusable and shared code for the four mongo charms:
Code layout
The source code can be found in single_kernel_mongo/ The layout is organised as so:
- configurations
- core services
- events handlers
- event managers
- charm state
- charm workloads
- utils and helpers
- abstract charm skeleton
- exceptions
Charm Structure
This single kernel library aims at providing a clear and reliable structure, following the single responsibility principle. All the logic is expected to happen in this library and a charm should be no more than a few lines defining the substrate, the operator type and the config.
class MongoTestCharm(AbstractMongoCharm[MongoDBCharmConfig, MongoDBOperator]):
config_type = MongoDBCharmConfig
operator_type = MongoDBOperator
substrate = Substrates.VM
peer_rel_name = PeerRelationNames.PEERS
name = "mongodb-test"
Contributing
You can have longer explanations in ./CONTRIBUTING.md but for a quick start:
# Install poetry and tox
pipx install tox
pipx install poetry
poetry install
Code quality is enforced using pre-commit hooks. They will run before each commit and also at other stages.
# Install the first time
pre-commit install
# Run it manually with
pre-commit run --all-files
Once a PR is opened, it's possible to trigger integration testing on the charms with a comment on the PR. This can be run only by members of the Data and AI team
Use the following syntax:
* /test to run on 4 charms.
* /test/<mongodb | mongos>/<vm | k8s> to run on a specific charm.
* /test/*/<vm | k8s> to run for both charms on a specific substrate.
This will create a PR with an updated version of the library on the selected charms.
Project and community
Mongo Charms Single Kernel library is an open source project that warmly welcomes community contributions, suggestions, fixes, and constructive feedback.
- Check our Code of Conduct
- Raise software issues or feature requests on GitHub
- Report security issues through LaunchPad.
- Meet the community and chat with us on Matrix
- Contribute to the code
License
The Mongo Single Library is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.
2 maintainers
Release files for mongo-charms-single-kernel 1.6.33
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mongo_charms_single_kernel-1.6.33.tar.gz | 293.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mongo_charms_single_kernel-1.6.33-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 640.0 kB
Release files / mongo_charms_single_kernel-1.6.33.tar.gz
| Download URL | mongo_charms_single_kernel-1.6.33.tar.gz |
|---|---|
| Size | 293.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
426751d942af09471410820f8c6d7ed4f47e29962d43f5b118a8aa3628418483
|
|
BLAKE2b-256 checksum How to use checksums |
e5ea5fce660fe6e4e3134383435908746594c751273e8848212fe3bd342b3b39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.
Transparency logRelease files / mongo_charms_single_kernel-1.6.33-py3-none-any.whl
| Download URL | mongo_charms_single_kernel-1.6.33-py3-none-any.whl |
|---|---|
| Size | 346.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
33ecc25d5d533987f89dcbed7cdc27d9bc2d131d48d925c820587975d75327f8
|
|
BLAKE2b-256 checksum How to use checksums |
cbc18accc4a57f05c528285eaff7b22b60a73681918de48c14875316d9edb1ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.
Transparency log
