incorporating review comments

ironcore-dev · Jan 10, 2025 · 5ff91a3 · 5ff91a3
1 parent 5ae06fc
commit 5ff91a3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/docs/usage/networking/loadbalancer.md b/docs/usage/networking/loadbalancer.md
@@ -20,9 +20,6 @@ spec:
       app: web
   ports:
   - port: 80
-#status:
-#  ips:
-#  - 10.0.0.1 # The publicly available IP of the load balancer
 
 ```
 (`Note`: Refer to <a href="https://github.com/ironcore-dev/ironcore/tree/main/config/samples/e2e/loadbalancer-public">E2E Examples</a> for more detailed examples.)
@@ -64,3 +61,4 @@ destinations:
   - name: my-machine-interface-2
     uid: 2020dcf9-e030-427e-b0fc-4fec2016e73d
 ```
+**LoadBalancer status update**: The `LoadBalancerController` in ironcore-net takes care of allocating IPs for defined `ipFamilies` in the spec and updates them in its `status.ips`.
diff --git a/docs/usage/networking/network.md b/docs/usage/networking/network.md
@@ -26,8 +26,11 @@ spec:
 
 # Reconciliation Process:
 
-- **Network creation**: `ironcore-net` which is the network provider for Ironcore realizes the `Network` resource and updates 
-providerID in the spec. Once resource is in available state status is marked to `Available`.
+- **Network creation**: `ironcore-net` which is the network provider for Ironcore realizes the `Network` resource via `apinetlet` controllers. When an Ironcore `Network` is created, a corresponding `core.apinet.ironcore.dev/Network` is created in the apinet cluster. The name of the Network in the apinet cluster is the uid of the Network in the Ironcore cluster.
+
+  Once created and with an allocated ID, the Ironcore Network will 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.
+  Once resource is in available state status is marked to `Available`. The format of a network provider ID is as follows:
+  `ironcore-net://<namespace>/<name>/<id>/<uid>`
 
 - **Network peering process**: Network peering is a technique used to interleave two isolated networks, allowing members of both networks to communicate with each 
 other as if they were in the same networking domain,  `NetworkPeeringController` facilitates this process.