Skip to content

Commit eb52953

Browse files
committed
Document obtaining CNI generated IP address
Signed-off-by: Erik Sipsma <[email protected]>
1 parent 62a2b3a commit eb52953

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,12 @@ With the above configuration, when the Firecracker VM is started the SDK will in
101101
CNI and place the final VM inside the resultant network namespace. The end result being:
102102
* Outside the network namespace, a single veth endpoint created by the `ptp` plugin will
103103
exist with a static IP from the `host-local` plugin (i.e. `192.168.127.1`)
104+
* Users can obtain the IP address and other static network configuration generated for
105+
their machine via CNI by inspecting the network interface's `StaticConfiguration`
106+
field, which will be automatically filled out after the machine has been started.
107+
* The IP address, for example, can be obtained at
108+
`NetworkInterfaces[0].StaticConfiguration.IPConfiguration.IPAddr` after a call to the
109+
machine object's `Start` method succeeds.
104110
* Inside the VM's network namespace:
105111
* The other side of the veth device will exist with name `veth0`, as specified by the
106112
`IfName` parameter above, and a different IP (i.e. `192.168.127.2`)

0 commit comments

Comments
 (0)