Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

Commit

Permalink
docs: Fix typos and formatting
Browse files Browse the repository at this point in the history
Fix spelling mistakes and formatting issues.

Fixes #562.

Signed-off-by: James O. D. Hunt <[email protected]>
  • Loading branch information
jodh-intel committed May 24, 2019
1 parent c2ad71d commit ca18685
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ machine using the debug console](https://github.com/kata-containers/documentatio

## `cpuset` cgroup details

See the [cupset cgroup documentation](documentation/features/cpuset.md).
See the [cpuset cgroup documentation](documentation/features/cpuset.md).
12 changes: 8 additions & 4 deletions documentation/features/cpuset.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,31 @@ The cpuset CPU cgroup will be applied on two events:
- container update

When the runtime requests to apply cpuset cgroup to the agent, the amount of
vcpus available might not be the same to the required vcpus in the request.
VCPUs available might not be the same to the required VCPUs in the request.

This is because the request from the agent client (i.e. the Kata runtime)
passes cpusets that are requested to be placed on the host. This isolates the
container workload on some specific host CPUs. The runtime passes the requested
cpuset to the agent, which tries to apply the cgroup cpuset on the guest.

The runtime only calculates and hot-plugs the CPUSs based on the container
The runtime only calculates and hot-plugs the CPUs based on the container
period and quota. This is why the VM will not have the same amount of CPUs as
the host.

Example:

docker run -ti --cpus 2 --cpuset 0,1 busybox
```
$ docker run -ti --cpus 2 --cpuset 0,1 busybox
```

This should result with the container limited to the time of 2 CPUs, but is
only allowed to be scheduled on CPUs 0 and 1.

The following is an example of a similar case with a valid traditional container:

docker run -ti --cpus 2 --cpuset 2,3,4 busybox
```
$ docker run -ti --cpus 2 --cpuset 2,3,4 busybox
```

Here, the container is limited to 2 CPUs and can be scheduled on CPU 2, 3, and
4.
Expand Down

0 comments on commit ca18685

Please sign in to comment.