Document how to use KubeVirt #528

gursewak1997 · 2023-04-04T18:09:26Z

Document how to get starting with FCOS on KubeVirt.

https://pagure.io/fedora-web/websites/pull-request/241 will add KubeVirt to the GetFedora page.

dustymabe

some comments

dustymabe · 2023-04-04T20:46:46Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+Here the Ignition config is exposed to the VMI via a Kubernetes Secret.
+Learn about various ways to expose userdata to VMIs in the https://kubevirt.io/user-guide/virtual_machines/startup_scripts/#startup-scripts[KubeVirt user guide].
+
+NOTE: You must edit the following commands per your container management system. For example, you must replace `kubectl` with `oc` if you use Openshift.


You can actually use kubectl with OpenShift, it just doesn't support everything. Maybe just update the note here to say if the user prefers they can use oc instead of kubectl.

dustymabe · 2023-04-04T20:47:30Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+Now that you have an image it can be used in your VMI definitions. The following example will use the image from the stable stream.
+
+You'll also need the Ignition config.
+Here the Ignition config is exposed to the VMI via a Kubernetes Secret.


Suggested change

Here the Ignition config is exposed to the VMI via a Kubernetes Secret.

In the example below the Ignition config stored in local file `example.ign` is exposed to the VMI via a Kubernetes Secret.

dustymabe · 2023-04-04T20:48:18Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+.Accessing the VM instance using kubectl via ssh
+[source, bash]
+----
+kubectl virt ssh core@my-fcos
+----


I would just drop this since it requires a plugin being installed for kubectl.

dustymabe · 2023-04-04T20:48:51Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+.Accessing the VM instance using virtctl via ssh
+[source, bash]
+----
+virtctl ssh core@my-fcos
+----


would be nice if we could link to some docs about virtctl here, but I don't there really are any. Could you find some?

I can only see https://kubevirt.io/user-guide/operations/virtctl_client_tool/ which is decent and will help to install virtctl for users who don't have it installed. You've probably already seen this option but there really isn't any other good option.

That looks great. Let's use that.

dustymabe · 2023-04-04T20:49:21Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+.Mirroring a fcos image from stable stream
+[source, bash]
+----
+skopeo copy docker://quay.io/coreos/fedora-coreos:stable docker://myregistry.io/myorg/fedora-coreos:stable


Suggested change

skopeo copy docker://quay.io/coreos/fedora-coreos:stable docker://myregistry.io/myorg/fedora-coreos:stable

skopeo copy docker://quay.io/coreos/fedora-coreos-kubevirt:stable docker://myregistry.io/myorg/fedora-coreos-kubevirt:stable

dustymabe · 2023-04-04T20:50:25Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+
+== Mirroring the image for use in private registries
+
+If a private registry in air-gapped installations is used, the image can be mirrored to that registry.


Suggested change

If a private registry in air-gapped installations is used, the image can be mirrored to that registry.

If a private registry in air-gapped installations is used, the image can be mirrored to that registry using https://github.com/containers/skopeo[`skopeo`].

dustymabe · 2023-04-04T20:50:52Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+
+If a private registry in air-gapped installations is used, the image can be mirrored to that registry.
+
+.Mirroring a fcos image from stable stream


Suggested change

.Mirroring a fcos image from stable stream

.Mirroring a stable stream FCOS image

dustymabe · 2023-05-03T21:14:23Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+
+.Launching a VM instance referencing the secret
+[source, bash]
+----


Let's let the user choose the stream here in the example:

STREAM='stable' # or 'testing' or 'next'

dustymabe · 2023-05-03T21:16:30Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+Now that you have an image it can be used in your VMI definitions. The following example will use the image from the stable stream.
+
+You'll also need the Ignition config.


Let's drop the reference to the stream here (we'll select that below) in the "code" and also combine a few sentences:

Suggested change

Now that you have an image it can be used in your VMI definitions. The following example will use the image from the stable stream.

You'll also need the Ignition config.

Given the `quay.io/fedora/fedora-coreos-kubevirt` images you can create a VMI defnition and combine that with an Ignition config to launch a machine.

In the example below...

dustymabe · 2023-05-03T21:18:15Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+----
+quay.io/fedora/fedora-coreos-kubevirt
+----


maybe let's just go ahead and make this a bulleted list and list out the three options:

quay.io/fedora/fedora-coreos-kubevirt:stable

quay.io/fedora/fedora-coreos-kubevirt:testing

quay.io/fedora/fedora-coreos-kubevirt:next

dustymabe · 2023-05-03T21:18:51Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+        memory: 2048M
+  volumes:
+  - containerDisk:
+      image: quay.io/coreos/fedora-coreos:stable


Suggested change

image: quay.io/coreos/fedora-coreos:stable

image: quay.io/coreos/fedora-coreos:${STREAM}

dustymabe · 2023-05-03T21:19:33Z

modules/ROOT/pages/provisioning-kubevirt.adoc

+.Launching a VM instance referencing the secret
+[source, bash]
+----
+cat << END > vmi.yaml


optional/preference: remove the space

Suggested change

cat << END > vmi.yaml

cat <<END > vmi.yaml

dustymabe

LGTM

dustymabe · 2023-05-04T14:18:02Z

This branch has conflicts that must be resolved

gursewak1997 requested a review from dustymabe April 4, 2023 18:09

dustymabe reviewed Apr 4, 2023

View reviewed changes

gursewak1997 force-pushed the kubevirt-docs branch from e326a03 to 8c5205b Compare April 5, 2023 16:25

dustymabe reviewed May 3, 2023

View reviewed changes

gursewak1997 force-pushed the kubevirt-docs branch from 8c5205b to 9cc0559 Compare May 4, 2023 07:08

dustymabe approved these changes May 4, 2023

View reviewed changes

gursewak1997 closed this May 4, 2023

gursewak1997 force-pushed the kubevirt-docs branch from 9cc0559 to 580a533 Compare May 4, 2023 15:46

gursewak1997 reopened this May 4, 2023

Add new documentation for KubeVirt

d797f67

gursewak1997 force-pushed the kubevirt-docs branch from e9c6557 to d797f67 Compare May 4, 2023 18:07

gursewak1997 merged commit 8144898 into coreos:main May 4, 2023

gursewak1997 deleted the kubevirt-docs branch May 4, 2023 18:09

dustymabe mentioned this pull request May 4, 2023

Platform Request: kubevirt coreos/fedora-coreos-tracker#1126

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document how to use KubeVirt #528

Document how to use KubeVirt #528

gursewak1997 commented Apr 4, 2023 •

edited

Loading

dustymabe left a comment

dustymabe Apr 4, 2023

dustymabe Apr 4, 2023

dustymabe Apr 4, 2023

dustymabe Apr 4, 2023

gursewak1997 Apr 4, 2023

dustymabe Apr 5, 2023

dustymabe Apr 4, 2023

dustymabe Apr 4, 2023

dustymabe Apr 4, 2023

dustymabe May 3, 2023

dustymabe May 3, 2023

dustymabe May 3, 2023

dustymabe May 3, 2023

dustymabe May 3, 2023

dustymabe left a comment

dustymabe commented May 4, 2023

	Here the Ignition config is exposed to the VMI via a Kubernetes Secret.
	In the example below the Ignition config stored in local file `example.ign` is exposed to the VMI via a Kubernetes Secret.

	skopeo copy docker://quay.io/coreos/fedora-coreos:stable docker://myregistry.io/myorg/fedora-coreos:stable
	skopeo copy docker://quay.io/coreos/fedora-coreos-kubevirt:stable docker://myregistry.io/myorg/fedora-coreos-kubevirt:stable


		== Mirroring the image for use in private registries

		If a private registry in air-gapped installations is used, the image can be mirrored to that registry.


		If a private registry in air-gapped installations is used, the image can be mirrored to that registry.

		.Mirroring a fcos image from stable stream

	.Mirroring a fcos image from stable stream
	.Mirroring a stable stream FCOS image

		Now that you have an image it can be used in your VMI definitions. The following example will use the image from the stable stream.

		You'll also need the Ignition config.

	image: quay.io/coreos/fedora-coreos:stable
	image: quay.io/coreos/fedora-coreos:${STREAM}

Document how to use KubeVirt #528

Document how to use KubeVirt #528

Conversation

gursewak1997 commented Apr 4, 2023 • edited Loading

dustymabe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dustymabe left a comment

Choose a reason for hiding this comment

dustymabe commented May 4, 2023

gursewak1997 commented Apr 4, 2023 •

edited

Loading