Skip to content

Commit 6045754

Browse files
authored
Merge pull request #863 from layer5io/copilot/add-dry-run-documentation
[Kanvas] Add documentation for dry running a design
2 parents 5b18a6a + 3706ab6 commit 6045754

File tree

5 files changed

+48
-0
lines changed

5 files changed

+48
-0
lines changed
144 KB
Loading
153 KB
Loading
121 KB
Loading
107 KB
Loading
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Dry Running a Design
3+
description: >
4+
A dry run simulates the deployment of your design in the selected target environment without making any actual changes.
5+
weight: 3
6+
categories: [Designer]
7+
tags: [designs]
8+
aliases:
9+
- /meshmap/tasks/designs/dry-running-a-design
10+
---
11+
12+
A dry run in Meshery simulates the deployment of your design in the selected target environment without making any actual changes. This step is highly beneficial as it helps identify potential issues before they occur, ensuring a smoother and more reliable deployment process.
13+
14+
## Performing Dry Run
15+
16+
1. Navigate to the **Actions** button at the top of the Design canvas.
17+
18+
2. Click on the **Dry Run** icon.
19+
20+
3. Review the results to identify any potential issues.
21+
22+
4. Make necessary adjustments to your configuration based on the feedback provided by the dry run.
23+
24+
5. Re-run the dry run to ensure all issues have been resolved.
25+
26+
## Dry Run Errors
27+
28+
### Invalid Field Value
29+
30+
This error indicates that a field has an invalid value. For example, when configuring a Kubernetes Service, the fields `spec.ports[0].port` and `spec.ports[0].targetPort` may have invalid values of 0. These values must be between 1 and 65535, inclusive.
31+
32+
![Invalid Field Value Error](/kanvas/getting-started/images/dry-running-designs/invalid-field-value-1.png)
33+
34+
![Invalid Field Value Details](/kanvas/getting-started/images/dry-running-designs/invalid-field-value-2.png)
35+
36+
### Missing Required Field
37+
38+
This error occurs when a required field in the configuration has not been provided. Ensure all required fields are properly configured before running the dry run.
39+
40+
![Missing Required Field Error](/kanvas/getting-started/images/dry-running-designs/missing-field.png)
41+
42+
### Missing Dependencies
43+
44+
This error occurs because a Kubernetes Custom Resource Definition (CRD) should have been deployed first before attempting to deploy a component that relies on it.
45+
46+
To resolve this, ensure that all necessary dependencies, such as CRDs, are deployed before deploying the components that rely on them.
47+
48+
![Missing Dependencies Error](/kanvas/getting-started/images/dry-running-designs/missing-resource.png)

0 commit comments

Comments
 (0)