Skip to content

Commit

Permalink
docs: PLT-1397 clarify CDI upload proxy wording for ova import (#4053) (
Browse files Browse the repository at this point in the history 
#4067)

* docs: PLT-1397 clarify CDI upload proxy wording for ova import

Signed-off-by: Artur Shad Nik <[email protected]>

* ci: auto-formatting prettier issues

* Update deploy-import-ova.md

* ci: auto-formatting prettier issues

* docs: defined CDI

* docs: suggestion fix

---------

Signed-off-by: Artur Shad Nik <[email protected]>
Co-authored-by: arturshadnik <[email protected]>
Co-authored-by: Tyler Gillson <[email protected]>
Co-authored-by: TylerGillson <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>
(cherry picked from commit 8960236)

Co-authored-by: Artur Shad Nik <[email protected]>
  • Loading branch information
@vault-token-factory-spectrocloud @arturshadnik
vault-token-factory-spectrocloud[bot] and arturshadnik authored Sep 24, 2024
1 parent 50d72c7 commit 8266251
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions ...ocs-content/vm-management/create-manage-vm/advanced-topics/deploy-import-ova.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ kubeadmconfig:
SystemdCgroup = true
```
If you are in a proxied environment, you must configure the CDI custom resource in order to deploy to a `DataVolume`.
Refer to the
If you are in a proxied environment, you must configure the
[Containerized Data Importer](https://kubevirt.io/user-guide/storage/containerized_data_importer/) (CDI) custom resource
in order to deploy to a `DataVolume`. Refer to the
[CDI Configuration](https://github.com/kubevirt/containerized-data-importer/blob/main/doc/cdi-config.md#options)
documentation.

Expand Down Expand Up @@ -254,18 +255,18 @@ name, for example `cdi-uploadproxy.mycompany.io`, to the Nginx load balancer’s

The Palette CLI prompts you for information regarding the OVA you want to import.

| **Parameter** | **Description** | **Values** |
| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| **OVA Path** | The path to the image your have uploaded to your VM. The path for the example provided is `/root/bitnami-wordpress-6.2.2-r1-debian-11-amd64.ova/`. | |
| **Container Disk Upload Method** | Indicate whether to upload the image directly to the target cluster as a `DataVolume` or build and push a Docker image. You will need to provide an existing image registry if you select Docker. | `DataVolume` / `Docker Image` |
| **Kubeconfig Path** | The path to the kubeconfig file you have uploaded to your VM. | |
| **DataVolume Namespace** | The namespace to create your `DataVolume`, if you selected this option previously. | |
| **DataVolume Name** | The name of your `DataVolume`. | |
| **Overhead Percentage for DataVolume Size** | Set an overhead percentage for your `DataVolume` compared to the OVA specification. This parameter is optional and can be skipped with the value `-1`. If skipped, the filesystem overhead percentage will be inferred from the CDI Custom Resource in your VMO cluster. Refer to the [CDI Configuration](https://github.com/kubevirt/containerized-data-importer/blob/main/doc/cdi-config.md#options) for further details. | |
| **Access Mode for the PVC** | Set the access mode for your `DataVolume`. Ensure that your configured CSI supports your selection. | `ReadWriteMany` / `ReadWriteOnce` |
| **Create a PVC with VolumeMode=Block** | Indicate whether to set `Block` volume mode on the `DataVolume`. | `y` / `N` |
| **StorageClass** | The storage class on the destination that will be used to create the VM volume. | |
| **CDI Upload Proxy URL** | Optionally, provide a URL to upload the CDI custom resource. If you have configured a CDI as part of your environment, specify `https://cdi-uploadproxy.mycompany.io`. Refer to the [Prerequisites](#prerequisites) section for configuration details. | |
| **Parameter** | **Description** | **Values** |
| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| **OVA Path** | The path to the OVA you uploaded to your VM. The path for the example provided is `/root/bitnami-wordpress-6.2.2-r1-debian-11-amd64.ova/`. | |
| **Container Disk Upload Method** | Indicate whether to upload the image directly to the target cluster as a `DataVolume` or build and push a Docker image. You will need to provide an existing image registry if you select Docker. | `DataVolume` / `Docker Image` |
| **Kubeconfig Path** | The path to the kubeconfig file you have uploaded to your VM. | |
| **DataVolume Namespace** | The namespace to create your `DataVolume`, if you selected this option previously. | |
| **DataVolume Name** | The name of your `DataVolume`. | |
| **Overhead Percentage for DataVolume Size** | Set an overhead percentage for your `DataVolume` compared to the OVA specification. This parameter is optional and can be skipped with the value `-1`. If skipped, the filesystem overhead percentage will be inferred from the CDI Custom Resource in your VMO cluster. Refer to the [CDI Configuration](https://github.com/kubevirt/containerized-data-importer/blob/main/doc/cdi-config.md#options) for further details. | |
| **Access Mode for the PVC** | Set the access mode for your `DataVolume`. Ensure that your configured CSI supports your selection. | `ReadWriteMany` / `ReadWriteOnce` |
| **Create a PVC with VolumeMode=Block** | Indicate whether to set `Block` volume mode on the `DataVolume`. | `y` / `N` |
| **StorageClass** | The storage class on the destination that will be used to create the VM volume. | |
| **CDI Upload Proxy URL** | Optionally provide a custom CDI upload proxy URL. If ingress is configured for the CDI upload proxy, the ingress hostname will be used by default and must be resolvable via DNS. If the CDI upload proxy is exposed via a NodePort, a node IP and ephemeral port will be used. Depending on how CDI and DNS are configured, you may need to edit `/etc/hosts` to ensure DNS resolution. You may also port-forward the CDI upload proxy via `kubectl --namespace cdi port-forward deployment/cdi-uploadproxy 8443` and provide `https://localhost:8443` as the CDI upload proxy URL. However, this approach will be less efficient. | |

12. The import may take a few minutes to complete. The Palette CLI outputs the path for your OVA configuration file.
Make a note of it.
Expand Down

0 comments on commit 8266251

Please sign in to comment.