[zh] Sync #13174 into Chinese and improve format (#13985)

* Sync #13174 into Chinese and format it

* reformat

* fix lint

* Fix table
This commit is contained in:
Wilson Wu 2023-10-10 15:10:18 +08:00 committed by GitHub
parent c9fea31d0c
commit 48ce7e1c00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 57 additions and 44 deletions

View File

@ -18,52 +18,53 @@ Note: this contains feature status from
https://docs.google.com/spreadsheets/d/1Nbjat-juyQ8AWhkq3njLckmHM8TRL4O-sjm9Bfr9zrU/edit#gid=0
-->
本页面列出了每个 Istio 特性的相对成熟度和支持级别。请注意,这些阶段是针对项目中的各个功能而不是整个项目。以下是对这些内容的高级描述标签。
本页面列出了每个 Istio 特性的相对成熟度和支持级别。请注意,
这些阶段是针对项目中的各个功能而不是整个项目。以下是对这些内容的高级描述标签。
## 功能定义阶段{#feature-phase-definitions}
## 功能定义阶段 {#feature-phase-definitions}
| | Experimental | Alpha | Beta | Stable |
|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| 目的 | 该功能正在积极开发中,用户的 API 可能会发生变化。用户在部署实验性功能时应极度谨慎,最好在非生产环境中使用,因为实验版本可能需要进行迁移工作。 | 用于获取有关设计或功能的反馈,或查看试探性设计的执行情况等。针对开发人员和专家用户。 | 用于审查生产中的解决方案,但没有长期承诺,以评估其可行性、性能、可用​​性等。针对所有用户。 | 经过生产验证,可靠。 |
| 稳定性 | 可能存在错误。使用该功能可能会暴露出错误。默认不活动。 | 可能存在错误。使用该功能可能会暴露出错误。默认不活动 | 代码经过充分测试。该功能在生产环境中使用是安全的。 | 代码经过充分测试且稳定。在生产环境中可以安全广泛部署使用。 |
| 安全性 | 使用该功能可能存在明显的安全漏洞。发现的漏洞可能不会被广泛传播。 | 使用该功能可能存在明显的安全漏洞。发现的漏洞可能不会被广泛传播。 | 任何发现的安全漏洞都将公开披露并进行修补。 | 任何发现的安全漏洞都将公开披露并进行修补。 |
| 性能 | 性能特征未知。启用实验性功能可能会对性能产生负面影响。 | 性能要求作为设计的一部分进行评估。 | 具备性能和可扩展性的特性,但可能存在一些注意事项。 | 性能(延迟/规模)被量化并记录下来,保证不会出现退化。 |
| 支持 | 不保证向后兼容性。该功能可能随时被删除,不会另行通知。 | 不保证向后兼容性。该功能可能随时被删除,不会另行通知。 | 整体功能不会被取消,但细节可能会发生变化。 | 该功能将在随后发布的多个版本的软件中出现。 |
| 弃用政策 | 无,功能可能随时被删除。 | 无,功能可以随时被删除。 | 弱,会提前 3 个月通知删除功能。 | 强,该功能可以在提前 1 年通知的情况下被删除,但通常会提供支持的升级路径以替换该功能。 |API 版本名称包含 dev例如 v1dev1。 | API 版本名称包含 alpha例如 v1alpha1。 | API 版本名称包含 beta例如 v1beta1。 |API 版本是 `vX`,其中 X 是一个整数(例如 v1。 |
| 可用性 | 该功能可能在主 Istio 存储库中可用,也可能不可用。该功能可能会也可能不会出现在 Istio 版本中。如果它确实出现在 Istio 版本中,它将默认被禁用。除了使用该功能所需的任何配置外,该功能还需要一个显式标志来启用,以便打开开发功能。 | 该功能已提交给 Istio 存储库。该功能出现在 Istio 的官方版本中。该功能需要明确的用户操作才能使用,例如标志翻转、配置资源的使用、显式安装操作或调用的 API。当某个功能被禁用时它不得影响系统稳定性。 |在官方 Istio 版本中默认启用。 |与测试版相同。 |
| 观众 | 其他开发人员在功能或概念验证方面密切合作。 |该功能面向有兴趣提供早期反馈的开发人员和专家用户。 |有兴趣提供有关功能的反馈的用户。 | 所有用户。 |
| 完整性 | 功能的功能有限。此功能可用作概念证明。 |某些 API 操作或 CLI 命令可能未实现 该功能不需要进行 API 审查(在正常代码审查之上对 API 进行密集和有针对性的审查)。 | 应实施所有 API 操作和 CLI 命令 端到端测试完整且可靠 该 API 已经过全面的 API 审查并被认为是完整的,尽管在 beta 期间使用经常会出现审查期间未考虑的 API 问题。 |与测试版相同。 |
|文档 |实验性功能在自动生成的参考文档中被标记为实验性或不公开。 | Alpha 功能在自动生成的参考文档中标记为 alpha。描述该功能的作用、如何启用它、限制和警告的基本文档以及指向该功能所基于的问题或设计文档的指针。 |发布到 Istio.io 的完整功能文档 除了基本的 alpha 级文档beta 文档还包括示例、教程、术语表条目等。 | 与测试版相同。 |
|可升级性 |实验性功能的架构和语义可能会在较新版本中发生变化,但无法保证在升级期间需要更改配置的向后兼容性。 API 版本的增加速度可能比发布节奏快,开发人员无需维护多个版本以实现向后兼容性。当架构或语义以不兼容的方式更改时,鼓励开发人员增加 API 版本。 | alpha 功能的架构和语义可能会在以后的软件版本中发生变化,在现有的 Istio 安装中没有任何保留配置对象的规定 API 版本的增长速度可能比发布节奏快,开发人员不需要维护多个版本 开发人员应该增加 API模式或语义以不兼容的方式更改时的版本。 |架构和语义可能会在以后的软件版本中更改 如果发生这种情况,将记录升级路径 在某些情况下,对象将自动转换为新版本 在其他情况下,可能需要手动升级 手动升级可能需要停机对于依赖新功能的任何事物,并且可能需要将对象手动转换为新版本 当需要手动转换时,项目将提供有关该过程的文档。 |在随后的软件版本中只允许严格兼容的更改。 |
|测试 |该功能的存在不得影响任何已发布的功能。 | 该功能由单元测试和集成测试覆盖,其中启用了该功能并且测试是稳定的。测试可能无法涵盖所有​​极端情况,但已经涵盖了最常见的情况。测试代码覆盖率 >= 70%。当该功能被禁用时,它不会降低系统的性能。 |集成测试涵盖边缘情况以及常见用例。集成测试涵盖了该功能上报告的所有问题。该功能具有涵盖该功能示例/教程的端到端测试。测试代码覆盖率 >= 80%。 | Beta 的超集,包括对 Beta 期间发现的任何问题的测试。测试代码覆盖率 >= 90%。 |
|可靠性 |用户不应期望可靠的功能可能未经测试。 | 由于该功能相对较新,并且可能缺乏完整的端到端测试,因此通过标志启用该功能可能会暴露导致 Istio 不稳定的错误(例如,控制循环中的错误可能会迅速创建过多的对象,耗尽 API 存储空间) . |由于该功能具有 e2e 测试,因此启用该功能不应在不相关的功能中产生新的错误。由于该功能相对较新,因此可能存在小错误。 | 高的。该功能经过充分测试,适用于所有用途,稳定可靠。 |
|支持 | Istio 社区没有承诺改进、维护或完成该功能,并且该功能可能会在新版本中完全删除。 | Istio 没有承诺完成该功能 该功能可能会在以后的软件版本中完全删除。| Istio 承诺在后续稳定版本中以某种形式完成该功能,通常这会在 3 个月内发生,但有时会需要更长的时间。发布版本应该同时支持两个连续版本(例如 v1alpha1 和 v1beta1或 v1beta1 和 v1至少支持一个发布周期一般为3个月让用户有足够的时间升级和迁移资源。 |该功能将继续存在于许多后续版本中。 |
|推荐用例 |在短期开发或测试环境中,旨在征求用户的早期反馈以制定开发工作。 | 在短期开发或测试环境中,由于可升级性的复杂性和缺乏长期支持。 |在开发或测试环境中。在生产环境中作为功能评估的一部分以提供反馈。 | 任何。 |
| | Experimental | Alpha | Beta | Stable |
|------|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
| 目的 | 该功能正在积极开发中,用户的 API 可能会发生变化。用户在部署实验性功能时应极度谨慎,最好在非生产环境中使用,因为实验版本可能需要进行迁移工作。 | 用于获取有关设计或功能的反馈,或查看试探性设计的执行情况等。针对开发人员和专家用户。 | 用于审查生产中的解决方案,但没有长期承诺,以评估其可行性、性能、可用​​性等。针对所有用户。 | 经过生产验证,可靠。 |
| 稳定性 | 可能存在错误。使用该功能可能会暴露出错误。默认不活动。 | 可能存在错误。使用该功能可能会暴露出错误。默认不活动 | 代码经过充分测试。该功能在生产环境中使用是安全的。 | 代码经过充分测试且稳定。在生产环境中可以安全广泛部署使用。 |
| 性能 | 性能特征未知。启用实验性功能可能会对性能产生负面影响。 | 性能要求作为设计的一部分进行评估。 | 具备性能和可扩展性的特性,但可能存在一些注意事项。 | 性能(延迟/规模)被量化并记录下来,保证不会出现退化。 |
| 支持 | 不保证向后兼容性。Istio 社区不承诺改进、维护或完成该功能,并且该功能可能随时在后续软件版本中完全删除,恕不另行通知。 | 不保证向后兼容性。Istio 不承诺完成该功能。该功能可能会随时在后续软件版本中完全删除,恕不另行通知。 | 尽管细节可能会发生变化但整体功能不会被删除。Istio 承诺在后续的稳定版本中以某种形式完成该功能。通常这会在 3 个月内发生,但有时会更长。 版本应在至少一个受支持的发布周期(通常为 3 个月)内同时支持两个连续版本(例如 v1alpha1 和 v1beta1或 v1beta1 和 v1以便用户有足够的时间升级和迁移资源。 | 该功能将在许多后续版本中继续存在。 |
| 弃用政策 | 无,功能可能随时被删除。 | 无,功能可以随时被删除。 | 弱,会提前 3 个月通知删除功能。 | 强,该功能可以在提前 1 年通知的情况下被删除,但通常会提供支持的升级路径以替换该功能。 |
| 版本控制 | API 版本名称包含 dev例如 v1dev1。 | API 版本名称包含 alpha例如 v1alpha1。 | API 版本名称包含 beta例如 v1beta1。 | API 版本是 `vX`,其中 X 是整数(例如 v1。 |
| 可用性 | 该功能可能在主 Istio 存储库中可用,也可能不可用。该功能可能会也可能不会出现在 Istio 版本中。如果它确实出现在 Istio 版本中,它将默认被禁用。除了使用该功能所需的任何配置外,该功能还需要一个显式标志来启用,以便打开开发功能。 | 该功能已提交给 Istio 存储库。该功能出现在 Istio 的官方版本中。该功能需要明确的用户操作才能使用,例如标志翻转、配置资源的使用、显式安装操作或调用的 API。当某个功能被禁用时它不得影响系统稳定性。 | 在官方 Istio 版本中默认启用。 | 与 Beta 版相同。 |
| 受众 | 其他开发人员在功能或概念验证方面密切合作。 | 该功能面向有兴趣提供早期反馈的开发人员和专家用户。 | 有兴趣提供有关功能的反馈的用户。 | 所有用户。 |
| 完整性 | 功能的兼容性有限。此功能可以作为概念证明。 | 某些 API 操作或 CLI 命令可能无法实现。该功能不需要进行 API 审查(在正常的代码审查之上对 API 进行深入且有针对性的审查)。 | 应实现所有 API 操作和 CLI 命令。端到端测试完整且可靠。该 API 已经过彻底的 API 审查,并且被认为是完整的,尽管在测试期间使用经常会出现审查期间未考虑到的 API 问题。 | 与 Beta 版相同。 |
| 文档 | 实验性功能在自动生成的参考文档中被标记为实验性或不公开。 | Alpha 功能在自动生成的参考文档中标记为 alpha。描述该功能的作用、如何启用它、限制和警告的基本文档以及指向该功能所基于的问题或设计文档的指针。 | 发布到 Istio.io 的完整功能文档 除了基本的 alpha 级文档beta 文档还包括示例、教程、术语表条目等。 | 与 Beta 版相同。 |
| 可升级性 | 实验性功能的架构和语义可能会在较新版本中发生变化但无法保证在升级期间需要更改配置的向后兼容性。API 版本的增加速度可能比发布节奏快,开发人员无需维护多个版本以实现向后兼容性。当架构或语义以不兼容的方式更改时,鼓励开发人员增加 API 版本。 | Alpha 功能的架构和语义可能会在后续软件版本中发生变化,而无需在现有 Istio 安装中保留配置对象。API 版本的增加速度可能快于发布节奏,并且开发人员无需维护多个版本。当架构或语义以不兼容的方式更改时,开发人员应增加 API 版本。 | 架构和语义可能会在以后的软件版本中发生变化。发生这种情况时,将记录升级路径。在某些情况下,对象将自动转换为新版本。在其他情况下,可能需要手动升级。手动升级可能需要对依赖新功能的任何内容进行停机,并且可能需要将对象手动转换为新版本。当需要手动转换时,项目将提供有关该过程的文档。 | 在随后的软件版本中只允许严格兼容的更改。 |
| 测试 | 该功能的存在不得影响任何已发布的功能。 | 该功能由单元测试和集成测试覆盖,其中启用了该功能并且测试是稳定的。测试可能无法涵盖所有​​极端情况,但已经涵盖了最常见的情况。测试代码覆盖率 >= 70%。当该功能被禁用时,它不会降低系统的性能。 | 集成测试涵盖边缘情况以及常见用例。集成测试涵盖了该功能上报告的所有问题。该功能具有涵盖该功能示例/教程的端到端测试。测试代码覆盖率 >= 80%。 | Beta 的超集,包括对 Beta 期间发现的任何问题的测试。测试代码覆盖率 >= 90%。 |
| 可靠性 | 用户不应期望可靠的功能可能未经测试。 | 由于该功能相对较新,并且可能缺乏完整的端到端测试,因此通过标志启用该功能可能会暴露导致 Istio 不稳定的错误(例如,控制循环中的错误可能会迅速创建过多的对象,耗尽 API 存储空间) . | 由于该功能具有 e2e 测试,因此启用该功能不应在不相关的功能中产生新的错误。由于该功能相对较新,因此可能存在小错误。 | 高的。该功能经过充分测试,适用于所有用途,稳定可靠。 |
| 推荐用例 | 在短期开发或测试环境中,旨在征求用户的早期反馈以制定开发工作。 | 在短期开发或测试环境中,由于可升级性的复杂性和缺乏长期支持。 | 在开发或测试环境中。在生产环境中作为功能评估的一部分以提供反馈。 | 任何。 |
## Istio 特性{#Istio-features}
## Istio 特性 {#Istio-features}
以下是我们现有功能及其当前阶段的列表。此信息将在每次发布后更新。
### 流量管理{#traffic-management}
### 流量管理 {#traffic-management}
{{< features section="Traffic Management" >}}
### 可观察性{#observability}
### 可观察性 {#observability}
{{< features section="Observability" >}}
### 可扩展性{#extensibility}
### 可扩展性 {#extensibility}
{{< features section="Extensibility" >}}
### 安全和政策执行{#security-and-policy-enforcement}
### 安全和政策执行 {#security-and-policy-enforcement}
{{< features section="Security and policy enforcement" >}}
### 核心{#core}
### 核心 {#core}
{{< features section="Core" >}}
{{< idea >}}
如果您希望在我们的未来版本中看到某些功能,请通过[加入我们的社区](/zh/get-involved/)与我们联系!
如果您希望在我们的未来版本中看到某些功能,
请通过[加入我们的社区](/zh/get-involved/)与我们联系!
{{< /idea >}}

View File

@ -9,14 +9,17 @@ owner: istio/wg-docs-maintainers
test: n/a
---
我们非常感谢那些报告 Istio 安全漏洞的安全研究人员和用户。我们会彻底分析和评估每份报告。
我们非常感谢那些报告 Istio 安全漏洞的安全研究人员和用户。
我们会彻底分析和评估每份报告。
## 报告漏洞{#reporting-a-vulnerability}
## 报告漏洞 {#reporting-a-vulnerability}
要进行漏洞报告,请将包含漏洞详细信息的电子邮件发送到 [istio-security-vulnerability-reports@googlegroups.com](mailto:istio-security-vulnerability-reports@googlegroups.com)
对于与潜在安全漏洞无关的普通产品错误,请转到我们的[报告错误](/zh/docs/releases/bugs/)页面以了解如何操作。
要进行漏洞报告,请将包含漏洞详细信息的电子邮件发送到
[istio-security-vulnerability-reports@googlegroups.com](mailto:istio-security-vulnerability-reports@googlegroups.com)
对于与潜在安全漏洞无关的普通产品错误,
请转到我们的[报告错误](/zh/docs/releases/bugs/)页面以了解如何操作。
### 何时报告安全漏洞?{#when-to-report-a-security-vulnerability}
### 何时报告安全漏洞? {#when-to-report-a-security-vulnerability}
只要您有以下情况,请向我们发送报告:
@ -30,7 +33,7 @@ test: n/a
- 任何的安全策略(比如认证或授权)的绕过或者脆弱性
- 任何潜在的拒绝服务DoS
### 什么时候不报告安全漏洞?{#when-not-to-report-a-security-vulnerability}
### 什么时候不报告安全漏洞? {#when-not-to-report-a-security-vulnerability}
在以下情况下,请勿发送漏洞报告:
@ -39,25 +42,30 @@ test: n/a
- 您的问题与安全性无关。
- 您的问题与基础镜像依赖关系有关(查看[基础镜像](#base-images))。
## 评估{#evaluation}
## 评估 {#evaluation}
Istio 安全团队会在三个工作日内确认并分析每个漏洞报告。
您与 Istio 安全团队共享的任何漏洞信息都属于 Istio 项目,我们仅共享解决问题所需的信息,不会将信息传播给其他项目。
您与 Istio 安全团队共享的任何漏洞信息都属于 Istio 项目,
我们仅共享解决问题所需的信息,不会将信息传播给其他项目。
`triaged``identified fix` 再到 `release planning`,我们会随时反馈安全问题的状态。
`triaged``identified fix` 再到
`release planning`,我们会随时反馈安全问题的状态。
## 修复问题{#fixing-the-issue}
## 修复问题 {#fixing-the-issue}
一旦对安全漏洞进行了充分描述Istio 团队就会开发出修复程序。修复程序的开发和测试在私有 GitHub 仓库中进行,以防止过早披露此漏洞信息。
一旦对安全漏洞进行了充分描述Istio 团队就会开发出修复程序。
修复程序的开发和测试在私有 GitHub 仓库中进行,以防止过早披露此漏洞信息。
## 早期披露{#early-disclosure}
## 早期披露 {#early-disclosure}
Istio 项目维护了一个邮件列表,用于在私下及早的公开安全漏洞。该列表用于提供可操作的信息给与 Istio 密切的合作伙伴。该列表不用于让个人了解安全问题。
Istio 项目维护了一个邮件列表,用于在私下及早的公开安全漏洞。
该列表用于提供可操作的信息给与 Istio 密切的合作伙伴。
该列表不用于让个人了解安全问题。
请参阅[早期披露的安全漏洞](https://github.com/istio/community/blob/master/EARLY-DISCLOSURE.md)以获取更多信息。
## 公开披露{#public-disclosure}
## 公开披露 {#public-disclosure}
在选择公开披露的当天,下面一系列动作会尽可能快的进行:
@ -72,11 +80,14 @@ Istio 项目维护了一个邮件列表,用于在私下及早的公开安全
- [Istio Twitter feed](https://twitter.com/IstioMesh)
- Slack 上的 [#announcements](https://istio.slack.com/messages/CFXS256EQ/) 频道
该公告将尽可能包含客户在升级到固定版本之前能够采取的任何缓解措施,这些公告的建议发布时间是 UTC 时间星期一至四的 16:00。这意味着该公告将在太平洋时间的早上、欧洲傍晚和亚洲傍晚发布。
该公告将尽可能包含客户在升级到固定版本之前能够采取的任何缓解措施,
这些公告的建议发布时间是 UTC 时间星期一至四的 16:00。
这意味着该公告将在太平洋时间的早上、欧洲傍晚和亚洲傍晚发布。
## 基础镜像{#base-images}
## 基础镜像 {#base-images}
Istio 提供了两组基于 `ubuntu` 和基于 `distroless` 的默认 Docker 镜像,更多详情请查阅([加固 Docker 容器镜像](/zh/docs/ops/configuration/security/harden-docker-images/))。
Istio 提供了两组基于 `ubuntu` 和基于 `distroless` 的默认 Docker 镜像,
更多详情请查阅([加固 Docker 容器镜像](/zh/docs/ops/configuration/security/harden-docker-images/))。
这些镜像中偶尔会存在一些新发现的 CVE 安全漏洞。
Istio 安全团队会对这些镜像进行自动扫描,以确保基础镜像中没有已知的 CVE 安全漏洞。
@ -85,7 +96,8 @@ Istio 安全团队会对这些镜像进行自动扫描,以确保基础镜像
在大多数情况下,这些漏洞可能存在于基础镜像包中,但无法在 Istio 使用这些镜像时被人加以利用。
对于这些情况,新版本通常不会仅仅为了解决这些 CVE 而发布,具体的修复将包含在下一个定期发布的版本中。
因此,基础镜像 CVE 安全漏洞不应被[报告](#reporting-a-vulnerability),除非有证据表明它可以在 Istio 中被利用。
因此,基础镜像 CVE 安全漏洞不应被[报告](#reporting-a-vulnerability)
除非有证据表明它可以在 Istio 中被利用。
如果减少基础镜像 CVE 安全漏洞对您很重要,强烈建议使用
[`distroless`](/zh/docs/ops/configuration/security/harden-docker-images/) 基础镜像。