Skip to content

Commit 7d22e5f

Browse files
committed
kanvas docs updated
Signed-off-by: YASHMAHAKAL <yvsst01@gmail.com>
1 parent 3827e4a commit 7d22e5f

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

content/en/kanvas/concepts/relationships/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,17 +92,17 @@ spec:
9292
9393
Hierarchical relationships involve either an ancestral connection of the components (i.e. the creation/deletion of a component higher up affects the existence of the components below in the lineage) or a connection which involves the inheritence of features from one component to the other. There are 2 subtypes of the hierarchical relationship.
9494
95-
**i. Hierarchical-Inventory**
95+
**i. Hierarchical-Parent-Inventory**
9696
9797
This is a relationship between components where the configuration settings of one component, known as the parent, are combined or integrated with the configuration settings of another component, known as the child. This implies that changes or updates made to the parent component can affect or influence the configuration of the child component. Here's an example of a Hierarchical-Inventory relationship
9898
99-
![example of edge-permission relationship](images/Hierachical_Inventory_Relationships.svg)
99+
![example of hierarchical-parent-inventory relationship](../../getting-started/creating-relationships/images/relationships/create-parent-child.gif)
100100
101-
**ii. Hierarchical-Parent**
101+
**ii. Hierarchical-Parent-Wallet**
102102
103-
A parent-child relationship implies that the parent component must be present or established before the child component can be created. For instance, in Kubernetes, a 'Namespace' can serve as a parent to 'Pods' within that namespace. Therefore, the namespace must be created beforehand for pods to be deployed within it. Here's an example of a Hierarchical-Parent relationship
103+
This is a relationship between components where one component is directly attached to a host component, acting as an integrated inventory item. This implies a reverse configuration dependency: the configuration settings of the parent component are mutated or updated to synchronize with the attached child component. For example, attaching a sidecar container or a WebAssembly (WASM) filter to a workload will automatically modify the host workload's configuration to include the new item. On the canvas, these attached items are visualized as a numeric design inventory badge on the parent component rather than as standalone shapes. Here's an example of a Hierarchical-Parent-wallet relationship
104104
105-
![example of edge-permission relationship](images/Hierarchical_Parent_Relationship.svg)
105+
![example of hierarchical-wallet relationship](../../getting-started/creating-relationships/images/relationships/create-inventory-wallet.gif)
106106
107107
### 3. TagSets Relationships
108108

content/en/kanvas/designer/relationship-evaluation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ identify connections, validate them, and keep related configuration in sync.
1515
This page explains how you can choose which engine performs that evaluation, how
1616
to read the relationship indicator, and how to diagnose results that look wrong.
1717

18+
## Understanding the Evaluation Engine
19+
20+
The evaluation engine is a dynamic runtime engine (not a static linter) that analyzes and mutates the design based on registered rules. When processing, it enforces:
21+
22+
- **Semantic Validity**: Validates if manually drawn connections are actually allowed by a registered `RelationshipDefinition` in the registry.
23+
- **Dependency Fulfillment**: Flags missing required components and can auto-inject them (e.g., automatically adding a Namespace if a Pod requires one).
24+
- **Configuration Mutability (Patching)**: Validates and applies patches (e.g., automatically injecting Component B's IP address or selector into Component A's configuration based on the policy).
25+
1826
## How Relationships Are Evaluated
1927

2028
Kanvas can run relationship evaluation using one of two interchangeable engines:

0 commit comments

Comments
 (0)