Skip to content

Commit

Permalink
doc: update keep_original_source docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tchiotludo committed Sep 5, 2023
1 parent e0fff3d commit 4e7a716
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ data "kestra_flow" "example" {

### Optional

- `keep_original_source` (Boolean) Use the content as source code, keeping comment and indentation. Defaults to `false`.
- `keep_original_source` (Boolean) Use the content as source code, keeping comment and indentation. Defaults to `true`.

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/working-with-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Most of kestra ressource need to be described as Yaml like [kestra_flow](../reso
We have chosen to use a full yaml in terraform definition since the structure is recursive and dynamic, so it can't be described using terraform internal schema.

There is 2 ways (for flow) to handle yaml:
* use `keep_original_source = true` method: the raw yaml will be send and save in Kestra.
* use `keep_original_source = false` method: the default one (due to BC change), the yaml will be encoded in json before behind to the server, so comment and indent will be handle by the server
* use `keep_original_source = true` method: the default one, the raw yaml will be send and save in Kestra.
* use `keep_original_source = false` method: the yaml will be encoded in json before behind to the server, so comment and indent will be handle by the server

!> Take care with `keep_original_source = false` that this terraform provider is not aware of task & plugins. It can't know default values of properties, and most of convertion logic done by Kestra Server. If you see diff that **is always present** (even just after apply), your flow on terraform must have a minor difference return from the server. In this case, **copy the source from Kestra UI** in your terraform files to avoid these difference.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ EOT

### Optional

- `keep_original_source` (Boolean) Use the content as source code, keeping comment and indentation. Defaults to `false`.
- `keep_original_source` (Boolean) Use the content as source code, keeping comment and indentation. Defaults to `true`.

### Read-Only

Expand Down

0 comments on commit 4e7a716

Please sign in to comment.