From 43e88ca462e44b8b82f6dbc4dc87ed62395305d1 Mon Sep 17 00:00:00 2001 From: Elaine Fonaro Date: Wed, 23 Aug 2023 19:22:11 +0000 Subject: [PATCH] KubeVirt Doc changes (r8, dsr8) - Removed command $ sudo hostname vm-cirros. - Removed Extra "\" - Fixed code indentation. - Updated commands. - Minor indentation fix. Change-Id: I6cd3cfc37b1bcf99b06966ef307e0cba7749013d Signed-off-by: Elaine Fonaro --- .../create-an-ubuntu-vm-fafb82ec424b.rst | 56 +++++++++---------- .../hello-world-kubevirt-vm-05503659173c.rst | 18 ++++-- .../kube-virt/installation-66477d7646db.rst | 2 +- .../set-up-cdi-proxy-ad165d884417.rst | 24 ++++---- 4 files changed, 53 insertions(+), 47 deletions(-) diff --git a/doc/source/kube-virt/create-an-ubuntu-vm-fafb82ec424b.rst b/doc/source/kube-virt/create-an-ubuntu-vm-fafb82ec424b.rst index 055b2f3c1..f13025549 100644 --- a/doc/source/kube-virt/create-an-ubuntu-vm-fafb82ec424b.rst +++ b/doc/source/kube-virt/create-an-ubuntu-vm-fafb82ec424b.rst @@ -43,7 +43,7 @@ The example uses: #. Create a new Data Network of type 'vlan' for SRIOV interfaces to be used by your KubeVirt |VMs|. - .. code-block:: + .. code-block:: ~(keystone_admin)$ system datanetwork-add kube-sriov vlan @@ -54,12 +54,12 @@ The example uses: compute-1's enp24s0f0 ethernet interface - .. code-block:: + .. code-block:: ~(keystone_admin)$ system host-if-modify -n sriov0 -c pci-sriov -N 64 --vf-driver vfio compute-1 enp24s0f0 ~(keystone_admin)$ system interface-datanetwork-assign compute-1 sriov0 kube-sriov - + #. Create a ``NetworkAttachmentDefinition`` in Kubernetes to point to the new Data Network and specify a particular vlan-id to use within that Data Network. @@ -75,10 +75,10 @@ The example uses: data network name, if any, converted to underscores). .. code-block:: yaml - - $ cat < 186-subnet.yaml - apiVersion: "k8s.cni.cncf.io/v1" - kind: NetworkAttachmentDefinition + + $ cat < 186-subnet.yaml + apiVersion: "k8s.cni.cncf.io/v1" + kind: NetworkAttachmentDefinition metadata: name: 186-subnet namespace: stx-lab @@ -115,12 +115,12 @@ The example uses: .. code-block:: yaml - $ cat < stx-lab-ubuntu-test-vm.yaml + $ cat < stx-lab-ubuntu-test.yaml apiVersion: kubevirt.io/v1alpha3 kind: VirtualMachine metadata: labels: - kubevirt.io/vm: stx-lab-ubuntu-test + kubevirt.io/vm: stx-lab-ubuntu-test name: stx-lab-ubuntu-test namespace: stx-lab spec: @@ -138,7 +138,7 @@ The example uses: name: myrootdisk - disk: bus: virtio - name: cloudinitdisk + name: cloudinitdisk interfaces: - masquerade: {} name: default @@ -148,7 +148,7 @@ The example uses: type: "" resources: requests: - cpu: 8 + cpu: 8 memory: 16Gi networks: - name: default @@ -162,12 +162,12 @@ The example uses: dataVolume: name: stx-lab-ubuntu-test-disk - cloudInitNoCloud: - userData: |- - #cloud-config - user: jenkins - password: myP@ssw0rd - chpasswd: { expire: False } - ssh_pwauth: True + userData: |- + #cloud-config + user: jenkins + password: myP@ssw0rd + chpasswd: { expire: False } + ssh_pwauth: True name: cloudinitdisk EOF @@ -175,17 +175,17 @@ The example uses: .. code-block:: - $ kubectl apply -f stx-lab-ubuntu-test-vm.yaml + $ kubectl apply -f stx-lab-ubuntu-test.yaml #. Connect to console and configure |VM| and the |VM|'s interface on the 10.10.186.0/24 network. .. code-block:: - $ virtctl -n stx-lab console stx-lab-ubuntu-test-vm + $ virtctl -n stx-lab console stx-lab-ubuntu-test Successfully connected to stx-lab-ubuntu-test console. The escape sequence is ^]4 - stx-lab-ubuntu-test login: jenkins + stx-lab-ubuntu-test login: jenkins Password: Welcome to Ubuntu 22.04 LTS (GNU/Linux 5.15.0-39-generic x86_64) @@ -194,9 +194,9 @@ The example uses: * Support: https://ubuntu.com/advantage System information as of Thu Dec 8 16:55:12 UTC 2022 - + System information as of Thu Dec 8 16:55:12 UTC 2022 - + System load: 0.2587890625 Processes: 178 Usage of /: 0.3% of 476.62GB Users logged in: 0 Memory usage: 1% IPv4 address for enp1s0: 10.0.2.2 @@ -207,7 +207,7 @@ The example uses: ... #. Still in the |VM| console, list the interfaces. - + Note that this |VM| has 2x interfaces. * enp1s0 is the default container |CNI| interface @@ -260,15 +260,15 @@ The example uses: .. code-block:: bash $ sudo su - - + $ cat < /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg network: {config: disabled} EOF - + # Update /etc/netplan/50-cloud-init.yaml as shown below. $ vi /etc/netplan/50-cloud-init.yaml - + network: ethernets: # enp1s0: @@ -306,7 +306,7 @@ The example uses: 2: enp1s0: mtu 1500 qdisc noop state DOWN mode DEFAULT group default qlen 1000 link/ether 52:54:00:41:84:a0 brd ff:ff:ff:ff:ff:ff 3: enp6s0: mtu 1500 qdisc mq state UP mode DEFAULT group default qlen 1000 - link/ether 46:c5:53:3b:b3:b3 brd ff:ff:ff:ff:ff:ff + link/ether 46:c5:53:3b:b3:b3 brd ff:ff:ff:ff:ff:ff jenkins@stx-lab-ubuntu-test:~$ ip addr 1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 @@ -328,7 +328,7 @@ The example uses: jenkins@stx-lab-ubuntu-test:~$ ip route default via 10.10.186.1 dev enp6s0 proto static - 10.10.186.0/24 dev enp6s0 proto kernel scope link src 10.10.186.97 + 10.10.186.0/24 dev enp6s0 proto kernel scope link src 10.10.186.97 #. Connect from a remote workstation. diff --git a/doc/source/kube-virt/hello-world-kubevirt-vm-05503659173c.rst b/doc/source/kube-virt/hello-world-kubevirt-vm-05503659173c.rst index fbdcde0ed..08db673b9 100644 --- a/doc/source/kube-virt/hello-world-kubevirt-vm-05503659173c.rst +++ b/doc/source/kube-virt/hello-world-kubevirt-vm-05503659173c.rst @@ -43,13 +43,23 @@ the |VM| via the console: .. code-block:: yaml apiVersion: kubevirt.io/v1 - kind: VirtualMachineInstance + kind: VirtualMachine metadata: + labels: + kubevirt.io/vm: vm-cirros name: vm-cirros + spec: + running: false + template: + metadata: + labels: + kubevirt.io/vm: vm-cirros spec: domain: devices: disks: + -disk: + bus: virtio - name: containerdisk disk: bus: virtio @@ -66,7 +76,7 @@ the |VM| via the console: image: kubevirt/cirros-container-disk-demo:latest - name: cloudinitdisk cloudInitNoCloud: - userDataBase64: IyEvYmluL3NoCgplY2hvICdwcmludGVkIGZyb20gY2xvdWQtaW5pdCB1c2VyZGF0YScKWQtaW5pdCB1c2VyZGF0YScK + userDataBase64: IyEvYmluL3NoCmVjaG8gJ3ByaW50ZWQgZnJvbSBjbG91ZC1pbml0IHVzZXJkYXRhJwo= #. Apply the ``yaml`` file to create the |VM| in a stopped state. @@ -108,8 +118,6 @@ the |VM| via the console: # vm-cirros login: cirros Password: - $ hostname vm-cirros - $ ls / bin home lib64 mnt root tmp boot init linuxrc old-root run usr @@ -155,8 +163,6 @@ the |VM| via the console: $ ssh -p 31562 cirros@ password: - $ hostname vm-cirros - # List Interfaces # Notice how the VM has a single eth0 interface, the default CNI interface. diff --git a/doc/source/kube-virt/installation-66477d7646db.rst b/doc/source/kube-virt/installation-66477d7646db.rst index dfc1e2fd6..21a9859bd 100644 --- a/doc/source/kube-virt/installation-66477d7646db.rst +++ b/doc/source/kube-virt/installation-66477d7646db.rst @@ -15,7 +15,7 @@ Complete the following steps to install KubeVirt. .. code-block:: none - ~(keystone_admin)$ system application-upload /usr/local/share/applications/helm/kubevirt-app-1.0-1.tgz + ~(keystone_admin)$ system application-upload /usr/local/share/applications/helm/kubevirt-app-.tgz ~(keystone_admin)$ system application-list diff --git a/doc/source/kube-virt/set-up-cdi-proxy-ad165d884417.rst b/doc/source/kube-virt/set-up-cdi-proxy-ad165d884417.rst index f41c5f2e7..79e840695 100644 --- a/doc/source/kube-virt/set-up-cdi-proxy-ad165d884417.rst +++ b/doc/source/kube-virt/set-up-cdi-proxy-ad165d884417.rst @@ -24,7 +24,8 @@ Configuring the NodePort service option is shown below: .. code-block:: yaml - $ cat < cdi-uploadproxy-nodeport-service.yaml apiVersion: v1 + $ cat < cdi-uploadproxy-nodeport-service.yaml + apiVersion: v1 kind: Service metadata: name: cdi-uploadproxy-nodeport @@ -34,12 +35,12 @@ Configuring the NodePort service option is shown below: spec: type: NodePort ports: - - port: 443 - targetPort: 8443 - nodePort: 32111 # Use unused nodeport in 31,500 to 32,767 range - protocol: TCP - selector: - cdi.kubevirt.io: cdi-uploadproxy + - port: 443 + targetPort: 8443 + nodePort: 32111 # Use unused nodeport in 31,500 to 32,767 range + protocol: TCP + selector: + cdi.kubevirt.io: cdi-uploadproxy EOF @@ -52,7 +53,7 @@ Configuring the NodePort service option is shown below: .. rubric:: |result| Now the ``virtctl`` command can be used to upload a |VM| image file into an -existing or new DataVolume (|PVC|). +existing or new DataVolume (|PVC|). See the example (:ref:`create-an-ubuntu-vm-fafb82ec424b`) that uploads an ubuntu cloud image (``jammy-server-cloudimg-amd64.img`` from @@ -61,10 +62,9 @@ named stx-lab-jenkins-disk: .. code-block:: - $ virtctl image-upload dv stx-lab-jenkins-disk -n jenkins-ns --insecure \ - --access-mode ReadWriteOnce --size 500Gi --image-path \ - /home/sysadmin/admin/kubevirt/images/jammy-server-cloudimg-amd64.img \ - --uploadproxy-url https://admin.starlingx.abc.com:32111 + $ virtctl image-upload dv -n --insecure \ + --access-mode ReadWriteOnce --size Gi --image-path \ + --uploadproxy-url https://: See sections on :ref:`create-an-ubuntu-vm-fafb82ec424b` and :ref:`create-a-windows-vm-82957181df02` on how to then use this DataVolume to