howto: add sandbox config annotation howto by bergwolf · Pull Request #576 · kata-containers/documentation

bergwolf · 2019-12-10T06:47:34Z

It explains the details of current supported annotations.

Fixes: #486
Fixes: #294
Signed-off-by: Peng Tao bergwolf@hyper.sh

bergwolf · 2019-12-10T07:14:38Z

/test

bergwolf · 2019-12-10T07:16:55Z

Spell check doesn't understand some tech words, what shall I do to fix it?

WARNING: Word ''drop': did you mean one of the following?: drop, droop, drupe, troop
WARNING: Word 'MiB': did you mean one of the following?: MB, Mia, Min, Mir, Mil, Mic, Mi, Mis, Mid, Mi B, Nib, Mob, Rib
WARNING: Word 'MiB': did you mean one of the following?: MB, Mia, Min, Mir, Mil, Mic, Mi, Mis, Mid, Mi B, Nib, Mob, Rib
WARNING: Word 'accpets': did you mean one of the following?: accepts, accents, carpets, accosts, aspects, accepter, accepted
WARNING: Word 'dev': did you mean one of the following?: Dev, deb, div, den, rev, deg, def, dew, Nev, Rev, Lev, Kev, devil, devise
WARNING: Word 'dev': did you mean one of the following?: Dev, deb, div, den, rev, deg, def, dew, Nev, Rev, Lev, Kev, devil, devise
WARNING: Word 'enotes': did you mean one of the following?: emotes, notes, denotes, e notes, endnote, notates, denote, note's, entice, endorse
WARNING: Word 'in'': did you mean one of the following?: in, ins, inn, int, inc, ind, inf, ink, In, IN, Ian, ion's
WARNING: Word 'kata': did you mean one of the following?: Kata, data, Nata, Mata, Katina, Katmai
WARNING: Word 'kata': did you mean one of the following?: Kata, data, Nata, Mata, Katina, Katmai
WARNING: Word 'kata': did you mean one of the following?: Kata, data, Nata, Mata, Katina, Katmai
WARNING: Word 'kata': did you mean one of the following?: data, Katz, Kate, Tanaka, attack, kart, Kurt
WARNING: Word 'modprobe': did you mean one of the following?: mod probe, mod-probe, prober, problem, mobbed, mobber, probated, probates
WARNING: Word 'msize': did you mean one of the following?: maize, size, m size, seize, Mozes, mises
WARNING: Word 'nvdimm': did you mean one of the following?: dimming, Nevadian, Nevada
WARNING: Word 'nvdimm': did you mean one of the following?: dimming, Nevadian, Nevada
WARNING: Word 'oci': did you mean one of the following?: loci, foci, sci, obi, cocci, socio, Ci, ocean, Oise
WARNING: Word 'scsi': did you mean one of the following?: SCSI
WARNING: Word 'seccomp': did you mean one of the following?: sec comp, sec-comp, decompose, compose, recompense, comprise, scamper, scampi
WARNING: Word 'seccomp': did you mean one of the following?: sec comp, sec-comp, decompose, compose, recompense, comprise, scamper, scampi
WARNING: Word 'seccomp': did you mean one of the following?: sec comp, sec-comp, decompose, compose, recompense, comprise, scamper, scampi
WARNING: Word 'urandom': did you mean one of the following?: random, u random, Durand, Armando, Omdurman, Brando, grandam, grandma
WARNING: Word 'vcpus': did you mean one of the following?: CPUs, pus, copious, scops
WARNING: Word 'vhost': did you mean one of the following?: VHOST
WARNING: Word 'vhost': did you mean one of the following?: host, ghost, v host, Host, Horst, hoist
WARNING: Word 'virtiofs': did you mean one of the following?: virtuoso, vision's, vivisection
WARNING: Word 'vm': did you mean one of the following?: cm, v, m, vim, em, vs, vi, am, nm, rm, om, um, gm, mm, pm
WARNING: Word 'vsock': did you mean one of the following?: sock, v sock, viscus, viscose
ERROR: Spell check failed for file: 'how-to/how-to-set-sandbox-config-kata.md'
ERROR: spell check failed for document how-to/how-to-set-sandbox-config-kata.md

grahamwhaley

Looking good! thanks!
I left some nitpicks. For the spelling, some words (like kata) need capitalisation I think (to Kata) - others, you might have to add to the dictionary, or they may be some 'magic quoting' that can effectively mark them as 'ignore'. See https://github.com/kata-containers/tests/tree/master/cmd/check-spelling#adding-a-new-word - and consult the spell master @jodh-intel ;-)

grahamwhaley · 2019-12-10T10:11:17Z

how-to/how-to-set-sandbox-config-kata.md

+|-------| ----- | ----- |
+| `io.katacontainers.config_path` | string | kata config file location that overrides the default config paths |
+| `io.katacontainers.pkg.oci.bundle_path` | string | oci bundle path |
+| `io.katacontainers.pkg.oci.container_type`| string | oci container type. Only accpets `pod_container` and `pod_sandbox` |


s/accpets/accepts/

grahamwhaley · 2019-12-10T10:11:58Z

how-to/how-to-set-sandbox-config-kata.md

+## Runtime Options
+| Key | Value Type | Comments |
+|-------| ----- | ----- |
+| `io.katacontainers.config.runtime.disable_guest_seccomp`| boolean | determines if seccomp should be applied inside guest |


s/seccomp/seccomp/ ?

grahamwhaley · 2019-12-10T10:12:23Z

how-to/how-to-set-sandbox-config-kata.md

+| Key | Value Type | Comments |
+|-------| ----- | ----- |
+| `io.katacontainers.config.runtime.disable_guest_seccomp`| boolean | determines if seccomp should be applied inside guest |
+| `io.katacontainers.config.runtime.sandbox_cgroup_only`| boolean | determines if kata processes are managed only in sandbox cgroup |


s/kata/Kata/ throughout?

grahamwhaley · 2019-12-10T10:13:45Z

how-to/how-to-set-sandbox-config-kata.md

+| `io.katacontainers.config.runtime.sandbox_cgroup_only`| boolean | determines if kata processes are managed only in sandbox cgroup |
+| `io.katacontainers.config.runtime.experimental` | boolean | determines if experimental features enabled |
+| `io.katacontainers.config.runtime.internetworking_model` | string| determines how the VM should be connected to the container network interface. Valid values are `macvtap`, `tcfilter` and `none` |
+| `io.katacontainers.config.runtime.disable_new_netns` | boolean | determines if create a netns for hypervisor process |


reword a little maybe:

determines if a new netns is created for the hypervisor process

grahamwhaley · 2019-12-10T10:14:53Z

how-to/how-to-set-sandbox-config-kata.md

+## Hypervisor Options
+| Key | Value Type | Comments |
+|-------| ----- | ----- |
+| `io.katacontainers.config.hypervisor.kernel` | string | the kernel needed to boot the container VM |


s/needed/used/

grahamwhaley · 2019-12-10T10:16:11Z

how-to/how-to-set-sandbox-config-kata.md

+| `io.katacontainers.config.hypervisor.guest_hook_path` | string | the path within the VM that will be used for 'drop-in' hooks |
+| `io.katacontainers.config.hypervisor.use_vsock` | boolean | specify use of vsock for agent communication |
+| `io.katacontainers.config.hypervisor.hotplug_vfio_on_root_bus` | boolean | indicate if devices need to be hotplugged on the root bus instead of a bridge|
+| `io.katacontainers.config.hypervisor.entropy_source` | string| the path to a host source of entropy (/dev/random, /dev/urandom or real hardware RNG device) |


s?/dev/random?/dev/random?

jodh-intel · 2019-12-12T10:07:55Z

Hi @bergwolf - tal at https://github.com/kata-containers/tests/tree/master/cmd/check-spelling/data/ - all acronymns / abbreviations need to use the "official" spelling (including capitalisation) and yes, s/kata/Kata/ please ;)

You can "bypass" the spell-checker by putting a word in backticks, but that should only be used for things like filenames and command names (see https://github.com/kata-containers/documentation/blob/master/Documentation-Requirements.md#files-and-command-names).

jodh-intel · 2019-12-12T10:08:33Z

how-to/how-to-set-sandbox-config-kata.md

+# Per-Pod Kata Configurations
+
+Kata Containers gives users freedom to customise at per-pod level, by setting
+a wide range of kata specific annotations in the pod spec.


s/spec/specification/

s/kata/Kata/

jodh-intel · 2019-12-12T10:09:03Z

how-to/how-to-set-sandbox-config-kata.md

+| Key | Value Type | Comments |
+|-------| ----- | ----- |
+| `io.katacontainers.config_path` | string | kata config file location that overrides the default config paths |
+| `io.katacontainers.pkg.oci.bundle_path` | string | oci bundle path |


jodh-intel · 2019-12-12T10:10:01Z

how-to/how-to-set-sandbox-config-kata.md

+| Key | Value Type | Comments |
+|-------| ----- | ----- |
+| `io.katacontainers.config.hypervisor.kernel` | string | the kernel needed to boot the container VM |
+| `io.katacontainers.config.hypervisor.image` | string | the guest image that will run in the container VM |


Can you sort the rows alphabetically by column 1 (the key)?

jodh-intel · 2019-12-16T10:38:54Z

Just a reminder that this PR needs updating based on review feedback.

egernst · 2020-01-14T15:40:22Z

This is a great document @bergwolf. I know these edits can be painful, but will you get a chance to update the document? I'd love to be able to reference this!

jodh-intel · 2020-01-20T09:41:18Z

Ping @bergwolf - just a few sed-type updates and this is good to go 😄

bergwolf · 2020-01-20T10:27:12Z

@grahamwhaley @jodh-intel Sorry for the delay. I've updated the PR to address all comments including sorting all options alphabetically. All spell checker warnings are fixed. PTAL.

bergwolf · 2020-01-20T10:37:02Z

The spell checker is still failing but doesn't show any errors. @jodh-intel Any clue? I can't reproduce it locally. .ci/static-checks.sh passed successfully on my local machine.

INFO: Checking document code blocks
INFO: processing file 'how-to/how-to-set-sandbox-config-kata.md'
INFO: processing file 'how-to/README.md'
INFO: processing file 'how-to/how-to-set-sandbox-config-kata.md'
INFO: processing file 'how-to/README.md'
INFO: processing file 'how-to/how-to-set-sandbox-config-kata.md'
INFO: processing file 'how-to/README.md'
INFO: Checking all document URLs
INFO: Checking URL https://github.com/kata-containers/documentation/wiki/Initial-release-of-Kata-Containers-with-Firecracker-support
INFO: Spell checking file 'how-to/how-to-set-sandbox-config-kata.md'
INFO: Spell check successful for file: 'how-to/how-to-set-sandbox-config-kata.md'
INFO: Spell checking file 'how-to/README.md'
INFO: Spell check successful for file: 'how-to/README.md'
INFO: Spell checking file 'how-to/how-to-set-sandbox-config-kata.md'
INFO: Spell check successful for file: 'how-to/how-to-set-sandbox-config-kata.md'
INFO: Spell checking file 'how-to/README.md'
INFO: Spell check successful for file: 'how-to/README.md'
INFO: Spell checking file 'how-to/how-to-set-sandbox-config-kata.md'
INFO: Spell check successful for file: 'how-to/how-to-set-sandbox-config-kata.md'
INFO: Spell checking file 'how-to/README.md'
INFO: Spell check successful for file: 'how-to/README.md'
The command ".ci/static-checks.sh" failed and exited with 1 during .

grahamwhaley · 2020-01-20T10:47:00Z

@bergwolf - yep, working on it kata-containers/tests#2240
we (I) broke it with a PR at the end of last week....

bergwolf · 2020-01-20T11:56:30Z

Thanks @grahamwhaley.

bergwolf · 2020-02-20T09:43:59Z

/test

GabyCT · 2020-03-02T15:48:59Z

@bergwolf could you please resolve the conflicts ? thanks

It explains the details of current supported annotations. Fixes: kata-containers#486 Fixes: kata-containers#294 Depends-on: github.com/kata-containers/tests#2240 Signed-off-by: Peng Tao <bergwolf@hyper.sh>

grahamwhaley · 2020-04-06T14:51:43Z

/test-ubuntu

grahamwhaley

lgtm
I'm happy to merge this, even if we may need to tweak anything, as having this visible is so much better than having it sat in a PR.

bergwolf requested a review from a team as a code owner December 10, 2019 06:47

bergwolf mentioned this pull request Dec 10, 2019

shimv2: support runtime config path via annotation kata-containers/runtime#2333

Merged

grahamwhaley reviewed Dec 10, 2019

View reviewed changes

jodh-intel reviewed Dec 12, 2019

View reviewed changes

bergwolf force-pushed the annotations branch 2 times, most recently from 9de435e to 752c67b Compare January 20, 2020 10:25

bergwolf force-pushed the annotations branch from 752c67b to 03d6348 Compare January 20, 2020 10:32

bergwolf force-pushed the annotations branch 2 times, most recently from d163609 to c855aaa Compare January 20, 2020 11:51

GabyCT approved these changes Mar 2, 2020

View reviewed changes

This was referenced Mar 11, 2020

document all the annotations #614

Closed

vc: add agent.container_pipe_size annotation kata-containers/runtime#2510

Merged

howto: add sandbox config annotation howto

8f0bb09

It explains the details of current supported annotations. Fixes: kata-containers#486 Fixes: kata-containers#294 Depends-on: github.com/kata-containers/tests#2240 Signed-off-by: Peng Tao <bergwolf@hyper.sh>

bergwolf force-pushed the annotations branch from c855aaa to 8f0bb09 Compare March 16, 2020 10:30

grahamwhaley approved these changes Apr 6, 2020

View reviewed changes

grahamwhaley merged commit c5a5ac9 into kata-containers:master Apr 6, 2020

Conversation

bergwolf commented Dec 10, 2019

Uh oh!

bergwolf commented Dec 10, 2019

Uh oh!

bergwolf commented Dec 10, 2019

Uh oh!

grahamwhaley left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jodh-intel commented Dec 12, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jodh-intel commented Dec 16, 2019

Uh oh!

egernst commented Jan 14, 2020

Uh oh!

jodh-intel commented Jan 20, 2020

Uh oh!

bergwolf commented Jan 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bergwolf commented Jan 20, 2020

Uh oh!

grahamwhaley commented Jan 20, 2020

Uh oh!

bergwolf commented Jan 20, 2020

Uh oh!

bergwolf commented Feb 20, 2020

Uh oh!

GabyCT commented Mar 2, 2020

Uh oh!

grahamwhaley commented Apr 6, 2020

Uh oh!

grahamwhaley left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bergwolf commented Jan 20, 2020 •

edited

Loading