Skip to content

Add docs for k8s annotations #4673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ffjlabo merged 1 commit into from
Nov 14, 2023
Merged

Add docs for k8s annotations #4673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/content/en/docs-dev/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down