From be00cbcd1940d23f35b46b950de91d40fe4b1945 Mon Sep 17 00:00:00 2001 From: Kajol Asabe Date: Mon, 8 Jul 2024 11:46:08 +0530 Subject: [PATCH] update docs --- docs/concepts/ironcore-integration.md | 4 ++++ docs/concepts/network-lifecycle.md | 18 ++++++++++++------ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/concepts/ironcore-integration.md b/docs/concepts/ironcore-integration.md index e4ee2b6e..75048f02 100644 --- a/docs/concepts/ironcore-integration.md +++ b/docs/concepts/ironcore-integration.md @@ -24,6 +24,10 @@ be patched with the corresponding provider ID of the `apinet` `Network` and set to `state: Available`. The provider ID format & parsing can be found in [`provider.go`](../../apinetlet/provider/provider.go). +If `ironcore` `Network` has peerings, then they will be translated and +patched into `apinet` `Network`. More details can be found here +[`Network Peering`](./network-lifecycle.md#network-peering) + ### `LoadBalancer` For a `networking.ironcore.dev/LoadBalancer` a corresponding diff --git a/docs/concepts/network-lifecycle.md b/docs/concepts/network-lifecycle.md index c4ed616d..f0aca7b0 100644 --- a/docs/concepts/network-lifecycle.md +++ b/docs/concepts/network-lifecycle.md @@ -32,11 +32,17 @@ When creating network peering both `ironcore` `Network`s has to specify matching multiple `network`s in any namespcae. The `apinetlet` `NetworkController` checks if there are any `peeringClaimRefs` -present in `ironcore` `Network`. If yes then get `ironcore-net` `Network` using `UID` of `peeringClaimRef` -and add `spec.ID` of that `ironcore-net` `Network` into `spec.peeredIDs` of current `ironcore-net` `Network`. +present in `ironcore` `Network`. If yes then get `ironcore-net` `Network` +using `UID` of `peeringClaimRef` and add `spec.ID` of that `ironcore-net` `Network` +along with corresponding peering name and peering prefixes into `spec.peerings` +of current `ironcore-net` `Network`. -The `apinetlet` `NetworkController` also checks for `status.peerings` in `ironcore` `Network`. -If yes then update `ironcore-net` `Network`s `status.peerings` with `ironcore` `Network`s `status.peerings` +Once `ironcore-net` `Network` is updated with `spec.peerings`, `metalnetlet` `NetworkController` +updates `metalnet` `Network`'s `spec.peeredIDs` and `spec.peeredPrefixes` +from corresponding `ironcore-net` `Network` `spec.peerings` -Once `ironcore-net` `Network` is updated with `spec.peeredIDs`, `metalnetlet` `NetworkController` -updates `metalnet` `Network` `spec.peeredIDs` with corresponding `ironcore-net` `Network` `spec.peeredIDs` \ No newline at end of file +The `metalnetlet` `NetworkController` also translates `status.peerings` +in `metalnet` `Network` to `ironcore-net` `Network`'s `status.peerings`. + +Then the `apinetlet` `NetworkController` also translates `status.peerings` +in `ironcore-net` `Network` to `ironcore` `Network`'s `status.peerings`. \ No newline at end of file