Skip to content

Commit

Permalink
[YUNIKORN-2382] Add supported K8s versions (apache#395)
Browse files Browse the repository at this point in the history
Closes: apache#395

Signed-off-by: Chia-Ping Tsai <[email protected]>
  • Loading branch information
wilfred-s authored and chia7712 committed Feb 9, 2024
1 parent 0f84c83 commit 06b8316
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 1 deletion.
58 changes: 58 additions & 0 deletions docs/get_started/version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
id: version
title: Version details
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

# Which version should be used?

The recommendation is to always run the latest possible version of YuniKorn.
New releases are made regular driven by new features for YuniKorn itself and or the shim.
Features and fixes are currently only added to the development branch from which releases are cut.

At this point in time the project only creates minor releases, no patch releases.

If a shim version, i.e. Kubernetes, is supported by multiple YuniKorn releases we recommend to always use the latest YuniKorn release possible.
Older build dependencies in earlier releases could prevent you from using some new functionality exposed by a newer shim.

# Kubernetes versions supported by YuniKorn

| K8s Version | Supported <br/>from version | Support ended |
|---------------------|:---------------------------:|:-------------:|
| 1.12.x (or earlier) | - | - |
| 1.13.x | 0.8.0 | 0.10.0 |
| 1.14.x | 0.8.0 | 0.10.0 |
| 1.15.x | 0.8.0 | 0.10.0 |
| 1.16.x | 0.10.0 | 0.11.0 |
| 1.17.x | 0.10.0 | 0.11.0 |
| 1.18.x | 0.10.0 | 0.11.0 |
| 1.19.x | 0.11.0 | 1.0.0 |
| 1.20.x | 0.12.1 | 1.2.0 |
| 1.21.x | 0.12.1 | 1.3.0 |
| 1.22.x | 0.12.2 | 1.3.0 |
| 1.23.x | 0.12.2 | 1.3.0 |
| 1.24.x | 1.0.0 | - |
| 1.25.x | 1.2.0 | - |
| 1.26.x | 1.2.0 | - |
| 1.27.x | 1.4.0 | - |
| 1.28.x | 1.4.0 | - |
| 1.29.x | 1.5.0 | - |

Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
id: version
title: 版本详情
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

# 应该使用哪个版本?


建议始终运行最新版本的 YuniKorn。新版本定期由 YuniKorn 本身和/或 shim 的新功能驱动。目前新功能和修复仅合并到用来做释出的开发分支。

此时该项目仅创建次要版本,没有补丁版本。

如果 shim 版本(即 Kubernetes)受多个 YuniKorn 版本支持,我们建议始终使用最新的 YuniKorn 版本。
早期版本中较旧的构建依赖项可能会阻止您使用 shim 的某些新功能。

# YuniKorn 支持的 Kubernetes 版本

| K8s 版本 | 发行版本 | 支持结束 |
|--------------|:------:|:------:|
| 1.12.x (或更早) | - | - |
| 1.13.x | 0.8.0 | 0.10.0 |
| 1.14.x | 0.8.0 | 0.10.0 |
| 1.15.x | 0.8.0 | 0.10.0 |
| 1.16.x | 0.10.0 | 0.11.0 |
| 1.17.x | 0.10.0 | 0.11.0 |
| 1.18.x | 0.10.0 | 0.11.0 |
| 1.19.x | 0.11.0 | 1.0.0 |
| 1.20.x | 0.12.1 | 1.2.0 |
| 1.21.x | 0.12.1 | 1.3.0 |
| 1.22.x | 0.12.2 | 1.3.0 |
| 1.23.x | 0.12.2 | 1.3.0 |
| 1.24.x | 1.0.0 | - |
| 1.25.x | 1.2.0 | - |
| 1.26.x | 1.2.0 | - |
| 1.27.x | 1.4.0 | - |
| 1.28.x | 1.4.0 | - |
| 1.29.x | 1.5.0 | - |

3 changes: 2 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ module.exports = {
docs: {
'Get Started': [
'get_started/user_guide',
'get_started/core_features'
'get_started/core_features',
'get_started/version'
],
'User Guide': [
'user_guide/deployment_modes',
Expand Down

0 comments on commit 06b8316

Please sign in to comment.