Performance Limits and Tuning
Learn about the performance limits of Kanvas and how to tune your environment for optimal performance.
Category: Designer
Understanding Design Components
A complete reference for all components available in the Kanvas designer.
Categories:
Design Render Quality
Control the level of detail in Kanvas design rendering using advanced URL query parameters.
Getting Started with Designs
Learn how to create, import, and share cloud native infrastructure designs in Kanvas — from your first design to deployable architecture.
Categories:
Starting from scratch
Welcome to Kanvas, your comprehensive tool for creating and managing cloud native deployment designs. This documentation will guide you through the steps, emphasizing the underlying system behavior for each action you take.
Categories:
Understanding Edge Styles
Learn how to use and customize edge styles in Kanvas to create clear and meaningful designs.
Categories:
Validating Designs
Prior to deploying a design, you can validate the configuration that it contains in accordance with the target platform.
Categories:
Whiteboarding
Kanvas Designer supports freestyle design, meaning that you can customize the appearance and layout of your diagrams without any constraints.
Categories:
Auto-pan on Drag
Kanvas automatically pans the viewport while you drag a component past the canvas edge. Learn when it helps, how to toggle it, and the performance gates that decide when it stays active.
Categories:
Dry Running a Design
A dry run simulates the deployment of your design in the selected target environment without making any actual changes.
Categories:
Exploring Designer
Designer mode is for those who want to create their own Kanvas, using the palette of components provided by Meshery.
Categories:
Importing a Design
Learn how to import designs from various sources and formats, including Kubernetes manifests, Helm charts, Docker Compose files, and more.
Categories:
Interpreting Component Badges
Learn to interpret component badges, the small visual indicators that provide at-a-glance information about a component’s status in both Designer and Operator modes.
Categories:
Undeploying Designs
Undeploy a design in order to rollback a deployment from one or more Kubernetes clusters.
Categories:
Understanding Tool Modes
Kanvas Designer offers three modes: Default, Pencil, and Connector, which behave differently based on the context in which they are used. Learn how to interact with components and the canvas in each mode.
Categories:
Whiteboarding
Whiteboarding and Freestyle Drawing inside Kanvas
Categories:
Creating Relationships
Relationships identify and facilitate genealogy between Components.
Categories:
Deploying Designs
Each Meshery design is deployable to one or more Kubernetes clusters.
Categories:
Publishing to Catalog
Publish a Kanvas design to the Catalog from Details, understand visibility versus publish, and know what happens during review and approval.
Render Modes
Kanvas renders a design at four distinct levels of detail. Learn what each render mode shows, what it hides, the feature size gates tied to each mode, and how Adaptive Render Mode picks the right one automatically based on live performance signals.
Reviewing Designs
Learn how to leverage comments in Kanvas’s Designer Mode to enhance collaboration and streamline design reviews.
Categories:
Understanding Relationships
Kanvas uses relationships to map how interconnected components interact.
Categories:
Working with Components
Meshery Components are reusable, interactive elements that can be used to build your designs. Learn how to work with components.
Categories:
Working with Designs
Kanvas Designs are descriptive, declarative characterizations of how your Kubernetes infrastructure should be configured.
Categories:
Cloning a Design
Treat designs as templates by cloning an existing design to modify and build upon.
Categories:
Collaborative Editing
Share a Kanvas design, set Private or Public visibility, invite collaborators, leave review comments, and understand what to expect from live collaboration.
Sharing Designs
Share designs with other users and use access controls to manage design permissions and visibility.
Categories:
Building a GCP Data Pipeline Design
Walk through creating the data-pipeline-gcp design in Kanvas, connecting GCP services in orbital-production.
Deleting a Design
Permanently delete a design you own, and understand how deleting differs from unpublishing a design or removing it from a workspace.
Categories:
Embedding Designs
How to embed your designs for sharing on your sites.
Categories:
Working with Tags
Share design with other users and use control access to manage design access permissions and visibility.
Categories:
Cross-Org Design Access: stellar-saas-platform
Learn how Stellar Dynamics accesses and collaborates on a shared design with Orbital Labs using cross-org permissions in Kanvas.
Working with Canvas Objects
Add, copy, clone, lock, delete, style, reset and resize the shapes, sections, textboxes and components on your Kanvas Designer canvas.
Categories:
Exporting Designs
How to export your designs for backup, sharing or offline use.
Categories:
Publishing Designs
Learn to publish, manage, and work with designs in Meshery with clear state transitions, role-based permissions, and common workflow FAQs.
Categories:
Pinning Models to the Dock
Learn how to pin and remove models from the dock in the Kanvas Designer for quick access.
Categories:
Policy Engine
Choose how Kanvas evaluates relationships in your designs, understand the relationship indicator states, and diagnose failing or unexpected relationship results.
Categories:
Canvas Actions
The canvas context menu - screenshots, the Help Center, keyboard shortcuts and canvas-wide editing actions.
Categories:
Layout and Layers
Arrange the components in a design automatically, and choose which entities the canvas draws.
Categories:
Merging and Loading Designs
Drag one design onto another to combine them, or open it in place of what is on the canvas.
Categories:
Saving Designs
How Kanvas persists your work, what the save indicator is telling you, and how to save a copy.
Categories:
Configuring Components
Edit a component’s configuration on the canvas, using the form Kanvas builds for it and its inline help.
Categories:
Design Review Mechanics
Kanvas’s Designer enables you to place comments “inline” with your infrastructure as code.
Categories:
Design Reviews in Kanvas
Add comments to your designs in Kanvas’s Designer Mode to enhance collaboration and streamline design reviews.
Categories:
Design Reviews: Adding Comments
Add comments to your designs in Kanvas’s Designer Mode to enhance collaboration and streamline design reviews.
Categories:
Kanvas Designer Overview
With thousands of components available, you can collaboratively design and operate your multi-cloud and cloud native infrastructure.
Categories:
Pinning Models to Dock
Pinning models to the dock allows you to quickly access your most used models. This is a great way to keep your workspace organized and efficient.
Categories:
Publishing Designs
How to publish your designs to the Cloud Catalog.
Categories:
Whiteboarding in Kanvas
One late-night alert, worked from page to postmortem on a single live design: sketch the blast radius, style the flow, put the evidence in context, and fix the configuration where the team can see it.