Skip to content
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

[docs] Add notes about drift detection #5120

Merged
merged 6 commits into from
Aug 19, 2024
Merged

[docs] Add notes about drift detection #5120

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8286365
add note: `ignoreFields` is available for only K8sApp
t-kikuc Aug 8, 2024
7ed87bc
add prerequisites: OnOutOfSync.disabled=false
t-kikuc Aug 8, 2024
e4d9e4c
fix duplicated
t-kikuc Aug 8, 2024
2f0785b
fix default
t-kikuc Aug 8, 2024
a25e438
link to `trigger-configuration`
t-kikuc Aug 8, 2024
7b6dba3
fix
t-kikuc Aug 8, 2024
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
2 changes: 1 addition & 1 deletion 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 @@ -807,7 +807,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c

| Field | Type | Description | Required |
|-|-|-|-|
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`. | No |

## PipeCD rich defined types

Expand Down
2 changes: 2 additions & 0 deletions ...nt/en/docs-dev/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be a note and place under L57

This feature is automatically enabled for all applications.

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's an easier to read flow

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, i fixed 7b6dba3


You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

### Ignore drift detection for specific fields
Expand Down
2 changes: 2 additions & 0 deletions ...n/docs-v0.39.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,6 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
2 changes: 2 additions & 0 deletions ...n/docs-v0.40.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,6 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
2 changes: 2 additions & 0 deletions ...n/docs-v0.41.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,6 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
2 changes: 2 additions & 0 deletions ...n/docs-v0.42.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,6 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
2 changes: 1 addition & 1 deletion docs/content/en/docs-v0.43.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,7 +661,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c

| Field | Type | Description | Required |
|-|-|-|-|
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |

## PipeCD rich defined types

Expand Down
2 changes: 2 additions & 0 deletions ...n/docs-v0.43.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

### Ignore drift detection for specific fields
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs-v0.44.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c

| Field | Type | Description | Required |
|-|-|-|-|
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |

## PipeCD rich defined types

Expand Down
2 changes: 2 additions & 0 deletions ...n/docs-v0.44.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

### Ignore drift detection for specific fields
Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -703,7 +703,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c

| Field | Type | Description | Required |
|-|-|-|-|
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |

## PipeCD rich defined types

Expand Down
2 changes: 2 additions & 0 deletions ...n/docs-v0.45.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

### Ignore drift detection for specific fields
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -771,7 +771,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c

| Field | Type | Description | Required |
|-|-|-|-|
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |

## PipeCD rich defined types

Expand Down
2 changes: 2 additions & 0 deletions ...n/docs-v0.46.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

### Ignore drift detection for specific fields
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c

| Field | Type | Description | Required |
|-|-|-|-|
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |

## PipeCD rich defined types

Expand Down
2 changes: 2 additions & 0 deletions ...n/docs-v0.47.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

### Ignore drift detection for specific fields
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs-v0.48.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c

| Field | Type | Description | Required |
|-|-|-|-|
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |

## PipeCD rich defined types

Expand Down
2 changes: 2 additions & 0 deletions ...n/docs-v0.48.x/user-guide/managing-application/configuration-drift-detection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ This status means the application is deploying and the configuration drift detec

This feature is automatically enabled for all applications.

If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).

You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.

### Ignore drift detection for specific fields
Expand Down
Loading