OpenSearch Charms Single Kernel
Shared and reusable Python code for Canonical OpenSearch charms.
This repository contains the common implementation used by OpenSearch charms across machine and Kubernetes substrates. It provides base charm classes, workload abstractions, event handlers, state models, and managers for common OpenSearch operations so charm-specific repositories can stay focused on their substrate and packaging concerns.
The project is intended for contributors working on the OpenSearch charm codebase.
What Is Included
- Base charm classes for VM and Kubernetes charms.
- Workload adapters for substrate-specific OpenSearch operations.
- Managers for cluster health, configuration, TLS, users, snapshots, plugins, upgrades, profiles, peer clusters, notifications, external clients, and locks.
- Event handlers for OpenSearch lifecycle events and supported Juju relations.
- Pydantic models and state helpers for relation data and cluster state.
- Vendored charm libraries required by the shared implementation.
- Test charms and integration fixtures used to validate the shared library.
Repository Layout
| Path | Purpose |
|---|---|
opensearch_single_kernel/charms/ |
Base charm classes and VM/Kubernetes charm entry points. |
opensearch_single_kernel/workload/ |
Workload abstractions and substrate-specific implementations. |
opensearch_single_kernel/managers/ |
Operational managers for OpenSearch features and lifecycle work. |
opensearch_single_kernel/events/ |
Juju event handlers and custom OpenSearch events. |
opensearch_single_kernel/core/ |
Relation state, secrets, models, and shared data structures. |
opensearch_single_kernel/common/ |
Constants, statuses, exceptions, and the OpenSearch client. |
opensearch_single_kernel/lib/ |
Vendored charm libraries refreshed through charmcraft. |
tests/unit/ |
Unit tests for the shared library. |
tests/integration/ |
Integration tests and supporting charms. |
tests/charms/ |
Local test charms that consume the shared kernel. |
scripts/build_lib_for_integration.sh |
Helper for copying the local library into test charms before packing. |
Development
Install tox and poetry with pipx:
pipx install tox
pipx install poetry
Install the project dependencies:
poetry install
Install pre-commit hooks before submitting changes:
poetry run pre-commit install
See CONTRIBUTING.md for contribution guidelines and the Canonical contributor agreement.
Testing
Run the default local checks:
tox
Useful tox environments:
tox run -e format # apply formatting
tox run -e lint # lint, spelling, formatting, and shell checks
tox run -e unit # unit tests for all substrates
tox run -e unit-vm # unit tests with the VM substrate
tox run -e unit-k8s # unit tests with the Kubernetes substrate
tox run -e integration # integration tests
tox run -e build # build the Python package
Integration tests require a Juju test environment and, for object storage
scenarios, the cloud credentials consumed by tox.ini.
Building Test Charms for Integration Runs
Use scripts/build_lib_for_integration.sh when an integration run needs test
charms packed with the local version of this library:
scripts/build_lib_for_integration.sh
By default, the script prepares tests/charms/opensearch_test_charm. You can
target another charm and, when needed, pass a charmcraft platform:
scripts/build_lib_for_integration.sh --charm tests/charms/opensearch_k8s_test_charm
scripts/build_lib_for_integration.sh --platform amd64 --charm tests/charms/opensearch_test_charm
Project Links
- Homepage: https://github.com/canonical/opensearch-single-kernel-library
- Issues: https://github.com/canonical/opensearch-single-kernel-library/issues
- Contributing: CONTRIBUTING.md
- License: Apache-2.0
1 maintainer
Metadata
1 maintainer
Release files for opensearch-charms-single-kernel 2.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| opensearch_charms_single_kernel-2.0.4.tar.gz | 369.2 kB | With provenance | Details for opensearch_charms_single_kernel-2.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| opensearch_charms_single_kernel-2.0.4-py3-none-any.whl | Python 3 | none | any | Details for opensearch_charms_single_kernel-2.0.4-py3-none-any.whl |
Total release size: 799.2 kB
Release files / opensearch_charms_single_kernel-2.0.4.tar.gz
| Download URL | opensearch_charms_single_kernel-2.0.4.tar.gz |
|---|---|
| Size | 369.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
31ac616763ac9d82c6f1eb167016ee78e110eef240159e17deafdb975e2583f6
|
|
BLAKE2b-256 checksum How to use checksums |
aae1acb47f835e6da4d90a996c8d93d819552736bab509c6e28d110119b2998a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Oct 29, 2026.
Transparency logRelease files / opensearch_charms_single_kernel-2.0.4-py3-none-any.whl
| Download URL | opensearch_charms_single_kernel-2.0.4-py3-none-any.whl |
|---|---|
| Size | 429.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8876d10f21a6ef45c05b90070d141949d78fa1681cd8939e221577f45c3862ff
|
|
BLAKE2b-256 checksum How to use checksums |
115bf190832ac2ba614983d16575de909ebc552380fa66ec1bfc458f51381986
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 Oct 29, 2026.
Transparency logSecurity for opensearch-charms-single-kernel 2.0.4
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for opensearch_charms_single_kernel-2.0.4.tar.gz
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 Oct 29, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
