-
Notifications
You must be signed in to change notification settings - Fork 722
Blog post on helm kanvas snapshot #2162
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Aijeyomah
wants to merge
13
commits into
meshery:master
Choose a base branch
from
Aijeyomah:helm-kanvas-snapshot-post
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
d13ff67
write blog post on helm kanvas snapshot
Aijeyomah 77a1ac3
remove platform type from docker build
Aijeyomah e50add0
fix multiple backtick
Aijeyomah dfab212
add meshery permalink to text
Aijeyomah 296901a
Include article cover image
Aijeyomah 1f55df2
format codeblock
Aijeyomah eff250a
improve paragraph that explains how to get started
Aijeyomah 9cd858f
Merge branch 'master' into helm-kanvas-snapshot-post
Aijeyomah 7a0603e
Update collections/_posts/2025/05/13/2025-05-13-meshery-helm-kanvas-s…
vishalvivekm c6c17af
Update collections/_posts/2025/05/13/2025-05-13-meshery-helm-kanvas-s…
vishalvivekm cae7365
Merge branch 'master' into helm-kanvas-snapshot-post
vishalvivekm d1a1b9d
Merge branch 'master' into helm-kanvas-snapshot-post
vr-varad 51934f5
Merge branch 'master' into helm-kanvas-snapshot-post
Aijeyomah File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
68 changes: 68 additions & 0 deletions
68
collections/_posts/2025/05/13/2025-05-13-meshery-helm-kanvas-snapshot.md
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: Helm Kanvas Snapshot | ||
| subheading: Visualize Helm Charts as Meshery Designs with helm-kanvas-snapshot | ||
| permalink: | ||
| author: Ijeoma Eti, Lee Calcote | ||
| categories: | ||
| - Design | ||
| - meshery | ||
| - Helm | ||
| redirect_from: /blog/meshery-helm-kanvas-snapshot | ||
| featured-image: /assets/images/posts/2025-3-25-meshery-reaches-7000-stars/meshery-reaches-7000-stars.png | ||
| date: 2025-05-13 | ||
| --- | ||
|
|
||
|
|
||
| Helm Kanvas Snapshot is one of Meshery's extension that generates a snapshot of the visual representation a Helm chart. It makes it easier to understand, review and share your kubernetes deployments with peers without needing them to go through YAML files or set up a cluster. Showing a clear picture of every Kubernetes object in your chart, their component, and how they relate to each other all in a single, shareable view. | ||
|
|
||
| At the core of this process is the Meshery Design. A Meshery Design is a declarative representation of your infrastructure. It captures each component of your deployment, its properties, how the they are connected and interact with each other. | ||
|
|
||
| As the name implies, Helm kanvas snapshot plugin can only use "Helm" as the deployment source. When you use the plugin, it uses Kanvas Snapshot which takes your chart, renders the manifests, and generates a Design from it based on Meshery’s declarative syntax. That Design is then stored and rendered as an immutable snapshot you can view through a public link. | ||
|
|
||
| The Helm kanvas snapshot is useful in many ways. It doesn't require you to be authenticated to use the plugin, so it's very quick to get started. Also, if you provide a valid email address, the snapshot is sent directly to your inbox after it is generated, this is most helpful as it can take a few moment to render. One thing to note is that, Once created, the snapshot is immutable. This makes it a stable reference that you can share in Slack, attach to pull requests, or store alongside your deployment documentation. | ||
Aijeyomah marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| To get started, you’ll need to ensure Helm is installed on your machine, You can follow the official Helm documentation to install Helm for your system. To verify run the command below; | ||
|
|
||
| ```bash | ||
| helm version | ||
| ```` | ||
|
|
||
| The plugin supports Linux, macOS, and Windows. So, Once Helm is installed, you can install the plugin using: | ||
vishalvivekm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```bash | ||
| helm plugin install https://github.com/meshery-extensions/helm-kanvas-snapshot | ||
| ``` | ||
|
|
||
| To generate a snapshot, use the following command: | ||
|
|
||
| ```bash | ||
| helm helm-kanvas-snapshot -f helm helm-kanvas-snapshot -f https://meshery.io/charts/meshery-v0.8.12.tgz --name meshery-chart | ||
| ``` | ||
|
|
||
| This command takes your Helm chart and creates a Meshery Design snapshot from it. You’ll get a link to the snapshot in your terminal. If you provided an email, the snapshot link will also be sent to your inbox. | ||
|
|
||
| ### What each flag means: | ||
| **-f, --file (required)** | ||
| The path or URL to your Helm chart. This is the deployment source the plugin will render and convert into a snapshot. | ||
|
|
||
| **-e, --email (optional but recommended)** | ||
| Your email address. If you provide this, the snapshot link will be sent to you once it’s ready. Useful if the chart is large and rendering takes time. | ||
|
|
||
| **--name (optional)** | ||
| A custom name for the Meshery Design. If you don't set this, a default name will be generated based on the chart. | ||
|
|
||
| **-h** | ||
| Shows help information about how to use the helm-kanvas-snapshot plugin. | ||
|
|
||
|
|
||
| ### Helpful links | ||
|
|
||
| * [Meshery Designs Documentation](https://docs.meshery.io/concepts/logical/designs) | ||
| * [Kanvas Snapshot Documentation](https://docs.meshery.io/extensions/kanvas-snapshot) | ||
| * [Helm Kanvas Snapshot Documentation](https://docs.meshery.io/extensions/helm-kanvas-snapshot) | ||
| * [Helm Kanvas Snapshot Plugin Repository](https://github.com/meshery-extensions/helm-kanvas-snapshot) | ||
|
|
||
| ### Summary | ||
|
|
||
| In summary, the Helm Kanvas Snapshot plugin gives you a fast and reliable way to visualize Helm chart deployments. By converting charts into Meshery Designs and generating snapshots, you can improve collaboration and maintain better visibility into your infrastructure. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.