Gitops product crd #1001

NimRegev · 2024-06-27T12:15:21Z

No description provided.

Added first draft of sample CRD with field descriptions

Removed Promotion template CRD

Updated field descriptions

Completed field descriptions

Fixed html syntax and tags

_docs/promotions/product-crd.md

oleksandr-codefresh · 2024-06-27T14:22:30Z

_docs/promotions/product-crd.md

+            <li><code class="highlighter-rouge">.versionSource.jsonPath</code>: The JSON path expression pointing to the location of the attribute containing the application version within the specified <code class="highlighter-rouge">.file</code>.<br>For example, <code class="highlighter-rouge">$.appVersion</code> indicates the value should be extracted from the field <code class="highlighter-rouge">.appVersion</code> in <code class="highlighter-rouge">chart.yaml</code></li>
+          </ul>
+        </li>
+        <li><code class="highlighter-rouge">.promotion</code>: The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of <code class="highlighter-rouge">&lt;filename&gt;:jsonPaths</code>.<br><code class="highlighter-rouge">jsonPaths</code> can define the path to single or multiple attributes within the same file.<br>If <code class="highlighter-rouge">versionSource</code> is not defined, it must include at least one file and its JSON path containing the product's release version to extract.<br>When empty, <em>all</em> changes in <em>all</em> applications connected to the Product are promoted.<br><br>Examples:<ul><li>Extract <code class="highlighter-rouge">name</code> attribute from <code class="highlighter-rouge">chart.yaml</code><br>JSON path: <code class="highlighter-rouge">$.name</code></li><li>Extract all properties of the <code class="highlighter-rouge">dependencies</code> object from <code class="highlighter-rouge">chart.yaml</code><br>JSON path: <code class="highlighter-rouge">$..dependencies.*</code></li><li>Extract the <code class="highlighter-rouge">repository</code> property from the <code class="highlighter-rouge">image</code> object in <code class="highlighter-rouge">values.yaml</code><br>JSON path: <code class="highlighter-rouge">$..image.repository</code></li>


If versionSource is not defined, it must include at least one file and its JSON path containing the product's release version to extract. - I don't know such behaviour, did you ask someone of devs ?

this may have changed; it was the behavior when i documented the first version of Promotion Template CRD - reviewed and approved by Noam. Will clarify

_docs/promotions/product-crd.md

oleksandr-codefresh · 2024-06-27T14:26:30Z

_docs/promotions/product-crd.md

+    <td>The top-level element defining one or more Promotion Flows to orchestrate the product's promotion from the trigger environment, across all the target environments to the final target environment.<br>When there is more than one Promotion Flow, the first one in the list that matches the product is executed.
+      <ul>
+         <li><code class="highlighter-rouge">.promotionFlows.name</code>: The name of the Promotion Flow to execute.</li>
+         <li><code class="highlighter-rouge">.promotionFlows.gitTriggerSelectors</code>: The criteria or conditions to trigger the Promotion Flow, evaluated according to the payload from the application's Git repository.<br>You can have more than one <code class="highlighter-rouge">gitTriggerSelector</code> for the same Promotion Flow. In such cases, the conditions are matched according to the <code class="highlighter-rouge">key</code>, <code class="highlighter-rouge">operator</code>, and <code class="highlighter-rouge">values</code> fields.<br><ul><li><code class="highlighter-rouge">key</code>: The specific attribute from the Git payload to evaluate, and can be one of the following:<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided. </li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul></li><li><code class="highlighter-rouge">operator</code>: The operator to apply when matching the <code class="highlighter-rouge">key</code>, and can be one of the following:<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision <em>includes</em> the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match. If asterisks are used as wildcards, it can also perform partial matches.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision <em>does not include</em> the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list.<br>The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, and by partial match when asterisks are used as wildcards.</li></ul></li><li><code class="highlighter-rouge">values</code>: Single or list of comma-separated values used to match or exclude Promotion Flows based on criteria defined by the operator. The values can be strings, numbers, or other data types depending on the context.</li></ul><br>Examples:


Trigger the Promotion Flow based on the git branch / tag.

Added promotion template CRD and updated nav yaml

Updated product and promotion template

ATGardner · 2024-07-01T12:30:08Z

_docs/promotions/promotion-template-crd.md

+
+{: .table .table-bordered .table-hover}
+| Field            | Description                                            | Type  |  Required/Optional|
+| `metadata.name`  | The name of the Promotion Template, which can correspond to the name of the Product, or any other meaningful identifier.|Optional|


the "type" should be "string".
and the name is "required", and not "optional"

ATGardner · 2024-07-01T12:35:03Z

_docs/promotions/promotion-template-crd.md

+|       | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |
+|       | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |


Suggested change

| | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |

| | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |

| `spec.versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |

| `spec.versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |

ATGardner · 2024-07-01T12:36:29Z

_docs/promotions/promotion-template-crd.md

+|  `spec.versionSource`      |  The location of the file and the attribute from which to extract the product's application release version. This is the version displayed in the Products and Environments dashboards.|   |Required | 
+|       | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |
+|       | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |
+|`spec.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`.<br>`jsonPaths` can define the path to a single or multiple attributes within the same file. <br>When omitted, *all* changes in *all* applications connected to the Product are promoted.<br><br>Examples:<ul><li>Extract `name` attribute from `chart.yaml`<br>JSON path: `$.name`</li><li>Extract all properties of the `dependencies` object from `chart.yaml`<br>JSON path: `$..dependencies.*`</li><li>Extract the `repository` property from the `image` object in `values.yaml`<br>JSON path: `$..image.repository`</li></ul></ul> |array | Optional |


Suggested change

|`spec.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`. `jsonPaths` can define the path to a single or multiple attributes within the same file. When omitted, *all* changes in *all* applications connected to the Product are promoted. Examples:<ul><li>Extract `name` attribute from `chart.yaml` JSON path: `$.name`</li><li>Extract all properties of the `dependencies` object from `chart.yaml` JSON path: `$..dependencies.*`</li><li>Extract the `repository` property from the `image` object in `values.yaml` JSON path: `$..image.repository`</li></ul></ul> |array | Optional |

|`spec.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through an array of one or more `<filename>:jsonPaths`. `jsonPaths` can define the path to a single or multiple attributes within the same file. When omitted, *all* changes in *all* applications connected to the Product are promoted. Examples:<ul><li>Extract `name` attribute from `chart.yaml` JSON path: `$.name`</li><li>Extract all properties of the `dependencies` object from `chart.yaml` JSON path: `$..dependencies.*`</li><li>Extract the `repository` property from the `image` object in `values.yaml` JSON path: `$..image.repository`</li></ul></ul> |array | Optional |

also, the html
does not seem to render correctly in the browser

ATGardner · 2024-07-01T12:37:14Z

_docs/promotions/promotion-template-crd.md

+|       | `promotion.filename`: The file path relative to the application's file path from which to select properties to promote.  | string | Optional |
+|       | `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |


Suggested change

| | `promotion.filename`: The file path relative to the application's file path from which to select properties to promote. | string | Optional |

| | `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |

| `spec.promotion.filename`: The file path relative to the application's file path from which to select properties to promote. | string | Optional |

| `spec.promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |

ATGardner · 2024-07-01T12:37:53Z

_docs/promotions/product-crd.md

+|       | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |
+|       | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |


Suggested change

| | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |

| | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |

| `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |

| `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |

ATGardner · 2024-07-01T12:38:08Z

_docs/promotions/product-crd.md

+|       | `promotion.filename`: The file path relative to the application's file path from which to select properties to promote.  | string | Optional |
+|       | `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |


Suggested change

| | `promotion.filename`: The file path relative to the application's file path from which to select properties to promote. | string | Optional |

| | `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |

| `spec.promotionTemplate.promotion.filename`: The file path relative to the application's file path from which to select properties to promote. | string | Optional |

| `spec.promotionTemplate.promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |

ATGardner · 2024-07-01T12:38:23Z

_docs/promotions/product-crd.md

+|     | `gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} |    |     |
+|     | `gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision <i>does not include</i> the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list.<br>The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} |  |  |


Suggested change

| | `gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} | | |

| | `gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision includes the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision does not include the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list. The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} | | |

| `gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} | | |

| `gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision includes the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision does not include the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list. The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} | | |

ATGardner · 2024-07-01T12:40:18Z

_docs/promotions/product-crd.md

+|  `.promotionTemplate.versionSource`      |  The location of the file and the attribute from which to extract the product's application release version. This is the version displayed in the Products and Environments dashboards.| |Optional | 
+|       | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |
+|       | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |


Suggested change

| `.promotionTemplate.versionSource` | The location of the file and the attribute from which to extract the product's application release version. This is the version displayed in the Products and Environments dashboards.| |Optional |

| | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |

| | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |

| `spec.promotionTemplate.versionSource` | The location of the file and the attribute from which to extract the product's application release version. This is the version displayed in the Products and Environments dashboards.| |Optional |

| `spec.promotionTemplate.versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |

| `spec.promotionTemplate.versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |

ATGardner · 2024-07-01T12:41:15Z

_docs/promotions/product-crd.md

+|  `.promotionTemplate.versionSource`      |  The location of the file and the attribute from which to extract the product's application release version. This is the version displayed in the Products and Environments dashboards.| |Optional | 
+|       | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |
+|       | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |
+|`.promotionTemplate.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`.<br>`jsonPaths` can define the path to single or multiple attributes within the same file. <br>When omitted, *all* changes in *all* applications connected to the Product are promoted. |array | Optional |


Suggested change

|`.promotionTemplate.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`. `jsonPaths` can define the path to single or multiple attributes within the same file. When omitted, *all* changes in *all* applications connected to the Product are promoted. |array | Optional |

|`spec.promotionTemplate.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`. `jsonPaths` can define the path to single or multiple attributes within the same file. When omitted, *all* changes in *all* applications connected to the Product are promoted. |array | Optional |

ATGardner · 2024-07-01T12:42:22Z

_docs/promotions/product-crd.md

+| `promotionFlows.gitTriggerSelectors`   |The criteria or conditions to trigger the Promotion Flow, evaluated according to the payload from the application's Git repository.<br>You can have more than one `gitTriggerSelector` for the same Promotion Flow. In such cases, the conditions are matched according to the `key`, `operator`, and `values` fields.
+|     | `gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} |    |     |
+|     | `gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision <i>does not include</i> the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list.<br>The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} |  |  |


Suggested change

| `promotionFlows.gitTriggerSelectors` |The criteria or conditions to trigger the Promotion Flow, evaluated according to the payload from the application's Git repository. You can have more than one `gitTriggerSelector` for the same Promotion Flow. In such cases, the conditions are matched according to the `key`, `operator`, and `values` fields.

| | `gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} | | |

| | `gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision includes the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision does not include the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list. The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} | | |

| `spec.promotionFlows.gitTriggerSelectors` |The criteria or conditions to trigger the Promotion Flow, evaluated according to the payload from the application's Git repository. You can have more than one `gitTriggerSelector` for the same Promotion Flow. In such cases, the conditions are matched according to the `key`, `operator`, and `values` fields.

| `spec.promotionFlows.gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} | | |

| `spec.promotionFlows.gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision includes the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision does not include the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list. The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} | | |

ATGardner · 2024-07-01T12:42:34Z

_docs/promotions/product-crd.md

+| `promotionFlows.gitTriggerSelectors`   |The criteria or conditions to trigger the Promotion Flow, evaluated according to the payload from the application's Git repository.<br>You can have more than one `gitTriggerSelector` for the same Promotion Flow. In such cases, the conditions are matched according to the `key`, `operator`, and `values` fields.
+|     | `gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} |    |     |
+|     | `gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision <i>does not include</i> the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list.<br>The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} |  |  |
+|  |`gitTriggerSelector.values`: Single or list of comma-separated values used to match or exclude Promotion Flows based on criteria defined by the operator. The values can be strings, numbers, or other data types depending on the context.|  |  |


Suggested change

| |`gitTriggerSelector.values`: Single or list of comma-separated values used to match or exclude Promotion Flows based on criteria defined by the operator. The values can be strings, numbers, or other data types depending on the context.| | |

|`spec.promotionFlows.gitTriggerSelector.values`: Single or list of comma-separated values used to match or exclude Promotion Flows based on criteria defined by the operator. The values can be strings, numbers, or other data types depending on the context.| | |

ATGardner · 2024-07-01T12:42:54Z

_docs/promotions/promotion-template-crd.md

+| Field            | Description                                            | Type  |  Required/Optional|
+| `metadata.name`  | The name of the Promotion Template, which can correspond to the name of the Product, or any other meaningful identifier.|Optional|
+| `spec.applicationSourceSelector`  | The label used to match the application to which to apply the Promotion Template. Application selectors conform to Kubernetes _label selectors_, defined as `matchLabels` with `key-value` pairs, `matchExpressions` with `key-operator-value` arrays, or a combination of both. The values identify all the Promotion Template manifests that match the specific application or applications within the target environment.|  | Required|
+| `.applicationSourceSelector.matchLabels`         | One or more `key-value` pairs. <br>For example:{::nomarkdown}<ul><li><code class="highlighter-rouge">codefresh.io/environment: production</code> applies the Promotion Template to all applications within the Production Environment.</li><li><code class="highlighter-rouge">codefresh.io/product: loans</code> applies the Promotion Template only to applications belonging to the Loans Product.</li></ul>{:/}| object  | Optional |


Suggested change

| `.applicationSourceSelector.matchLabels` | One or more `key-value` pairs. For example:{::nomarkdown}<ul><li><code class="highlighter-rouge">codefresh.io/environment: production</code> applies the Promotion Template to all applications within the Production Environment.</li><li><code class="highlighter-rouge">codefresh.io/product: loans</code> applies the Promotion Template only to applications belonging to the Loans Product.</li></ul>{:/}| object | Optional |

| `spec.applicationSourceSelector.matchLabels` | One or more `key-value` pairs. For example:{::nomarkdown}<ul><li><code class="highlighter-rouge">codefresh.io/environment: production</code> applies the Promotion Template to all applications within the Production Environment.</li><li><code class="highlighter-rouge">codefresh.io/product: loans</code> applies the Promotion Template only to applications belonging to the Loans Product.</li></ul>{:/}| object | Optional |

ATGardner · 2024-07-01T12:43:08Z

_docs/promotions/promotion-template-crd.md

+| `metadata.name`  | The name of the Promotion Template, which can correspond to the name of the Product, or any other meaningful identifier.|Optional|
+| `spec.applicationSourceSelector`  | The label used to match the application to which to apply the Promotion Template. Application selectors conform to Kubernetes _label selectors_, defined as `matchLabels` with `key-value` pairs, `matchExpressions` with `key-operator-value` arrays, or a combination of both. The values identify all the Promotion Template manifests that match the specific application or applications within the target environment.|  | Required|
+| `.applicationSourceSelector.matchLabels`         | One or more `key-value` pairs. <br>For example:{::nomarkdown}<ul><li><code class="highlighter-rouge">codefresh.io/environment: production</code> applies the Promotion Template to all applications within the Production Environment.</li><li><code class="highlighter-rouge">codefresh.io/product: loans</code> applies the Promotion Template only to applications belonging to the Loans Product.</li></ul>{:/}| object  | Optional |
+| `.applicationSourceSelector.matchExpressions`         | List of expressions, each with a `key`, an `operator`, and a set of `values`. <br>The `operator` defines the relationship between the `key` and its `values`, and can be one of the following: {::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: The value _must match_ one of those specified in the <code class="highlighter-rouge">values</code> array.</li> <li><code class="highlighter-rouge">NotIn</code>: The value _must NOT match_ any of  those in the <code class="highlighter-rouge">values</code> array.</li><li><code class="highlighter-rouge">Exists</code>: Only the <code class="highlighter-rouge">key</code> must exist regardless of its values.<br>The <code class="highlighter-rouge">values</code> array must be empty. </li><li><code class="highlighter-rouge">DoesNotExist</code>: The <code class="highlighter-rouge">key</code> must not exist.<br>The <code class="highlighter-rouge">values</code> array must be empty.</li></ul>{:/}For example:<br>`key: codefresh.io/product` and `operator: Exists` applies the Promotion Template to any application containing the label `codefresh.io/product`.| string  | Optional |


Suggested change

| `.applicationSourceSelector.matchExpressions` | List of expressions, each with a `key`, an `operator`, and a set of `values`. The `operator` defines the relationship between the `key` and its `values`, and can be one of the following: {::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: The value _must match_ one of those specified in the <code class="highlighter-rouge">values</code> array.</li> <li><code class="highlighter-rouge">NotIn</code>: The value _must NOT match_ any of those in the <code class="highlighter-rouge">values</code> array.</li><li><code class="highlighter-rouge">Exists</code>: Only the <code class="highlighter-rouge">key</code> must exist regardless of its values. The <code class="highlighter-rouge">values</code> array must be empty. </li><li><code class="highlighter-rouge">DoesNotExist</code>: The <code class="highlighter-rouge">key</code> must not exist. The <code class="highlighter-rouge">values</code> array must be empty.</li></ul>{:/}For example: `key: codefresh.io/product` and `operator: Exists` applies the Promotion Template to any application containing the label `codefresh.io/product`.| string | Optional |

| `spec.applicationSourceSelector.matchExpressions` | List of expressions, each with a `key`, an `operator`, and a set of `values`. The `operator` defines the relationship between the `key` and its `values`, and can be one of the following: {::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: The value _must match_ one of those specified in the <code class="highlighter-rouge">values</code> array.</li> <li><code class="highlighter-rouge">NotIn</code>: The value _must NOT match_ any of those in the <code class="highlighter-rouge">values</code> array.</li><li><code class="highlighter-rouge">Exists</code>: Only the <code class="highlighter-rouge">key</code> must exist regardless of its values. The <code class="highlighter-rouge">values</code> array must be empty. </li><li><code class="highlighter-rouge">DoesNotExist</code>: The <code class="highlighter-rouge">key</code> must not exist. The <code class="highlighter-rouge">values</code> array must be empty.</li></ul>{:/}For example: `key: codefresh.io/product` and `operator: Exists` applies the Promotion Template to any application containing the label `codefresh.io/product`.| string | Optional |

ATGardner · 2024-07-01T12:43:46Z

_docs/promotions/promotion-template-crd.md

+|       | `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.| string | Required |
+|       | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |
+|`spec.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`.<br>`jsonPaths` can define the path to a single or multiple attributes within the same file. <br>When omitted, *all* changes in *all* applications connected to the Product are promoted.<br><br>Examples:<ul><li>Extract `name` attribute from `chart.yaml`<br>JSON path: `$.name`</li><li>Extract all properties of the `dependencies` object from `chart.yaml`<br>JSON path: `$..dependencies.*`</li><li>Extract the `repository` property from the `image` object in `values.yaml`<br>JSON path: `$..image.repository`</li></ul></ul> |array | Optional |
+|       | `promotion.filename`: The file path relative to the application's file path from which to select properties to promote.  | string | Optional |


Suggested change

| | `promotion.filename`: The file path relative to the application's file path from which to select properties to promote. | string | Optional |

| | `spec.promotion.filename`: The file path relative to the application's file path from which to select properties to promote. | string | Optional |

ATGardner · 2024-07-01T12:44:00Z

_docs/promotions/promotion-template-crd.md

+|       | `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Required |
+|`spec.promotion`| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`.<br>`jsonPaths` can define the path to a single or multiple attributes within the same file. <br>When omitted, *all* changes in *all* applications connected to the Product are promoted.<br><br>Examples:<ul><li>Extract `name` attribute from `chart.yaml`<br>JSON path: `$.name`</li><li>Extract all properties of the `dependencies` object from `chart.yaml`<br>JSON path: `$..dependencies.*`</li><li>Extract the `repository` property from the `image` object in `values.yaml`<br>JSON path: `$..image.repository`</li></ul></ul> |array | Optional |
+|       | `promotion.filename`: The file path relative to the application's file path from which to select properties to promote.  | string | Optional |
+|       | `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |


Suggested change

| | `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |

| `spec.promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`. For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.| string| Optional |

ATGardner · 2024-07-01T12:44:58Z

_data/nav.yml

+      url: "/promotion-template-crd"
+    - title: Promotion Flow CRD
+      url: "/promotion-flow-crd"
+    - title: Promotion Flow CRD


Suggested change

- title: Promotion Flow CRD

- title: Promotion Policy CRD

ATGardner · 2024-07-01T12:45:56Z

_docs/promotions/promotion-flow-crd.md

+|          |`steps[].environment`: The name of the specific environment for which to trigger the promotion.   | string | Required         |
+|          | `steps[].dependsOn`: One or more environments that must be successfully promoted before this step can be triggered.   | array  | Required |


Removed app selector and priority from template CRD, and product.tags from policy CRD

codefresh-git-integration · 2024-07-17T06:53:32Z

"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-product-crd/docs/"

denis-codefresh · 2024-08-16T11:58:03Z

_docs/promotions/promotion-policy-crd.md

+```
+
+
+## Promotion Policy CRD field descriptions


Table layout is broken. 2 empty columns at the end.
Also some of the values are not in correct columns.

_docs/promotions/promotion-policy-crd.md

Implemented review comments from Denis for PP CRD; added related article links to all CRDs

codefresh-git-integration · 2024-08-21T06:59:47Z

"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-product-crd/docs/"

codefresh-git-integration · 2024-08-21T07:56:24Z

"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-product-crd/docs/"

Fixed table syntax

codefresh-git-integration · 2024-08-21T08:22:31Z

"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-product-crd/docs/"

codefresh-git-integration · 2024-08-21T08:39:22Z

"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-product-crd/docs/"

NimRegev added 8 commits June 24, 2024 16:26

Create product-crd.md

db45e25

Added first draft of sample CRD with field descriptions

Update product-crd.md

548c267

Removed Promotion template CRD

Update product-crd.md

6fb48da

Updated field descriptions

Update product-crd.md

4366329

Completed field descriptions

Update product-crd.md

ce4fa6b

Fixed html syntax and tags

Update product-crd.md

4586c33

Add product crd entry to nav yaml

9ca1689

Update nav.yml

3254d7d

oleksandr-codefresh reviewed Jun 27, 2024

View reviewed changes

_docs/promotions/product-crd.md Outdated Show resolved Hide resolved

oleksandr-codefresh reviewed Jun 27, 2024

View reviewed changes

_docs/promotions/product-crd.md Show resolved Hide resolved

oleksandr-codefresh reviewed Jun 27, 2024

View reviewed changes

_docs/promotions/product-crd.md Show resolved Hide resolved

oleksandr-codefresh reviewed Jun 27, 2024

View reviewed changes

_docs/promotions/product-crd.md Outdated Show resolved Hide resolved

oleksandr-codefresh reviewed Jun 27, 2024

View reviewed changes

_docs/promotions/product-crd.md Outdated Show resolved Hide resolved

oleksandr-codefresh reviewed Jun 27, 2024

View reviewed changes

_docs/promotions/product-crd.md Outdated Show resolved Hide resolved

oleksandr-codefresh reviewed Jun 27, 2024

View reviewed changes

NimRegev added 7 commits June 30, 2024 08:21

Create promotion-policy.md

c1e792c

Update product-crd.md

9234c1b

Update product-crd.md

0ab1b9a

Create promotion-flow.md

501a393

Add promotion template CRD

fd1b3e8

Added promotion template CRD and updated nav yaml

Update product CRD

ca165bb

Update CRDs

6fce760

Updated product and promotion template

ATGardner reviewed Jul 1, 2024

View reviewed changes

NimRegev added 7 commits July 1, 2024 16:17

Update product-crd.md

deecc34

Update product-crd.md

74a5147

Update CRD content

4217927

Update nav.yml

c61a208

Update promotion-policy-crd.md

8e194e2

Update promotion-policy-crd.md

56fe3cc

Update policy & template CRDs

9debe04

Removed app selector and priority from template CRD, and product.tags from policy CRD

denis-codefresh reviewed Aug 16, 2024

View reviewed changes

denis-codefresh mentioned this pull request Aug 16, 2024

Gitops promotion policy #1019

Closed

Update promotion policy CRD

a749bc3

Implemented review comments from Denis for PP CRD; added related article links to all CRDs

NimRegev requested a review from lukasmagik as a code owner August 21, 2024 06:54

Update promotion-policy-crd.md

3850a28

Update promotion-policy-crd.md

5d57b5a

Fixed table syntax

Update promotion-policy-crd.md

2cea5b5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Gitops product crd #1001

Gitops product crd #1001

NimRegev commented Jun 27, 2024

oleksandr-codefresh Jun 27, 2024 •

edited

Loading

NimRegev Jun 30, 2024

oleksandr-codefresh Jun 27, 2024 •

edited

Loading

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024 •

edited

Loading

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024 •

edited

Loading

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024 •

edited

Loading

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024 •

edited

Loading

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

ATGardner Jul 1, 2024

codefresh-git-integration bot commented Jul 17, 2024

denis-codefresh Aug 16, 2024

codefresh-git-integration bot commented Aug 21, 2024

codefresh-git-integration bot commented Aug 21, 2024

codefresh-git-integration bot commented Aug 21, 2024

codefresh-git-integration bot commented Aug 21, 2024

	\| `metadata.name` \| The name of the Promotion Template, which can correspond to the name of the Product, or any other meaningful identifier.\|Optional\|
	\| `metadata.name` \| The name of the Promotion Template, which can correspond to the name of the Product, or any other meaningful identifier.\|string\|Reruied\|

		\| \| `versionSource.file`: The file path relative to the application's file path from which to extract the application's release version. For example, `chart.yaml` indicates that the release version should be extracted from this file.\| string \| Required \|
		\| \| `versionSource.jsonPath`: The JSON path expression pointing to the location of the attribute containing the application version within the specified `file`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.\| string\| Required \|

		\| \| `promotion.filename`: The file path relative to the application's file path from which to select properties to promote. \| string \| Optional \|
		\| \| `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.\| string\| Optional \|

		\| \| `gitTriggerSelector.key`: The specific attribute from the Git payload to evaluate, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">commitMessage</code>: Trigger the Promotion Flow based on the text description associated with the commit message. The commit message is matched against the values provided.</li><li><code class="highlighter-rouge">gitRevision</code>: Trigger the Promotion Flow based on the commit hash generated by Git as a unique identifier for the commit. The commit hash is matched against the values provided.</li></ul>{:/} \| \| \|
		\| \| `gitTriggerSelector.operator`: The operator to apply when matching the `key`, and can be one of the following:{::nomarkdown}<ul><li><code class="highlighter-rouge">In</code>: Checks if the commit message or Git revision <i>includes</i> the specified value or any value within a set of values. The <code class="highlighter-rouge">In</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li><li><code class="highlighter-rouge">NotIn</code>: Checks if the commit message or Git revision <i>does not include</i> the specified value or any value within a set of values. Useful for excluding resources that match any value within a predefined list.<br>The <code class="highlighter-rouge">NotIn</code> operator matches values by exact match, or by partial match when asterisks are used as wildcards.</li></ul></li>{:/} \| \| \|

	\|`.promotionTemplate.promotion`\| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`.<br>`jsonPaths` can define the path to single or multiple attributes within the same file. <br>When omitted, all changes in all applications connected to the Product are promoted. \|array \| Optional \|
	\|`spec.promotionTemplate.promotion`\| The top-level element defining the specific changes to be promoted to the target environment, through a single or a list of `<filename>:jsonPaths`.<br>`jsonPaths` can define the path to single or multiple attributes within the same file. <br>When omitted, all changes in all applications connected to the Product are promoted. \|array \| Optional \|

	\| \|`gitTriggerSelector.values`: Single or list of comma-separated values used to match or exclude Promotion Flows based on criteria defined by the operator. The values can be strings, numbers, or other data types depending on the context.\| \| \|
	\|`spec.promotionFlows.gitTriggerSelector.values`: Single or list of comma-separated values used to match or exclude Promotion Flows based on criteria defined by the operator. The values can be strings, numbers, or other data types depending on the context.\| \| \|

	\| \| `promotion.filename`: The file path relative to the application's file path from which to select properties to promote. \| string \| Optional \|
	\| \| `spec.promotion.filename`: The file path relative to the application's file path from which to select properties to promote. \| string \| Optional \|

	\| \| `promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.\| string\| Optional \|
	\| `spec.promotion.jsonPath`: The JSON path expression pointing to the location of the attribute with the value to be promoted within the specified `filename`.<br>For example, `$.appVersion` indicates the value should be extracted from the field `appVersion` in `chart.yaml`.\| string\| Optional \|

		\| \|`steps[].environment`: The name of the specific environment for which to trigger the promotion. \| string \| Required \|
		\| \| `steps[].dependsOn`: One or more environments that must be successfully promoted before this step can be triggered. \| array \| Required \|

Gitops product crd #1001

Are you sure you want to change the base?

Gitops product crd #1001

Conversation

NimRegev commented Jun 27, 2024

oleksandr-codefresh Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oleksandr-codefresh Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ATGardner Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ATGardner Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ATGardner Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ATGardner Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codefresh-git-integration bot commented Jul 17, 2024

Choose a reason for hiding this comment

codefresh-git-integration bot commented Aug 21, 2024

codefresh-git-integration bot commented Aug 21, 2024

codefresh-git-integration bot commented Aug 21, 2024

codefresh-git-integration bot commented Aug 21, 2024

oleksandr-codefresh Jun 27, 2024 •

edited

Loading

oleksandr-codefresh Jun 27, 2024 •

edited

Loading

ATGardner Jul 1, 2024 •

edited

Loading

ATGardner Jul 1, 2024 •

edited

Loading

ATGardner Jul 1, 2024 •

edited

Loading

ATGardner Jul 1, 2024 •

edited

Loading