From 318cca9d9e537214f739711ca27514b0da6216cd Mon Sep 17 00:00:00 2001 From: Yoshiki Fujikane <40124947+ffjlabo@users.noreply.github.com> Date: Tue, 14 Nov 2023 18:10:58 +0900 Subject: [PATCH] Add docs for k8s annotations (#4673) Signed-off-by: Yoshiki Fujikane --- .../en/docs-dev/user-guide/configuration-reference.md | 8 ++++++++ .../en/docs-v0.45.x/user-guide/configuration-reference.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/content/en/docs-dev/user-guide/configuration-reference.md b/docs/content/en/docs-dev/user-guide/configuration-reference.md index 6f94c24137..436c7ecbc1 100644 --- 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 index 2c04c5b50e..bd815274ac 100644 --- 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