From e614e8a7ff463f8e50f5680ae6b3f278ec05528e Mon Sep 17 00:00:00 2001 From: Deepak Date: Fri, 17 May 2024 19:31:14 +0530 Subject: [PATCH 1/3] Update contributing-model-relationships.md added faq's Signed-off-by: Deepak --- .../contributing-model-relationships.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/pages/project/contributing/contributing-model-relationships.md b/docs/pages/project/contributing/contributing-model-relationships.md index 0232bc60633..b7f98fbf94e 100644 --- a/docs/pages/project/contributing/contributing-model-relationships.md +++ b/docs/pages/project/contributing/contributing-model-relationships.md @@ -234,3 +234,25 @@ 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. +
From 9967a19273326820ec1b98879f700d27aa7e0ce6 Mon Sep 17 00:00:00 2001 From: Deepak Date: Fri, 17 May 2024 19:55:01 +0530 Subject: [PATCH 2/3] Update contributing-model-relationships.md Signed-off-by: Deepak --- .../contributing-model-relationships.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/pages/project/contributing/contributing-model-relationships.md b/docs/pages/project/contributing/contributing-model-relationships.md index b7f98fbf94e..5b33052344a 100644 --- a/docs/pages/project/contributing/contributing-model-relationships.md +++ b/docs/pages/project/contributing/contributing-model-relationships.md @@ -239,20 +239,24 @@ For more information refer - [Model - Construct Models in Meshery](https://docs. 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. + -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. + -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. +-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. +-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. +-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. +-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. From 383fcd01b964fea8a85e89dd13fcaf8b0e7594c3 Mon Sep 17 00:00:00 2001 From: Deepak Date: Fri, 17 May 2024 20:06:55 +0530 Subject: [PATCH 3/3] Update contributing-model-relationships.md Signed-off-by: Deepak --- .../project/contributing/contributing-model-relationships.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/pages/project/contributing/contributing-model-relationships.md b/docs/pages/project/contributing/contributing-model-relationships.md index 5b33052344a..302aedce7ab 100644 --- a/docs/pages/project/contributing/contributing-model-relationships.md +++ b/docs/pages/project/contributing/contributing-model-relationships.md @@ -235,8 +235,7 @@ Scope is defined and controlled via the `selectors` [Selectors](#structure-of-se For more information refer - [Model - Construct Models in Meshery](https://docs.google.com/document/d/16z5hA8qVfSq885of9LXFUVvfom-hQXr-6oTD_GgoFmk/edit) -
-Frequently Asked Questions (FAQ) +### 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 @@ -259,4 +258,4 @@ For more information refer - [Model - Construct Models in Meshery](https://docs. ## 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. -
+