Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docusaurus/docs/api/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,32 @@ the context for all Helm operations.

Args:
namespace: Kubernetes namespace to operate in (default: "default")
kubeconfig: Path to kubeconfig file (default: uses $KUBECONFIG or ~/.kube/config)
kubeconfig: Kubeconfig source. Can be:
- None: Uses $KUBECONFIG env var or ~/.kube/config (default)
- File path: Path to a kubeconfig file (e.g., "/path/to/config.yaml")
- YAML string: Kubeconfig content as a YAML string (auto-detected)
kubecontext: Kubernetes context to use (default: current context)

Example:

```python
>>> import asyncio
>>> # Using default kubeconfig
>>> config = Configuration(namespace="my-namespace")
>>>
>>> # Using explicit file path
>>> config = Configuration(
... namespace="default",
... kubeconfig="/path/to/kubeconfig.yaml"
... )
>>>
>>> # Using kubeconfig YAML string (useful for secrets/env vars)
>>> kubeconfig_content = os.environ.get("KUBECONFIG_CONTENT")
>>> config = Configuration(
... namespace="default",
... kubeconfig=kubeconfig_content
... )
>>>
>>> install = Install(config)
>>> result = asyncio.run(install.run("my-release", "/path/to/chart"))
```
Expand Down
7 changes: 4 additions & 3 deletions docusaurus/docs/api/chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@ Example:

### Methods

#### `run(self, chart_ref: 'str', dest_dir: 'str | None' = None) -> 'None'`
#### `run(self, chart_ref: 'str', dest_dir: 'str | None' = None, version: 'str | None' = None) -> 'None'`

Pull a chart asynchronously.

Args:
chart_ref: Chart reference (e.g., "repo/chart" or "oci://...")
dest_dir: Destination directory (default: current directory)
version: Chart version to pull (e.g., "1.2.3"). If not specified, uses latest

Raises:
ChartError: If pull fails
Expand Down Expand Up @@ -92,7 +93,7 @@ Raises:
ChartError: If show fails


## Test
## ReleaseTest

Helm test action.

Expand All @@ -106,7 +107,7 @@ Example:
```python
>>> import asyncio
>>> config = Configuration()
>>> test = Test(config)
>>> test = ReleaseTest(config)
>>> result = asyncio.run(test.run("my-release"))
```

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/scripts/generate-api-docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
# Import after adding to path
from helm_sdkpy import Configuration # noqa: E402
from helm_sdkpy.actions import Install, Upgrade, Uninstall, List, Status, Rollback, GetValues, History # noqa: E402
from helm_sdkpy.chart import Pull, Show, Test, Lint, Package # noqa: E402
from helm_sdkpy.chart import Pull, Show, ReleaseTest, Lint, Package # noqa: E402
from helm_sdkpy.repo import RepoAdd, RepoRemove, RepoList, RepoUpdate # noqa: E402
from helm_sdkpy import exceptions # noqa: E402

Expand Down Expand Up @@ -191,7 +191,7 @@ def generate_chart_docs(output_dir):
"",
format_class_docs(Show, "Show"),
"",
format_class_docs(Test, "Test"),
format_class_docs(ReleaseTest, "ReleaseTest"),
"",
format_class_docs(Lint, "Lint"),
"",
Expand Down