TELCODOCS:857 - document resource requirements and prerequisites for … by MirzWeiss · Pull Request #7 · MirzWeiss/openshift-docs

MirzWeiss · 2023-02-27T08:49:48Z

@bpradipt @jensfr @abhbaner @cpmeadors @snir911 please review/approve. This PR covers the prerequisites an resource requirements for peer-pods only, not the other content.

QE review:

QE has approved this change.

…pport in OSC.

…d new prereqs section for Azure

bpradipt · 2023-03-30T10:14:53Z

-A container running without a memory resource consumes free memory until the total memory used by the VM reaches the default allocation. The guest and its I/O buffers also consume memory.
-
-If a container is given a specific amount of memory, then that memory is hot-plugged into the VM before the container starts.
+* You have {product-title} {product-version} installed on AWS or Azure.


Since vSphere is already mentioned, should the above line also include vSphere ?
cc @@jensfr

@bpradipt Sorry, the section about vSphere should be removed. Not sure why it's still here.

bpradipt · 2023-03-30T10:15:48Z

+A peer-pod uses resources in two locations:

-The following table lists some the default values for resource allocation.
+* The Kubernetes worker node. The worker node stores metadata, Kata shim resources (`containerd-shim-kata-v2`), remote-hypervisor (`cloud-api-adaptor`) resources, and the tunnel setup between the worker nodes and the peer-pod VM.


Suggested change

* The Kubernetes worker node. The worker node stores metadata, Kata shim resources (`containerd-shim-kata-v2`), remote-hypervisor (`cloud-api-adaptor`) resources, and the tunnel setup between the worker nodes and the peer-pod VM.

The Kubernetes worker node. The worker node stores metadata, Kata shim resources (`containerd-shim-kata-v2`), remote-hypervisor (`cloud-api-adaptor`) resources, and the tunnel setup between the worker node and the pod VMs.

bpradipt · 2023-03-30T10:18:41Z


-The following table lists some the default values for resource allocation.
+* The Kubernetes worker node. The worker node stores metadata, Kata shim resources (`containerd-shim-kata-v2`), remote-hypervisor (`cloud-api-adaptor`) resources, and the tunnel setup between the worker nodes and the peer-pod VM.
+* The cloud instance. This is the actual peer-pod VM running in the cloud.


Suggested change

* The cloud instance. This is the actual peer-pod VM running in the cloud.

The cloud instance. This is the actual pod VM created in the cloud in response to pod creation.

bpradipt · 2023-03-30T10:21:10Z

-|===
-[.small]
--
+The total capacity of the peer-pod VMs running in the cloud is defined as Kubernetes Node extended resources. This enables the Kubernetes scheduler to handle capacity tracking and accounting. The extended resource is named `kata.peerpods.io/vm`, and defines the maximum number of peer-pods that you can create in the cluster.


Suggested change

The total capacity of the peer-pod VMs running in the cloud is defined as Kubernetes Node extended resources. This enables the Kubernetes scheduler to handle capacity tracking and accounting. The extended resource is named `kata.peerpods.io/vm`, and defines the maximum number of peer-pods that you can create in the cluster.

The total peer-pods capacity of the cluster is the total number of pod VMs that can be created in the cloud and is defined using Kubernetes Node extended resources. This enables the Kubernetes scheduler to handle capacity tracking and accounting. The extended resource is named `kata.peerpods.io/vm`, and defines the maximum number of peer-pods that you can create in the cluster.

bpradipt · 2023-03-30T10:23:40Z

+The total capacity of the peer-pod VMs running in the cloud is defined as Kubernetes Node extended resources. This enables the Kubernetes scheduler to handle capacity tracking and accounting. The extended resource is named `kata.peerpods.io/vm`, and defines the maximum number of peer-pods that you can create in the cluster.

-File buffers appear and are accounted for in multiple locations:
+A link:https://https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/[mutating webhook] removes any resource-specific entries from the pod specifications and adds them to the peer-pods extended resources. This enables the Kubernetes scheduler to account for these extended resources, ensuring the peer-pod is only scheduled when resources are available.


Suggested change

A link:https://https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/[mutating webhook] removes any resource-specific entries from the pod specifications and adds them to the peer-pods extended resources. This enables the Kubernetes scheduler to account for these extended resources, ensuring the peer-pod is only scheduled when resources are available.

A link:https://https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/[mutating webhook] removes any cpu and memory resource-specific entries from the pod specification (if it exists) and adds a peer-pods extended resource to the pod specification. This enables the Kubernetes scheduler to account for these extended resources, ensuring the peer-pod is only scheduled when capacity is available.

bpradipt · 2023-03-30T10:25:26Z

 == Creating peer-pod VM images for {sandboxed-containers-first}

-include::modules/sandboxed-containers-creating-peer-pod-vm-images.adoc[leveloffset=+1]
+To use {sandboxed-containers-first} with peer-pods, you must prepare your {product-title} cluster, and create a peer-pod VM image before installing the {sandboxed-containers-operator}. You can install the {sandboxed-containers-operator} using either the web console or OpenShift CLI (`oc`).


Suggested change

To use {sandboxed-containers-first} with peer-pods, you must prepare your {product-title} cluster, and create a peer-pod VM image before installing the {sandboxed-containers-operator}. You can install the {sandboxed-containers-operator} using either the web console or OpenShift CLI (`oc`).

To use {sandboxed-containers-first} with peer-pods, you must prepare your {product-title} cluster, and create a pod VM image before installing the {sandboxed-containers-operator}. You can install the {sandboxed-containers-operator} using either the web console or OpenShift CLI (`oc`).

cpmeadors · 2023-04-04T15:22:49Z

In the rendered preview, I am seeing the channel name is still "stable-1.3". It should be "stable". I am also seeing the runtimeclass as "kata" in the peerpod examples. That should probably be kata-remote-cc. Not easy to find the lines in the source because I think they are variables.

cpmeadors · 2023-04-04T15:25:11Z

I am also not seeing a section to describe installing the kataconfig with the appropriate options to enable peerpods.

[edit] I see that this will be in a different PR. Will review that when it is ready.

MirzWeiss · 2023-04-16T09:32:53Z

I am also not seeing a section to describe installing the kataconfig with the appropriate options to enable peerpods.

[edit] I see that this will be in a different PR. Will review that when it is ready.

@cpmeadors this PR only covers the updates to the resource requirements and prereqs. I have other PRs to cover those sections, that's why those updates don't appear here.

TELCODOCS-1990: Docfooding feedback #2 applied TELCODOCS-1990: Docfooding feedback #3 applied TELCODOCS-1990: Docfooding feedback #4 applied TELCODOCS-1990: Docfooding feedback #5 applied TELCODOCS-1990: Docfooding feedback #6 applied TELCODOCS-1990: Docfooding feedback #7 applied TELCODOCS-1990: Docfooding feedback #8 applied TELCODOCS-1990: Docfooding feedback #9 applied TELCODOCS-1990: Docfooding feedback #10 applied TELCODOCS-1990: Docfooding feedback #11 applied TELCODOCS-1990: Peer review feedback applied TELCODOCS-1990: Dev review feedback applied TELCODOCS-1990: Dev/Peer review feedback applied TELCODOCS-1990: Dev/Peer #2 review feedback applied TELCODOCS-1990: Dev #2 review feedback applied TELCODOCS-1990: Peer review squad feedback applied

MirzWeiss force-pushed the KATA-1635 branch from 3388d01 to 57302bc Compare March 13, 2023 12:29

MirzWeiss force-pushed the KATA-1635 branch from 57302bc to bee80b7 Compare March 28, 2023 08:44

MirzWeiss force-pushed the TELCODOCS-857 branch from 0b95bc2 to 849a522 Compare March 28, 2023 09:22

MirzWeiss commented Mar 28, 2023

View reviewed changes

MirzWeiss force-pushed the KATA-1635 branch from bee80b7 to 390af7a Compare March 29, 2023 05:09

MirzWeiss added 2 commits March 29, 2023 08:09

KATA:1635 - Consolidated PR for doc work for KATA-1635 - peer pods su…

593d681

…pport in OSC.

TELCODOCS: 857 - updated prereqs with comments from Pradipta and adde…

edba302

…d new prereqs section for Azure

MirzWeiss force-pushed the TELCODOCS-857 branch from 849a522 to edba302 Compare March 29, 2023 05:33

bpradipt reviewed Mar 30, 2023

View reviewed changes

	* The Kubernetes worker node. The worker node stores metadata, Kata shim resources (`containerd-shim-kata-v2`), remote-hypervisor (`cloud-api-adaptor`) resources, and the tunnel setup between the worker nodes and the peer-pod VM.
	The Kubernetes worker node. The worker node stores metadata, Kata shim resources (`containerd-shim-kata-v2`), remote-hypervisor (`cloud-api-adaptor`) resources, and the tunnel setup between the worker node and the pod VMs.

	* The cloud instance. This is the actual peer-pod VM running in the cloud.
	The cloud instance. This is the actual pod VM created in the cloud in response to pod creation.

	The total capacity of the peer-pod VMs running in the cloud is defined as Kubernetes Node extended resources. This enables the Kubernetes scheduler to handle capacity tracking and accounting. The extended resource is named `kata.peerpods.io/vm`, and defines the maximum number of peer-pods that you can create in the cluster.
	The total peer-pods capacity of the cluster is the total number of pod VMs that can be created in the cloud and is defined using Kubernetes Node extended resources. This enables the Kubernetes scheduler to handle capacity tracking and accounting. The extended resource is named `kata.peerpods.io/vm`, and defines the maximum number of peer-pods that you can create in the cluster.

	To use {sandboxed-containers-first} with peer-pods, you must prepare your {product-title} cluster, and create a peer-pod VM image before installing the {sandboxed-containers-operator}. You can install the {sandboxed-containers-operator} using either the web console or OpenShift CLI (`oc`).
	To use {sandboxed-containers-first} with peer-pods, you must prepare your {product-title} cluster, and create a pod VM image before installing the {sandboxed-containers-operator}. You can install the {sandboxed-containers-operator} using either the web console or OpenShift CLI (`oc`).

Conversation

MirzWeiss commented Feb 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bpradipt Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

MirzWeiss Apr 16, 2023

Choose a reason for hiding this comment

Uh oh!

bpradipt Mar 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bpradipt Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

bpradipt Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

bpradipt Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

bpradipt Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

cpmeadors commented Apr 4, 2023

Uh oh!

cpmeadors commented Apr 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MirzWeiss commented Apr 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MirzWeiss commented Feb 27, 2023 •

edited

Loading

bpradipt Mar 30, 2023 •

edited

Loading

cpmeadors commented Apr 4, 2023 •

edited

Loading