network: clarify VMI IP reporting

Make it clear that IP reported in VMI status always reflects the first address from IPs list. This is already the case, but has not been documented. This behavior matches the logic seen in Kubernetes' PodIPs that were recently introduced to support dual-stack. Signed-off-by: Petr Horacek <[email protected]>
PiotrProkop · May 28, 2020 · 9f7badb · 9f7badb
1 parent 276971c
commit 9f7badb
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 4 deletions.
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -6777,7 +6777,7 @@
       "type": "string"
      },
      "ipAddress": {
-      "description": "IP address of a Virtual Machine interface",
+      "description": "IP address of a Virtual Machine interface. It is always the first item of IPs",
       "type": "string"
      },
      "ipAddresses": {

diff --git a/staging/src/kubevirt.io/client-go/api/v1/openapi_generated.go b/staging/src/kubevirt.io/client-go/api/v1/openapi_generated.go
diff --git a/staging/src/kubevirt.io/client-go/api/v1/types.go b/staging/src/kubevirt.io/client-go/api/v1/types.go
@@ -317,7 +317,8 @@ func (m *VirtualMachineInstanceMigration) TargetIsHandedOff() bool {
 //
 // +k8s:openapi-gen=true
 type VirtualMachineInstanceNetworkInterface struct {
-	// IP address of a Virtual Machine interface
+	// IP address of a Virtual Machine interface. It is always the first item of
+	// IPs
 	IP string `json:"ipAddress,omitempty"`
 	// Hardware address of a Virtual Machine interface
 	MAC string `json:"mac,omitempty"`

diff --git a/staging/src/kubevirt.io/client-go/api/v1/types_swagger_generated.go b/staging/src/kubevirt.io/client-go/api/v1/types_swagger_generated.go