Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ endif::[]
:VirtVersion: 4.21
:HCOVersion: 4.21.0
:HCOVersionPrev: 4.20.0
:HCOCliKind: hyperconvergeds.v1beta1.hco.kubevirt.io
:CNVNamespace: openshift-cnv
:CNVOperatorDisplayName: OpenShift Virtualization Operator
:CNVSubscriptionSpecSource: redhat-operators
Expand Down
14 changes: 7 additions & 7 deletions modules/hcp-virt-evict-vms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@ In cases where KubeVirt virtual machines (VMs) cannot be live migrated, such as
+
[source,terminal]
----
$ oc explain hyperconverged.spec.evictionStrategy
$ oc explain --api-version=hco.kubevirt.io/v1beta1 hyperconverged.spec.evictionStrategy
----

. Patch the `hyperconverged` resource by entering the following command:
+
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc -n openshift-cnv patch hyperconverged kubevirt-hyperconverged \
$ oc patch -n {CNVNamespace} {HCOCliKind} kubevirt-hyperconverged \
--type=merge \
-p '{"spec": {"evictionStrategy": "External"}}'
----

. Patch the workload update strategy and the workload update methods by entering the following command:
+
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc -n openshift-cnv patch hyperconverged kubevirt-hyperconverged \
$ oc patch -n {CNVNamespace} {HCOCliKind} kubevirt-hyperconverged \
--type=merge \
-p '{"spec": {"workloadUpdateStrategy": {"workloadUpdateMethods": ["LiveMigrate","Evict"]}}}'
----
Expand All @@ -41,9 +41,9 @@ By applying this patch, you specify that VMs should be live-migrated if possible

* Check whether the patch command was applied properly by entering the following command:
+
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc -n openshift-cnv get hyperconverged kubevirt-hyperconverged -ojsonpath='{.spec.evictionStrategy}'
$ oc get -n {CNVNamespace} {HCOCliKind} kubevirt-hyperconverged -ojsonpath='{.spec.evictionStrategy}'
----
+
.Example output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Add a custom golden image in a heterogeneous cluster by setting the `ssp.kubevir
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Edit the `HyperConverged` CR, to add the custom golden image. You must add the appropriate values for `ssp.kubevirt.io/dict.architectures` annotation in the `dataImportCronTemplates` section. For example:
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-attaching-vm-to-primary-udn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ spec:
. Optional: If you are using the Plug a Simple Socket Transport (passt) network binding plugin, set the `hco.kubevirt.io/deployPasstNetworkBinding` annotation to `true` in the `HyperConverged` custom resource (CR) by running the following command:
+
--
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc annotate hco kubevirt-hyperconverged -n kubevirt-hyperconverged hco.kubevirt.io/deployPasstNetworkBinding=true --overwrite
$ oc annotate {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} hco.kubevirt.io/deployPasstNetworkBinding=true --overwrite
----

:FeatureName: Using the passt binding plugin to attach a VM to the primary UDN
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-autoupdate-custom-bootsource.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Edit the `HyperConverged` CR, adding the appropriate template and boot source in the `dataImportCronTemplates` section. For example:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configure-ksm-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can enable or disable {VirtProductName}'s kernel samepage merging (KSM) acti
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Edit the `ksmConfiguration` stanza:
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-configuring-aaq-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ You can configure the AAQ Operator by specifying the fields of the `spec.applica
.Procedure
* Update the `HyperConverged` CR by running the following command:
+
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc patch hco kubevirt-hyperconverged -n openshift-cnv --type merge -p '{
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} --type merge -p '{
"spec": {
"applicationAwareConfig": {
"vmiCalcConfigName": "DedicatedVirtualResources",
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configuring-certificate-rotation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can do this during {VirtProductName} installation in the web console or afte
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Edit the `spec.certConfig` fields as shown in the following example. To avoid overloading the system, ensure that all values are greater than or equal to 10 minutes. Express all values as strings that comply with the link:https://golang.org/pkg/time/#ParseDuration[golang `ParseDuration` format].
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-configuring-cluster-dpdk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ $ oc get performanceprofiles.performance.openshift.io profile-1 -o=jsonpath='{.s
+
[source,terminal,subs="attributes+"]
----
$ oc patch hyperconverged kubevirt-hyperconverged -n {CNVNamespace} \
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} \
--type='json' -p='[{"op": "add", "path": "/spec/defaultRuntimeClass", "value":"<runtimeclass-name>"}]'
----
+
Expand All @@ -119,7 +119,7 @@ Editing the `HyperConverged` CR changes a global setting that affects all VMs th
+
[source,terminal,subs="attributes+"]
----
$ oc patch hyperconverged kubevirt-hyperconverged -n {CNVNamespace} \
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} \
--type='json' -p='[{"op": "replace", "path": "/spec/featureGates/alignCPUs", "value": true}]'
----
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can configure an eviction strategy for a cluster by using the command line.
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Set the cluster eviction strategy as shown in the following example:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configuring-default-cpu-model.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The `defaultCPUModel` is case sensitive.
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Add the `defaultCPUModel` field to the CR and set the value to the name of a CPU model that exists in the cluster:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configuring-highburst-profile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can use the `highBurst` profile to create and maintain a large number of vir
+
[source,terminal,subs="attributes+"]
----
$ oc patch hyperconverged kubevirt-hyperconverged -n {CNVNamespace} \
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} \
--type=json -p='[{"op": "add", "path": "/spec/tuningPolicy", \
"value": "highBurst"}]'
----
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configuring-live-migration-heavy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Configure live migration for heavy workloads by updating the `HyperConverged` cu
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----
+
Example configuration file:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configuring-live-migration-limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Configure live migration limits and timeouts for the cluster by updating the `Hy
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----
+
Example configuration file:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configuring-pod-log-verbosity.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can configure the verbosity level of {VirtProductName} pod logs by editing t
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Set the log level for one or more components by editing the `spec.logVerbosityConfig` stanza. For example:
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-configuring-secondary-dns-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The Cluster Network Addons Operator (CNAO) deploys a Domain Name Server (DNS) se
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Enable the DNS server and monitoring components according to the following example:
Expand Down Expand Up @@ -69,7 +69,7 @@ dns-lb LoadBalancer 172.30.27.5 10.46.41.94 53:31829/TCP 5s
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Add the external IP address that you previously retrieved to the `kubeSecondaryDNSNameServerIP` field in the enterprise DNS server records. For example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ spec:
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Add the name of the `NetworkAttachmentDefinition` object to the `spec.liveMigrationConfig` stanza of the `HyperConverged` CR.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To ensure stable behavior and avoid unnecessary re-importing, you can specify th
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Add the `dataImportCronTemplate` to the spec section of the `HyperConverged` resource and set the `storageClassName`:
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-configuring-vm-use-usb-device.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ You can configure virtual machine (VM) access to a USB device. This configuratio

. In the `HyperConverged` custom resource (CR), find the assigned resource name of the USB device:
+
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc get hyperconverged kubevirt-hyperconverged -n openshift-cnv
$ oc get {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----
+
*Example output*
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-configuring-workload-update-methods.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If a `VirtualMachineInstance` CR contains `evictionStrategy: LiveMigrate` and th
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Edit the `workloadUpdateStrategy` stanza of the `HyperConverged` CR. For example:
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-creating-and-exposing-mediated-devices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ NVIDIA A2-2Q
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Create and expose the mediated devices by updating the configuration:
Expand All @@ -97,7 +97,7 @@ Example `HyperConverged` CR:
+
[source,yaml,subs="attributes+"]
----
apiVersion: hco.kubevirt.io/v1
apiVersion: hco.kubevirt.io/v1beta1
kind: HyperConverged
metadata:
name: kubevirt-hyperconverged
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-custom-kubemacpool-range.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ As a cluster administrator, you can configure this range to ensure that MAC addr
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Update the `HyperConverged` CR to configure the `rangeStart` and `rangeEnd` parameters that define your required MAC address range:
Expand All @@ -46,7 +46,7 @@ spec:
+
[source,terminal,subs="attributes+"]
----
$ oc get hco kubevirt-hyperconverged -n {CNVNamespace} -o=jsonpath='{.spec.kubeMacPoolConfiguration}'
$ oc get {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} -o=jsonpath='{.spec.kubeMacPoolConfiguration}'
----
+
If you have successfully applied the configuration changes, the output shows the new MAC pool range you have configured:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-defining-storageclass.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can define the storage class that the Containerized Data Importer (CDI) uses
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Add the `spec.scratchSpaceStorageClass` field to the CR, setting the value to the name of a storage class that exists in the cluster:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-disable-auto-updates-single-boot-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can disable automatic updates for an individual boot source, whether it is c
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Disable automatic updates for an individual boot source by editing the `spec.dataImportCronTemplates` field.
Expand Down
8 changes: 4 additions & 4 deletions modules/virt-disable-kubervirt-hotplug-ratio.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ If you are a cluster administrator and want to disable hot plugging for an entir

. Modify the `HyperConverged` CR and set the `maxHotplugRatio` value to `1.0`:
+
[source,yaml]
[source,yaml,subs="attributes+"]
----
apiVersion: hco.kubevirt.io/v1beta1
kind: HyperConverged
metadata:
name: kubevirt-hyperconverged
namespace: kubevirt-hyperconverged
namespace: {CNVNamespace}
spec:
# ...
kubevirtConfiguration:
Expand All @@ -44,9 +44,9 @@ $ oc apply -f <filename>.yaml

. Check that you have configured the `maxHotplugRatio` value correctly, by running the following command:
+
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc get hyperconverged -n openshift-cnv -o jsonpath='{.spec.liveUpdateConfiguration.maxHotplugRatio}'
$ oc get {HCOCliKind} -n {CNVNamespace} -o jsonpath='{.spec.liveUpdateConfiguration.maxHotplugRatio}'
----
+
If the configuration was successful, the output is the `maxHotplugRatio` value that you set in the previous procedure:
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-disabling-tls-for-registry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can disable TLS (transport layer security) for one or more container registr
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Add a list of insecure registries to the `spec.storageImport.insecureRegistries` field.
Expand Down
2 changes: 1 addition & 1 deletion modules/virt-enable-guest-log-default-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can enable default access to VM guest system logs by editing the `HyperConve
+
[source,terminal,subs="attributes+"]
----
$ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
$ oc edit {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace}
----

. Update the `disableSerialConsoleLog` value. For example:
Expand Down
4 changes: 2 additions & 2 deletions modules/virt-enabling-aaq-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ To deploy the AAQ Operator, set the `enableApplicationAwareQuota` field value to
.Procedure
* Set the `enableApplicationAwareQuota` field value to `true` in the `HyperConverged` CR by running the following command:
+
[source,terminal]
[source,terminal,subs="attributes+"]
----
$ oc patch hco kubevirt-hyperconverged -n openshift-cnv \
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} \
--type json -p '[{"op": "add", "path": "/spec/enableApplicationAwareQuota", "value": true}]'
----
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To expose downward metrics for a host virtual machine, you can enable the `downw
+
[source,terminal,subs="attributes+"]
----
$ oc patch hco kubevirt-hyperconverged -n openshift-cnv \
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} \
--type json -p '[{"op": "replace", "path": \
"/spec/featureGates/downwardMetrics", \
"value": true}]'
Expand All @@ -32,7 +32,7 @@ $ oc patch hco kubevirt-hyperconverged -n openshift-cnv \
+
[source,terminal,subs="attributes+"]
----
$ oc patch hco kubevirt-hyperconverged -n openshift-cnv \
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} \
--type json -p '[{"op": "replace", "path": \
"/spec/featureGates/downwardMetrics", \
"value": false}]'
Expand Down
Loading