fix sidecarset ControllerRevision doc (#84)

Signed-off-by: Reason94 <ruisen_liu@163.com>

Signed-off-by: Reason94 <ruisen_liu@163.com>
This commit is contained in:
Reason94 2022-12-06 15:50:57 +08:00 committed by GitHub
parent 2d9298d787
commit 5412255d50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 11 additions and 11 deletions

View File

@ -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. 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.** **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=<your-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=<your-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. 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: There are two configuration methods as follows:

View File

@ -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 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 OpenKruiseEnable: TemplateNoDefaults #### Install OpenKruiseEnable: 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: Therefore, when installing openkruise, you need to open gates **TemplateNoDefaults**, as follows:
``` ```
# Firstly add openkruise charts repository if you haven't do this. # Firstly add openkruise charts repository if you haven't do this.
$ helm repo add openkruise https://openkruise.github.io/charts/ $ helm repo add openkruise https://openkruise.github.io/charts/

View File

@ -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. 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=<your-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=<your-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 #### select revision via ControllerRevision name
```yaml ```yaml

View File

@ -103,7 +103,7 @@ status:
SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本,并允许用户在 Pod 创建时选择特定的历史版本进行注入。 SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本,并允许用户在 Pod 创建时选择特定的历史版本进行注入。
基于这一特性,用户可以规避在 SidecarSet 灰度发布时因Deployment 等 Workload 扩容、升级等操作带来的 SidecarSet 发布风险。如果不选择注入版本SidecarSet 将对重建 Pod 默认全都注入最新版本 Sidecar。 基于这一特性,用户可以规避在 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 名称,以方便自行记录。 此外,用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称,以方便自行记录。
#### 通过 ControllerRevision 名称指定注入的 Sidecar 版本 #### 通过 ControllerRevision 名称指定注入的 Sidecar 版本

View File

@ -216,7 +216,7 @@ spec:
SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本,并允许用户在 Pod 创建时选择特定的历史版本进行注入。 SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本,并允许用户在 Pod 创建时选择特定的历史版本进行注入。
基于这一特性,用户可以规避在 SidecarSet 灰度发布时因Deployment 等 Workload 扩容、升级等操作带来的 SidecarSet 发布风险。如果不选择注入版本SidecarSet 将对重建 Pod 默认全都注入最新版本 Sidecar。 基于这一特性,用户可以规避在 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 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称,以方便自行记录。** **注SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中,用户可以使用 `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=<your-sidecarset-name>` 来查看。此外,用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称,以方便自行记录。**
#### 通过 ControllerRevision 名称指定注入的 Sidecar 版本 #### 通过 ControllerRevision 名称指定注入的 Sidecar 版本
```yaml ```yaml

View File

@ -216,7 +216,7 @@ spec:
SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本,并允许用户在 Pod 创建时选择特定的历史版本进行注入。 SidecarSet 通过 ControllerRevision 记录了关于 `containers`、`volumes`、`initContainers`、`imagePullSecrets` 和 `patchPodMetadata` 等字段的历史版本,并允许用户在 Pod 创建时选择特定的历史版本进行注入。
基于这一特性,用户可以规避在 SidecarSet 灰度发布时因Deployment 等 Workload 扩容、升级等操作带来的 SidecarSet 发布风险。如果不选择注入版本SidecarSet 将对重建 Pod 默认全都注入最新版本 Sidecar。 基于这一特性,用户可以规避在 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 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称,以方便自行记录。** **注SidecarSet 相关 ControllerRevision 资源被放置在了与 Kruise-Manager 相同的命名空间中,用户可以使用 `kubectl get controllerrevisions -n kruise-system -l kruise.io/sidecarset-name=<your-sidecarset-name>` 来查看。此外,用户还可以通过 SidecarSet 的 `status.latestRevision` 字段看到当前版本对应的 ControllerRevision 名称,以方便自行记录。**
#### 通过 ControllerRevision 名称指定注入的 Sidecar 版本 #### 通过 ControllerRevision 名称指定注入的 Sidecar 版本
```yaml ```yaml

View File

@ -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 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 OpenKruiseEnable: TemplateNoDefaults #### Install OpenKruiseEnable: 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: Therefore, when installing openkruise, you need to open gates **TemplateNoDefaults**, as follows:
``` ```
# Firstly add openkruise charts repository if you haven't do this. # Firstly add openkruise charts repository if you haven't do this.
$ helm repo add openkruise https://openkruise.github.io/charts/ $ helm repo add openkruise https://openkruise.github.io/charts/

View File

@ -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 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 OpenKruiseEnable: TemplateNoDefaults #### Install OpenKruiseEnable: 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: Therefore, when installing openkruse, you need to open gates **TemplateNoDefaults**, as follows:
``` ```
# Firstly add openkruise charts repository if you haven't do this. # Firstly add openkruise charts repository if you haven't do this.

View File

@ -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. 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=<your-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=<your-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 #### select revision via ControllerRevision name
```yaml ```yaml