Skip to content

Commit 560e7d4

Browse files
committed
fixing some doc links
Signed-off-by: Mike Brown <[email protected]>
1 parent ba70277 commit 560e7d4

11 files changed

Lines changed: 24 additions & 24 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ loaded for the user's shell environment.
272272
`cri` is a native plugin of containerd. Since containerd 1.1, the cri plugin is built into the release binaries and enabled by default.
273273

274274
> **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)
275-
was moved to [`containerd/containerd/pkg/cri` package](https://github.com/containerd/containerd/tree/master/pkg/cri).
275+
was moved to [`containerd/containerd/pkg/cri` package](https://github.com/containerd/containerd/tree/main/pkg/cri).
276276

277277
The `cri` plugin has reached GA status, representing that it is:
278278
* Feature complete
@@ -292,7 +292,7 @@ A Kubernetes incubator project, [cri-tools](https://github.com/kubernetes-sigs/c
292292
* [CRI Plugin Testing Guide](./docs/cri/testing.md)
293293
* [Debugging Pods, Containers, and Images with `crictl`](./docs/cri/crictl.md)
294294
* [Configuring `cri` Plugins](./docs/cri/config.md)
295-
* [Configuring containerd](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.8.md)
295+
* [Configuring containerd](https://github.com/containerd/containerd/blob/main/docs/man/containerd-config.8.md)
296296

297297
### Communication
298298

docs/cri/config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This document provides the description of the CRI plugin configuration.
33
The CRI plugin config is part of the containerd config (default
44
path: `/etc/containerd/config.toml`).
55

6-
See [here](https://github.com/containerd/containerd/blob/master/docs/ops.md)
6+
See [here](https://github.com/containerd/containerd/blob/main/docs/ops.md)
77
for more information about containerd config.
88

99
The explanation and default value of each configuration item are as follows:
@@ -102,7 +102,7 @@ version = 2
102102
# default unset profile will map to `unconfined`)
103103
# Note: The default unset seccomp profile should not be confused with the seccomp profile
104104
# used in CRI when the runtime default seccomp profile is requested. In the later case, the
105-
# default is set by the following code (https://github.com/containerd/containerd/blob/master/contrib/seccomp/seccomp_default.go).
105+
# default is set by the following code (https://github.com/containerd/containerd/blob/main/contrib/seccomp/seccomp_default.go).
106106
# To summarize, there are two different seccomp defaults, the unset default used when the CRI request is
107107
# set to nil or `unconfined`, and the default used when the runtime default seccomp profile is requested.
108108
unset_seccomp_profile = ""
@@ -244,20 +244,20 @@ version = 2
244244
[plugins."io.containerd.grpc.v1.cri".image_decryption]
245245
# key_model defines the name of the key model used for how the cri obtains
246246
# keys used for decryption of encrypted container images.
247-
# The [decryption document](https://github.com/containerd/cri/blob/master/docs/decryption.md)
247+
# The [decryption document](https://github.com/containerd/containerd/blob/main/docs/cri/decryption.md)
248248
# contains additional information about the key models available.
249249
#
250250
# Set of available string options: {"", "node"}
251251
# Omission of this field defaults to the empty string "", which indicates no key model,
252252
# disabling image decryption.
253253
#
254254
# In order to use the decryption feature, additional configurations must be made.
255-
# The [decryption document](https://github.com/containerd/cri/blob/master/docs/decryption.md)
255+
# The [decryption document](https://github.com/containerd/containerd/blob/main/docs/cri/decryption.md)
256256
# provides information of how to set up stream processors and the containerd imgcrypt decoder
257257
# with the appropriate key models.
258258
#
259259
# Additional information:
260-
# * Stream processors: https://github.com/containerd/containerd/blob/master/docs/stream_processors.md
260+
# * Stream processors: https://github.com/containerd/containerd/blob/main/docs/stream_processors.md
261261
# * Containerd imgcrypt: https://github.com/containerd/imgcrypt
262262
key_model = "node"
263263

docs/cri/decryption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ version = 2
4040
```
4141

4242
In this example, container image decryption is set to use the "node" key model.
43-
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.
43+
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.
4444

4545
The `$OCICRYPT_KEYPROVIDER_CONFIG` environment variable is used for [ocicrypt keyprovider protocol](https://github.com/containers/ocicrypt/blob/main/docs/keyprovider.md).

docs/cri/proposal.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Containerd is one potential alternative to Docker as the runtime for Kubernetes
2323
### Cons
2424
* **User Adoption**:
2525
* 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.
26-
* 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.
26+
* 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.
2727
* **Maturity**: The rescoped containerd is pretty new, and it's still under heavy development.
2828
## Goals
2929
* Make sure containerd meets the requirement of Kubernetes, now and into the foreseeable future.
@@ -64,7 +64,7 @@ CRI-containerd should:
6464
* Call [network plugin](https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/network/plugins.go) to update the options of the network namespace;
6565
* Let the user containers in the same sandbox share the network namespace.
6666
### Container Metrics
67-
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).
67+
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).
6868

6969
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.
7070
### Image Management
@@ -77,7 +77,7 @@ CRI image filesystem metrics needs to be defined ([#33048](https://github.com/ku
7777
### Out of Scope
7878
Following items are out of the scope of this design, we may address them in future version as enhancement or optimization.
7979
* **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.
80-
* **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.
80+
* **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.
8181
* **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.
8282
* **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.
8383
* **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.

docs/hosts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ OPTIONS:
101101

102102
Although we have deprecated the old CRI config pattern for specifying registry.mirrors
103103
and registry.configs you can still specify your credentials via
104-
[CRI config](https://github.com/containerd/containerd/blob/master/docs/cri/registry.md#configure-registry-credentials).
104+
[CRI config](https://github.com/containerd/containerd/blob/main/docs/cri/registry.md#configure-registry-credentials).
105105

106106
Additionally, the containerd CRI plugin implements/supports the authentication parameters passed in through CRI pull image service requests.
107107
For example, when containerd is the container runtime implementation for `Kubernetes`, the containerd CRI plugin receives

pkg/cri/config/config.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,10 @@ type ImageDecryption struct {
182182
// KeyModel specifies the trust model of where keys should reside.
183183
//
184184
// Details of field usage can be found in:
185-
// https://github.com/containerd/cri/tree/master/docs/config.md
185+
// https://github.com/containerd/containerd/tree/main/docs/cri/config.md
186186
//
187187
// Details of key models can be found in:
188-
// https://github.com/containerd/cri/tree/master/docs/decryption.md
188+
// https://github.com/containerd/containerd/tree/main/docs/cri/decryption.md
189189
KeyModel string `toml:"key_model" json:"keyModel"`
190190
}
191191

releases/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
When moving from rc to final, the rc file may just be renamed and updated.
1010
See [release-tool](https://github.com/containerd/release-tool)
1111

12-
2. Update the version file at `https://github.com/containerd/containerd/blob/master/version/version.go`
12+
2. Update the version file at `https://github.com/containerd/containerd/blob/main/version/version.go`
1313

1414
3. Update RELEASES.md to refer to the new release and dates.
1515

releases/v1.0.0.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ previous = "v1.0.0-rc.0"
1010
pre_release = false
1111

1212
preface = """\
13-
`containerd` provides a daemon for managing running containers.
13+
`containerd` provides a daemon for managing running containers.
1414
1515
The new containerd is designed for use designed for use in container-based
1616
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:
2424
- Snapshot-based container storage system
2525
- Content-addressed image storage system
2626
- Arbitrary metadata storage for association with containerd objects
27-
- Extensive, namespaced [GRPC API](https://github.com/containerd/containerd/tree/master/api/services)
28-
- 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)).
27+
- Extensive, namespaced [GRPC API](https://github.com/containerd/containerd/tree/main/api/services)
28+
- 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)).
2929
3030
You can read about the full details of the project in the [README](https://github.com/containerd/containerd/blob/v1.0.0/README.md).
3131
@@ -41,7 +41,7 @@ candidate full of stability fixes, hardening, and API improvements. If you run
4141
into a new problems, please file an
4242
[issue](https://github.com/containerd/containerd/issues).
4343
44-
The [_support horizon_](https://github.com/containerd/containerd/blob/master/RELEASES.md#support-horizon)
44+
The [_support horizon_](https://github.com/containerd/containerd/blob/main/RELEASES.md#support-horizon)
4545
for containerd has been updated to include the 1.0 release. With this release,
4646
the 0.2 release line is now moved to the "End of Life" state. No new releases
4747
on that branch will be made. The 1.0 release train will be considered an active

releases/v1.1.0.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ To set up containerd with Kubernetes...
130130
131131
## Support
132132
133-
The [_support horizon_](https://github.com/containerd/containerd/blob/master/RELEASES.md#support-horizon)
133+
The [_support horizon_](https://github.com/containerd/containerd/blob/main/RELEASES.md#support-horizon)
134134
for containerd has been updated to include the 1.1 release. With the addition of
135135
the CRI plugin, we are expanding the support horizon for 1.1 to include the
136136
entire lifespan of Kubernetes 1.10. The containerd 1.1 release train will be

releases/v1.2.0.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ API.
2727
Various runtimes can be selected on a per container basis using the `WithRuntime` opt
2828
or to test via ctr `ctr run --runtime io.containerd.runc.v1`.
2929
30-
[Documentation](https://github.com/containerd/containerd/blob/master/runtime/v2/README.md)
30+
[Documentation](https://github.com/containerd/containerd/blob/main/runtime/v2/README.md)
3131
3232
## Updated CRI Plugin
3333
@@ -64,7 +64,7 @@ Users can:
6464
A new proxy plugin configuration has been added to allow external snapshotters
6565
be connected to containerd using gRPC.
6666
67-
[Documentation](https://github.com/containerd/containerd/blob/master/PLUGINS.md)
67+
[Documentation](https://github.com/containerd/containerd/blob/main/PLUGINS.md)
6868
6969
## Managed /opt directory
7070
@@ -80,7 +80,7 @@ containerd system. It can also be used to install `runc` and other related tools
8080
> ctr install docker.io/crosbymichael/runc:latest
8181
```
8282
83-
[Documentation](https://github.com/containerd/containerd/blob/master/docs/managed-opt.md)
83+
[Documentation](https://github.com/containerd/containerd/blob/main/docs/managed-opt.md)
8484
8585
## Garbage Collection
8686

0 commit comments

Comments
 (0)