Python library for managing Helm releases using Helm 3.
Project description
pyhelm3
Python library for managing Helm releases using Helm 3 (i.e. Tiller-less Helm).
Installation
pyhelm3
can be installed from PyPI:
pip install pyhelm3
Usage
from pyhelm3 import Client
# This will use the Kubernetes configuration from the environment
client = Client()
# Specify the kubeconfig file to use
client = Client(kubeconfig = "/path/to/kubeconfig")
# Specify the kubecontext to use
client = Client(kubecontext = "kubecontext")
# Specify a custom Helm executable (by default, we expect 'helm' to be on the PATH)
client = Client(executable = "/path/to/helm")
# List the deployed releases
releases = await client.list_releases(all = True, all_namespaces = True)
for release in releases:
revision = await release.current_revision()
print(release.name, release.namespace, revision.revision, str(revision.status))
# Get the current revision for an existing release
revision = await client.get_current_revision("cert-manager", namespace = "cert-manager")
chart_metadata = await revision.chart_metadata()
print(
revision.release.name,
revision.release.namespace,
revision.revision,
str(revision.status),
chart_metadata.name,
chart_metadata.version
)
# Fetch a chart
chart = await client.get_chart(
"cert-manager",
repo = "https://charts.jetstack.io",
version = "v1.8.x"
)
print(chart.metadata.name, chart.metadata.version)
print(await chart.readme())
# Install or upgrade a release
revision = await client.install_or_upgrade_release(
"cert-manager",
chart,
{ "installCRDs": True },
atomic = True,
wait = True
)
print(
revision.release.name,
revision.release.namespace,
revision.revision,
str(revision.status)
)
# Uninstall a release
# Via the revision
revision = await client.get_current_revision("cert-manager", namespace = "cert-manager")
await revision.release.uninstall(wait = True)
# Or directly by name
await client.uninstall_release("cert-manager", namespace = "cert-manager", wait = True)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyhelm3-0.4.0.tar.gz
(20.2 kB
view details)
Built Distribution
pyhelm3-0.4.0-py3-none-any.whl
(20.9 kB
view details)
File details
Details for the file pyhelm3-0.4.0.tar.gz
.
File metadata
- Download URL: pyhelm3-0.4.0.tar.gz
- Upload date:
- Size: 20.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ce688cab8e12df5240641774c36acfd3cad6d9a6325781bc7b5a354e522c594 |
|
MD5 | 0266eb684d669d657b9535b27d43fb83 |
|
BLAKE2b-256 | 940687de4675e8c114a0251e87ed97e4cae1b9bc4d36d3471348ac20c7e7db1e |
File details
Details for the file pyhelm3-0.4.0-py3-none-any.whl
.
File metadata
- Download URL: pyhelm3-0.4.0-py3-none-any.whl
- Upload date:
- Size: 20.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f608891fbe8db9b8015b839f29524dccd6eade0da879820690d71de9c3f2f8d |
|
MD5 | 59c717ec1a98b74380dc6eaafd60e85b |
|
BLAKE2b-256 | 06fd8521dc138655be8f9d736d30dd198bdeb35b8b2f0683331e5b08febd9b06 |