Skip to content

Commit 0f98458

Browse files
authored
Merge pull request #61688 from apinnick/cnv-reorg
CNV docs reorganization
2 parents 93b2a18 + af64e17 commit 0f98458

File tree

68 files changed

+494
-523
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+494
-523
lines changed

_topic_maps/_topic_map.yml

Lines changed: 46 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -3594,78 +3594,75 @@ Name: Virtualization
35943594
Dir: virt
35953595
Distros: openshift-enterprise,openshift-origin
35963596
Topics:
3597-
- Name: About OpenShift Virtualization
3598-
File: about-virt
3597+
- Name: About
3598+
Dir: about_virt
3599+
Topics:
3600+
- Name: About OpenShift Virtualization
3601+
File: about-virt
3602+
Distros: openshift-enterprise
3603+
- Name: About OKD Virtualization
3604+
File: about-virt
3605+
Distros: openshift-origin
3606+
- Name: Security policies
3607+
File: virt-security-policies
3608+
- Name: Architecture
3609+
File: virt-architecture
3610+
Distros: openshift-enterprise
35993611
- Name: Release notes
36003612
Dir: release_notes
36013613
Topics:
36023614
- Name: OpenShift Virtualization release notes
3603-
File: placeholder-release-notes
3615+
File: virt-release-notes-placeholder
3616+
Distros: openshift-enterprise
3617+
# - Name: OKD Virtualization release notes
3618+
# File: virt-release-notes-placeholder
3619+
# Distros: openshift-origin
3620+
- Name: Getting started
3621+
Dir: getting_started
3622+
Topics:
3623+
- Name: Getting started with OpenShift Virtualization
3624+
File: virt-getting-started
3625+
Distros: openshift-enterprise
3626+
- Name: Getting started with OKD Virtualization
3627+
File: virt-getting-started
3628+
Distros: openshift-origin
3629+
- Name: Using the virtctl and libguestfs CLI tools
3630+
File: virt-using-the-cli-tools
3631+
- Name: Web console overview
3632+
File: virt-web-console-overview
36043633
Distros: openshift-enterprise
3605-
# - Name: Release notes
3606-
# Dir: release_notes
3607-
# Topics:
3608-
# - Name: OKD release notes
3609-
# File: placeholder-release-notes
3610-
# Distros: openshift-origin
3611-
- Name: OpenShift Virtualization architecture
3612-
File: virt-architecture
3613-
Distros: openshift-enterprise
3614-
- Name: About OKD Virtualization
3615-
File: about-virt
3616-
Distros: openshift-origin
3617-
- Name: Getting started with OpenShift Virtualization
3618-
File: virt-getting-started
3619-
Distros: openshift-enterprise
3620-
- Name: Getting started with OKD Virtualization
3621-
File: virt-getting-started
3622-
Distros: openshift-origin
3623-
- Name: Web console overview
3624-
File: virt-web-console-overview
3625-
Distros: openshift-enterprise
36263634
- Name: Installing
36273635
Dir: install
36283636
Topics:
3629-
- Name: Preparing your cluster for OpenShift Virtualization
3637+
- Name: Preparing your cluster
36303638
File: preparing-cluster-for-virt
3639+
- Name: Installing OpenShift Virtualization
3640+
File: installing-virt
36313641
Distros: openshift-enterprise
3632-
- Name: Preparing your OKD cluster for OKD Virtualization
3633-
File: preparing-cluster-for-virt
3642+
- Name: Installing OKD Virtualization
3643+
File: installing-virt
36343644
Distros: openshift-origin
36353645
- Name: Specifying nodes for OpenShift Virtualization components
36363646
File: virt-specifying-nodes-for-virtualization-components
36373647
Distros: openshift-enterprise
36383648
- Name: Specifying nodes for OKD Virtualization components
36393649
File: virt-specifying-nodes-for-virtualization-components
36403650
Distros: openshift-origin
3641-
- Name: Installing OpenShift Virtualization using the web console
3642-
File: installing-virt-web
3643-
Distros: openshift-enterprise
3644-
- Name: Installing OKD Virtualization using the web console
3645-
File: installing-virt-web
3646-
Distros: openshift-origin
3647-
- Name: Installing OpenShift Virtualization using the CLI
3648-
File: installing-virt-cli
3649-
Distros: openshift-enterprise
3650-
- Name: Installing OKD Virtualization using the CLI
3651-
File: installing-virt-cli
3652-
Distros: openshift-origin
36533651
- Name: Uninstalling OpenShift Virtualization
36543652
File: uninstalling-virt
36553653
Distros: openshift-enterprise
36563654
- Name: Uninstalling OKD Virtualization
36573655
File: uninstalling-virt
36583656
Distros: openshift-origin
3659-
- Name: Updating OpenShift Virtualization
3660-
File: upgrading-virt
3661-
Distros: openshift-enterprise
3662-
- Name: Updating OKD Virtualization
3663-
File: upgrading-virt
3664-
Distros: openshift-origin
3665-
- Name: Security policies
3666-
File: virt-security-policies
3667-
- Name: Using the virtctl and libguestfs CLI tools
3668-
File: virt-using-the-cli-tools
3657+
- Name: Updating
3658+
Dir: updating
3659+
Topics:
3660+
- Name: Updating OpenShift Virtualization
3661+
File: upgrading-virt
3662+
Distros: openshift-enterprise
3663+
- Name: Updating OKD Virtualization
3664+
File: upgrading-virt
3665+
Distros: openshift-origin
36693666
- Name: Virtual machines
36703667
Dir: virtual_machines
36713668
Topics:

applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The Managed services option is also available if the RHOAS Operator is installed
5050
* *Re-ordering of resources*: Use these resources to re-order pinned resources added to your navigation pane. The drag-and-drop icon is displayed on the left side of the pinned resource when you hover over it in the navigation pane. The dragged resource can be dropped only in the section where it resides.
5151
5252
ifdef::openshift-enterprise,openshift-webscale[]
53-
Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the xref:../../cicd/pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines Operator], link:https://docs.openshift.com/serverless/1.28/install/install-serverless-operator.html#serverless-install-web-console_install-serverless-operator[{ServerlessOperatorName}], and xref:../../virt/install/installing-virt-web.adoc#virt-subscribing-to-the-catalog_installing-virt-web[OpenShift Virtualization Operator] are installed, respectively.
53+
Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the xref:../../cicd/pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines Operator], link:https://docs.openshift.com/serverless/1.28/install/install-serverless-operator.html#serverless-install-web-console_install-serverless-operator[{ServerlessOperatorName}], and xref:../../virt/install/installing-virt.adoc#virt-subscribing-cli_installing-virt[OpenShift Virtualization Operator] are installed, respectively.
5454
endif::[]
5555

5656
[id="prerequisites_odc-creating-applications-using-developer-perspective"]

installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=
1717
[role="_additional-resources"]
1818
.Additional resources
1919

20+
* xref:../../virt/getting_started/virt-getting-started.adoc#virt-getting-started[Getting started with {VirtProductName}]
2021
* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}]
21-
* xref:../../virt/virt-getting-started.adoc#virt-getting-started[Getting started with {VirtProductName}]
2222
* xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks]
2323
* xref:../../virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc#virt-attaching-vm-to-sriov-network[Connecting a virtual machine to an SR-IOV network]
2424

installing/installing_sno/install-sno-installing-sno.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ include::modules/install-sno-generating-the-discovery-iso-with-the-assisted-inst
2020
.Additional resources
2121

2222
* xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#persistent-storage-using-lvms_logical-volume-manager-storage[Persistent storage using logical volume manager storage]
23-
* xref:../../virt/about-virt.adoc#virt-what-you-can-do-with-virt_about-virt[What you can do with OpenShift Virtualization]
23+
* xref:../../virt/about_virt/about-virt.adoc#virt-what-you-can-do-with-virt_about-virt[What you can do with OpenShift Virtualization]
2424

2525
include::modules/install-sno-installing-with-the-assisted-installer.adoc[leveloffset=+2]
2626

modules/olm-approving-pending-upgrade.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * operators/admin/olm-upgrading-operators.adoc
4-
// * virt/upgrading-virt.adoc
4+
// * virt/updating/upgrading-virt.adoc
55

66
:_content-type: PROCEDURE
77
[id="olm-approving-pending-upgrade_{context}"]

modules/virt-about-eus-updates.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/upgrading-virt.adoc
3+
// * virt/updating/upgrading-virt.adoc
44

55
:_content-type: CONCEPT
66
[id="virt-about-eus-updates_{context}"]
77
= About EUS-to-EUS updates
88

9-
Every even-numbered minor version of {product-title}, including 4.10 and 4.12, is an Extended Update Support (EUS) version. However, because Kubernetes design mandates serial minor version updates, you cannot directly update from one EUS version to the next.
9+
Every even-numbered minor version of {product-title}, including 4.10 and 4.12, is an Extended Update Support (EUS) version. However, because Kubernetes design mandates serial minor version updates, you cannot directly update from one EUS version to the next.
1010

11-
After you update from the source EUS version to the next odd-numbered minor version, you must sequentially update {VirtProductName} to all z-stream releases of that minor version that are on your update path. When you have upgraded to the latest applicable z-stream version, you can then update {product-title} to the target EUS minor version.
11+
After you update from the source EUS version to the next odd-numbered minor version, you must sequentially update {VirtProductName} to all z-stream releases of that minor version that are on your update path. When you have upgraded to the latest applicable z-stream version, you can then update {product-title} to the target EUS minor version.
1212

1313
When the {product-title} update succeeds, the corresponding update for {VirtProductName} becomes available. You can now update {VirtProductName} to the target EUS version.
1414

@@ -17,7 +17,7 @@ When the {product-title} update succeeds, the corresponding update for {VirtProd
1717

1818
Before beginning an EUS-to-EUS update, you must:
1919

20-
* Pause worker nodes' machine config pools before you start an EUS-to-EUS update so that the workers are not rebooted twice.
20+
* Pause worker nodes' machine config pools before you start an EUS-to-EUS update so that the workers are not rebooted twice.
2121

2222
* Disable automatic workload updates before you begin the update process. This is to prevent {VirtProductName} from migrating or evicting your virtual machines (VMs) until you update to your target EUS version.
2323

modules/virt-about-libguestfs-tools-virtctl-guestfs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/virt-using-the-cli-tools.adoc
3+
// * virt/getting_started/virt-using-the-cli-tools.adoc
44

55
:_content-type: REFERENCE
66
[id="virt-about-libguestfs-tools-virtctl-guestfs_{context}"]

modules/virt-about-storage-volumes-for-vm-disks.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/about-virt.adoc
3+
// * virt/about/about-virt.adoc
4+
// * virt/install/preparing-cluster-for-virt.adoc
45

56
:_content-type: CONCEPT
67
[id="virt-about-storage-volumes-for-vm-disks_{context}"]
7-
= About storage volumes for virtual machine disks
8+
= About volume and access modes for virtual machine disks
89

9-
If you use the storage API with known storage providers, volume and access modes are selected automatically. However, if you use a storage class that does not have a storage profile, you must select the volume and access mode.
10+
If you use the storage API with known storage providers, the volume and access modes are selected automatically. However, if you use a storage class that does not have a storage profile, you must configure the volume and access mode.
1011

11-
For best results, use `accessMode: ReadWriteMany` and `volumeMode: Block`. This is important for the following reasons:
12+
For best results, use the `ReadWriteMany` (RWX) access mode and the `Block` volume mode. This is important for the following reasons:
1213

13-
* The ReadWriteMany (RWX) access mode is required for live migration.
14+
* `ReadWriteMany` (RWX) access mode is required for live migration.
1415
15-
* The `Block` volume mode performs significantly better in comparison to the `Filesystem` volume mode. This is because the `Filesystem` volume mode uses more storage layers, including a file system layer and a disk image file. These layers are not necessary for VM disk storage.
16+
* The `Block` volume mode performs significantly better than the `Filesystem` volume mode. This is because the `Filesystem` volume mode uses more storage layers, including a file system layer and a disk image file. These layers are not necessary for VM disk storage.
1617
+
1718
For example, if you use {rh-storage-first}, Ceph RBD volumes are preferable to CephFS volumes.
18-
+
19+
1920
[IMPORTANT]
2021
====
21-
You cannot live migrate virtual machines that use:
22-
23-
* A storage volume with ReadWriteOnce (RWO) access mode
22+
You cannot live migrate virtual machines with the following configurations:
2423
24+
* Storage volume with `ReadWriteOnce` (RWO) access mode
2525
* Passthrough features such as GPUs
2626
2727
Do not set the `evictionStrategy` field to `LiveMigrate` for these virtual machines.

modules/virt-about-upgrading-virt.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/upgrading-virt.adoc
3+
// * virt/updating/upgrading-virt.adoc
44

55
:_content-type: CONCEPT
66
[id="virt-about-upgrading-virt_{context}"]

modules/virt-about-workload-updates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/upgrading-virt.adoc
3+
// * virt/updating/upgrading-virt.adoc
44

55
:_content-type: CONCEPT
66
[id="virt-about-workload-updates_{context}"]

0 commit comments

Comments
 (0)