From 5412255d500a775c7c3643bd484b1adbbd30aecf Mon Sep 17 00:00:00 2001 From: Reason94 Date: Tue, 6 Dec 2022 15:50:57 +0800 Subject: [PATCH] fix sidecarset ControllerRevision doc (#84) Signed-off-by: Reason94 Signed-off-by: Reason94 --- blog/2022-10-07-release-1.3.md | 2 +- docs/best-practices/gitops-with-kruise.md | 4 ++-- docs/user-manuals/sidecarset.md | 2 +- .../docusaurus-plugin-content-blog/2022-10-07-release-1.3.md | 2 +- .../current/user-manuals/sidecarset.md | 2 +- .../version-v1.3/user-manuals/sidecarset.md | 2 +- .../version-v1.0/best-practices/gitops-with-kruise.md | 4 ++-- .../version-v1.1/best-practices/gitops-with-kruise.md | 2 +- versioned_docs/version-v1.3/user-manuals/sidecarset.md | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/blog/2022-10-07-release-1.3.md b/blog/2022-10-07-release-1.3.md index 10ecaf5a5..a560aef38 100644 --- a/blog/2022-10-07-release-1.3.md +++ b/blog/2022-10-07-release-1.3.md @@ -106,7 +106,7 @@ ideally reducing initialization time by more than 80%. SidecarSet will record historical revision of some fields such as `containers`, `volumes`, `initContainers`, `imagePullSecrets` and `patchPodMetadata` via ControllerRevision. **Based on this feature, you can easily select a specific historical revision to inject when creating Pods, rather than always inject the latest revision of sidecar.** -SidecarSet records ControllerRevision in the same namespace as Kruse Manager. You can execute `kubectl get controllerrvisions -n kruise-system -l kruise.io/sidecarset-name=` to list the ControllerRevisions of your SidecarSet. +SidecarSet records ControllerRevision in the same namespace as Kruise Manager. You can execute `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=` to list the ControllerRevisions of your SidecarSet. Moreover, the ControllerRevision name of current SidecarSet revision is shown in `status.latestRevision` field, so you can record it very easily. There are two configuration methods as follows: diff --git a/docs/best-practices/gitops-with-kruise.md b/docs/best-practices/gitops-with-kruise.md index 31278bb87..7979e1bd9 100644 --- a/docs/best-practices/gitops-with-kruise.md +++ b/docs/best-practices/gitops-with-kruise.md @@ -17,8 +17,8 @@ Tekton is a Google open source Kubernetes native framework for creating continuo - Install Argo-cd, Reference [Official Documents](https://argo-cd.readthedocs.io/en/stable/getting_started/), Argo-cd is a declarative GitOps continuous delivery tool for Kubernetes. #### Install OpenKruise（Enable: TemplateNoDefaults） -Openkruse installed by default will inject the default value of pod / PVC template, which will conflict with the sync judgment logic of Argo CD. -Therefore, when installing openkruse, you need to open gates **TemplateNoDefaults**, as follows: +Openkruise installed by default will inject the default value of pod / PVC template, which will conflict with the sync judgment logic of Argo CD. +Therefore, when installing openkruise, you need to open gates **TemplateNoDefaults**, as follows: ``` # Firstly add openkruise charts repository if you haven't do this. $ helm repo add openkruise https://openkruise.github.io/charts/ diff --git a/docs/user-manuals/sidecarset.md b/docs/user-manuals/sidecarset.md index 9930a3d9d..a2b7edab2 100644 --- a/docs/user-manuals/sidecarset.md +++ b/docs/user-manuals/sidecarset.md @@ -223,7 +223,7 @@ SidecarSet will record historical revision of some fields such as `containers`, Based on this feature, users can address the risk of SidecarSet publishing due to scaling and rolling workload. -**Note: SidecarSet records ControllerRevision in the same namespace as Kruse Manager. You can execute `kubectl get controllerrvisions -n kruise-system -l kruise.io/sidecarset-name=` to list the ControllerRevisions of your SidecarSet. Moreover, the ControllerRevision name of current SidecarSet revision is shown in `status.latestRevision` field, so you can record it very easily.** +**Note: SidecarSet records ControllerRevision in the same namespace as Kruise Manager. You can execute `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=` to list the ControllerRevisions of your SidecarSet. Moreover, the ControllerRevision name of current SidecarSet revision is shown in `status.latestRevision` field, so you can record it very easily.** #### select revision via ControllerRevision name ```yaml diff --git a/i18n/zh/docusaurus-plugin-content-blog/2022-10-07-release-1.3.md b/i18n/zh/docusaurus-plugin-content-blog/2022-10-07-release-1.3.md index f85843655..44428ae16 100644 --- a/i18n/zh/docusaurus-plugin-content-blog/2022-10-07-release-1.3.md +++ b/i18n/zh/docusaurus-plugin-content-blog/2022-10-07-release-1.3.md @@ -103,7 +103,7 @@ status: SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本，并允许用户在 Pod 创建时选择特定的历史版本进行注入。 基于这一特性，用户可以规避在 SidecarSet 灰度发布时，因Deployment 等 Workload 扩容、升级等操作带来的 SidecarSet 发布风险。如果不选择注入版本，SidecarSet 将对重建 Pod 默认全都注入最新版本 Sidecar。 -SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中，用户可以使用 `kubectl get controllerrvisions -n kruise-system -l kruise.io/sidecarset-name=your-sidecarset-name` 来查看。 +SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中，用户可以使用 `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=your-sidecarset-name` 来查看。 此外，用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称，以方便自行记录。 #### 通过 ControllerRevision 名称指定注入的 Sidecar 版本 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-manuals/sidecarset.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-manuals/sidecarset.md index 43ad30ab2..d033c895e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-manuals/sidecarset.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-manuals/sidecarset.md @@ -216,7 +216,7 @@ spec: SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本，并允许用户在 Pod 创建时选择特定的历史版本进行注入。 基于这一特性，用户可以规避在 SidecarSet 灰度发布时，因Deployment 等 Workload 扩容、升级等操作带来的 SidecarSet 发布风险。如果不选择注入版本，SidecarSet 将对重建 Pod 默认全都注入最新版本 Sidecar。 -**注：SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中，用户可以使用 `kubectl get controllerrvisions -n kruise-system -l kruise.io/sidecarset-name=` 来查看。此外，用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称，以方便自行记录。** +**注：SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中，用户可以使用 `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=` 来查看。此外，用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称，以方便自行记录。** #### 通过 ControllerRevision 名称指定注入的 Sidecar 版本 ```yaml diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/user-manuals/sidecarset.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/user-manuals/sidecarset.md index cfea2b041..ccbc2c182 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/user-manuals/sidecarset.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/user-manuals/sidecarset.md @@ -216,7 +216,7 @@ spec: SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本，并允许用户在 Pod 创建时选择特定的历史版本进行注入。 基于这一特性，用户可以规避在 SidecarSet 灰度发布时，因Deployment 等 Workload 扩容、升级等操作带来的 SidecarSet 发布风险。如果不选择注入版本，SidecarSet 将对重建 Pod 默认全都注入最新版本 Sidecar。 -**注：SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中，用户可以使用 `kubectl get controllerrvisions -n kruise-system -l kruise.io/sidecarset-name=` 来查看。此外，用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称，以方便自行记录。** +**注：SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中，用户可以使用 `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=` 来查看。此外，用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称，以方便自行记录。** #### 通过 ControllerRevision 名称指定注入的 Sidecar 版本 ```yaml diff --git a/versioned_docs/version-v1.0/best-practices/gitops-with-kruise.md b/versioned_docs/version-v1.0/best-practices/gitops-with-kruise.md index 31278bb87..7979e1bd9 100644 --- a/versioned_docs/version-v1.0/best-practices/gitops-with-kruise.md +++ b/versioned_docs/version-v1.0/best-practices/gitops-with-kruise.md @@ -17,8 +17,8 @@ Tekton is a Google open source Kubernetes native framework for creating continuo - Install Argo-cd, Reference [Official Documents](https://argo-cd.readthedocs.io/en/stable/getting_started/), Argo-cd is a declarative GitOps continuous delivery tool for Kubernetes. #### Install OpenKruise（Enable: TemplateNoDefaults） -Openkruse installed by default will inject the default value of pod / PVC template, which will conflict with the sync judgment logic of Argo CD. -Therefore, when installing openkruse, you need to open gates **TemplateNoDefaults**, as follows: +Openkruise installed by default will inject the default value of pod / PVC template, which will conflict with the sync judgment logic of Argo CD. +Therefore, when installing openkruise, you need to open gates **TemplateNoDefaults**, as follows: ``` # Firstly add openkruise charts repository if you haven't do this. $ helm repo add openkruise https://openkruise.github.io/charts/ diff --git a/versioned_docs/version-v1.1/best-practices/gitops-with-kruise.md b/versioned_docs/version-v1.1/best-practices/gitops-with-kruise.md index 31278bb87..abb19ad57 100644 --- a/versioned_docs/version-v1.1/best-practices/gitops-with-kruise.md +++ b/versioned_docs/version-v1.1/best-practices/gitops-with-kruise.md @@ -17,7 +17,7 @@ Tekton is a Google open source Kubernetes native framework for creating continuo - Install Argo-cd, Reference [Official Documents](https://argo-cd.readthedocs.io/en/stable/getting_started/), Argo-cd is a declarative GitOps continuous delivery tool for Kubernetes. #### Install OpenKruise（Enable: TemplateNoDefaults） -Openkruse installed by default will inject the default value of pod / PVC template, which will conflict with the sync judgment logic of Argo CD. +Openkruise installed by default will inject the default value of pod / PVC template, which will conflict with the sync judgment logic of Argo CD. Therefore, when installing openkruse, you need to open gates **TemplateNoDefaults**, as follows: ``` # Firstly add openkruise charts repository if you haven't do this. diff --git a/versioned_docs/version-v1.3/user-manuals/sidecarset.md b/versioned_docs/version-v1.3/user-manuals/sidecarset.md index 9930a3d9d..16c36c576 100644 --- a/versioned_docs/version-v1.3/user-manuals/sidecarset.md +++ b/versioned_docs/version-v1.3/user-manuals/sidecarset.md @@ -223,7 +223,7 @@ SidecarSet will record historical revision of some fields such as `containers`, Based on this feature, users can address the risk of SidecarSet publishing due to scaling and rolling workload. -**Note: SidecarSet records ControllerRevision in the same namespace as Kruse Manager. You can execute `kubectl get controllerrvisions -n kruise-system -l kruise.io/sidecarset-name=` to list the ControllerRevisions of your SidecarSet. Moreover, the ControllerRevision name of current SidecarSet revision is shown in `status.latestRevision` field, so you can record it very easily.** +**Note: SidecarSet records ControllerRevision in the same namespace as Kruse Manager. You can execute `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=` to list the ControllerRevisions of your SidecarSet. Moreover, the ControllerRevision name of current SidecarSet revision is shown in `status.latestRevision` field, so you can record it very easily.** #### select revision via ControllerRevision name ```yaml