Skip to content

Commit

Permalink
Fix the markup and layout of pages in the VMO section (#2928) (#2935)
Browse files Browse the repository at this point in the history
* chore: Fix markup in the VMO docs

* chore: Improve page layout in the VMO section

* chore: Fix another small isue in the layout

* chore: Fix broken links in the VMO section

* chore: Fix a missed broken link

* docs: Remove the mention of virtual clusters from VMO
  • Loading branch information
yuliiiah committed May 28, 2024
1 parent dd7e841 commit 2526500
Show file tree
Hide file tree
Showing 17 changed files with 63 additions and 143 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the following steps to connect to your host cluster with the kubectl CLI.
:::info

If you are using Palette Virtual Machine (VM) Management, you can find steps on how to connect to your virtual machines
with the [virtctl CLI](https://kubevirt.io/user-guide/operations/virtctl_client_tool/) in the
with the [virtctl CLI](https://kubevirt.io/user-guide/user_workloads/virtctl_client_tool/) in the
[Access VM Cluster with virtctl](../../vm-management/create-manage-vm/access-cluster-with-virtctl.md) guide. The virtctl
CLI facilitates some of the VM operations you will perform, such as copying, pasting, or transferring files to and from
a virtual machine using Secure Copy Protocol (SCP).
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/integrations/kubevirt.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ manifests:
## References
- [Installing KubeVirt on Kubernetes](https://KubeVirt.io/user-guide/operations/installation/#installing-KubeVirt-on-kubernetes)
- [Installing KubeVirt on Kubernetes](https://kubevirt.io/user-guide/cluster_admin/installation/#installing-kubevirt-on-kubernetes)
- [GitHub KubeVirt](https://github.com/KubeVirt/KubeVirt/releases/tag/v0.51.0)
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ can use to transfer files to and from a VM. Its usage is similar to the ssh comm

## Prerequisites

- An active virtual cluster with Palette Virtual Machine Orchestrator (VMO).
- An active cluster with Palette Virtual Machine Orchestrator (VMO).

- Access to the virtual cluster.
- Access to the cluster.

## Download and Connect virtctl

Expand All @@ -29,13 +29,9 @@ can use to transfer files to and from a VM. Its usage is similar to the ssh comm

2. Assign the execute permission to the virtctl command.

<br />

```shell
chmod +x virtctl
```

<br />
```shell
chmod +x virtctl
```

3. Next, log in to [Palette](https://console.spectrocloud.com) to connect your host cluster with the virtctl CLI.

Expand All @@ -52,31 +48,25 @@ chmod +x virtctl

Example:

```shell
export KUBECONFIG=~/Downloads/dev-cluster.kubeconfig
```

<br />
```shell
export KUBECONFIG=~/Downloads/dev-cluster.kubeconfig
```

9. Issue the `virtctl ssh <virtual_machinename>` or `virtctl vnc <virtual_machinename>` command to display the login
screen.

Example:

```shell
virtctl ssh ubuntu
```

<br />
```shell
virtctl ssh ubuntu
```

You can now issue virtctl commands against the VM in your Kubernetes cluster.

## Validate

Verify you have access to your virtual machine by issuing virtctl commands against it, as shown in the example below.

<br />

```bash
virtctl guestosinfo
```
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ containerized applications.

You can create a VM three ways:

<br />

- Deploy a VM from a template. Palette provides out-of-the-box templates, or your organization may provide templates.
For the latter, refer to the [Create a VM Template](create-vm-template.md) guide.

Expand All @@ -46,8 +44,6 @@ Additionally, Virtio is a virtualization standard for network and disk device dr
driver knows it is deployed in a virtual environment, and cooperates with the hypervisor. This enables guests to receive
high performance network and disk operations and provides most of the performance benefits of paravirtualization.

<br />

:::warning

We recommend installing the QEMU guest agent to display additional details in Palette Virtual Machine Orchestrator. We
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ Although Palette provides out-of-the box templates, we recommend that you create

Create a template by adding a YAML file as a manifest in an add-on profile.

<br />

1. Log in to [Palette](https://console.spectrocloud.com).

2. From the left **Main Menu**, click **Profiles** and click the **Add Cluster Profile** button.
Expand All @@ -37,8 +35,6 @@ Create a template by adding a YAML file as a manifest in an add-on profile.

8. Click **Finish Configuration**.

<br />

#### Example YAML for a VM template

```yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ and identifiers as the parent VM. After you clone a VM, it as a separate virtual
Cloning is a quick way to create a new virtual machine that shares the same properties as the parent. You may want to
clone a VM for the following reasons:

<br />

- Software testing - developers can clone an active VM to test new changes to their code.

- Forensics - security administators can clone an infected machine and connect it to an air-gaped network to investigate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ organization's administrator provides.

These steps will help guide you to deploy a VM from an out-of-the-box VM template.

<br />

1. Log in to [Palette](https://console.spectrocloud.com).

2. From the left **Main Menu**, click **Clusters** and select the cluster in which you deploy VMs.
Expand All @@ -37,17 +35,11 @@ These steps will help guide you to deploy a VM from an out-of-the-box VM templat

7. You can deploy from a template or create an empty VM as follows:

<br />

- To deploy from a template, select one of the VM templates. These can be Palette's out-of-the-box templates or
templates that you or your administrator created.

<br />

- To create an empty VM, close the templates choice page and install the OS using a different method.

<br />

8. Give the VM a name and specify memory and CPUs.

9. Optionally, you can enable the checkbox to start the VM automatically after creation.
Expand All @@ -63,8 +55,6 @@ VM status will display as **Starting** for several minutes while the required re
pulled from the registry. If you did not enable the checkbox to start the VM automatically, VM status displays as
**Stopped** until the VM is fully deployed.

<br />

:::warning

VMs do not self-heal. If a VM is running on a node that fails, the VM is re-scheduled to a different node. Similar to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ is placed into maintenance or upgraded, all VM instances require a `LiveMigrate`

5. Click **Migrate Node to Node**.

## Validate
### Validate

1. Log in to [Palette](https://console.spectrocloud.com).

Expand All @@ -66,12 +66,12 @@ need to be resolved. To learn more, check out the
[Safely Drain a Node](https://kubernetes.io/docs/tasks/administer-cluster/safely-drain-node/#use-kubectl-drain-to-remove-a-node-from-service)
Kubernetes resource.

## Prerequisites
### Prerequisites

- Ensure `LiveMigrate` is set as the eviction strategy for all affected VMs. When the host is put in maintenance mode,
this feature allows for a smooth and uninterrupted migration process.

## Evacuate VMs in Palette
### Evacuate VMs in Palette

1. Log in to [Palette](https://console.spectrocloud.com).

Expand All @@ -83,20 +83,16 @@ Kubernetes resource.
4. Turn off maintenance mode by clicking the **three-dot Menu** in the row of the evacuated node and select **Turn off
maintenance mode**.

<br />

:::warning

Maintenance mode reduces cluster capacity. Be sure to turn off maintenance mode after maintenance completes.

:::

## Validate
### Validate

You can validate evacuation completed by following the steps below.

<br />

1. Log in to [Palette](https://console.spectrocloud.com).

2. From the left **Main Menu**, choose **Clusters**.
Expand All @@ -105,17 +101,13 @@ You can validate evacuation completed by following the steps below.

## Evacuate VMs Manually

<br />

1. Obtain the kubeconfig file from Palette, and set the KUBECONFIG environment variable to access it so you can issue
kubectl commands to the cluster. To learn how, refer to
[Set up Kubectl](../../../clusters/cluster-management/palette-webctl.md#set-up-kubectl).

2. Issue the following command to mark the node as _un-schedulable_. This alerts the Kubernetes scheduler not to
schedule any new pods on that node but allows existing pods on the node to continue to operate.

<br />

Example:

```bash
Expand All @@ -135,23 +127,19 @@ You can validate evacuation completed by following the steps below.

**node-name**: The name of the node that you wish to drain.

<br />

:::info

The kubectl `drain` command should only be issued to a single node at a time.

:::

## Validate
### Validate

1. Using kubectl, log in to a machine that has access to the kubernetes cluster.

2. Issue the following command to verify the pods are rescheduled on a different node by verifying the name and IP
address of the new node changed.

<br />

```bash
kubectl get pods --output wide
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ tags: ["vmo"]

Palette Virtual Machine Orchestrator (VMO) supports standard VM power operations:

<br />

- **Start**

- **Stop**
Expand All @@ -26,8 +24,6 @@ of each listed VM.
When you select a VM from the **Clusters** > **Virtual Machines** tab, the following tabs display. Tabs are specific to
the selected VM.

<br />

- **Overview**: Provides general information about the VM, such as its IP address, operating system, creation date and
time zone, status, active users, whether the guest agent is installed or not, the quantity of Network Interface Cards
(NIC) and disks, and any recent events.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ snapshot of an active VM, the controller checks for the QEMU guest agent in the
controller freezes the VM file system before it takes the snapshot and unfreezes the file system afterwards. This
provides for crash consistency.

<br />

:::info

For optimal snapshots, we recommend taking snapshots of online VMs that have the QEMU Guest Agent installed. If the
Expand All @@ -29,8 +27,6 @@ participation.

:::

<br />

You can take a snapshot of an online VM that has hotplugged disks. Only persistent hotplugged disks will be included in
the snapshot. Only disks with a snapshot-supported storage class defined are included in snapshots. If no eligible disk
is found, the **Snapshot** action is not possible.
Expand Down Expand Up @@ -68,8 +64,6 @@ status will display as **Failed**. The VM will be unfrozen and the snapshot cont
snapshot will remain in **Failed** state until you delete it. You can change the default snapshot time to meet your
workload requirements.

<br />

:::warning

Snapshots should not be used as a backup method, as running a VM on a snapshot for extended periods of time can cause
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ You can add storage and additional network interfaces to your virtual machines (
KubeVirt allows hot plugging additional storage into a running VM. Both block and file system volume types are
supported.

## Prerequisites
### Prerequisites

- A deployed VM.

## Add a Disk
### Add a Disk

1. Log in to [Palette](https://console.spectrocloud.com).

Expand All @@ -33,28 +33,20 @@ supported.
The interface type determines out-of-the-box operating system (OS) support and disk performance. Choose from the
following:

<br />

- **virtio**: Optimized for best performance, but the operating system may require additional Virtio drivers.

<br />

- **sata**: Most operating systems support Serial ATA (SATA). However it offers lower performance.

<br />

- **scsi**: A paravirtualized Internet Small Computer System Interface (iSCSI) HDD driver that offers similar
functionality to the virtio-block device but with some additional enhancements. In particular, this driver supports
adding hundreds of devices and names devices using the standard SCSI device naming scheme.

5. Click **Add** when you are done.

## Validate
### Validate

The **Disks** tab lists the newly added disk as `PersistingHotplug`.

<br />

## Add Network Interfaces

You can add additional network interfaces to a VM. By default, VMs use the native networking already configured in the
Expand All @@ -69,11 +61,11 @@ Kubernetes. If you use Multus as your network, ensure that Multus is installed a
created a default `NetworkAttachmentDefinition` CRD. For more information, refer to the
[Multus CNI](/integrations/multus-cni) guide.

## Prerequisites
### Prerequisites

- A deployed VM.

## Add an Interface
### Add an Interface

1. Log in to [Palette](https://console.spectrocloud.com).

Expand All @@ -85,19 +77,17 @@ created a default `NetworkAttachmentDefinition` CRD. For more information, refer

5. Click **Add** when you are done.

<br />

:::info

Multus allows hot plugging network interfaces only when interfaces use the **virtio** model connected through bridge
binding.

:::

## Validate
### Validate

The **Network Interfaces** tab lists the newly added interface.

# Resources
## Resources

- [Multus CNI](../../../integrations/multus-cni.md)
Loading

0 comments on commit 2526500

Please sign in to comment.