RELEASES.md: describe the deprecated config properties
These deprecations were mentioned in `pkg/cri/config/config.go` but not mentioned in `RELEASES.md`. Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
This commit is contained in:
parent
8cc09e6a71
commit
625217d5fb
51
RELEASES.md
51
RELEASES.md
@ -373,15 +373,64 @@ against total impact.
|
|||||||
The deprecated features are shown in the following table:
|
The deprecated features are shown in the following table:
|
||||||
|
|
||||||
| Component | Deprecation release | Target release for removal | Recommendation |
|
| Component | Deprecation release | Target release for removal | Recommendation |
|
||||||
|----------------------------------------------------------------------------------|---------------------|----------------------------|-----------------------------------|
|
|----------------------------------------------------------------------------------|---------------------|----------------------------|------------------------------------------|
|
||||||
| Runtime V1 API and implementation (`io.containerd.runtime.v1.linux`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
|
| Runtime V1 API and implementation (`io.containerd.runtime.v1.linux`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
|
||||||
| Runc V1 implementation of Runtime V2 (`io.containerd.runc.v1`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
|
| Runc V1 implementation of Runtime V2 (`io.containerd.runc.v1`) | containerd v1.4 | containerd v2.0 | Use `io.containerd.runc.v2` |
|
||||||
| config.toml `version = 1` | containerd v1.5 | containerd v2.0 | Use config.toml `version = 2` |
|
| config.toml `version = 1` | containerd v1.5 | containerd v2.0 | Use config.toml `version = 2` |
|
||||||
| Built-in `aufs` snapshotter | containerd v1.5 | containerd v2.0 | Use `overlayfs` snapshotter |
|
| Built-in `aufs` snapshotter | containerd v1.5 | containerd v2.0 | Use `overlayfs` snapshotter |
|
||||||
|
| Container label `containerd.io/restart.logpath` | containerd v1.5 | containerd v2.0 | Use `containerd.io/restart.loguri` label |
|
||||||
| `cri-containerd-*.tar.gz` release bundles | containerd v1.6 | containerd v2.0 | Use `containerd-*.tar.gz` bundles |
|
| `cri-containerd-*.tar.gz` release bundles | containerd v1.6 | containerd v2.0 | Use `containerd-*.tar.gz` bundles |
|
||||||
| Pulling Schema 1 images (`application/vnd.docker.distribution.manifest.v1+json`) | containerd v1.7 | containerd v2.0 | Use Schema 2 or OCI images |
|
| Pulling Schema 1 images (`application/vnd.docker.distribution.manifest.v1+json`) | containerd v1.7 | containerd v2.0 | Use Schema 2 or OCI images |
|
||||||
| CRI `v1alpha2` | containerd v1.7 | containerd v2.0 | Use CRI `v1` |
|
| CRI `v1alpha2` | containerd v1.7 | containerd v2.0 | Use CRI `v1` |
|
||||||
|
|
||||||
|
### Deprecated config properties
|
||||||
|
The deprecated properties in [`config.toml`](./docs/cri/config.md) are shown in the following table:
|
||||||
|
|
||||||
|
| Property Group | Property | Deprecation release | Target release for removal | Recommendation |
|
||||||
|
|----------------------------------------------------------------------|------------------------------|---------------------|----------------------------|-------------------------------------------------|
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri"]` | `systemd_cgroup` | containerd v1.3 | containerd v2.0 | Use `SystemdCgroup` in runc options (see below) |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".cni]` | `conf_template` | containerd v1.? | containerd v2.0 | Create a CNI config in `/etc/cni/net.d` |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".containerd]` | `untrusted_workload_runtime` | containerd v1.2 | containerd v2.0 | Create `untrusted` runtime in `runtimes` |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".containerd]` | `default_runtime` | containerd v1.3 | containerd v2.0 | Use `default_runtime_name` |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.*]` | `runtime_engine` | containerd v1.3 | containerd v2.0 | Use runtime v2 |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.*]` | `runtime_root` | containerd v1.3 | containerd v2.0 | Use `options.Root` |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.*.options]` | `CriuPath` | containerd v1.7 | containerd v2.0 | Set `$PATH` to the `criu` binary |
|
||||||
|
|`[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). |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".registry]` | `configs` | containerd v1.5 | containerd v2.0 | Use [`config_path`](./docs/hosts.md) |
|
||||||
|
|`[plugins."io.containerd.grpc.v1.cri".registry]` | `mirrors` | containerd v1.5 | containerd v2.0 | Use [`config_path`](./docs/hosts.md) |
|
||||||
|
|
||||||
|
<details><summary>Example: runc option <code>SystemdCgroup</code></summary><p>
|
||||||
|
|
||||||
|
```toml
|
||||||
|
version = 2
|
||||||
|
|
||||||
|
# OLD
|
||||||
|
# [plugins."io.containerd.grpc.v1.cri"]
|
||||||
|
# systemd_cgroup = true
|
||||||
|
|
||||||
|
# NEW
|
||||||
|
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
|
||||||
|
SystemdCgroup = true
|
||||||
|
```
|
||||||
|
|
||||||
|
</p></details>
|
||||||
|
|
||||||
|
<details><summary>Example: runc option <code>Root</code></summary><p>
|
||||||
|
|
||||||
|
```toml
|
||||||
|
version = 2
|
||||||
|
|
||||||
|
# OLD
|
||||||
|
# [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc]
|
||||||
|
# runtime_root = "/path/to/runc/root"
|
||||||
|
|
||||||
|
# NEW
|
||||||
|
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.runc.options]
|
||||||
|
Root = "/path/to/runc/root"
|
||||||
|
```
|
||||||
|
|
||||||
|
</p></details>
|
||||||
|
|
||||||
## Experimental features
|
## Experimental features
|
||||||
|
|
||||||
Experimental features are new features added to containerd which do not have the
|
Experimental features are new features added to containerd which do not have the
|
||||||
|
@ -156,7 +156,7 @@ type CniConfig struct {
|
|||||||
// (https://kubernetes.io/docs/concepts/cluster-administration/network-plugins/#kubenet)
|
// (https://kubernetes.io/docs/concepts/cluster-administration/network-plugins/#kubenet)
|
||||||
// today, who don't have a cni daemonset in production. NetworkPluginConfTemplate is
|
// today, who don't have a cni daemonset in production. NetworkPluginConfTemplate is
|
||||||
// a temporary backward-compatible solution for them.
|
// a temporary backward-compatible solution for them.
|
||||||
// TODO(random-liu): Deprecate this option when kubenet is deprecated.
|
// DEPRECATED: use CNI configs
|
||||||
NetworkPluginConfTemplate string `toml:"conf_template" json:"confTemplate"`
|
NetworkPluginConfTemplate string `toml:"conf_template" json:"confTemplate"`
|
||||||
// IPPreference specifies the strategy to use when selecting the main IP address for a pod.
|
// IPPreference specifies the strategy to use when selecting the main IP address for a pod.
|
||||||
//
|
//
|
||||||
@ -210,7 +210,7 @@ type Registry struct {
|
|||||||
Mirrors map[string]Mirror `toml:"mirrors" json:"mirrors"`
|
Mirrors map[string]Mirror `toml:"mirrors" json:"mirrors"`
|
||||||
// Configs are configs for each registry.
|
// Configs are configs for each registry.
|
||||||
// The key is the domain name or IP of the registry.
|
// The key is the domain name or IP of the registry.
|
||||||
// This option will be fully deprecated for ConfigPath in the future.
|
// DEPRECATED: Use ConfigPath instead.
|
||||||
Configs map[string]RegistryConfig `toml:"configs" json:"configs"`
|
Configs map[string]RegistryConfig `toml:"configs" json:"configs"`
|
||||||
// Auths are registry endpoint to auth config mapping. The registry endpoint must
|
// Auths are registry endpoint to auth config mapping. The registry endpoint must
|
||||||
// be a valid url with host specified.
|
// be a valid url with host specified.
|
||||||
|
Loading…
Reference in New Issue
Block a user