docs: updated the docs

Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com>
zarf-dev · Mar 25, 2024 · 762be1c · 762be1c
1 parent 939f4e6
commit 762be1c
Show file tree

Hide file tree

Showing 2 changed files with 135 additions and 16 deletions.
diff --git a/docs/3-create-a-zarf-package/4-zarf-schema.md b/docs/3-create-a-zarf-package/4-zarf-schema.md
@@ -1185,6 +1185,91 @@ Must be one of:
 </blockquote>
 </details>
 
+<details open>
+<summary>
+<strong> <a name="components_items_charts_items_variables"></a>variables</strong>
+</summary>
+&nbsp;
+<blockquote>
+
+  ## components > charts > variables
+
+**Description:** List of variables to set in the Helm chart
+
+|          |         |
+| -------- | ------- |
+| **Type** | `array` |
+
+![Min Items: N/A](https://img.shields.io/badge/Min%20Items%3A%20N/A-gold)
+![Max Items: N/A](https://img.shields.io/badge/Max%20Items%3A%20N/A-gold)
+![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
+![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
+
+ ### <a name="autogenerated_heading_13"></a>ZarfChartVariable  
+
+|                           |                                                                                                          |
+| ------------------------- | -------------------------------------------------------------------------------------------------------- |
+| **Type**                  | `object`                                                                                                 |
+| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
+| **Defined in**            | #/definitions/ZarfChartVariable                                                                          |
+
+<details>
+<summary>
+<strong> <a name="components_items_charts_items_variables_items_name"></a>name *</strong>
+</summary>
+&nbsp;
+<blockquote>
+
+![Required](https://img.shields.io/badge/Required-red)
+
+**Description:** The name of the variable
+
+|          |          |
+| -------- | -------- |
+| **Type** | `string` |
+
+</blockquote>
+</details>
+
+<details>
+<summary>
+<strong> <a name="components_items_charts_items_variables_items_description"></a>description *</strong>
+</summary>
+&nbsp;
+<blockquote>
+
+![Required](https://img.shields.io/badge/Required-red)
+
+**Description:** A brief description of what the variable controls
+
+|          |          |
+| -------- | -------- |
+| **Type** | `string` |
+
+</blockquote>
+</details>
+
+<details>
+<summary>
+<strong> <a name="components_items_charts_items_variables_items_path"></a>path *</strong>
+</summary>
+&nbsp;
+<blockquote>
+
+![Required](https://img.shields.io/badge/Required-red)
+
+**Description:** The path within the Helm chart values where this variable applies
+
+|          |          |
+| -------- | -------- |
+| **Type** | `string` |
+
+</blockquote>
+</details>
+
+</blockquote>
+</details>
+
 </blockquote>
 </details>
 
@@ -1208,7 +1293,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_13"></a>ZarfDataInjection  
+ ### <a name="autogenerated_heading_14"></a>ZarfDataInjection  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -1371,7 +1456,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_14"></a>ZarfFile  
+ ### <a name="autogenerated_heading_15"></a>ZarfFile  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -1465,7 +1550,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_15"></a>symlinks items  
+ ### <a name="autogenerated_heading_16"></a>symlinks items  
 
 |          |          |
 | -------- | -------- |
@@ -1511,7 +1596,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_16"></a>images items  
+ ### <a name="autogenerated_heading_17"></a>images items  
 
 |          |          |
 | -------- | -------- |
@@ -1538,7 +1623,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_17"></a>repos items  
+ ### <a name="autogenerated_heading_18"></a>repos items  
 
 |          |          |
 | -------- | -------- |
@@ -1633,7 +1718,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_18"></a>valuesFiles items  
+ ### <a name="autogenerated_heading_19"></a>valuesFiles items  
 
 |          |          |
 | -------- | -------- |
@@ -1676,7 +1761,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_19"></a>fluxPatchFiles items  
+ ### <a name="autogenerated_heading_20"></a>fluxPatchFiles items  
 
 |          |          |
 | -------- | -------- |
@@ -1824,7 +1909,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_20"></a>env items  
+ ### <a name="autogenerated_heading_21"></a>env items  
 
 |          |          |
 | -------- | -------- |
@@ -1939,7 +2024,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_21"></a>ZarfComponentAction  
+ ### <a name="autogenerated_heading_22"></a>ZarfComponentAction  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -2029,7 +2114,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_22"></a>env items  
+ ### <a name="autogenerated_heading_23"></a>env items  
 
 |          |          |
 | -------- | -------- |
@@ -2094,7 +2179,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_23"></a>ZarfComponentActionSetVariable  
+ ### <a name="autogenerated_heading_24"></a>ZarfComponentActionSetVariable  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -2448,7 +2533,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_24"></a>ZarfComponentAction  
+ ### <a name="autogenerated_heading_25"></a>ZarfComponentAction  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -2479,7 +2564,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_25"></a>ZarfComponentAction  
+ ### <a name="autogenerated_heading_26"></a>ZarfComponentAction  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -2510,7 +2595,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_26"></a>ZarfComponentAction  
+ ### <a name="autogenerated_heading_27"></a>ZarfComponentAction  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -2590,7 +2675,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_27"></a>ZarfPackageConstant  
+ ### <a name="autogenerated_heading_28"></a>ZarfPackageConstant  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |
@@ -2709,7 +2794,7 @@ Must be one of:
 ![Item unicity: False](https://img.shields.io/badge/Item%20unicity%3A%20False-gold)
 ![Additional items: N/A](https://img.shields.io/badge/Additional%20items%3A%20N/A-gold)
 
- ### <a name="autogenerated_heading_28"></a>ZarfPackageVariable  
+ ### <a name="autogenerated_heading_29"></a>ZarfPackageVariable  
 
 |                           |                                                                                                          |
 | ------------------------- | -------------------------------------------------------------------------------------------------------- |

diff --git a/zarf.schema.json b/zarf.schema.json
@@ -256,6 +256,40 @@
           },
           "type": "array",
           "description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed"
+        },
+        "variables": {
+          "items": {
+            "$schema": "http://json-schema.org/draft-04/schema#",
+            "$ref": "#/definitions/ZarfChartVariable"
+          },
+          "type": "array",
+          "description": "List of variables to set in the Helm chart"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object",
+      "patternProperties": {
+        "^x-": {}
+      }
+    },
+    "ZarfChartVariable": {
+      "required": [
+        "name",
+        "description",
+        "path"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the variable"
+        },
+        "description": {
+          "type": "string",
+          "description": "A brief description of what the variable controls"
+        },
+        "path": {
+          "type": "string",
+          "description": "The path within the Helm chart values where this variable applies"
         }
       },
       "additionalProperties": false,