Skip to content

[DNM] docs: Add KVM support to VM Importer #964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
votdev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[DNM] docs: Add KVM support to VM Importer #964

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 45 additions & 1 deletion docs/advanced/addons/vmimport.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,15 @@ Currently, the following source providers are supported:
* VMware
* OpenStack
* Open Virtual Appliance (OVA)
* KVM

## API
The vm-import-controller introduces two CRDs.

### Sources
Sources allow users to define valid source clusters.

For example:
#### VMware

```yaml
apiVersion: migration.harvesterhci.io/v1beta1
Expand Down Expand Up @@ -70,6 +71,8 @@ NAME STATUS
vcsim clusterReady
```

#### OpenStack

For OpenStack-based source clusters, an example definition is as follows:

```yaml
Expand Down Expand Up @@ -110,6 +113,8 @@ NAME STATUS
devstack clusterReady
```

#### Open Virtual Appliance

For OVA-based sources, an example definition is as follows:

```yaml
Expand Down Expand Up @@ -150,6 +155,45 @@ NAME STATUS
example clusterReady
```

#### KVM

For KVM-based sources, an example definition is as follows:

```yaml
apiVersion: migration.harvesterhci.io/v1beta1
kind: KVMSource
metadata:
name: kvm
namespace: default
spec:
endpoint: "ssh://192.168.0.10:22"
sshTimeoutSeconds: 10
virshConnectionURI: "qemu:///system"
credentials:
name: example-kvm-credentials
namespace: default
```

- `endpoint`: SSH endpoint of the host where the KVM instance is running.
- `sshTimeoutSeconds`: (Optional) Number of seconds Harvester allows for the SSH connection to be established. The default value is `30`. When the value is `0`, the timeout function is disabled.
- `virshConnectionURI`: (Optional) URI used when running `virsh` commands on the endpoint host. For information about configuring this field, see [Local hypervisor URIs](https://libvirt.org/uri.html#local-hypervisor-uris) in the libvirt documentation.

When configuring the secret, you can include the authentication credentials that are used to log into the source system via SSH.

```yaml
apiVersion: v1
kind: Secret
metadata:
name: example-kvm-credentials
namespace: default
stringData:
"username": "user"
"password": "password"
"privateKey": "pem-encoded-private-key"
```

As part of the reconciliation process, the controller runs a test `virsh` command on the specified endpoint via SSH before marking the source as ready.

### VirtualMachineImport
The VirtualMachineImport CRD provides a way for users to define a source VM and map to the actual source cluster to perform VM export/import.

Expand Down