Skip to content

Commit 724d68e

Browse files
authored
Merge pull request #73143 from sbeskin-redhat/CNV_29468_Update_pipeline_documentation
CNV-29468: Update pipeline documentation
2 parents efa6ede + 20caf09 commit 724d68e

File tree

5 files changed

+9
-59
lines changed

5 files changed

+9
-59
lines changed

modules/virt-about-ssp-operator.adoc

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,4 @@
66
[id="virt-about-ssp-operator_{context}"]
77
= About the Scheduling, Scale, and Performance (SSP) Operator
88

9-
The SSP Operator, `ssp-operator`, deploys the common templates, the related default boot sources, and the template validator.
10-
11-
image::cnv_components_ssp-operator.png[ssp-operator components]
12-
13-
.SSP Operator components
14-
[cols="1,1"]
15-
|===
16-
|*Component* |*Description*
17-
18-
|`deployment/create-vm-from-template`
19-
| Creates a VM from a template.
20-
21-
|`deployment/copy-template`
22-
| Copies a VM template.
23-
24-
|`deployment/modify-vm-template`
25-
| Creates or removes a VM template.
26-
27-
|`deployment/modify-data-object`
28-
| Creates or removes data volumes or data sources.
29-
30-
|`deployment/cleanup-vm`
31-
| Runs a script or a command on a VM, then stops or deletes the VM afterward.
32-
33-
|`deployment/disk-virt-customize`
34-
| Runs a `customize` script on a target persistent volume claim (PVC) using `virt-customize`.
35-
36-
|`deployment/disk-virt-sysprep`
37-
| Runs a `sysprep` script on a target PVC by using `virt-sysprep`.
38-
39-
|`deployment/wait-for-vmi-status`
40-
| Waits for a specific virtual machine instance (VMI) status, then fails or succeeds according to that status.
41-
42-
|`deployment/create-vm-from-manifest`
43-
| Creates a VM from a manifest.
44-
|===
9+
The SSP Operator, `ssp-operator`, deploys the common templates, the related default boot sources, the pipeline tasks, and the template validator.

modules/virt-temporary-token-VNC.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,12 @@ $ virtctl vnc <vm_name> -n <namespace>
7070

7171
[WARNING]
7272
====
73-
It is currently not possible to revoke a specific token.
73+
It is currently not possible to revoke a specific token.
7474
7575
To revoke a token, you must delete the service account that was used to create it. However, this also revokes all other tokens that were created by using the service account. Use the following command with caution:
7676
7777
[source,terminal]
7878
----
79-
$ virtctl delete serviceaccount --namespace "<namespace>" "<vm_name>-vnc-access"
79+
$ virtctl delete serviceaccount --namespace "<namespace>" "<vm_name>-vnc-access"
8080
----
8181
====

virt/about_virt/virt-architecture.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ The Operator Lifecycle Manager (OLM) deploys operator pods for each component of
1212
* Storage: `cdi-operator`
1313
* Network: `cluster-network-addons-operator`
1414
* Scaling: `ssp-operator`
15-
* Templating: `tekton-tasks-operator`
1615
1716
OLM also deploys the `hyperconverged-cluster-operator` pod, which is responsible for the deployment, configuration, and life cycle of other components, and several helper pods: `hco-webhook`, and `hyperconverged-cluster-cli-download`.
1817

virt/live_migration/virt-configuring-live-migration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can configure live migration settings to ensure that the migration processes
1010

1111
You can configure live migration policies to apply different migration configurations to groups of virtual machines (VMs).
1212

13-
include::modules/virt-configuring-live-migration-limits.adoc[leveloffset=+2]
13+
include::modules/virt-configuring-live-migration-limits.adoc[leveloffset=+1]
1414

1515
[id="live-migration-policies"]
1616
== Live migration policies

virt/virtual_machines/virt-managing-vms-openshift-pipelines.adoc

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,25 @@ The Scheduling, Scale, and Performance (SSP) Operator integrates {VirtProductNam
1414
* Run commands in VMs
1515
* Manipulate disk images with `libguestfs` tools
1616
17-
:FeatureName: Managing virtual machines with {pipelines-title}
18-
include::snippets/technology-preview.adoc[]
19-
20-
2117
[id="prerequisites_virt-managing-vms-openshift-pipelines"]
2218
== Prerequisites
2319

2420
* You have access to an {product-title} cluster with `cluster-admin` permissions.
2521
* You have installed the OpenShift CLI (`oc`).
2622
* You have link:https://docs.openshift.com/pipelines/latest/install_config/installing-pipelines.html[installed {pipelines-shortname}].
2723

28-
29-
include::modules/virt-deploying-ssp.adoc[leveloffset=+1]
30-
3124
include::modules/virt-supported-ssp-tasks.adoc[leveloffset=+1]
3225

26+
[id="windows-efi-installer-pipeline_{context}"]
27+
== Windows EFI installer pipeline
3328

34-
[id="example-pipelines_virt-managing-vms-openshift-pipelines"]
35-
== Example pipelines
36-
37-
The SSP Operator includes the following example `Pipeline` manifests. You can run the example pipelines by using the web console or CLI.
38-
39-
You might have to run more than one installer pipeline if you need multiple versions of Windows. If you run more than one installer pipeline, each one requires unique parameters, such as the `autounattend` config map and base image name. For example, if you need Windows 10 and Windows 11 or Windows Server 2022 images, you have to run both the Windows efi installer pipeline and the Windows bios installer pipeline. However, if you need Windows 11 and Windows Server 2022 images, you have to run only the Windows efi installer pipeline.
40-
41-
Windows EFI installer pipeline:: This pipeline installs Windows 11 or Windows Server 2022 into a new data volume from a Windows installation image (ISO file). A custom answer file is used to run the installation process.
42-
43-
Windows BIOS installer pipeline:: This pipeline installs Windows 10 into a new data volume from a Windows installation image, also called an ISO file. A custom answer file is used to run the installation process.
29+
You can run the link:https://artifacthub.io/packages/tekton-pipeline/redhat-pipelines/windows-efi-installer[Windows EFI installer pipeline] by using the web console or CLI.
4430

45-
Windows customize pipeline:: This pipeline clones the data volume of a basic Windows 10, 11, or Windows Server 2022 installation, customizes it by installing Microsoft SQL Server Express or Microsoft Visual Studio Code, and then creates a new image and template.
31+
The Windows EFI installer pipeline installs Windows 10, Windows 11, or Windows Server 2022 into a new data volume from a Windows installation image (ISO file). A custom answer file is used to run the installation process.
4632

4733
[NOTE]
4834
====
49-
The example pipelines use a config map file with `sysprep` predefined by {product-title} and suitable for Microsoft ISO files. For ISO files pertaining to different Windows editions, it may be necessary to create a new config map file with a system-specific sysprep definition.
35+
The Windows EFI installer pipeline uses a config map file with `sysprep` predefined by {product-title} and suitable for Microsoft ISO files. For ISO files pertaining to different Windows editions, it may be necessary to create a new config map file with a system-specific `sysprep` definition.
5036
====
5137

5238
include::modules/virt-running-ssp-pipeline-web.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)