Commit Graph

95 Commits

Author SHA1 Message Date
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
Sebastiaan van Stijn
356782cb47
Makefile: man page: rename containerd.1 to containerd.8
The generated file was incorrectly named containerd.1 and should
be in section 8 (see [MAN-PAGES(7)]: Sections of the manual pages)

This patch fixes the filename and updates references to containerd(1)
to refer to containerd(8).

The generated file itself already had the correct section set in its
header, so didn't need updating.

[MAN-PAGES(7)]: http://man7.org/linux/man-pages/man7/man-pages.7.html

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-02 13:52:06 +02:00
Mihai Coman
5e6d56ee2d Fix startup_delay within default configuration
Without this patch, the containerd daemon fails to start using the
default configuration example:
containerd[37139]: containerd: time: missing unit in duration 100000000

Signed-off-by: Mihai Coman <mihai.cmn@gmail.com>
2020-01-29 15:34:23 +02:00
Akihiro Suda
b553bc14a2 update docs/rootless.md
* Updated an example config to v2 syntax
* Updated for shim v2 (relates to #2767)

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-01-08 13:37:29 +09:00
Akihiro Suda
b127b666aa ctr: support $CONTAINERD_ADDRESS env var
`$CONTAINERD_ADDRESS` can be specified instead of the `ctr --address` flag.

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2020-01-07 15:59:12 +09:00
Ameya Gawde
d21f0f116e
windows process shim installer
Signed-off-by: Ameya Gawde <ameya.gawde@docker.com>
2019-10-30 16:22:02 -07:00
Lantao Liu
aaccfcbe2b Fix containerd config dump.
Signed-off-by: Lantao Liu <lantaol@google.com>
2019-10-23 22:38:18 -07:00
Michael Crosby
f3a5b8c0a9 Add command to generate man pages
The climan package has a command that can be registered with any urfav
cli app to generate man pages.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2019-09-11 15:31:02 -04:00
Michael Crosby
f76eefd272
Merge pull request #3574 from mxpv/cfg
Support config imports
2019-09-04 16:34:11 -04:00
chentanjun
92a5b08a68 fix-grammar-mistake
Signed-off-by: chentanjun <2799194073@qq.com>
2019-08-28 16:10:08 +08:00
Maksym Pavlenko
8ebffecbc3 Use map for stream processors
Signed-off-by: Maksym Pavlenko <makpav@amazon.com>
2019-08-23 15:31:37 -07:00
Maksym Pavlenko
ea6c749e35 Update config doc
Signed-off-by: Maksym Pavlenko <makpav@amazon.com>
2019-08-23 11:08:25 -07:00
Phil Estes
b77e25dade
Merge pull request #3516 from crosbymichael/remote-enc
Remove encryption code from containerd core
2019-08-13 10:52:48 -04:00
Michael Crosby
0dadef19cf Add docs for stream processors
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2019-08-09 18:40:43 +00:00
Michael Crosby
d085d9b464 Remove encryption code from containerd core
We are separating out the encryption code and have designed a few new
interfaces and APIs for processing content streams.  This keep the core
clean of encryption code but enables not only encryption but support of
multiple content types ( custom media types ).

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2019-08-09 15:01:16 +00:00
Derek McGowan
adad947b77
Merge pull request #3460 from lumjjb/ctrrecipients
Specify protocols in ctr encrypt recipients
2019-08-01 15:37:40 -07:00
Akihiro Suda
4195136eea
Merge pull request #3433 from dmcgowan/gc-docs
Add garbage collection doc
2019-07-30 14:03:01 +09:00
Brandon Lum
8cd480c233 Specify protocols in ctr encrypt recipients
Signed-off-by: Brandon Lum <lumjjb@gmail.com>
2019-07-26 13:20:22 -04:00
Derek McGowan
22f44c44d9
Add garbage collection doc
Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2019-07-25 14:42:30 -07:00
Brandon Lum
c6d437fd70 Corrected lease implementation
Signed-off-by: Brandon Lum <lumjjb@gmail.com>
2019-07-18 18:17:20 -04:00
Stefan Berger
bf8804c743 Implemented image encryption/decryption libraries and ctr commands
Signed-off-by: Stefan Berger <stefanb@linux.ibm.com>
Signed-off-by: Brandon Lum <lumjjb@gmail.com>
2019-07-17 15:19:58 -04:00
Michael Crosby
bb9616ba20
Merge pull request #3379 from Ace-Tang/clean-doc
docs: remove shim_no_newns in ops.md
2019-06-26 11:30:21 -04:00
Ace-Tang
2d03791158 docs: remove shim_no_newns in ops.md
this ops is removed in commit fd2e3cd326,
remove from doc avoid misleading users.

Signed-off-by: Ace-Tang <aceapril@126.com>
2019-06-26 16:37:36 +08:00
Phil Estes
0886e4f1b7
No need to keep 2017 DockerCon doc
Remove outdated discussion document from repo.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2019-06-26 00:00:59 -04:00
BoWen Yan
d15a06b190 docs: Fix typo to some markdown files in /docs.
Signed-off-by: BoWen Yan <loneybw@gmail.com>
2019-06-13 15:29:12 +08:00
Derek McGowan
2f60e389a0
Merge pull request #2626 from krsoninikhil/defaults3
Uses namespace labels for default options
2019-04-02 11:46:35 -07:00
Shengjing Zhu
fb80483711 docs: Add NAME section in all manpages
As described in https://lintian.debian.org/tags/manpage-has-bad-whatis-entry.html
each manual page should start with a "NAME" section.

Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2019-02-22 23:40:28 +08:00
Nikhil Soni
da2ab865e0 Add documentation for using namespace labels for configuring defaults.
Signed-off-by: Nikhil Soni <krsoninikhil@gmail.com>
2019-02-01 23:14:33 +05:30
Derek McGowan
8706a355dd
Merge pull request #2889 from linxiulei/isolated_content
metadata: define content sharing policy
2019-01-14 13:15:38 -08:00
Phil Estes
a79879e9dd
Add security audit report to README
Also remove weekly development reports section from README as those are
not being produced regularly at this time.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2019-01-04 09:56:03 -05:00
Eric Lin
4247f2684d metadata: define content sharing policy
This changeset modifies the metadata store to allow one to set a
"content sharing policy" that defines how blobs are shared between
namespaces in the content store.

The default mode "shared" will make blobs available in all namespaces
once it is pulled into any namespace.  The blob will be pulled into
the namespace if a writer is opened with the "Expected" digest that
is already present in the backend.

The alternative mode, "isolated" requires that clients prove they have
access to the content by providing all of the content to the ingest
before the blob is added to the namespace.

Both modes share backing data, while "shared" will reduce total
bandwidth across namespaces, at the cost of allowing access to any
blob just by knowing its digest.

Note: Most functional codes and changelog of this commit originate from
Stephen J Day <stephen.day@docker.com>, see
40455aade8

Fixes #1713 Fixes #2865

Signed-off-by: Eric Lin <linxiulei@gmail.com>
2018-12-21 15:02:21 +08:00
Sebastiaan van Stijn
723797d320
docs: remove website leftovers
The website content moved to the github.com/containerd/containerd.io
repository.

Commit da1fba0050 removed all website-
related content, but there were some stray files left behind.

This patch removes those files, and updates the `.editorconfig` file
to only match Markdown files.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-12-20 10:01:51 +01:00
Sebastiaan van Stijn
555ea3fb43
Ignore modprobe failures in ExecStartPre (systemd unit)
When running containerd inside LXC, due to systemd being unable to execute
`modprobe overlay` inside the container (module is already loaded in host kernel).

This patch adds a `-` prefix to the `ExecStartPre` command, so that failures
are ignored, and the service can start as usual.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-11-10 12:52:06 +01:00
Akihiro Suda
ce6d4c9a9f add docs/rootless.md
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2018-11-06 17:39:30 +09:00
Phil Estes
da1fba0050
Website no longer managed from this repo
Website content is deployed from containerd/containerd.io now

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2018-08-23 14:55:04 -04:00
Aleksa Sarai
7aa132ffc7
docs: man: rename config.toml(5) to be more descriptive
The man page namespace is global, so in order to avoid colliding with
other man pages named "config.toml" rename ours to be more descriptive.
This also helps with discoverability (now tab-completion of 'man
containerd<tab>' will return the config man page), as well as making it
much cleaner from the perspective of distributions that want to package
containerd.

Signed-off-by: Aleksa Sarai <asarai@suse.de>
2018-08-08 18:33:29 +10:00
Michael Crosby
2742238909 Add docs for managed opts dir
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2018-08-03 11:50:02 -04:00
Alban Crequy
6ef65b74e1 Document how to use systemd-run
It is also useful when testing local changes, I just run:

sudo systemd-run -p Delegate=yes -p KillMode=process bin/containerd

Signed-off-by: Alban Crequy <alban@kinvolk.io>
2018-06-27 16:58:30 +02:00
Luc Perkins
e5e63539a6 Return Markdown files to /docs directory
Signed-off-by: Luc Perkins <lucperkins@gmail.com>
2018-05-16 11:23:50 -07:00
Luc Perkins
d1503dc9ce Migrate website to Hugo
Signed-off-by: Luc Perkins <lucperkins@gmail.com>
2018-05-15 12:30:26 -07:00
Kunal Kushwaha
b12c3215a0 Licence header added
Signed-off-by: Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp>
2018-02-19 10:32:26 +09:00
Michael Crosby
aa82d17d1d
Merge pull request #2079 from estesp/man-pages
Add initial man pages
2018-02-15 11:07:35 -05:00
Phil Estes
8f183b5ee9
Add basic manpages for ctr, containerd, containerd-config
Adds initial manpages for ctr, containerd, and containerd config
commands, as well as the config.toml configuration file.

Adds targets to Makefile for generating and installing manpages.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2018-02-14 15:17:31 -05:00
Phil Estes
a929f9c746
Add further updates for website refresh
Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2018-02-12 13:45:45 -05:00
Micheal Waltz
43b655b557
Link Docker release notes for containerd version
Clarify which version of Docker use containerd versions and link to
release notes.

Signed-off-by: Micheal Waltz <ecliptik@gmail.com>
2018-02-12 13:38:07 -05:00
Micheal Waltz
38ef0b6d3c
Updates to containerd.io index page
- Fixes broken Dockercon link
- Attemps to clarify 1.0.0 release and support status

Signed-off-by: Micheal Waltz <ecliptik@gmail.com>
2018-02-12 13:37:56 -05:00
Tom Godkin
19e9e1642a Fix typo in docs
Signed-off-by: Tom Godkin <tgodkin@pivotal.io>
2018-02-12 17:11:05 +00:00
Chris Aniszczyk
b12e5794b1 Force ruby version for docs build
Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
2018-01-04 10:49:50 -06:00
Chris Aniszczyk
fea2c381b1 Add build config for jekyll + netlify
https://www.netlify.com/blog/2017/05/11/migrating-your-jekyll-site-to-netlify/

Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
2018-01-03 16:22:22 -06:00