Commit Graph

242 Commits

Author SHA1 Message Date
Mike Brown
4379557924
Merge pull request #5086 from eramos2/revise-docs
Fixed wording in docs, and broken link
2021-02-25 15:32:25 -06:00
alexyadon
c61f0ceada
Fix broken docs links (#5085)
* docs: fix broken links

Signed-off-by: Alex Yadon <alex.yadon@ibm.com>

* docs: use relative paths

Signed-off-by: Alex Yadon <alex.yadon@ibm.com>
2021-02-25 14:09:49 -06:00
Emmanuel Ramos
224efa9dae Fixed wording in docs, and broken link
Signed-off-by: Emmanuel Ramos <emmanuel.ramos2@ibm.com>
2021-02-25 13:18:13 -05:00
Lorenz Brun
36d0bc1f2b Allow moving netns directory into StateDir
Signed-off-by: Lorenz Brun <lorenz@nexantic.com>
2021-02-10 18:33:14 +01:00
Wei Fu
3299c5560d
Merge pull request #4967 from dmcgowan/cleanup-root
Move documentation and helper directories out of root
2021-01-24 15:08:19 +08:00
Aditi Sharma
d09bf18862 Clean Up Doc and fix some broken links
Signed-off-by: Aditi Sharma <adi.sky17@gmail.com>
2021-01-20 15:45:43 +05:30
Derek McGowan
7dffdfa560
Move documentation and helper directories out of root
Signed-off-by: Derek McGowan <derek@mcg.dev>
2021-01-12 12:19:50 -08:00
Shengjing Zhu
91dc69ee43 docs: point cri release tarball to github release page
Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2021-01-03 17:50:40 +08:00
Shengjing Zhu
5988bfc1ef docs: Various typo found by codespell
Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2020-12-22 13:22:16 +08:00
Akihiro Suda
7e6e4c466f
remove "selinux" build tag
The build tag was removed in go-selinux v1.8.0: opencontainers/selinux#132

Related: remove "apparmor" build tag: 0a9147f3aa

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-12-15 20:05:25 +09:00
Kazuyoshi Kato
03cc4cedc5 docs: fix broken links
This change fixes broken links in docs/.

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2020-11-11 10:19:17 -08:00
Kazuyoshi Kato
a05fa4214d Move CRI plugin's docs from docs/ to docs/cri/
There are a lot of documents which are specifically talking about
the CRI plugin. These docs should be in docs/cri/.

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2020-11-10 11:49:05 -08:00
Mike Brown
1ab8bdc27b refresh cri testing guide after move
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2020-10-30 18:22:37 -05:00
Mike Brown
b6053fb7c3 change default for disablesnapshotannotations
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2020-10-29 15:30:13 -05:00
shouhei
f1a3235e84 Fix typo in examples of registry config
Signed-off-by: shouhei <shouhei.yamaguchi.be@gmail.com>
2020-10-11 01:52:16 +09:00
Derek McGowan
e7a350176a
Merge containerd/cri into containerd/containerd
Signed-off-by: Derek McGowan <derek@mcg.dev>
2020-10-07 10:58:39 -07:00
Martin Hickey
fe5fdccdaf Update after review
Review comments:
- https://github.com/containerd/cri/pull/1591#pullrequestreview-499636859

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
2020-09-30 19:00:08 +00:00
Martin Hickey
70a56ae327 Updates to the image registry doc
Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
2020-09-30 14:51:59 +00:00
Mike Brown
2c2dd59f32
Merge branch 'master' into update-config-syntax 2020-09-24 15:58:39 -05:00
Akihiro Suda
0762fdd9e2
Revert "Fix doc for runtime specific options"
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-09-22 17:23:19 +09:00
Akihiro Suda
e3e2c39462
update docs/rootless.md
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-08-08 04:08:35 +09:00
Wei Fu
df8352f1ff
Merge pull request #4335 from ktock/sn-doc
Add doc about snapshotter based on shared remote storage
2020-07-30 23:19:59 +08:00
Mike Brown
fe9bb8da65
Merge branch 'master' into ssdoc 2020-07-29 11:44:10 -05:00
Mike Brown
63400c7694
Merge pull request #1543 from ktock/discard-content
Allow GC to discard content after successful pull and unpack
2020-07-29 11:39:28 -05:00
Takumasa Sakao
4c8164bccf Specify version = 2 & fix wrong key in registry.md (GCR example)
Signed-off-by: Takumasa Sakao <sakataku7@gmail.com>
2020-07-28 17:54:12 +09:00
ktock
375dd76255 Add description about disable_snapshot_annotations to configuration doc
Signed-off-by: Kohei Tokunaga <ktokunaga.mail@gmail.com>
2020-07-28 09:30:20 +09:00
ktock
c80660b82b Allow GC to discard content after successful pull and unpack
This commit adds a config flag for allowing GC to clean layer contents up after
unpacking these contents completed, which leads to deduplication of layer
contents between the snapshotter and the contnet store.

Signed-off-by: Kohei Tokunaga <ktokunaga.mail@gmail.com>
2020-07-28 09:05:47 +09:00
ktock
c2081369c5 Add doc about remote snapshotter
Signed-off-by: Kohei Tokunaga <ktokunaga.mail@gmail.com>
2020-07-23 13:05:05 +09:00
Michael Crosby
5f5d954b6a add selinux category range to config
This allows an admin to set the upper bounds on the category range for selinux
labels.  This can be useful when handling allocation of PVs or other volume
types that need to be shared with selinux enabled on the hosts and volumes.

Signed-off-by: Michael Crosby <michael@thepasture.io>
2020-07-20 16:02:07 -04:00
Brandon Lum
f93b72530f Update doc cri plugin convention
Signed-off-by: Brandon Lum <lumjjb@gmail.com>
2020-07-22 17:34:17 +00:00
HsuanChi (Austin) Kuo
904ab30f9d Fix doc for runtime specifc options
Signed-off-by: Hsuan-Chi Kuo <hckuo2@illinois.edu>
2020-07-10 11:04:49 -05:00
Akihiro Suda
fe6833a9a4
config: TolerateMissingHugePagesCgroupController -> TolerateMissingHugetlbController
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-07-02 13:49:42 +09:00
Avi Deitcher
e7f069e2c3 describe content flow and dependencies
Signed-off-by: Avi Deitcher <avi@deitcher.net>
2020-06-24 21:20:42 +03:00
Mike Brown
b661ad711e
Merge pull request #1504 from lorenz/ignore-image-defined-volumes
Add option for ignoring volumes defined in images
2020-06-14 11:52:48 -05:00
Wei Fu
ae8200bf93
Merge pull request #1499 from webwurst/patch-1
Fix typo
2020-06-10 13:46:29 +08:00
Lorenz Brun
5a1d49b063 Add option for ignoring volumes defined in images
Signed-off-by: Lorenz Brun <lorenz@brun.one>
2020-06-09 21:02:47 +02:00
Brian Goff
c694c63176 Add config for registry http headers
This adds a configuration knob for adding request headers to all
registry requests. It is not namespaced to a registry.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2020-06-08 18:56:15 -07:00
Tobias Bradtke
098e040014 Fix typo
Signed-off-by: Tobias Bradtke <webwurst@gmail.com>
2020-06-05 18:19:49 +02:00
Michael Crosby
8898550e34
Merge pull request #1498 from mxpv/base
Specify base OCI runtime spec
2020-05-29 16:34:29 -04:00
Maksym Pavlenko
df8d6c5b7b Update documentation for base OCI spec files
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2020-05-28 14:45:11 -07:00
Maksym Pavlenko
8d54f39753 Allow specify base OCI runtime spec
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2020-05-28 13:39:31 -07:00
Mike Brown
a7ad3bc01f add a registry auth tutorial
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2020-05-22 15:39:30 -05:00
Mike Brown
3f0aa45453 removing boilerplate test replace by projectboiler check
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2020-05-14 17:52:12 -05:00
Maksym Pavlenko
674fe72aa8 Update docs for unset seccomp profile
Signed-off-by: Maksym Pavlenko <pavlenko.maksym@gmail.com>
2020-05-10 10:46:58 -07:00
Dave Syer
5ac8515bf0 Clarify that plugin names are long in version = 2
Otherwise it's confusing for readers who just need quick reference
for plugin configurations.

Signed-off-by: Dave Syer <dsyer@pivotal.io>
2020-04-27 14:35:41 +01:00
Martin Hickey
02307da36d Add improvement to docs
Some small improvements to docs of things I found while
using the docs.

Signed-off-by: Martin Hickey <martin.hickey@ie.ibm.com>
2020-04-23 09:47:54 +00:00
Wei Fu
a45f57bcf1
Merge pull request #1375 from jdewinne/registry-doc
Update registry.md for auth config
2020-04-21 16:25:08 +08:00
Joris De Winne
050e8c63c0
Update registry.md for auth config
Signed-off-by: Joris De Winne <joris.dewinne@gmail.com>
2020-04-20 21:19:35 -07:00
Brian Goff
8574083153 This config no longer exists, so remove from docs.
This was changed to `no_subreaper` in
6e9f24b711 and, as far as I can tell,
`no_subreaper` doesn't exist as a config anymore.

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2020-04-17 14:14:35 -07:00
Sebastiaan van Stijn
ad090e67e9
man: move ctr.1, containerd-config to section 8, and fix generation
I missed this in my previous change: the ctr man page is also
in Section 8, because it's considered an administrative tool,
and containerd-config is related to containerd so updating these
as well.

This commit also fixes naming of the generated files, which was
hard-coded to .1.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-03 12:32:52 +02:00