Skip to content

Commit

Permalink
added validating designs
Browse files Browse the repository at this point in the history
Signed-off-by: Hargun Kaur <[email protected]>
  • Loading branch information
hargunkaur286 committed Aug 26, 2024
1 parent 413d219 commit c02350f
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 3 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 44 additions & 3 deletions content/en/meshmap/tasks/designs/validating-designs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,51 @@ weight: 2
categories: [Designer]
tags: [designs]
---
## How Validation Works

{{% pageinfo %}}
Page under construction.
{{% /pageinfo %}}
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.

This comprehensive validation ensures that:

1. The design adheres to the expected structure and format.

2. All components are valid and recognized by Meshery.

3. There are no missing required configurations.

## Performing Validation

1. To validate your design, navigate to the Actions button at the top of the Design canvas.

2. Click on the **Validate** Icon.

![Performing Validation](/meshmap/getting-started/images/validating-designs/performing-validation.png)

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:

![Successful Validation](/meshmap/getting-started/images/validating-designs/successful-validation.png)

## Handling Validation Errors

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.

### Validation Errors

A common validation error is:

**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.

![Validation Error](/meshmap/getting-started/images/validating-designs/validation-error.png)


To troubleshoot and remediate validation issues:

1. Click on the error on the modal.
2. This will open the configuration tab of the component that has that error.
3. Fix the configuration using the error details provided.
4. Re-run validation after any significant changes to your design to ensure all issues are resolved.

The validation process is confined to schema-based checks within Meshery and does not require communication with your target environment.

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

0 comments on commit c02350f

Please sign in to comment.