Skip to content
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.

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

docs: VMO refactor #3040

Merged
merged 34 commits into from
Jul 23, 2024
Merged

docs: VMO refactor #3040

merged 34 commits into from
Jul 23, 2024

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Jun 7, 2024

Describe the Change

This PR refactors the VMO section of the docs.

Changed Pages

💻 Virtual Machine Orchestrator
💻 Architecture

Jira Tickets

🎫 DOC-1056

Backports

Can this PR be backported?

  • [] Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

Copy link

netlify bot commented Jun 7, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 10431f2
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/669fdaee48ad270008ca29a9
😎 Deploy Preview https://deploy-preview-3040--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Lenny Chen and others added 9 commits June 7, 2024 15:33
* docs: Update the VMO index page

* docs: Document the VMO architecture (WIP)

* docs: Finish the VMO arch draft and update the higl-level topic structure

* chore: Fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix typos flagged by Vale

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Copy link
Contributor

@addetz addetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful work! Big improvement already!
I left you some comments to get the ball rolling ⚽

@yuliiiah yuliiiah added the do-not-merge/work-in-progress Work in-progress. DO NOT MERGE label Jun 25, 2024
@lennessyy lennessyy marked this pull request as ready for review July 19, 2024 18:52
@lennessyy lennessyy requested a review from a team as a code owner July 19, 2024 18:52
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/vm-management/create-manage-vm/update-vm-configuration.md|77 col 60| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/create-manage-vm/update-vm-configuration.md|101 col 1| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/create-manage-vm/update-vm-configuration.md|112 col 4| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/architecture.md|30 col 55| [Vale.Terms] Use 'Disable' instead of 'disable'.
docs/docs-content/vm-management/architecture.md|60 col 4| [Vale.Spelling] Did you really mean 'PVCs'?
docs/docs-content/vm-management/architecture.md|65 col 5| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/architecture.md|75 col 3| [Vale.Spelling] Did you really mean 'VMExport'?
docs/docs-content/vm-management/architecture.md|79 col 8| [Vale.Spelling] Did you really mean 'Hotplug'?
docs/docs-content/vm-management/environment-setup.md|20 col 29| [Vale.Spelling] Did you really mean 'Rackmount'?
docs/docs-content/vm-management/environment-setup.md|20 col 82| [Vale.Spelling] Did you really mean 'Rackmount'?
docs/docs-content/vm-management/environment-setup.md|23 col 53| [Vale.Spelling] Did you really mean 'mgmt'?
docs/docs-content/vm-management/environment-setup.md|23 col 86| [Vale.Spelling] Did you really mean 'Gbps'?
docs/docs-content/vm-management/environment-setup.md|23 col 112| [Vale.Spelling] Did you really mean 'Gbps'?
docs/docs-content/vm-management/environment-setup.md|23 col 118| [Vale.Spelling] Did you really mean 'mgmt'?
docs/docs-content/vm-management/environment-setup.md|23 col 150| [Vale.Spelling] Did you really mean 'mgmt'?
docs/docs-content/vm-management/environment-setup.md|24 col 33| [Vale.Spelling] Did you really mean 'Gbps'?
docs/docs-content/vm-management/environment-setup.md|24 col 86| [Vale.Spelling] Did you really mean 'Gbps'?
docs/docs-content/vm-management/environment-setup.md|25 col 182| [Vale.Spelling] Did you really mean 'multipath'?
docs/docs-content/vm-management/environment-setup.md|27 col 51| [spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/vm-management/environment-setup.md|35 col 50| [spectrocloud-docs-internal.acronym] Use title case to define the acronym '(GB)'.
docs/docs-content/vm-management/environment-setup.md|46 col 62| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/environment-setup.md|47 col 41| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/environment-setup.md|57 col 23| [Vale.Spelling] Did you really mean 'mgmt'?
docs/docs-content/vm-management/environment-setup.md|61 col 35| [Google.EmDash] Don't put a space before or after a dash.
docs/docs-content/vm-management/environment-setup.md|76 col 1| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vm-management/environment-setup.md|76 col 81| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/environment-setup.md|85 col 5| [Vale.Spelling] Did you really mean 'bond_mgmt'?
docs/docs-content/vm-management/environment-setup.md|87 col 5| [Vale.Spelling] Did you really mean 'bond_data'?
docs/docs-content/vm-management/environment-setup.md|89 col 31| [Vale.Spelling] Did you really mean 'bond_data'?
docs/docs-content/vm-management/environment-setup.md|91 col 43| [spectrocloud-docs-internal.inclusive] Consider avoiding 'master' in favor of more inclusive language.
docs/docs-content/vm-management/environment-setup.md|91 col 63| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/environment-setup.md|92 col 20| [spectrocloud-docs-internal.inclusive] Consider avoiding 'master' in favor of more inclusive language.
docs/docs-content/vm-management/environment-setup.md|97 col 91| [Vale.Spelling] Did you really mean 'Switchport'?
docs/docs-content/vm-management/environment-setup.md|109 col 95| [spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/vm-management/environment-setup.md|110 col 22| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|113 col 22| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|115 col 41| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|123 col 45| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/environment-setup.md|129 col 14| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/environment-setup.md|141 col 111| [Vale.Spelling] Did you really mean 'Switchport'?
docs/docs-content/vm-management/environment-setup.md|146 col 24| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/environment-setup.md|147 col 10| [Vale.Spelling] Did you really mean 'subinterfaces'?
docs/docs-content/vm-management/environment-setup.md|147 col 38| [spectrocloud-docs-internal.inclusive] Consider avoiding 'master' in favor of more inclusive language.
docs/docs-content/vm-management/environment-setup.md|147 col 64| [Vale.Spelling] Did you really mean 'subinterfaces'?
docs/docs-content/vm-management/environment-setup.md|149 col 16| [spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/vm-management/environment-setup.md|149 col 55| [Vale.Spelling] Did you really mean 'mgmt'?
docs/docs-content/vm-management/environment-setup.md|159 col 42| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|160 col 26| [spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 79.6%, saving 312.79 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/vm-management_architecture_vmo-architecture.webp 205.48 KB 52.94 KB -74.2% View diff
static/assets/docs/images/vm-mangement_vmo-diagram.webp 187.34 KB 27.09 KB -85.5% View diff

715 images did not require optimisation.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/vm-management/environment-setup.md|92 col 20| [spectrocloud-docs-internal.inclusive] Consider avoiding 'master' in favor of more inclusive language.
docs/docs-content/vm-management/environment-setup.md|97 col 91| [Vale.Spelling] Did you really mean 'Switchport'?
docs/docs-content/vm-management/environment-setup.md|109 col 95| [spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/vm-management/environment-setup.md|110 col 22| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|113 col 22| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|115 col 41| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|123 col 45| [Vale.Spelling] Did you really mean 'Multus'?
docs/docs-content/vm-management/environment-setup.md|129 col 14| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/environment-setup.md|141 col 111| [Vale.Spelling] Did you really mean 'Switchport'?
docs/docs-content/vm-management/environment-setup.md|146 col 24| [Vale.Spelling] Did you really mean 'VLANs'?
docs/docs-content/vm-management/environment-setup.md|147 col 10| [Vale.Spelling] Did you really mean 'subinterfaces'?
docs/docs-content/vm-management/environment-setup.md|147 col 38| [spectrocloud-docs-internal.inclusive] Consider avoiding 'master' in favor of more inclusive language.
docs/docs-content/vm-management/environment-setup.md|147 col 64| [Vale.Spelling] Did you really mean 'subinterfaces'?
docs/docs-content/vm-management/environment-setup.md|149 col 16| [spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/vm-management/environment-setup.md|149 col 55| [Vale.Spelling] Did you really mean 'mgmt'?
docs/docs-content/vm-management/environment-setup.md|159 col 42| [Vale.Spelling] Did you really mean 'subinterface'?
docs/docs-content/vm-management/environment-setup.md|160 col 26| [spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.


| Interface | Type | Contents | VLAN | CIDR | Gateway |
| ---------------- | ------ | -------------------- | ------ | -------------- | ---------- |
| **bond_mgmt** | Bond | enp1s0 <br /> enp2s0 | Native | 192.168.0.0/22 | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'bond_mgmt'?

| ---------------- | ------ | -------------------- | ------ | -------------- | ---------- |
| **bond_mgmt** | Bond | enp1s0 <br /> enp2s0 | Native | 192.168.0.0/22 | |
| **bond_mgmt.10** | VLAN | bond_mgmt | 10 | 172.16.0.0/22 | |
| **bond_data** | Bond | enp1s1 <br /> enp2s1 | Native | | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'bond_data'?

| **bond_mgmt.10** | VLAN | bond_mgmt | 10 | 172.16.0.0/22 | |
| **bond_data** | Bond | enp1s1 <br /> enp2s1 | Native | | |
| **bond_data.20** | VLAN | bond_data | 20 | 10.20.30.0/16 | 10.20.30.1 |
| **br0** | Bridge | bond_data | Native | | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'bond_data'?

| **bond_data.20** | VLAN | bond_data | 20 | 10.20.30.0/16 | 10.20.30.1 |
| **br0** | Bridge | bond_data | Native | | |

The **br0** bridge interface is used as a master interface by Multus to automatically create VLAN interfaces for VMs. In
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.inclusive] Consider avoiding 'master' in favor of more inclusive language.

| **bond_data.20** | VLAN | bond_data | 20 | 10.20.30.0/16 | 10.20.30.1 |
| **br0** | Bridge | bond_data | Native | | |

The **br0** bridge interface is used as a master interface by Multus to automatically create VLAN interfaces for VMs. In
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Multus'?

@karl-cardenas-coding karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 labels Jul 22, 2024
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice changes and re-org. Things are flowing better together. I left some comments and suggestions below.

One thing we are missing is the previous VMO state in the deprecation folder. Let's get that add there for historical purposes.

docs/docs-content/vm-management/vm-management.md Outdated Show resolved Hide resolved
docs/docs-content/vm-management/vm-management.md Outdated Show resolved Hide resolved
docs/docs-content/vm-management/environment-setup.md Outdated Show resolved Hide resolved
Comment on lines 27 to 29
Typically, the cluster control plane nodes do not operate any VMO workloads. As a result, they can have lighter hardware
specifications. For example, a server with 4 cores and 8 GB RAM is sufficient for a minimum-specification control plane
node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the table above, we state that 8 cores are the minimum. Are four cores the minimum then?

Copy link
Contributor Author

@lennessyy lennessyy Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From reading the table, 8 cores is the minimum for worker nodes. 4 core is the minimum for control plane nodes whose requirements are less stringent. I'll make the distinction clearer.

specifications. For example, a server with 4 cores and 8 GB RAM is sufficient for a minimum-specification control plane
node.

You can increase the hardware specifications based on the total number of control plane and worker nodes you want in the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can help the reader by explaining and linking to this section in the comments cell for CPU in the table above.

docs/docs-content/vm-management/environment-setup.md Outdated Show resolved Hide resolved
docs/docs-content/vm-management/rbac/rbac.md Show resolved Hide resolved
Comment on lines 27 to 29
Typically, the cluster control plane nodes do not operate any VMO workloads. As a result, they can have lighter hardware
specifications. For example, a server with 4 cores and 8 GB RAM is sufficient for a minimum-specification control plane
node.
Copy link
Contributor Author

@lennessyy lennessyy Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From reading the table, 8 cores is the minimum for worker nodes. 4 core is the minimum for control plane nodes whose requirements are less stringent. I'll make the distinction clearer.

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
docs/docs-content/vm-management/environment-setup.md Outdated Show resolved Hide resolved
docs/docs-content/vm-management/environment-setup.md Outdated Show resolved Hide resolved
| **Server** | 2U Rackmount Chassis | 2U Rackmount Chassis | Needs to fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). |
| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| **Server** | 2U Rackmount Chassis | 2U Rackmount Chassis | Needs to fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). |
| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
| **Storage Adapters** | 2 x 16 Gbps FC | 2 x 16 Gbps FC | Storage adapters must support the FC protocol, a high-speed network protocol used for data transfer. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
| **Storage Adapters** | 2 x 16 Gbps FC | 2 x 16 Gbps FC | Storage adapters must support the FC protocol, a high-speed network protocol used for data transfer. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?


For publishing workloads from VMs, you have the following ways:

- Running the VM on the pod network like containers and publishing the individual VM ports as Kubernetes services on the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'operating' instead of 'Running'.


| Component | Minimum | Recommended | Comments |
| -------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Rackmount'?

| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
| **Storage Adapters** | 2 x 16 Gbps FC | 2 x 16 Gbps FC | Storage adapters must support the FC protocol, a high-speed network protocol used for data transfer. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| **CPU** | Intel or AMD x64 CPU with 8 cores | Intel or AMD x64 CPU with 8 cores | |
| **RAM** | 24 GB | 256 GB or more | Assumes the deployment of 20 VMs per node multiplied by the median RAM per VM. |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
| **Storage Adapters** | 2 x 16 Gbps FC | 2 x 16 Gbps FC | Storage adapters must support the FC protocol, a high-speed network protocol used for data transfer. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?


| Component | Minimum | Recommended | Comments |
| -------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Rackmount'?

| Component | Minimum | Recommended | Comments |
| -------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| Component | Minimum | Recommended | Comments |
| -------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| -------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
| **Storage Adapters** | 2 x 16 Gbps FC | 2 x 16 Gbps FC | Storage adapters must support the FC protocol, a high-speed network protocol used for data transfer. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

| -------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Form Factor** | The server must fit Fiber Channel (FC) adapters and have sufficient Network Interface Cards (NIC). | 2U Rackmount Chassis | |
| **Network Adapters** | 2 x 10 Gbps <br /> (data + management) | 2 x 10 Gbps (data) <br /> 2 x 10 Gbps (management) | Pod overlay operates on the management network. |
| **Storage Adapters** | 2 x 16 Gbps FC | 2 x 16 Gbps FC | Storage adapters must support the FC protocol, a high-speed network protocol used for data transfer. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Gbps'?

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 78.3%, saving 434.26 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/vm-management_architecture_vmo-architecture.webp 554.62 KB 120.36 KB -78.3% View diff

713 images did not require optimisation.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 2%, saving 2.43 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/vm-management_architecture_vmo-architecture.webp 120.36 KB 117.93 KB -2.0% View diff

713 images did not require optimisation.

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a minor suggestion,

The CPU and RAM requirements for control plane nodes increase with the number of worker nodes and namespaces in the
cluster. Refer to the following table for guidance on control plane node sizing.

::: warning
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lennessyy I'm not sure why this is happening. I wonder if the space between the last : and the word warning is causing this 🤔

CleanShot 2024-07-23 at 08 21 05

@lennessyy lennessyy enabled auto-merge (squash) July 23, 2024 16:31
@lennessyy lennessyy merged commit 87be13f into master Jul 23, 2024
17 checks passed
@lennessyy lennessyy deleted the vmo-refactor branch July 23, 2024 16:42
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Jul 23, 2024
* docs: organize vmo structure

* docs: fix broken links

* fix redirect issue

* docs: fix broken link

* docs: fix broken link

* docs: fix broken link

* docs: start refactoring VMO pages

* docs: refactor create and manage VMs

* Update the VMO index page and document its architecture (#3073)

* docs: Update the VMO index page

* docs: Document the VMO architecture (WIP)

* docs: Finish the VMO arch draft and update the higl-level topic structure

* chore: Fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix typos flagged by Vale

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>

* docs: progress on vmo

* docs: document options in update configurations

* docs: edit prerequisites

* docs: Update the VMO architecture, add the environment setup topic, other refactoring work

* Optimised images with calibre/image-actions

* docs: fix broken link

* Optimised images with calibre/image-actions

* docs: inclusive language

* docs: fix ablism terms

* docs: address review comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: clarify cpu specifications

* docs: webp conversion

* docs: minor edit

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken admonition

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <horbenko.yuliya@gmail.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
(cherry picked from commit 87be13f)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-0:
- docs: DOC-1118 Image Conversion to webp (#2439)
- docs: updated URLs to use file path context
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- docs: DOC-1118 Image Conversion to webp (#2439)
version-4-2 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-2:
- docs: DOC-1118 Image Conversion to webp (#2439)
- replace caution with warning (#2039)
version-4-3 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-3:
- Security Bulletin Changes (#3120)
- docs: add new known issue (#3340)
version-4-4

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 3040

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

vault-token-factory-spectrocloud bot added a commit that referenced this pull request Jul 23, 2024
* docs: organize vmo structure

* docs: fix broken links

* fix redirect issue

* docs: fix broken link

* docs: fix broken link

* docs: fix broken link

* docs: start refactoring VMO pages

* docs: refactor create and manage VMs

* Update the VMO index page and document its architecture (#3073)

* docs: Update the VMO index page

* docs: Document the VMO architecture (WIP)

* docs: Finish the VMO arch draft and update the higl-level topic structure

* chore: Fix formatting

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix typos flagged by Vale

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>

* docs: progress on vmo

* docs: document options in update configurations

* docs: edit prerequisites

* docs: Update the VMO architecture, add the environment setup topic, other refactoring work

* Optimised images with calibre/image-actions

* docs: fix broken link

* Optimised images with calibre/image-actions

* docs: inclusive language

* docs: fix ablism terms

* docs: address review comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* docs: clarify cpu specifications

* docs: webp conversion

* docs: minor edit

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix broken admonition

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <horbenko.yuliya@gmail.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
(cherry picked from commit 87be13f)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.4.12 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 backport-version-4-4 Backport change to version 4.4 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants