HelmInventory

class neophile.inventory.helm.HelmInventory(session: ClientSession)

Bases: object

Inventory the versions available from a Helm repository.

Parameters

session (aiohttp.ClientSession) – The aiohttp client session to use to make requests for Helm repository index files.

Methods Summary

canonicalize_url(url)

Canonicalize the URL for a Helm repository.

inventory(url)

Inventory the available versions of Helm charts.

Methods Documentation

canonicalize_url(url: str) str

Canonicalize the URL for a Helm repository.

Parameters

url (str) – The URL for a Helm repository.

Returns

canonical_url – The canonical URL for the index.yaml file of the repository.

Return type

str

async inventory(url: str) Dict[str, str]

Inventory the available versions of Helm charts.

Retrieve the inventory from the given Helm repository.

Parameters

url (str) – URL of the repository.

Returns

results – Returns a dict of Helm chart names to the latest available version of that Helm chart.

Return type

Dict[str, str]

Raises
  • aiohttp.ClientError – Failure to retrieve the index file from the Helm repository.

  • yaml.YAMLError – The index file for the repository doesn’t parse as YAML.