github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

fixing some doc links

Browse Source 
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
This commit is contained in:
Mike Brown 2021-06-21 18:24:47 -05:00
parent ba70277fb7
commit 560e7d4799
11 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -272,7 +272,7 @@ loaded for the user's shell environment.
`cri` is a native plugin of containerd. Since containerd 1.1, the cri plugin is built into the release binaries and enabled by default.
> **Note:** As of containerd 1.5, the `cri` plugin is merged into the containerd/containerd repo. For example, the source code previously stored under [`containerd/cri/pkg`](https://github.com/containerd/cri/tree/release/1.4/pkg)
was moved to [`containerd/containerd/pkg/cri` package](https://github.com/containerd/containerd/tree/master/pkg/cri).
was moved to [`containerd/containerd/pkg/cri` package](https://github.com/containerd/containerd/tree/main/pkg/cri).
The `cri` plugin has reached GA status, representing that it is:
* Feature complete
@ -292,7 +292,7 @@ A Kubernetes incubator project, [cri-tools](https://github.com/kubernetes-sigs/c
* [CRI Plugin Testing Guide](./docs/cri/testing.md)
* [Debugging Pods, Containers, and Images with `crictl`](./docs/cri/crictl.md)
* [Configuring `cri` Plugins](./docs/cri/config.md)
* [Configuring containerd](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.8.md)
* [Configuring containerd](https://github.com/containerd/containerd/blob/main/docs/man/containerd-config.8.md)
### Communication

10
docs/cri/config.md
View File

@ -3,7 +3,7 @@ This document provides the description of the CRI plugin configuration.
The CRI plugin config is part of the containerd config (default
path: `/etc/containerd/config.toml`).
See [here](https://github.com/containerd/containerd/blob/master/docs/ops.md)
See [here](https://github.com/containerd/containerd/blob/main/docs/ops.md)
for more information about containerd config.
The explanation and default value of each configuration item are as follows:
@ -102,7 +102,7 @@ version = 2
# default unset profile will map to `unconfined`)
# Note: The default unset seccomp profile should not be confused with the seccomp profile
# used in CRI when the runtime default seccomp profile is requested. In the later case, the
# default is set by the following code (https://github.com/containerd/containerd/blob/master/contrib/seccomp/seccomp_default.go).
# default is set by the following code (https://github.com/containerd/containerd/blob/main/contrib/seccomp/seccomp_default.go).
# To summarize, there are two different seccomp defaults, the unset default used when the CRI request is
# set to nil or `unconfined`, and the default used when the runtime default seccomp profile is requested.
unset_seccomp_profile = ""
@ -244,7 +244,7 @@ version = 2
[plugins."io.containerd.grpc.v1.cri".image_decryption]
# key_model defines the name of the key model used for how the cri obtains
# keys used for decryption of encrypted container images.
# The [decryption document](https://github.com/containerd/cri/blob/master/docs/decryption.md)
# The [decryption document](https://github.com/containerd/containerd/blob/main/docs/cri/decryption.md)
# contains additional information about the key models available.
#
# Set of available string options: {"", "node"}
@ -252,12 +252,12 @@ version = 2
# disabling image decryption.
#
# In order to use the decryption feature, additional configurations must be made.
# The [decryption document](https://github.com/containerd/cri/blob/master/docs/decryption.md)
# The [decryption document](https://github.com/containerd/containerd/blob/main/docs/cri/decryption.md)
# provides information of how to set up stream processors and the containerd imgcrypt decoder
# with the appropriate key models.
#
# Additional information:
# * Stream processors: https://github.com/containerd/containerd/blob/master/docs/stream_processors.md
# * Stream processors: https://github.com/containerd/containerd/blob/main/docs/stream_processors.md
# * Containerd imgcrypt: https://github.com/containerd/imgcrypt
key_model = "node"

2
docs/cri/decryption.md
View File

@ -40,6 +40,6 @@ version = 2
```
In this example, container image decryption is set to use the "node" key model.
In addition, the decryption [`stream_processors`](https://github.com/containerd/containerd/blob/master/docs/stream_processors.md) are configured as specified in [containerd/imgcrypt project](https://github.com/containerd/imgcrypt), with the additional field `--decryption-keys-path` configured to specify where decryption keys are located locally in the node.
In addition, the decryption [`stream_processors`](https://github.com/containerd/containerd/blob/main/docs/stream_processors.md) are configured as specified in [containerd/imgcrypt project](https://github.com/containerd/imgcrypt), with the additional field `--decryption-keys-path` configured to specify where decryption keys are located locally in the node.
The `$OCICRYPT_KEYPROVIDER_CONFIG` environment variable is used for [ocicrypt keyprovider protocol](https://github.com/containers/ocicrypt/blob/main/docs/keyprovider.md).

6
docs/cri/proposal.md
View File

@ -23,7 +23,7 @@ Containerd is one potential alternative to Docker as the runtime for Kubernetes
### Cons
* **User Adoption**:
* Ideally, Kubernetes users don't interact with the underlying container runtime directly. However, for the lack of debug toolkits, sometimes users still need to login the node to debug with Docker CLI directly.
* Containerd provides barebone CLIs [ctr](https://github.com/containerd/containerd/tree/master/cmd/ctr) and [dist](https://github.com/containerd/containerd/tree/master/cmd/dist) for development and debugging purpose, but they may not be sufficient and necessary. Additionally, presuming these are sufficient and necessary tools, a plan and time would be needed to sufficiently document these CLIs and educate users in their use.
* Containerd provides barebone CLIs [ctr](https://github.com/containerd/containerd/tree/main/cmd/ctr) and [dist](https://github.com/containerd/containerd/tree/main/cmd/dist) for development and debugging purpose, but they may not be sufficient and necessary. Additionally, presuming these are sufficient and necessary tools, a plan and time would be needed to sufficiently document these CLIs and educate users in their use.
* **Maturity**: The rescoped containerd is pretty new, and it's still under heavy development.
## Goals
* Make sure containerd meets the requirement of Kubernetes, now and into the foreseeable future.
@ -64,7 +64,7 @@ CRI-containerd should:
* Call [network plugin](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/network/plugins.go) to update the options of the network namespace;
* Let the user containers in the same sandbox share the network namespace.
### Container Metrics
Containerd provides [container cgroup metrics](https://github.com/containerd/containerd/blob/master/reports/2017-03-17.md#metrics), and plans to provide [container writable layer disk usage](https://github.com/containerd/containerd/issues/678).
Containerd provides [container cgroup metrics](https://github.com/containerd/containerd/blob/main/reports/2017-03-17.md#metrics), and plans to provide [container writable layer disk usage](https://github.com/containerd/containerd/issues/678).
CRI container metrics api needs to be defined ([#27097](https://github.com/kubernetes/kubernetes/issues/27097)). After that, CRI-containerd should translate containerd container metrics into CRI container metrics.
### Image Management
@ -77,7 +77,7 @@ CRI image filesystem metrics needs to be defined ([#33048](https://github.com/ku
### Out of Scope
Following items are out of the scope of this design, we may address them in future version as enhancement or optimization.
* **Debuggability**: One of the biggest concern of CRI-containerd is debuggability. We should provide equivalent debuggability with Docker CLI through `kubectl`, [`cri-tools`](https://github.com/kubernetes-sigs/cri-tools) or containerd CLI.
* **Built-in CRI support**: The [plugin model](https://github.com/containerd/containerd/blob/master/design/plugins.md) provided by containerd makes it possible to directly build CRI support into containerd as a plugin, which will eliminate one more hop from the stack. But because of the [limitation of golang plugin](https://github.com/containerd/containerd/issues/563), we have to either maintain our own branch or push CRI plugin upstream.
* **Built-in CRI support**: The [plugin model](https://github.com/containerd/containerd/blob/main/design/plugins.md) provided by containerd makes it possible to directly build CRI support into containerd as a plugin, which will eliminate one more hop from the stack. But because of the [limitation of golang plugin](https://github.com/containerd/containerd/issues/563), we have to either maintain our own branch or push CRI plugin upstream.
* **Seccomp**: ([#36997](https://github.com/kubernetes/kubernetes/issues/36997)) Seccomp is supported in OCI runtime spec. However, current seccomp implementation in Kubernetes is experimental and docker specific, the api needs to be defined in CRI first before CRI-containerd implements it.
* **Streaming server authentication**: ([#36666](https://github.com/kubernetes/kubernetes/issues/36666)) CRI-containerd will be out-of-process with Kubelet, so it could not reuse Kubelet authentication. Its streaming server should implement its own authentication mechanism.
* **Move container facilities into pod cgroup**: Container facilities including container image puller, container streaming handler, log handler and containerd-shim serve a specific container. They should be moved to the corresponding pod cgroup, and the overhead introduced by them should be charged to the pod.

2
docs/hosts.md
View File

@ -101,7 +101,7 @@ OPTIONS:
Although we have deprecated the old CRI config pattern for specifying registry.mirrors
and registry.configs you can still specify your credentials via
[CRI config](https://github.com/containerd/containerd/blob/master/docs/cri/registry.md#configure-registry-credentials).
[CRI config](https://github.com/containerd/containerd/blob/main/docs/cri/registry.md#configure-registry-credentials).
Additionally, the containerd CRI plugin implements/supports the authentication parameters passed in through CRI pull image service requests.
For example, when containerd is the container runtime implementation for `Kubernetes`, the containerd CRI plugin receives

4
pkg/cri/config/config.go
View File

@ -182,10 +182,10 @@ type ImageDecryption struct {
// KeyModel specifies the trust model of where keys should reside.
//
// Details of field usage can be found in:
// https://github.com/containerd/cri/tree/master/docs/config.md
// https://github.com/containerd/containerd/tree/main/docs/cri/config.md
//
// Details of key models can be found in:
// https://github.com/containerd/cri/tree/master/docs/decryption.md
// https://github.com/containerd/containerd/tree/main/docs/cri/decryption.md
KeyModel string `toml:"key_model" json:"keyModel"`
}

2
releases/README.md
View File

@ -9,7 +9,7 @@
When moving from rc to final, the rc file may just be renamed and updated.
See [release-tool](https://github.com/containerd/release-tool)
2. Update the version file at `https://github.com/containerd/containerd/blob/master/version/version.go`
2. Update the version file at `https://github.com/containerd/containerd/blob/main/version/version.go`
3. Update RELEASES.md to refer to the new release and dates.

8
releases/v1.0.0.toml
View File

@ -10,7 +10,7 @@ previous = "v1.0.0-rc.0"
pre_release = false
preface = """\
`containerd` provides a daemon for managing running containers.
`containerd` provides a daemon for managing running containers.
The new containerd is designed for use designed for use in container-based
systems, like Docker and Kubernetes. It provides minimal abstractions over the
@ -24,8 +24,8 @@ A short list of differences from the 0.2 version of containerd follow:
- Snapshot-based container storage system
- Content-addressed image storage system
- Arbitrary metadata storage for association with containerd objects
- Extensive, namespaced [GRPC API](https://github.com/containerd/containerd/tree/master/api/services)
- Rich API Client ([getting started](https://github.com/containerd/containerd/blob/master/docs/getting-started.md) and [godoc](https://godoc.org/github.com/containerd/containerd)).
- Extensive, namespaced [GRPC API](https://github.com/containerd/containerd/tree/main/api/services)
- Rich API Client ([getting started](https://github.com/containerd/containerd/blob/main/docs/getting-started.md) and [godoc](https://godoc.org/github.com/containerd/containerd)).
You can read about the full details of the project in the [README](https://github.com/containerd/containerd/blob/v1.0.0/README.md).
@ -41,7 +41,7 @@ candidate full of stability fixes, hardening, and API improvements. If you run
into a new problems, please file an
[issue](https://github.com/containerd/containerd/issues).
The [_support horizon_](https://github.com/containerd/containerd/blob/master/RELEASES.md#support-horizon)
The [_support horizon_](https://github.com/containerd/containerd/blob/main/RELEASES.md#support-horizon)
for containerd has been updated to include the 1.0 release. With this release,
the 0.2 release line is now moved to the "End of Life" state. No new releases
on that branch will be made. The 1.0 release train will be considered an active

2
releases/v1.1.0.toml
View File

@ -130,7 +130,7 @@ To set up containerd with Kubernetes...
## Support
The [_support horizon_](https://github.com/containerd/containerd/blob/master/RELEASES.md#support-horizon)
The [_support horizon_](https://github.com/containerd/containerd/blob/main/RELEASES.md#support-horizon)
for containerd has been updated to include the 1.1 release. With the addition of
the CRI plugin, we are expanding the support horizon for 1.1 to include the
entire lifespan of Kubernetes 1.10. The containerd 1.1 release train will be

6
releases/v1.2.0.toml
View File

@ -27,7 +27,7 @@ API.
Various runtimes can be selected on a per container basis using the `WithRuntime` opt
or to test via ctr `ctr run --runtime io.containerd.runc.v1`.
[Documentation](https://github.com/containerd/containerd/blob/master/runtime/v2/README.md)
[Documentation](https://github.com/containerd/containerd/blob/main/runtime/v2/README.md)
## Updated CRI Plugin
@ -64,7 +64,7 @@ Users can:
A new proxy plugin configuration has been added to allow external snapshotters
be connected to containerd using gRPC.
[Documentation](https://github.com/containerd/containerd/blob/master/PLUGINS.md)
[Documentation](https://github.com/containerd/containerd/blob/main/PLUGINS.md)
## Managed /opt directory
@ -80,7 +80,7 @@ containerd system. It can also be used to install `runc` and other related tools
> ctr install docker.io/crosbymichael/runc:latest
```
[Documentation](https://github.com/containerd/containerd/blob/master/docs/managed-opt.md)
[Documentation](https://github.com/containerd/containerd/blob/main/docs/managed-opt.md)
## Garbage Collection

2
reports/2017-01-13.md
View File

@ -41,6 +41,6 @@ We finished porting over the shim from the existing containerd implementation th
Next week we will be working towards a full PoC with the runtime, storage, and fetching of images. Getting the core functionality up and running quickly is important to us to ensure that integration between the different subsystems in the core flow well together. We want to make sure the responsibilities of pulling an image from a remote source do not spill into the storage layer and vice-versa.
We still have more documentation work to do on the design and lifecycle of components in the core which is another focus for next week. You can find the current design docs in the [repo here](https://github.com/containerd/containerd/tree/master/design).
We still have more documentation work to do on the design and lifecycle of components in the core which is another focus for next week. You can find the current design docs in the [repo here](https://github.com/containerd/containerd/tree/main/design).
I hope this status report helps. If you are looking for ways to contribute, check out the issues on the current milestone.