Validate and Deploy

Check a design, simulate its deployment, apply it to clusters, and remove it again.

Four actions take a design from the canvas to running infrastructure and back. Run them in this order. Each one is stricter than the last and costs a little more.

ActionChecks or changesNeeds a clusterChanges the cluster
ValidateEach component’s configuration against its schema, in your browserNoNo
Dry runThe design against the Kubernetes API of each target clusterYesNo
DeployCreates or updates every component’s object on the target clustersYesYes
UndeployDeletes every component’s object from the target clustersYesYes

The deploy and undeploy flows are five-step wizards that run validation and a dry run for you, so you do not need to run them separately first.

All four are Designer-mode actions in the design’s Actions menu. They run on a Meshery you run, with the Meshery Server’s kubeconfig doing the work. The hosted kanvas.new site does not run them and shows a self-hosted-feature prompt. See How Kanvas Works with Meshery and Layer5 Cloud for what each environment supports.

ActionPermission
ValidateValidate Design (enforced on mobile only)
Dry runValidate Design
DeployDeploy Design
UndeployUndeploy Design

A denied action is hidden or disabled. The permission by role matrix is in Permissions by Role. Deploys, dry runs, and undeploys also appear in the notification center, where failures carry error codes and remediations.

For environment selection, connection problems, and loading failures, see Troubleshoot Kanvas.


Validate a Design

Check every component’s configuration against its schema before you deploy, read the results, and fix what they flag.

Dry-run a Design

Preview what a deployment would do by having each target cluster’s Kubernetes API check your design without applying it.

Deploy a Design

Apply a design to one or more Kubernetes clusters, and understand targets, ordering, dependencies, results, and failure behavior.

Undeploy a Design

Remove the resources a design describes from your clusters, and understand exactly what is and is not deleted.

Related Reading