Skip to content

Commit

Permalink
[docs] Add notes about drift detection (#5120)
Browse files Browse the repository at this point in the history
* add note: `ignoreFields` is available for only K8sApp

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* add prerequisites:  OnOutOfSync.disabled=false

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix duplicated

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix default

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* link to `trigger-configuration`

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
  • Loading branch information
t-kikuc authored Aug 19, 2024
1 parent deecab6 commit 5c1c633
Show file tree
Hide file tree
Showing 18 changed files with 29 additions and 7 deletions.
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ 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).

### Ignore drift detection for specific fields

> Note: This feature is currently supported for only Kubernetes application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
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).
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
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).
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
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).
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
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).
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ 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).

### Ignore drift detection for specific fields

> Note: This feature is currently supported for only Kubernetes application.
Expand Down
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ 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).

### Ignore drift detection for specific fields

> Note: This feature is currently supported for only Kubernetes application.
Expand Down
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ 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).

### Ignore drift detection for specific fields

> Note: This feature is currently supported for only Kubernetes application.
Expand Down
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ 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).

### Ignore drift detection for specific fields

> Note: This feature is currently supported for only Kubernetes application.
Expand Down
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ 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).

### Ignore drift detection for specific fields

> Note: This feature is currently supported for only Kubernetes application.
Expand Down
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ 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).

### Ignore drift detection for specific fields

> Note: This feature is currently supported for only Kubernetes application.
Expand Down

0 comments on commit 5c1c633

Please sign in to comment.