Skip to content

Commit

Permalink
Merge pull request #1473 from kubeshop/julianne/doc/monokle/helm-char…
Browse files Browse the repository at this point in the history
…t-preview-configurations

docs: Helm Chart Preview Documentation
  • Loading branch information
jfermi authored Mar 17, 2022
2 parents a3053ec + 3790f64 commit 6b9f8e0
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,37 @@ In Settings, set which Helm command to use when generating Helm previews in Mono

![Helm Settings](img/helm-settings-1.5.0.png)

## **Helm Preview Configurations**

Each Helm chart has a subsection named **Preview Configurations**. This allows you to configure how to run the Helm Preview and then save the configuration in order to quickly use it at any time.

![Helm Preview Configurations](img/helm-preview-configurations.png)

Hovering over the Preview Configurations section will show a Plus button to the right:

![Plus Button](img/helm-configuration-plus-sign.png)

Clicking on the button will open a Drawer to the right:

![Preview Configuration Drawer](img/preview-configuration-drawer.png)

This form allows you to:
- Name your configuration.
- Choose and order which values files to be used for the preview.
- Choose between using the **helm template** or **helm install** commands.
- And, optionally, provide options for the command. See more about the options in Helm’s documentation: https://helm.sh/docs/helm/helm_install/.

Finally, you can save your configuration for later use or save it and start previewing the resources right away.

Saved Preview Configurations will show up in the subsection of the Helm chart it was created for:

![My Preview Configuration](img/my-preview-configuration.png)

By hovering over the configuration you will see the Preview, Edit and Delete actions.

If you instead click and select the configuration, the source code editor from the right will be replaced with the Helm Command Pane, which will display the generated command that will be run by Monokle to create the preview:

![Helm Command Pane](img/helm-command-pane.png)

## **Helm Navigation**

Expand Down
Binary file added docs/img/helm-command-pane.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/helm-configuration-plus-sign.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/helm-preview-configurations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/my-preview-configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/preview-configuration-drawer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b9f8e0

Please sign in to comment.