Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RuntimeClass documentation for beta #13043

Merged
merged 5 commits into from
Mar 16, 2019
Merged

Update RuntimeClass documentation for beta #13043

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b7343ac
Update RuntimeClass documentation for beta
tallclair Mar 8, 2019
fe01694
Update feature gate & add upgrade section
tallclair Mar 11, 2019
cd9e6af
formatting fixes
tallclair Mar 12, 2019
caf1120
Highlight upgrade action required
tallclair Mar 12, 2019
3094961
Address feedback
tallclair Mar 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions content/en/docs/concepts/containers/runtime-class.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ weight: 20

This page describes the RuntimeClass resource and runtime selection mechanism.

{{< warning >}}
RuntimeClass includes *breaking* changes in the beta upgrade in v1.14. If you were using
RuntimeClass prior to v1.14, see [Upgrading RuntimeClass from Alpha to
Beta](#upgrading-runtimeclass-from-alpha-to-beta).
{{< /warning >}}

{{% /capture %}}


Expand All @@ -23,12 +29,6 @@ This page describes the RuntimeClass resource and runtime selection mechanism.
RuntimeClass is a beta feature (as of v1.14) for selecting the container runtime configuration to
use to run a pod's containers.

{{< warning >}}
RuntimeClass includes *breaking* changes in the beta upgrade in v1.14. If you were using
RuntimeClass prior to v1.14, see [Upgrading RuntimeClass from Alpha to
Beta](#upgrading-runtimeclass-from-alpha-to-beta).
{{< /warning >}}

### Set Up

Prerequisite: Ensure the RuntimeClass feature gate is enabled (it is by default). See [Feature
Expand Down Expand Up @@ -106,7 +106,7 @@ For more details on setting up CRI runtimes, see [CRI installation](/docs/setup/

#### dockershim

Kubernete's built-in dockershim CRI does not support runtime handlers.
Kubernetes built-in dockershim CRI does not support runtime handlers.

#### [containerd](https://containerd.io/)

Expand Down Expand Up @@ -150,13 +150,13 @@ RuntimeClass Beta (v1.14) included the following changes:
meaning it can no longer container `.` characters (in all versions). Valid handlers match the
following regular expression: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`.

If you were using RuntimeClass Alpha (prior to v1.14), the following actions are required
If you were using RuntimeClass Alpha (prior to v1.14), the following **actions are required**:

- RuntimeClass resources must be recreated *after* upgrading to v1.14, and the
`runtimeclasses.node.k8s.io` CRD should be manually deleted:

kubectl delete customresourcedefinitions.apiextensions.k8s.io runtimeclasses.node.k8s.io

```
kubectl delete customresourcedefinitions.apiextensions.k8s.io runtimeclasses.node.k8s.io
```
- Alpha RuntimeClasses with an unspecified or empty `runtimeHandler` or those using a `.` character
in the handler are no longer valid, and must be migrated to a valid handler configuration (see
above).
Expand Down