[doc] fix bandwidthPerMigration documentation (#2681)

Follow-up on kubevirt/kubevirt#8208
for bandwidthPerMigration.

Signed-off-by: Simone Tiraboschi <[email protected]>

Author: tiraboschi

api/v1beta1/hyperconverged_types.go

@@ -306,7 +306,7 @@ type LiveMigrationConfigurations struct {
 	// +default=2
 	ParallelOutboundMigrationsPerNode *uint32 `json:"parallelOutboundMigrationsPerNode,omitempty"`
 
-	// Bandwidth limit of each migration, in MiB/s.
+	// Bandwidth limit of each migration, the value is quantity of bytes per second (e.g. 2048Mi = 2048MiB/sec)
 	// +optional
 	// +kubebuilder:validation:Pattern=^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
 	BandwidthPerMigration *string `json:"bandwidthPerMigration,omitempty"`

api/v1beta1/zz_generated.openapi.go

@@ -2235,7 +2235,8 @@ spec:
                       triggers. Defaults to false
                     type: boolean
                   bandwidthPerMigration:
-                    description: Bandwidth limit of each migration, in MiB/s.
+                    description: Bandwidth limit of each migration, the value is quantity
+                      of bytes per second (e.g. 2048Mi = 2048MiB/sec)
                     pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                     type: string
                   completionTimeoutPerGiB:

config/crd/bases/hco.kubevirt.io_hyperconvergeds.yaml

@@ -2235,7 +2235,8 @@ spec:
                       triggers. Defaults to false
                     type: boolean
                   bandwidthPerMigration:
-                    description: Bandwidth limit of each migration, in MiB/s.
+                    description: Bandwidth limit of each migration, the value is quantity
+                      of bytes per second (e.g. 2048Mi = 2048MiB/sec)
                     pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                     type: string
                   completionTimeoutPerGiB:

deploy/crds/hco00.crd.yaml

@@ -2235,7 +2235,8 @@ spec:
                       triggers. Defaults to false
                     type: boolean
                   bandwidthPerMigration:
-                    description: Bandwidth limit of each migration, in MiB/s.
+                    description: Bandwidth limit of each migration, the value is quantity
+                      of bytes per second (e.g. 2048Mi = 2048MiB/sec)
                     pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                     type: string
                   completionTimeoutPerGiB:

deploy/index-image/community-kubevirt-hyperconverged/1.11.0/manifests/hco00.crd.yaml

@@ -2235,7 +2235,8 @@ spec:
                       triggers. Defaults to false
                     type: boolean
                   bandwidthPerMigration:
-                    description: Bandwidth limit of each migration, in MiB/s.
+                    description: Bandwidth limit of each migration, the value is quantity
+                      of bytes per second (e.g. 2048Mi = 2048MiB/sec)
                     pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                     type: string
                   completionTimeoutPerGiB:

deploy/olm-catalog/community-kubevirt-hyperconverged/1.11.0/manifests/hco00.crd.yaml

@@ -239,7 +239,7 @@ LiveMigrationConfigurations - Live migration limits and timeouts are applied so
 | ----- | ----------- | ------ | -------- |-------- |
 | parallelMigrationsPerCluster | Number of migrations running in parallel in the cluster. | *uint32 | 5 | false |
 | parallelOutboundMigrationsPerNode | Maximum number of outbound migrations per node. | *uint32 | 2 | false |
-| bandwidthPerMigration | Bandwidth limit of each migration, in MiB/s. | *string |  | false |
+| bandwidthPerMigration | Bandwidth limit of each migration, the value is quantity of bytes per second (e.g. 2048Mi = 2048MiB/sec) | *string |  | false |
 | completionTimeoutPerGiB | The migration will be canceled if it has not completed in this time, in seconds per GiB of memory. For example, a virtual machine instance with 6GiB memory will timeout if it has not completed migration in 4800 seconds. If the Migration Method is BlockMigration, the size of the migrating disks is included in the calculation. | *int64 | 800 | false |
 | progressTimeout | The migration will be canceled if memory copy fails to make progress in this time, in seconds. | *int64 | 150 | false |
 | network | The migrations will be performed over a dedicated multus network to minimize disruption to tenant workloads due to network saturation when VM live migrations are triggered. | *string |  | false |

docs/api.md

@@ -245,7 +245,7 @@ Set the live migration configurations by modifying the fields in the `liveMigrat
 
 ### bandwidthPerMigration
 
-Bandwidth limit of each migration, in MiB/s. The format is a number and with the `Mi` suffix, e.g. `2048Mi`.
+Bandwidth limit of each migrationi, the value is in quantity of bytes per second. The format is a number with an optional quantity suffix, e.g. `2048Mi` means 2048MiB/sec.
 
 **default**: unset