Skip to content

Commit e92e692

Browse files
mxpvmxpv
authored
Merge pull request #8241 from AkihiroSuda/deprecation-20230309
RELEASES.md: describe the deprecated config properties
2 parents 0fe3b49 + 625217d commit e92e692

2 files changed

Lines changed: 60 additions & 11 deletions

File tree

‎RELEASES.md‎

Lines changed: 58 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -372,15 +372,64 @@ against total impact.
372372

373373
The deprecated features are shown in the following table:
374374

375-
| Component | Deprecation release | Target release for removal | Recommendation |
376-
|----------------------------------------------------------------------------------|---------------------|----------------------------|-----------------------------------|
377-
| Runtime V1 API and implementation (`io.containerd.runtime.v1.linux`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
378-
| Runc V1 implementation of Runtime V2 (`io.containerd.runc.v1`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
379-
| config.toml `version = 1` | containerd v1.5 | containerd v2.0 | Use config.toml `version = 2` |
380-
| Built-in `aufs` snapshotter | containerd v1.5 | containerd v2.0 | Use `overlayfs` snapshotter |
381-
| `cri-containerd-*.tar.gz` release bundles | containerd v1.6 | containerd v2.0 | Use `containerd-*.tar.gz` bundles |
382-
| Pulling Schema 1 images (`application/vnd.docker.distribution.manifest.v1+json`) | containerd v1.7 | containerd v2.0 | Use Schema 2 or OCI images |
383-
| CRI `v1alpha2` | containerd v1.7 | containerd v2.0 | Use CRI `v1` |
375+
| Component | Deprecation release | Target release for removal | Recommendation |
376+
|----------------------------------------------------------------------------------|---------------------|----------------------------|------------------------------------------|
377+
| Runtime V1 API and implementation (`io.containerd.runtime.v1.linux`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
378+
| Runc V1 implementation of Runtime V2 (`io.containerd.runc.v1`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
379+
| config.toml `version = 1` | containerd v1.5 | containerd v2.0 | Use config.toml `version = 2` |
380+
| Built-in `aufs` snapshotter | containerd v1.5 | containerd v2.0 | Use `overlayfs` snapshotter |
381+
| Container label `containerd.io/restart.logpath` | containerd v1.5 | containerd v2.0 | Use `containerd.io/restart.loguri` label |
382+
| `cri-containerd-*.tar.gz` release bundles | containerd v1.6 | containerd v2.0 | Use `containerd-*.tar.gz` bundles |
383+
| Pulling Schema 1 images (`application/vnd.docker.distribution.manifest.v1+json`) | containerd v1.7 | containerd v2.0 | Use Schema 2 or OCI images |
384+
| CRI `v1alpha2` | containerd v1.7 | containerd v2.0 | Use CRI `v1` |
385+
386+
### Deprecated config properties
387+
The deprecated properties in [`config.toml`](./docs/cri/config.md) are shown in the following table:
388+
389+
| Property Group | Property | Deprecation release | Target release for removal | Recommendation |
390+
|----------------------------------------------------------------------|------------------------------|---------------------|----------------------------|-------------------------------------------------|
391+
|`[plugins."io.containerd.grpc.v1.cri"]` | `systemd_cgroup` | containerd v1.3 | containerd v2.0 | Use `SystemdCgroup` in runc options (see below) |
392+
|`[plugins."io.containerd.grpc.v1.cri".cni]` | `conf_template` | containerd v1.? | containerd v2.0 | Create a CNI config in `/etc/cni/net.d` |
393+
|`[plugins."io.containerd.grpc.v1.cri".containerd]` | `untrusted_workload_runtime` | containerd v1.2 | containerd v2.0 | Create `untrusted` runtime in `runtimes` |
394+
|`[plugins."io.containerd.grpc.v1.cri".containerd]` | `default_runtime` | containerd v1.3 | containerd v2.0 | Use `default_runtime_name` |
395+
|`[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.*]` | `runtime_engine` | containerd v1.3 | containerd v2.0 | Use runtime v2 |
396+
|`[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.*]` | `runtime_root` | containerd v1.3 | containerd v2.0 | Use `options.Root` |
397+
|`[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.*.options]` | `CriuPath` | containerd v1.7 | containerd v2.0 | Set `$PATH` to the `criu` binary |
398+
|`[plugins."io.containerd.grpc.v1.cri".registry]` | `auths` | containerd v1.3 | containerd v2.0 | Use [`ImagePullSecrets`](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). See also [#8228](https://github.com/containerd/containerd/issues/8228). |
399+
|`[plugins."io.containerd.grpc.v1.cri".registry]` | `configs` | containerd v1.5 | containerd v2.0 | Use [`config_path`](./docs/hosts.md) |
400+
|`[plugins."io.containerd.grpc.v1.cri".registry]` | `mirrors` | containerd v1.5 | containerd v2.0 | Use [`config_path`](./docs/hosts.md) |
401+
402+
<details><summary>Example: runc option <code>SystemdCgroup</code></summary><p>
403+
404+
```toml
405+
version = 2
406+
407+
# OLD
408+
# [plugins."io.containerd.grpc.v1.cri"]
409+
# systemd_cgroup = true
410+
411+
# NEW
412+
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
413+
SystemdCgroup = true
414+
```
415+
416+
</p></details>
417+
418+
<details><summary>Example: runc option <code>Root</code></summary><p>
419+
420+
```toml
421+
version = 2
422+
423+
# OLD
424+
# [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
425+
# runtime_root = "/path/to/runc/root"
426+
427+
# NEW
428+
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
429+
Root = "/path/to/runc/root"
430+
```
431+
432+
</p></details>
384433

385434
## Experimental features
386435

‎pkg/cri/config/config.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ type CniConfig struct {
156156
// (https://kubernetes.io/docs/concepts/cluster-administration/network-plugins/#kubenet)
157157
// today, who don't have a cni daemonset in production. NetworkPluginConfTemplate is
158158
// a temporary backward-compatible solution for them.
159-
// TODO(random-liu): Deprecate this option when kubenet is deprecated.
159+
// DEPRECATED: use CNI configs
160160
NetworkPluginConfTemplate string `toml:"conf_template" json:"confTemplate"`
161161
// IPPreference specifies the strategy to use when selecting the main IP address for a pod.
162162
//
@@ -210,7 +210,7 @@ type Registry struct {
210210
Mirrors map[string]Mirror `toml:"mirrors" json:"mirrors"`
211211
// Configs are configs for each registry.
212212
// The key is the domain name or IP of the registry.
213-
// This option will be fully deprecated for ConfigPath in the future.
213+
// DEPRECATED: Use ConfigPath instead.
214214
Configs map[string]RegistryConfig `toml:"configs" json:"configs"`
215215
// Auths are registry endpoint to auth config mapping. The registry endpoint must
216216
// be a valid url with host specified.

0 commit comments

Comments
 (0)