Commit Graph

582 Commits

Author SHA1 Message Date
alromeros 65f17beff5
Update vmexport docs with new flags (#903)
This commit updates the docs for the vmexport command with new flags and functionality examples.

Signed-off-by: Alvaro Romero <alromero@redhat.com>
2025-07-18 18:01:41 +01:00
Or Shoval f530840e6f
dns: Add note about ndots (#907)
Following https://github.com/kubevirt/kubevirt/issues/14934
We can see that when using subdomain,
`nslookup vmi.subdomain` won't resolve.
Reason is that despite virt-launcher has default k8s ndots:5,
ndots option isn't populated to the guest, and depends on the local resolver.

If desired, cloud init can be used to override ndots.

      - cloudInitNoCloud:
          userData: |-
            #cloud-config
            bootcmd:
            - nmcli connection modify "System eth0" ipv4.dns-options "ndots:2"
            - nmcli connection up "System eth0"
        name: cloudinitdisk

Update docs about ndots effect.

Signed-off-by: Or Shoval <oshoval@redhat.com>
2025-07-17 08:15:37 +01:00
Lee Yarwood 3c71826ed6
cluster_admin: Remove s390x and arm64 specific nightly installation docs (#909)
We now provide these arch specific images under a single nightly
manifest allowing users to use the same set of commands to install our
nightly builds across amd64, arm64 and s390x.

Signed-off-by: Lee Yarwood <lyarwood@redhat.com>
2025-07-16 09:49:36 +01:00
SKALA NETWORKS 3a9f2c3f56
feat(snapshot_api): add new volumeRestoreOverrides/volumeRestorePolicy features and gitops tips (#899)
Signed-off-by: Skala Networks <contact@skala.network>
2025-07-01 03:54:12 +01:00
Orel Misan 4d5107eb6c
net, hotplug: Add note about auto migration (#900)
Starting KubeVirt 1.6, the VM will be automatically migrated on
hotplug and hot-unplug scenarios.

[1] https://github.com/kubevirt/kubevirt/pull/14259

Signed-off-by: Orel Misan <omisan@redhat.com>
2025-06-29 14:32:10 +02:00
Lee Yarwood 26cf2ad24c
instancetype: Clean up docs ahead of v1.6.0 release (#902)
* instancetype: Add basic hotplug docs

Signed-off-by: Lee Yarwood <lyarwood@redhat.com>

* instancetype: Add >= v1.5.0 versioning docs

Signed-off-by: Lee Yarwood <lyarwood@redhat.com>

* instancetype: Add reference policy GA details

Signed-off-by: Lee Yarwood <lyarwood@redhat.com>

---------

Signed-off-by: Lee Yarwood <lyarwood@redhat.com>
2025-06-23 14:58:44 +02:00
Anish Bista 9a881e4b43
Add a note about VMIM hardening in NIC hotplug docs (#893)
Signed-off-by: Anish Bista <anishbista053@gmail.com>
2025-06-23 13:12:43 +02:00
Lennart Jern dfff2c1fca
storage: Add note about CDI and device ownership (#892)
Signed-off-by: Lennart Jern <lennart.jern@est.tech>
2025-06-03 09:46:10 +02:00
Orel Misan 6e36ee783a
CPU hotplug: Add net multi-queue limitation (#897)
PR kubevirt/kubevirt#14728, enabled CPU hotplug with network
multi-queue.

The fix was backported to release-1.5 [1] and release-1.4 [2].

[1] https://github.com/kubevirt/kubevirt/pull/14762
[2] https://github.com/kubevirt/kubevirt/pull/14763

Signed-off-by: Orel Misan <omisan@redhat.com>
2025-05-28 21:34:06 +02:00
SKALA NETWORKS c535d6caff
chore(doc): document missing features in vmsnapshotrestores (#890)
* chore(doc): document missing features in vmsnapshotrestores

Signed-off-by: SkalaNetworks <contact@skala.network>

* fix(clone_api): move json patches to clone api

Signed-off-by: SkalaNetworks <contact@skala.network>

---------

Signed-off-by: SkalaNetworks <contact@skala.network>
2025-05-21 15:51:27 +02:00
Felix Matouschek 7a6018d1d4
Document how to run legacy Windows versions (#895)
This adds documentation for the kubevirt.io/disablePCIHole64 annotation,
that allows to run legacy Windows versions on KubeVirt.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
2025-05-15 22:58:02 +02:00
James Force dbb990dcdd
Fixed broken examples of liveness and readiness probes (#865) (#883)
* Fixed broken examples of liveness and readiness probes (#865)

Signed-off-by: jforce <jforce@redhat.com>

* Update docs/user_workloads/liveness_and_readiness_probes.md

Co-authored-by: Federico Fossemò <ffossemo@redhat.com>
Signed-off-by: James Force <jforce@redhat.com>

* Rollback busybox trigger

Signed-off-by: James Force <jforce@redhat.com>

---------

Signed-off-by: jforce <jforce@redhat.com>
Signed-off-by: James Force <jforce@redhat.com>
Co-authored-by: Federico Fossemò <ffossemo@redhat.com>
2025-05-14 16:10:03 +02:00
Alice Frosi 630de94c7e
Document supplementalPool iothreads policy (#889)
Signed-off-by: Alice Frosi <afrosi@redhat.com>
2025-05-12 16:55:59 +02:00
Anish Bista c618e3305c
Update VM instead of VMI when exposing service objects (#839)
Signed-off-by: Anish Bista <anishbista053@gmail.com>
2025-05-09 10:21:56 +02:00
Barak Mordehai 0454801a3d
Modify docs regarding AutoResourceLimits FeatureGate (#876)
As it is GAed already

Signed-off-by: bmordeha <bmordeha@redhat.com>
2025-04-28 16:04:27 +02:00
Sibo Wang 5bc1a5ef9c
Update the completionTimeoutPerGiB default value and corresponding examples (#887)
Signed-off-by: Sibo Wang <siwang@redhat.com>
2025-04-21 11:57:42 +02:00
Nir Dothan e7000396e3
net, binding: Add managedTap (#884)
* net, binding: Remove FG requirement

Network binding plugins are GA since v1.5
https://github.com/kubevirt/kubevirt/pull/13314

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* net, binding: Add managedTap attachmentType

Available since v1.4.
Introduced in https://github.com/kubevirt/kubevirt/pull/13024.

Signed-off-by: Nir Dothan <ndothan@redhat.com>

---------

Signed-off-by: Nir Dothan <ndothan@redhat.com>
2025-04-17 15:51:40 +02:00
Federico Fossemò 07c9d6e133
Remove VMLiveUpdateFeatures FG references (#875)
Signed-off-by: fossedihelm <ffossemo@redhat.com>
2025-04-15 16:07:39 +02:00
Lee Yarwood b53bc70f2a
common-instancetypes: Correct spelling, formatting and enabled example (#882)
The field is actually `enabled` and not `enable` as documented in the
API reference guide below:

https://kubevirt.io/api-reference/main/definitions.html#_v1_commoninstancetypesdeployment

Signed-off-by: Lee Yarwood <lyarwood@redhat.com>
2025-04-11 21:53:35 +02:00
Nir Dothan 6400e5cb46
net, ifaces: Fix ports section (#881)
* net, ifaces: Fix ports documentation

The current documentation is incorrect. It indicates that the ports attribute
serves as some sort of firewall, when in fact is has a diffent effect on each
net binding. It is basically either a list of ports to forward or it has no effect
at all.

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* net, ifaces: Fix broken example

It currently says 'configured via cloud init, as shown below',
the example below has no cloud init.  Then in the bottom the note
inbdicates  'The IPv6 address for the VM and default gateway **must** be the ones
shown above', but nothing is showing above.
Hence resore the cloud-init part from the older documentation.

Signed-off-by: Nir Dothan <ndothan@redhat.com>

---------

Signed-off-by: Nir Dothan <ndothan@redhat.com>
2025-04-08 22:34:00 +02:00
Pierre-Yves Aillet 3ce7d53b9c
Update activating_feature_gates.md (#880)
* Update activating_feature_gates.md

Hi and thanks for this great project :)

I propose this modification because it took me some time to identify which value I should put on the yaml configuration to activate a specific Feature Gate.
I hope this change would help others.

Feel free to apply any modification if needed.

Signed-off-by: Pierre-Yves Aillet <pyaillet@users.noreply.github.com>

* Update docs/cluster_admin/activating_feature_gates.md

Fix after review

Co-authored-by: Itamar Holder <77444623+iholder101@users.noreply.github.com>
Signed-off-by: Pierre-Yves Aillet <pyaillet@users.noreply.github.com>

---------

Signed-off-by: Pierre-Yves Aillet <pyaillet@users.noreply.github.com>
Co-authored-by: Itamar Holder <77444623+iholder101@users.noreply.github.com>
2025-04-07 11:56:00 +02:00
Lee Yarwood d4ea2bc746
instancetype: Add InstancetypeReferencePolicy docs (#879)
Signed-off-by: Lee Yarwood <lyarwood@redhat.com>
2025-03-24 15:15:01 +01:00
aburdenthehand 76ed46e021
Adding v1.5 release notes to docs (#872)
Signed-off-by: Andrew Burden <aburden@redhat.com>
2025-03-14 10:50:05 +01:00
Orel Misan 8f27633c46
network: Add link state management section (#864)
Add documentation for the link state management feature.

Signed-off-by: Orel Misan <omisan@redhat.com>
2025-03-14 02:20:05 +01:00
Felix Matouschek d89cefbab1
virtctl: Cleanups to accessing VMs with virtctl ssh (#871)
These cleanups bring the documentation in line with the current
implementation of ssh and scp in virtctl.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
2025-03-13 09:38:04 +01:00
Felix Matouschek 8a052a6f17
vmpool: Update how to use individual configuration per VM (#868)
Update the description for using individual configuration per VM to
match the actual implementation in KubeVirt.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
2025-03-12 16:40:05 +01:00
Alice Frosi d3978402d4
Update volume migration doc (#840)
* Add volume migration cancellation and recovery

Signed-off-by: Alice Frosi <afrosi@redhat.com>

* Fix the title for volume migration doc

Signed-off-by: Alice Frosi <afrosi@redhat.com>

* Add volume_migration to the storage pages

Signed-off-by: Alice Frosi <afrosi@redhat.com>

---------

Signed-off-by: Alice Frosi <afrosi@redhat.com>
2025-03-04 11:25:29 +01:00
aburdenthehand 4eb612758c
removing need for VolumeUpdateStrategy and VolumeMigration feature gates (#873)
Signed-off-by: Andrew Burden <aburden@redhat.com>
2025-03-04 09:51:28 +01:00
Vladik Romanovsky e648b7e39a
Document the AllowWorkloadDisruption migration option (#863)
Signed-off-by: Vladik Romanovsky <vromanso@redhat.com>
2025-02-24 13:30:45 +01:00
Alice Frosi 89aa0cae7e
volume-migration: describe migration cancellation and recovery (#862)
Signed-off-by: Alice Frosi <afrosi@redhat.com>
2025-02-19 15:09:25 +01:00
Itamar Holder a48b1d94c7
Change clone API version from v1alpha1 to v1beta1 (#859)
To align with: https://github.com/kubevirt/kubevirt/pull/13520

Signed-off-by: Itamar Holder <iholder@redhat.com>
2025-02-17 14:59:24 +01:00
Ben Chapman aa073a0b64
Update virtual_hardware.md (#829)
This is a minor update to the Video and Graphics Device section, to clarify _not_ attaching a graphics device to a `VirtualMachineInstance`

Signed-off-by: Ben Chapman <5124569+Ben-Chapman@users.noreply.github.com>
2025-02-13 13:18:47 +01:00
mengkai 9d5a14466a
Fix the number of RunStrategies in RunStrategies.md (#869)
Signed-off-by: Mengkai <2608074326@qq.com>
Co-authored-by: mengkai <mengkai@cmss.chinamobile.com>
2025-02-11 14:12:46 +01:00
Javier Cano Cano 946faff049
virtiofs: Update feature gate usage, privileged containers and live migration (#866)
Change [#11997](https://github.com/kubevirt/kubevirt/pull/11997/)
introduces new feature gates for virtiofs and dropped the support of
privileged sharing mode. It syncs the documentation to the mentioned
change:

* Users need to enable the feature gate
  `EnableVirtioFsConfigVolumes` for sharing `configMaps`, `secrets`,
and `serviceAccounts`.
* Users need to enable the feature gate `EnableVirtioFsStorageVolumes`
  for sharing `PVCs`.
* Dropped support of privileged sharing mode.

Moreover, change
[#13756](https://github.com/kubevirt/kubevirt/pull/13756) enables to
migrate VMs while sharing devices with virtiofs. Therefore, all mentions
to live migration has been dropped.

Signed-off-by: Javier Cano Cano <jcanocan@redhat.com>
2025-02-05 16:33:12 +01:00
eryalito 64b41161b5
docs: Fix yaml file spacing on intallation.md (#838)
Signed-off-by: eryalito <eryalito@gmail.com>
2025-01-30 11:13:06 +01:00
Sumit Kumar Soni 01de5d190a
chore: replace device name for disks with bus type virtio as dev name is unsupported (#858)
Signed-off-by: zelfroster <sumitkumarsoni123@gmail.com>
2025-01-29 19:27:05 +01:00
Damien ceb20a0215
(migration_policies) fix wrong spec indentation (#854)
Signed-off-by: Damien Dassieu <dassieu.damien@gmail.com>
2025-01-20 12:04:49 +01:00
Lee Yarwood 21438caafa
common-instancetypes: Remove FG and update docs (#847)
Signed-off-by: Lee Yarwood <lyarwood@redhat.com>
2025-01-15 18:04:46 +01:00
Ian Bishop 0898196860
Update persistent TPM & UEFI page to clarify storageclass requirements (#830)
* Update persistent TPM & UEFI to clarify storageclass requirements

Signed-off-by: Ian Bishop <151477169+ianb-mp@users.noreply.github.com>

* persistent TPM & UEFI, corrections

Signed-off-by: Ian Bishop <151477169+ianb-mp@users.noreply.github.com>

* persistent TPM & UEFI, corrections

Signed-off-by: Ian Bishop <151477169+ianb-mp@users.noreply.github.com>

---------

Signed-off-by: Ian Bishop <151477169+ianb-mp@users.noreply.github.com>
2025-01-13 09:18:36 +01:00
Felix Matouschek f13b3b330d
fix(virtctl): Use correct flag for sysprep volume in example (#861)
Change the virtctl create vm examples to use the correct flag for adding
a sysprep volume to a created VM.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
2025-01-09 11:58:33 +01:00
Orel Misan aec5dde3d5
passt binding plugin: Update migration method (#860)
Currently, the passt binding plugin is registered using the LinkRefresh
migration method.

Unfortunately, the LinkRefresh method does not work well with all
guest OSes.
Add an explanation about this change and its consequences.

Signed-off-by: Orel Misan <omisan@redhat.com>
2024-12-19 15:12:08 +01:00
Itamar Holder 671254802d
Reflect the fact that VMsnapshots are already supported as clone source (#855)
Signed-off-by: Itamar Holder <iholder@redhat.com>
2024-12-10 15:53:43 +01:00
Nir Dothan 1724ad555f
compute, live-migrations: fix typo and improve grammer (#857)
* compute, live-migrations: Fix typo

migrationConfiguration does not exist in schema. Correct it to migrations.

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* compute, live-migrations: Improve grammer

Remove occurances of the word "being" which seems to have been overly used,
in order to make the text more concise

Signed-off-by: Nir Dothan <ndothan@redhat.com>

---------

Signed-off-by: Nir Dothan <ndothan@redhat.com>
2024-12-10 15:25:43 +01:00
Felix Matouschek e89accc2f9
creating_vms: Update example description (#853)
Update the example description to match the latest usage examples in
virtctl.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
2024-11-14 10:52:53 +01:00
Felix Matouschek 0ecba3f90b
virtctl: Overhaul virtctl create vm docs (#851)
* virtctl: Move Instancetype and Preference creation

Move the creation of instance types and preferences into their own page.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>

* virtctl: Minor enhancements to Instancetype and Preference creation

Apply minor enhancements to the instancetype and preference creation:

- Use code blocks for flags
- Be more specific about which resources are created
- Add colons to examples
- Reformat file to not exceed line length of 80
- Change heading levels to help the ToC

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>

* virtctl: Overhaul virtctl create vm docs

Overhaul the virtctl create vm docs by:

- Adding documentation for generatin cloud-init user data
- Adding documentation for the access credential flag
- Adding documentation for the sysprep volume flag
- Updating and extending the examples
- Applying minor fixes throughout the file

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>

---------

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
2024-11-14 10:18:53 +01:00
aburdenthehand e143ec31cb
Adding categorised release notes for the v1.4 release (#850)
Signed-off-by: Andrew Burden <aburden@redhat.com>
2024-11-13 16:18:53 +01:00
Eugenio Marzo 4ca0145970
Correct typo in contributing guide (#852)
Signed-off-by: Eugenio Marzo <luckysideburn@gmail.com>
Co-authored-by: Eugenio Marzo <eugenio@sourcesense.com>
2024-11-13 13:16:53 +01:00
Nir Dothan 0eb0f605b3
Interfaces and networks: update the networks and interfaces sections (#844)
* interfaces and networks: additional organization and cleanup

technical commit to make up for changes that had "slipped out"
of PR https://github.com/kubevirt/user-guide/pull/843/
- virtio-net multiqueue: push to the bottom under Additional Notes
- MTU: move up above virtio-net multiqueue, under Aditional Notes

no changes in content only positioning

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* networks: fix examples, links, multus primary net

- lose backend and frontend vocabulary
- inidicate that multus can be primary
- highlight advantages of pod network
- fix all yaml exmlpes in networks section such that it is closer to real VM schema
- fix multus links to the project that kubevirt actually uses
- chnage the bridge network+NAD example to a one that really works

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* interfaces: highlight plugins, remove redundant

    - highlight network biniding plugins
    - iptables -> nftables in masqurade
    - address ports as allow-list as opposed to port-forwarding
    - remove macvtap core bindings
      and reference the binding plugins instead
    - remove slirp following removal in v1.3.0 by PR https://github.com/kubevirt/kubevirt/pull/11701

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* interfaces: remove passt

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* interfaces: refactor sriov

remove  references  to sriov-network-operator as it is not strictly required
and is not a part of kubevirt upstream

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* modify all remaining broken VM spec yaml examples

All those example  started with type: VM which doesn't exist included
a "shortened" path to domain and network.
make all of those closer to the real schema and add a comment to each indicating that the
example is incomplete

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* convert HTML tables to Markdown tables

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* vmi to vm: modify indications and examples

use VM instead of VMI wherever applicable as VM is the offical
user facing API.

Signed-off-by: Nir Dothan <ndothan@redhat.com>

* interfaces: shorten example manifests

small verbiage corrections
elaborate sriov prep

Signed-off-by: Nir Dothan <ndothan@redhat.com>

---------

Signed-off-by: Nir Dothan <ndothan@redhat.com>
2024-11-12 15:54:52 +01:00
Nir Dothan a90d41d766
interfaces and networks: organization and cleanup (#843)
rearrange sections such that reading through would be easier,
mainly by moving most restiriction and limitations to the bottom.
Main sections are: Networks, Interfcaes. Security, Limitations and Known Issues, Additional Notes
Later on links will be added from the  sections in the top to their limitations in the bottom

Signed-off-by: Nir Dothan <ndothan@redhat.com>
2024-11-01 11:30:58 +01:00
Arnon Gilboa 7b21403c24
Change spec.running refs to runStrategy (#849)
* Change spec.running refs to runStrategy

Signed-off-by: Arnon Gilboa <agilboa@redhat.com>

* Textual cosmetics

Signed-off-by: Arnon Gilboa <agilboa@redhat.com>

---------

Signed-off-by: Arnon Gilboa <agilboa@redhat.com>
2024-10-30 14:08:56 +01:00