Skip to content

Commit 43b67e6

Browse files
committed
re-added validating-designs chapter
Signed-off-by: Hargun Kaur <hargunkaur286@gmail.com>
1 parent 9e781bf commit 43b67e6

File tree

4 files changed

+45
-3
lines changed

4 files changed

+45
-3
lines changed
230 KB
Loading
96.3 KB
Loading
84.6 KB
Loading

content/en/kanvas/tasks/designs/validating-designs.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,51 @@ aliases:
99
- /meshmap/tasks/designs/validating-designs
1010
---
1111

12-
{{% pageinfo %}}
13-
Page under construction.
14-
{{% /pageinfo %}}
12+
## How Validation Works
13+
14+
Meshery uses static analysis to verify your design. It checks all components within your design and all configured and unconfigured properties of your components against well-defined schemas based on Meshery Models.
15+
16+
This comprehensive validation ensures that:
17+
18+
1. The design adheres to the expected structure and format.
19+
20+
2. All components are valid and recognized by Meshery.
21+
22+
3. There are no missing required configurations.
23+
24+
## Performing Validation
25+
26+
1. To validate your design, navigate to the Actions button at the top of the Design canvas.
27+
28+
2. Click on the **Validate** Icon.
29+
30+
![Performing Validation](/kanvas/getting-started/images/validating-designs/performing-validation.png)
31+
32+
If the validation is successful, you will see a modal displaying the number of components validated and the number of annotations, similar to the one shown below:
33+
34+
![Successful Validation](/kanvas/getting-started/images/validating-designs/successful-validation.png)
35+
36+
## Handling Validation Errors
37+
38+
If your design fails validation checks, the modal will indicate the number of errors detected. Each error will provide specific information about the component or annotation that caused the failure. Use this detailed feedback to identify and correct the issues in your design before proceeding with the deployment.
39+
40+
### Validation Errors
41+
42+
A common validation error is:
43+
44+
**Missing Required Field:** This happens when a required field is not provided. For example, in the image below, the first error indicates that the field ".spec.template.spec.containers.0.env.0" must have a value.
45+
46+
![Validation Error](/kanvas/getting-started/images/validating-designs/validation-error.png)
47+
48+
49+
To troubleshoot and remediate validation issues:
50+
51+
1. Click on the error on the modal.
52+
2. This will open the configuration tab of the component that has that error.
53+
3. Fix the configuration using the error details provided.
54+
4. Re-run validation after any significant changes to your design to ensure all issues are resolved.
55+
56+
The validation process is confined to schema-based checks within Meshery and does not require communication with your target environment.
1557

1658
<!-- Text can be **bold**, _italic_, or ~~strikethrough~~. [Links](https://gohugo.io) should be blue with no underlines (unless hovered over).
1759

0 commit comments

Comments
 (0)