CNV#21150: instance types API

[ousleyp]

Version(s): 4.15+

Issue: CNV-21150

Links to docs preview:

Primary pages updated

• https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-cli.html
• https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-instance-types.html
• https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/getting_started/virt-using-the-cli-tools.html#vm-manifest-creation-commands_virt-using-the-cli-tools

New YAMLs

• https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/virt-accessing-vm-ssh.html#virt-adding-public-key-cli_static-key static key
• https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/virt-accessing-vm-ssh.html#virt-adding-public-key-cli_dynamic-key dynamic key

Minor updates

• https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/getting_started/virt-getting-started.html

QE review:

• QE has approved this change.

Additional information:

[ocpdocs-previewbot]

🤖 Tue May 07 16:38:18 - Prow CI generated the docs preview:
https://75235--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

[lyarwood]

/lgtm

[ousleyp]

@RoniKishner Hi, can you please review this PR from the QE perspective? Thank you!

[mburke5678]

Should this be a separate bullet, as it links to a different assembly than Create a VM from a Red Hat image? It is a touch confusing to me.

[ousleyp]

Good spot. I think there's some rework that needs to be done here in general, because there is overlap between the procedures in the "custom images" and "RH images" directories, and I think the separation is doing more harm than good. Sadly.

(I'm pretty sure that this link was attached to the previous bullet because the instance type assembly is in the "creating_vms_rh" directory.)

[ousleyp]

I think I'm going to leave this as-is and try to address it in a follow-up PR.

[mburke5678]

@ousleyp Overall looks good. A few suggestions/questions. I am not sure what you changed in Configuring SSH access to virtual machines, however. Otherwise LGTM.

[ousleyp]

@ousleyp Overall looks good. A few suggestions/questions. I am not sure what you changed in Configuring SSH access to virtual machines, however. Otherwise LGTM.

Great question. It was in this list of build preview links and I lazily assumed I had forgotten some random change... my apologies for the confusion!

Thanks so much for the thoughtful review, as always, @mburke5678 !

[openshift-ci]

New changes are detected. LGTM label has been removed.

[dominikholler]

Great to see this documented!

Can the example yaml in "Creating a VM from a VirtualMachine manifest" in https://docs.openshift.com/container-platform/4.15/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-cli.html#virt-creating-vm-cli_virt-creating-vms-cli be also adopted to use instancetypes?

A very minimalistic VM would be

 apiVersion: kubevirt.io/v1
 kind: VirtualMachine
 metadata:
  name: rhel-9-minimal
 spec:
  dataVolumeTemplates:
    - metadata:
        name: rhel-9-minimal-volume
      spec:
        sourceRef:
          kind: DataSource
          name: rhel9
          namespace: openshift-virtualization-os-images
        storage: {}
  instancetype:
    name: u1.medium
  preference:
    name: rhel.9
  running: true
  template:
    spec:
      domain:
        devices: {}
      volumes:
        - dataVolume:
            name: rhel-9-minimal-volume
          name: rootdisk

[ousleyp]

Great to see this documented!

Can the example yaml in "Creating a VM from a VirtualMachine manifest" in https://docs.openshift.com/container-platform/4.15/virt/virtual_machines/creating_vms_rh/virt-creating-vms-from-cli.html#virt-creating-vm-cli_virt-creating-vms-cli be also adopted to use instancetypes?

Great suggestion, thanks! I just changed that example to the manifest you provided and attempted to give some additional information in the callouts. Can you please review, @dominikholler ? Thanks!

[dominikholler]

Thanks @ousleyp .
If I may request another change, can the two examples in https://docs.openshift.com/container-platform/4.15/virt/virtual_machines/virt-accessing-vm-ssh.html#virt-adding-public-key-cli_static-key and https://docs.openshift.com/container-platform/4.15/virt/virtual_machines/virt-accessing-vm-ssh.html#virt-creating-vm-instancetype_dynamic-key be updated to

apiVersion: kubevirt.io/v1
kind: VirtualMachine
metadata:
  name: example-vm
spec:
  dataVolumeTemplates:
    - metadata:
        name: example-vm-volume
      spec:
        sourceRef:
          kind: DataSource
          name: rhel9
          namespace: openshift-virtualization-os-images
        storage:
          resources: {}
  instancetype:
    name: u1.medium
  preference:
    name: rhel.9
  running: true
  template:
    spec:
      domain:
        devices: {}
      volumes:
        - dataVolume:
            name: example-vm-volume
          name: rootdisk
        - cloudInitNoCloud:
            userData: |-
              #cloud-config
              user: cloud-user
          name: cloudinitdisk
      accessCredentials:
        - sshPublicKey:
            propagationMethod:
              noCloud: {}
            source:
              secret:
                secretName: authorized-keys
---
apiVersion: v1
kind: Secret
metadata:
  name: authorized-keys
data:
  key: c3NoLXJzYSBBQUFBQjNOemFDMXljMkVBQUFBREFRQUJBQUFCQVFDMU0rTDNSMUh4YjI3bFdjdjBJU01nYzhQcHVTcG1XUnRNTWFoR3BtRU5xQk5SSkZXbVhnMVlkeTFxRTNOSXJ4VzdGZmxZelRyOXlnRXZvZDhVNDBmVkNpMnRybnhEd2g5UHJUNzBCS29TcHZLazlTSzZ6ME10SWgxUEk5SDM0ME5YSW5DRGdwZkFFK200eVcwaFlQUWtkZzFZajRQOElVZEczV3pvOHZxK0dmM0M2aHVCVG5HNmpNekZVZEFGcUxrd0hEY3hRc0RjcXl2UFdvU0NzREg1OTM3aWRVZDE0MTRXRlU3bW5xOTBIRXRZbjFYcmt5SUpPSzFtOVk3K3RkSW1jNWJDcjNhN2J3WXVBRWZ6M2pZOGh5NVFYZDdWb29RaXg4UW5vMCtsOE9TWFZBWExaOW1lVGdkRUwxcEJ4Y2hUY2ZsZWU0ekhjQk5RMXdEZnNUSnYgZG9taW5pa0B0NDYwcA==

and the dynamic one to

apiVersion: kubevirt.io/v1
kind: VirtualMachine
metadata:
  name: example-vm
spec:
  dataVolumeTemplates:
    - metadata:
        name: example-vm-volume
      spec:
        sourceRef:
          kind: DataSource
          name: rhel9
          namespace: openshift-virtualization-os-images
        storage:
          resources: {}
  instancetype:
    name: u1.medium
  preference:
    name: rhel.9
  running: true
  template:
    spec:
      domain:
        devices: {}
      volumes:
        - dataVolume:
            name: example-vm-volume
          name: rootdisk
        - cloudInitNoCloud:
            userData: |-
              #cloud-config
              runcmd:
              - [ setsebool, -P, virt_qemu_ga_manage_ssh, on ]
          name: cloudinitdisk
      accessCredentials:
        - sshPublicKey:
            propagationMethod:
              qemuGuestAgent:
                users: ["cloud-user"]
            source:
              secret:
                secretName: authorized-keys
---
apiVersion: v1
kind: Secret
metadata:
  name: authorized-keys
data:
  key: c3NoLXJzYSBBQUFBQjNOemFDMXljMkVBQUFBREFRQUJBQUFCQVFDMU0rTDNSMUh4YjI3bFdjdjBJU01nYzhQcHVTcG1XUnRNTWFoR3BtRU5xQk5SSkZXbVhnMVlkeTFxRTNOSXJ4VzdGZmxZelRyOXlnRXZvZDhVNDBmVkNpMnRybnhEd2g5UHJUNzBCS29TcHZLazlTSzZ6ME10SWgxUEk5SDM0ME5YSW5DRGdwZkFFK200eVcwaFlQUWtkZzFZajRQOElVZEczV3pvOHZxK0dmM0M2aHVCVG5HNmpNekZVZEFGcUxrd0hEY3hRc0RjcXl2UFdvU0NzREg1OTM3aWRVZDE0MTRXRlU3bW5xOTBIRXRZbjFYcmt5SUpPSzFtOVk3K3RkSW1jNWJDcjNhN2J3WXVBRWZ6M2pZOGh5NVFYZDdWb29RaXg4UW5vMCtsOE9TWFZBWExaOW1lVGdkRUwxcEJ4Y2hUY2ZsZWU0ekhjQk5RMXdEZnNUSnYgZG9taW5pa0B0NDYwcA==

[ousleyp]

@dominikholler , thanks for the feedback! I have added a link to the SSH page and a note regarding the lack of authentication config to this PR, but I have not yet updated the YAMLs on the SSH page. That page is a little complicated because it uses one YAML with conditionals to cover both static and dynamic. I'll work on making that update shortly.

[ousleyp]

@dominikholler , I changed up the YAMLs on the SSH page. Please take a look when you can; thanks! :)

Here are the preview build pages that are specific to those YAMLs:
https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/virt-accessing-vm-ssh.html#virt-adding-public-key-cli_static-key static key
https://75235--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/virtual_machines/virt-accessing-vm-ssh.html#virt-adding-public-key-cli_dynamic-key dynamic key

[openshift-ci]

@ousleyp: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[dominikholler]

@lyarwood @akrejcir can you please have a look, too?

[ousleyp]

Hi @lyarwood @akrejcir , I can merge this if it LGTY, so please let me know when you've taken a look. Thank you!