Validate and Deploy on Layer5 Documentation

Validate a Design

Mon, 01 Jan 0001 00:00:00 +0000

Validation checks the configuration of each component in a design against the schema of that component’s definition. It runs in your browser, needs no cluster, and changes nothing. Run it while you build to catch missing or malformed fields before a dry run or a deployment spends time on them.

Before you start 🔗

Environment. Validation runs in a Meshery you run. The hosted kanvas.new site does not run it and shows a self-hosted-feature prompt instead.
A non-empty design. The Actions menu is disabled while the design has no components. An unsaved design validates; Kanvas validates the design as it is on the canvas.
Permission. On mobile, the Validate Design permission gates the action. See Permissions by Role.

What validation checks 🔗

Checked	Not checked
Each component’s configuration against the JSON schema of its registered definition, with all errors collected per component	Relationships between components
Required fields, types, and formats, including 32-bit and 64-bit integers and integer-or-string values	Dependencies, namespaces, and cross-references
	Anything in the target cluster

Annotation components (text, shapes, and other visual elements) carry no infrastructure and are skipped. They are counted separately in the summary.

Dry-run a Design

Mon, 01 Jan 0001 00:00:00 +0000

A dry run submits every component in the design to the Kubernetes API server of each target cluster as a server-side dry-run request. The API server validates the object exactly as it would on a real apply, including schema, field values, and admission, and then discards it. Nothing is created, updated, or persisted, so you can repeat a dry run as often as you like.

Before you start 🔗

A connected cluster. Meshery must hold at least one connected Kubernetes context. With none, the request fails with error meshery-server-1096, Kubernetes cluster is unavailable.
A non-empty design. The Actions menu is disabled for an empty design.
Permission. Dry run is gated by the Validate Design permission. See Permissions by Role.
A Meshery you run. The hosted kanvas.new site does not run dry runs.

Meshery Server performs the dry run with the kubeconfig it holds. Meshery Operator, MeshSync, and the broker are not required.

Deploy a Design

Mon, 01 Jan 0001 00:00:00 +0000

Deploying applies the components in a design to the Kubernetes clusters in the environments you choose. Meshery Server does the work with the kubeconfig it holds: it creates each object, or updates it in place when it already exists. Deploying the same design again is safe and idempotent.

Before you start 🔗

A Meshery you run, with a connected cluster. The hosted kanvas.new site does not deploy; it shows a self-hosted-feature prompt. Meshery needs at least one connected Kubernetes context that belongs to an environment in your organization.
A non-empty design. The Actions menu is disabled for an empty design. An unsaved design deploys as it stands on the canvas.
Permission. The Deploy Design permission gates the action. See Permissions by Role. Selecting environments from the empty state also needs the Create Environment and Edit Environment permissions.
A provider session. Without a signed-in session the request fails before any event is raised.

Deploying does not need Meshery Operator, MeshSync, or the broker. Those make the result visible in Operator mode.

Undeploy a Design

Mon, 01 Jan 0001 00:00:00 +0000

Undeploying deletes the Kubernetes objects that each component in a design describes, from every cluster in the environments you select. It does not touch the design itself. The design record, its versions, and its Operator view are unchanged.

Before you start 🔗

The prerequisites match Deploy a Design: a Meshery you run with a connected cluster, a non-empty design, and the Undeploy Design permission. The hosted kanvas.new site does not run undeploy. See Permissions by Role.