Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Added FAQ'S for contributing to relationships #10989

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[Docs] Added FAQ'S for contributing to relationships #10989

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e614e8a
Update contributing-model-relationships.md
deepak4566 May 17, 2024
9967a19
Update contributing-model-relationships.md
deepak4566 May 17, 2024
383fcd0
Update contributing-model-relationships.md
deepak4566 May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/pages/project/contributing/contributing-model-relationships.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,3 +234,28 @@ Scope is defined and controlled via the `selectors` [Selectors](#structure-of-se
of conflict

For more information refer - [Model - Construct Models in Meshery](https://docs.google.com/document/d/16z5hA8qVfSq885of9LXFUVvfom-hQXr-6oTD_GgoFmk/edit)

### Frequently Asked Questions (FAQ)

## How can I validate that my new or updated relationships are syntactically valid?
-To validate new relationships, you can use the [Schemas](https://github.com/meshery/schemas/tree/849c40f5766be18d36a7e250334d43e085b103a0/schemas/meshmodel/schemas). Since the relationship definitions are
written in JSON, JSON validators and formatters can be used to ensure they are correctly formatted.

## How do I test relationships that I have defined and verify that they are working as expected?
-You can test the relationships by running the Meshery server locally using `make`. As you update the relationship files locally, restart the server. The updates will be registered in the registry
automatically. Proceed to test the relationships from MeshMap.

## Can I do this with the command line?
-Yes, you can develop relationships through the CLI.

## Can I do this visually?
-At present, there is no feature to develop relationships visually, but it is on the future roadmap.

## Relationship scope: How can I avoid conflicting or overlapping evaluation of this relationship with existing relationships? How can I tell if there is a conflict and how can I control which policy will "win"?
-To avoid conflicts or overlapping evaluations of relationships, carefully define the scope and selectors. Currently, there is no automated conflict detection, so manual review of the relationships is necessary
to ensure there are no conflicts. Control over which policy will "win" can be managed by prioritizing or explicitly defining policy precedence.

## How do I know what selector to choose and what to fill inside MutatorRef or MutatedRef?
-This solely depends on what relationship you're working on , generally you may use helm charts of the components determine what should be filled in the mutator and mutated ref , you can always refer existing
relationship definations for better understanding.