Skip to content

Commit d13ff67

Browse files
committed
write blog post on helm kanvas snapshot
Signed-off-by: Eti Ijeoma <[email protected]>
1 parent 73b8ddd commit d13ff67

File tree

2 files changed

+69
-1
lines changed

2 files changed

+69
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ build:
1212
$(jekyll) build --drafts
1313

1414
docker:
15-
docker run --name meshery-io -d --rm -p 4000:4000 -v `pwd`:"/srv/jekyll" jekyll/jekyll:latest bash -c "bundle install; jekyll serve --drafts --livereload"
15+
docker run --platform linux/amd64 --name meshery-io -d --rm -p 4000:4000 -v `pwd`:"/srv/jekyll" jekyll/jekyll:latest bash -c "bundle install; jekyll serve --drafts --livereload"
1616

1717
docker-stop:
1818
docker stop meshery-io
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Helm Kanvas Snapshot
3+
subheading: Visualize Helm Charts as Meshery Designs with helm-kanvas-snapshot
4+
permalink:
5+
author: Ijeoma Eti, Lee Calcote
6+
categories:
7+
- Design
8+
- meshery
9+
- Helm
10+
redirect_from: /blog/meshery-helm-kanvas-snapshot
11+
featured-image: /assets/images/posts/2025-3-25-meshery-reaches-7000-stars/meshery-reaches-7000-stars.png
12+
date: 2025-05-13
13+
---
14+
15+
16+
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.
17+
18+
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.
19+
20+
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.
21+
22+
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.
23+
24+
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;
25+
26+
```bash
27+
helm version
28+
````
29+
30+
The plugin supports Linux, macOS, and Windows. So, Once Helm is installed, you can install the plugin using:
31+
32+
```bash
33+
helm plugin install https://github.com/meshery-extensions/helm-kanvas-snapshot
34+
```
35+
36+
To generate a snapshot, use the following command:
37+
38+
```bash
39+
helm helm-kanvas-snapshot -f helm helm-kanvas-snapshot -f https://meshery.io/charts/meshery-v0.8.12.tgz --name meshery-chart
40+
```
41+
42+
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.
43+
44+
### What each flag means:
45+
**-f, --file (required)**
46+
The path or URL to your Helm chart. This is the deployment source the plugin will render and convert into a snapshot.
47+
48+
**-e, --email (optional but recommended)**
49+
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.
50+
51+
**--name (optional)**
52+
A custom name for the Meshery Design. If you don't set this, a default name will be generated based on the chart.
53+
54+
**-h**
55+
Shows help information about how to use the helm-kanvas-snapshot plugin.
56+
57+
58+
### Helpful links
59+
60+
* [Meshery Designs Documentation](https://docs.meshery.io/concepts/logical/designs)
61+
* [Kanvas Snapshot Documentation](https://docs.meshery.io/extensions/kanvas-snapshot)
62+
* [Helm Kanvas Snapshot Documentation](https://docs.meshery.io/extensions/helm-kanvas-snapshot)
63+
* [Helm Kanvas Snapshot Plugin Repository](https://github.com/meshery-extensions/helm-kanvas-snapshot)
64+
65+
### Summary
66+
67+
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.
68+

0 commit comments

Comments
 (0)