Add docs for k8s annotations

Signed-off-by: Yoshiki Fujikane <[email protected]>
pipe-cd · Nov 14, 2023 · 3d84794 · 3d84794
1 parent 99509fd
commit 3d84794
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/content/en/docs-dev/user-guide/configuration-reference.md b/docs/content/en/docs-dev/user-guide/configuration-reference.md
@@ -40,6 +40,14 @@ spec:
 | eventWatcher | [][EventWatcher](#eventwatcher) | List of configurations for event watcher. | No |
 | driftDetection | [DriftDetection](#driftdetection) | Configuration for drift detection. | No |
 
+### Annotations
+
+Kubernetes resources can be managed by some annotations provided by PipeCD.
+
+| Annotation key | Target resource(es) | Possible values | Description |
+| `pipecd.dev/ignore-drift-detection` | any | "true" | Whether the drift detection should ignore this resource. |
+| `pipecd.dev/server-side-apply` | any | "true" | Use server side apply instead of client side apply. |
+
 ## Terraform application
 
 ``` yaml

diff --git a/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md
@@ -40,6 +40,14 @@ spec:
 | eventWatcher | [][EventWatcher](#eventwatcher) | List of configurations for event watcher. | No |
 | driftDetection | [DriftDetection](#driftdetection) | Configuration for drift detection. | No |
 
+### Annotations
+
+Kubernetes resources can be managed by some annotations provided by PipeCD.
+
+| Annotation key | Target resource(es) | Possible values | Description |
+| `pipecd.dev/ignore-drift-detection` | any | "true" | Whether the drift detection should ignore this resource. |
+| `pipecd.dev/server-side-apply` | any | "true" | Use server side apply instead of client side apply. |
+
 ## Terraform application
 
 ``` yaml