Deployment on Layer5 Documentation

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.

Validate and Deploy

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

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.

Action	Checks or changes	Needs a cluster	Changes the cluster
Validate	Each component’s configuration against its schema, in your browser	No	No
Dry run	The design against the Kubernetes API of each target cluster	Yes	No
Deploy	Creates or updates every component’s object on the target clusters	Yes	Yes
Undeploy	Deletes every component’s object from the target clusters	Yes	Yes

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.

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.