Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kasabe28 committed Jul 8, 2024
1 parent dd2dbe7 commit be00cbc
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
4 changes: 4 additions & 0 deletions docs/concepts/ironcore-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 12 additions & 6 deletions docs/concepts/network-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
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`.

0 comments on commit be00cbc

Please sign in to comment.