-
Notifications
You must be signed in to change notification settings - Fork 511
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: George Jenkins <[email protected]>
- Loading branch information
Showing
2 changed files
with
41 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,49 @@ | ||
--- | ||
title: "Examples" | ||
description: "Explains various advanced features for Helm power users" | ||
aliases: ["/docs/advanced_helm_techniques"] | ||
description: "Examples various features if the Helm SDK" | ||
weight: 2 | ||
--- | ||
|
||
This document runs though a series of examples of using the Helm SDK | ||
|
||
# Actions | ||
## Actions | ||
|
||
These examples are meant to be fully working. The code lives in the `sdkexamples` directory. The below driver runs through each example: | ||
These examples are intended to document various SDK functionalities The code is intended to be fully working, and lives in the `sdkexamples` directory. | ||
|
||
{{< highlightexamplego file="sdkexamples/main.go" >}} | ||
The final example documents a driver which can run these actions, including the necessary helper functions. | ||
|
||
## Install Action | ||
### Install Action | ||
|
||
This example installs the given chart/release, for the given version and values. | ||
|
||
{{< highlightexamplego file="sdkexamples/install.go" >}} | ||
|
||
## Upgrade Action | ||
### Upgrade Action | ||
|
||
This example upgrades the given release, with the given chart, version and values. | ||
|
||
{{< highlightexamplego file="sdkexamples/upgrade.go" >}} | ||
|
||
## Uninstall Action | ||
### Uninstall Action | ||
|
||
This example uninstalls the given release | ||
|
||
{{< highlightexamplego file="sdkexamples/uninstall.go" >}} | ||
|
||
## List Action | ||
### List Action | ||
|
||
This example lists all released charts (in the currently configured namespace) | ||
|
||
{{< highlightexamplego file="sdkexamples/list.go" >}} | ||
|
||
## Pull Action | ||
### Pull Action | ||
|
||
{{< highlightexamplego file="sdkexamples/list.go" >}} | ||
This example pulls a chart from an OCI repository | ||
|
||
{{< highlightexamplego file="sdkexamples/pull.go" >}} | ||
|
||
### Driver | ||
|
||
The driver here shows the necessary auxillary functions needed for the Helm SDK actions to function. And shows the above examples in action, to pull, install, update, and uninstall the 'podinfo' chart from an OCI repository. | ||
|
||
{{< highlightexamplego file="sdkexamples/main.go" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters