From c66c70b23a5124d670555ad01b1b1337db62d481 Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Mon, 25 Mar 2024 13:26:30 -0500 Subject: [PATCH 01/13] feat: allow chart deploy overrides - This feature allows chart deployment overrides. - https://github.com/defenseunicorns/zarf/issues/2133 Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- adr/0023-chart-override.md | 28 +++++ examples/helm-charts/zarf.yaml | 8 ++ src/pkg/packager/deploy.go | 81 ++++++++++-- src/pkg/packager/deploy_test.go | 215 ++++++++++++++++++++++++++++++++ src/types/component.go | 28 +++-- 5 files changed, 342 insertions(+), 18 deletions(-) create mode 100644 adr/0023-chart-override.md create mode 100644 src/pkg/packager/deploy_test.go diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md new file mode 100644 index 0000000000..a9b94072b5 --- /dev/null +++ b/adr/0023-chart-override.md @@ -0,0 +1,28 @@ +# 23. Simplifying Helm Chart Value Overrides + +Date: 2024-03-25 + +## Status + +Proposed + + +## Context + +The process of deploying applications with Helm charts in Kubernetes environments often necessitates the customization of chart values to align with specific operational or environmental requirements. The current method for customizing these values—either through manual edits or `###`. A more streamlined approach would greatly enhance the deployment experience by offering both flexibility and reliability. + +## Decision + +To address this issue, we propose the introduction of a feature designed to simplify the process of overriding chart values at the time of deployment. This feature would allow users to easily specify overrides for any chart values directly via command-line arguments, eliminating the need to alter the chart's default values file or manage multiple command-line arguments for each override. + +Key aspects of the proposed implementation include: +- Use existing `--set` flags to specify overrides for chart values. +- The ability to list all overrides in a structured and easily understandable format within the ZarfConfig file. +- Ensuring that during deployment, these specified overrides take precedence over the chart's default values, thus facilitating customized deployments without necessitating permanent modifications to the chart. + +## Consequences + +Adopting this feature would lead to several key improvements: +- **Streamlined Configuration Process**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive command-line arguments. + +Ultimately, this feature is aimed at enhancing the deployment workflow by offering a straightforward and efficient means of customizing Helm chart deployments via command-line inputs. diff --git a/examples/helm-charts/zarf.yaml b/examples/helm-charts/zarf.yaml index d6481b334d..7a02b3d8a1 100644 --- a/examples/helm-charts/zarf.yaml +++ b/examples/helm-charts/zarf.yaml @@ -16,6 +16,13 @@ components: localPath: chart valuesFiles: - values.yaml + # Variables are used to override the default values in the chart + # This can be overridden by the user at deployment time with the `--set` flag + variables: + - name: replicaCount + description: "Override the number of pod replicas" + path: replicaCount + value: 2 - name: podinfo-oci version: 6.4.0 @@ -77,3 +84,4 @@ components: name: cool-release-name-podinfo namespace: podinfo-from-repo condition: available + diff --git a/src/pkg/packager/deploy.go b/src/pkg/packager/deploy.go index 7ec050fd4f..0892297275 100644 --- a/src/pkg/packager/deploy.go +++ b/src/pkg/packager/deploy.go @@ -547,10 +547,74 @@ func (p *Packager) pushReposToRepository(reposPath string, repos []string) error return nil } +// generateValuesOverrides creates a map containing overrides for chart values based on the given inputs. +// It prioritizes the overrides in this order: +// 1. Variables defined in the ZarfComponent, including both Set Variables and Chart Variables. +// 2. Deployment options specified through DeployOpts. +// This function is useful for customizing the deployment of a Helm chart by programmatically setting chart values. +// +// Returns: +// - A map containing the final set of value overrides for the chart, where keys are the variable names. +func generateValuesOverrides(chartVariables []types.ZarfChartVariable, + setVariableMap map[string]*types.ZarfSetVariable, + deployOpts types.ZarfDeployOptions, + componentName, chartName string) (map[string]any, error) { + + valuesOverrides := make(map[string]any) + chartOverrides := make(map[string]any) + + for _, variable := range chartVariables { + if setVar, ok := setVariableMap[variable.Name]; ok && setVar != nil { + // Use the variable's path as a key to ensure unique entries for variables with the same name but different paths. + if err := mergePathAndValueIntoMap(chartOverrides, variable.Path, setVar.Value); err != nil { + return nil, fmt.Errorf("unable to merge path and value into map: %w", err) + } + } + } + + // Apply any direct overrides specified in the deployment options for this component and chart + if componentOverrides, ok := deployOpts.ValuesOverridesMap[componentName]; ok { + if chartSpecificOverrides, ok := componentOverrides[chartName]; ok { + for k, v := range chartSpecificOverrides { + // Directly apply overrides to valuesOverrides to avoid overwriting by path. + valuesOverrides[k] = v + } + } + } + + // Merge chartOverrides into valuesOverrides to ensure all overrides are applied. + // This corrects the logic to ensure that chartOverrides and valuesOverrides are merged correctly. + return helpers.MergeMapRecursive(valuesOverrides, chartOverrides), nil +} + +// mergePathAndValueIntoMap takes a path in dot notation as a string and a value (also as a string for simplicity), +// then merges this into the provided map. The value can be any type. +func mergePathAndValueIntoMap(m map[string]any, path string, value any) error { + pathParts := strings.Split(path, ".") + current := m + for i, part := range pathParts { + if i == len(pathParts)-1 { + // Set the value at the last key in the path. + current[part] = value + } else { + if _, exists := current[part]; !exists { + // If the part does not exist, create a new map for it. + current[part] = make(map[string]any) + } + + nextMap, ok := current[part].(map[string]any) + if !ok { + return fmt.Errorf("conflict at '%s', expected map but got %T", strings.Join(pathParts[:i+1], "."), current[part]) + } + current = nextMap + } + } + return nil +} + // Install all Helm charts and raw k8s manifests into the k8s cluster. func (p *Packager) installChartAndManifests(componentPaths *layout.ComponentPaths, component types.ZarfComponent) (installedCharts []types.InstalledChart, err error) { for _, chart := range component.Charts { - // zarf magic for the value file for idx := range chart.ValuesFiles { chartValueName := helm.StandardValuesName(componentPaths.Values, chart, idx) @@ -558,13 +622,14 @@ func (p *Packager) installChartAndManifests(componentPaths *layout.ComponentPath return installedCharts, err } } - - // TODO (@WSTARR): Currently this logic is library-only and is untested while it is in an experimental state - it may eventually get added as shorthand in Zarf Variables though - var valuesOverrides map[string]any - if componentChartValuesOverrides, ok := p.cfg.DeployOpts.ValuesOverridesMap[component.Name]; ok { - if chartValuesOverrides, ok := componentChartValuesOverrides[chart.Name]; ok { - valuesOverrides = chartValuesOverrides - } + // this is to get the overrides for the chart from the commandline and + // the chart variables set in the ZarfComponent and as well as DeployOpts set from the Library user. + // The order of precedence is as follows: + // 1. Set Variables and Chart Variables from the ZarfComponent + // 2. DeployOpts + valuesOverrides, err := generateValuesOverrides(chart.Variables, p.cfg.SetVariableMap, p.cfg.DeployOpts, component.Name, chart.Name) + if err != nil { + return installedCharts, err } helmCfg := helm.New( diff --git a/src/pkg/packager/deploy_test.go b/src/pkg/packager/deploy_test.go new file mode 100644 index 0000000000..ae244453b9 --- /dev/null +++ b/src/pkg/packager/deploy_test.go @@ -0,0 +1,215 @@ +// SPDX-License-Identifier: Apache-2.0 +// SPDX-FileCopyrightText: 2021-Present The Zarf Authors + +package packager + +import ( + "reflect" + "testing" + + "github.com/defenseunicorns/zarf/src/types" +) + +func TestGenerateValuesOverrides(t *testing.T) { + t.Parallel() + + tests := []struct { + name string + chartVariables []types.ZarfChartVariable + setVariableMap map[string]*types.ZarfSetVariable + deployOpts types.ZarfDeployOptions + componentName string + chartName string + want map[string]any + }{ + { + name: "Empty inputs", + chartVariables: []types.ZarfChartVariable{}, + setVariableMap: map[string]*types.ZarfSetVariable{}, + deployOpts: types.ZarfDeployOptions{}, + componentName: "", + chartName: "", + want: map[string]any{}, + }, + { + name: "Single variable", + chartVariables: []types.ZarfChartVariable{{Name: "testVar", Path: "testVar"}}, + setVariableMap: map[string]*types.ZarfSetVariable{"testVar": {Value: "testValue"}}, + deployOpts: types.ZarfDeployOptions{}, + componentName: "testComponent", + chartName: "testChart", + want: map[string]any{"testVar": "testValue"}, + }, + { + name: "Non-matching setVariable", + chartVariables: []types.ZarfChartVariable{{Name: "expectedVar", Path: "path.to.expectedVar"}}, + setVariableMap: map[string]*types.ZarfSetVariable{"unexpectedVar": {Value: "unexpectedValue"}}, + deployOpts: types.ZarfDeployOptions{}, + componentName: "testComponent", + chartName: "testChart", + want: map[string]any{}, + }, + { + name: "Nested 3 level setVariableMap", + chartVariables: []types.ZarfChartVariable{ + {Name: "level1.level2.level3Var", Path: "level1.level2.level3Var"}, + }, + setVariableMap: map[string]*types.ZarfSetVariable{ + "level1.level2.level3Var": {Value: "nestedValue"}, + }, + deployOpts: types.ZarfDeployOptions{}, + componentName: "nestedComponent", + chartName: "nestedChart", + want: map[string]any{ + "level1": map[string]any{ + "level2": map[string]any{ + "level3Var": "nestedValue", + }, + }, + }, + }, + { + name: "Multiple variables with nested and non-nested paths", + chartVariables: []types.ZarfChartVariable{ + {Name: "nestedVar.level2", Path: "nestedVar.level2"}, + {Name: "simpleVar", Path: "simpleVar"}, + }, + setVariableMap: map[string]*types.ZarfSetVariable{ + "nestedVar.level2": {Value: "nestedValue"}, + "simpleVar": {Value: "simpleValue"}, + }, + deployOpts: types.ZarfDeployOptions{}, + componentName: "mixedComponent", + chartName: "mixedChart", + want: map[string]any{ + "nestedVar": map[string]any{ + "level2": "nestedValue", + }, + "simpleVar": "simpleValue", + }, + }, + { + name: "Values override test", + chartVariables: []types.ZarfChartVariable{ + {Name: "overrideVar", Path: "path"}, + }, + setVariableMap: map[string]*types.ZarfSetVariable{ + "path": {Value: "overrideValue"}, + }, + deployOpts: types.ZarfDeployOptions{ + ValuesOverridesMap: map[string]map[string]map[string]any{ + "testComponent": { + "testChart": { + "path": "deployOverrideValue", + }, + }, + }, + }, + componentName: "testComponent", + chartName: "testChart", + want: map[string]any{ + "path": "deployOverrideValue", + }, + }, + { + name: "Missing variable in setVariableMap but present in ValuesOverridesMap", + chartVariables: []types.ZarfChartVariable{ + {Name: "missingVar", Path: "missingVarPath"}, + }, + setVariableMap: map[string]*types.ZarfSetVariable{}, + deployOpts: types.ZarfDeployOptions{ + ValuesOverridesMap: map[string]map[string]map[string]any{ + "testComponent": { + "testChart": { + "missingVarPath": "overrideValue", + }, + }, + }, + }, + componentName: "testComponent", + chartName: "testChart", + want: map[string]any{ + "missingVarPath": "overrideValue", + }, + }, + { + name: "Non-existent component or chart", + chartVariables: []types.ZarfChartVariable{{Name: "someVar", Path: "someVar"}}, + setVariableMap: map[string]*types.ZarfSetVariable{"someVar": {Value: "value"}}, + deployOpts: types.ZarfDeployOptions{ + ValuesOverridesMap: map[string]map[string]map[string]any{ + "nonExistentComponent": { + "nonExistentChart": { + "someVar": "overrideValue", + }, + }, + }, + }, + componentName: "actualComponent", + chartName: "actualChart", + want: map[string]any{"someVar": "value"}, + }, + { + name: "Variable in setVariableMap but not in chartVariables", + chartVariables: []types.ZarfChartVariable{}, + setVariableMap: map[string]*types.ZarfSetVariable{ + "orphanVar": {Value: "orphanValue"}, + }, + deployOpts: types.ZarfDeployOptions{}, + componentName: "orphanComponent", + chartName: "orphanChart", + want: map[string]any{}, + }, + { + name: "Empty ValuesOverridesMap with non-empty setVariableMap and chartVariables", + chartVariables: []types.ZarfChartVariable{ + {Name: "var1", Path: "path.to.var1"}, + {Name: "var2", Path: "path.to.var2"}, + {Name: "var3", Path: "path.to3.var3"}, + }, + setVariableMap: map[string]*types.ZarfSetVariable{ + "var1": {Value: "value1"}, + "var2": {Value: "value2"}, + "var3": {Value: "value3"}, + }, + deployOpts: types.ZarfDeployOptions{ + ValuesOverridesMap: map[string]map[string]map[string]any{}, + }, + componentName: "componentWithVars", + chartName: "chartWithVars", + want: map[string]any{ + "path": map[string]any{ + "to": map[string]any{ + "var1": "value1", + "var2": "value2", + }, + "to3": map[string]any{ + "var3": "value3", + }, + }, + }, + }, + { + name: "Empty chartVariables and non-empty setVariableMap", + chartVariables: []types.ZarfChartVariable{}, + setVariableMap: map[string]*types.ZarfSetVariable{ + "var1": {Value: "value1"}, + "var2": {Value: "value2"}, + }, + deployOpts: types.ZarfDeployOptions{}, + componentName: "componentWithVars", + chartName: "chartWithVars", + want: map[string]any{}, + }, + } + + for _, tt := range tests { + tt := tt + t.Run(tt.name, func(t *testing.T) { + got, _ := generateValuesOverrides(tt.chartVariables, tt.setVariableMap, tt.deployOpts, tt.componentName, tt.chartName) + if !reflect.DeepEqual(got, tt.want) { + t.Errorf("%s: generateValuesOverrides() got = %v, want %v", tt.name, got, tt.want) + } + }) + } +} diff --git a/src/types/component.go b/src/types/component.go index 028f25202c..dc2e28319e 100644 --- a/src/types/component.go +++ b/src/types/component.go @@ -105,16 +105,24 @@ type ZarfFile struct { // ZarfChart defines a helm chart to be deployed. type ZarfChart struct { - Name string `json:"name" jsonschema:"description=The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo"` - Version string `json:"version,omitempty" jsonschema:"description=The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')"` - URL string `json:"url,omitempty" jsonschema:"example=OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo,example=helm chart repo: https://stefanprodan.github.io/podinfo,example=git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)" jsonschema_description:"The URL of the OCI registry, chart repository, or git repo where the helm chart is stored"` - RepoName string `json:"repoName,omitempty" jsonschema:"description=The name of a chart within a Helm repository (defaults to the Zarf name of the chart)"` - GitPath string `json:"gitPath,omitempty" jsonschema:"description=(git repo only) The sub directory to the chart within a git repo,example=charts/your-chart"` - LocalPath string `json:"localPath,omitempty" jsonschema:"description=The path to a local chart's folder or .tgz archive"` - Namespace string `json:"namespace" jsonschema:"description=The namespace to deploy the chart to"` - ReleaseName string `json:"releaseName,omitempty" jsonschema:"description=The name of the Helm release to create (defaults to the Zarf name of the chart)"` - NoWait bool `json:"noWait,omitempty" jsonschema:"description=Whether to not wait for chart resources to be ready before continuing"` - ValuesFiles []string `json:"valuesFiles,omitempty" jsonschema:"description=List of local values file paths or remote URLs to include in the package; these will be merged together when deployed"` + Name string `json:"name" jsonschema:"description=The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo"` + Version string `json:"version,omitempty" jsonschema:"description=The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')"` + URL string `json:"url,omitempty" jsonschema:"example=OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo,example=helm chart repo: https://stefanprodan.github.io/podinfo,example=git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)" jsonschema_description:"The URL of the OCI registry, chart repository, or git repo where the helm chart is stored"` + RepoName string `json:"repoName,omitempty" jsonschema:"description=The name of a chart within a Helm repository (defaults to the Zarf name of the chart)"` + GitPath string `json:"gitPath,omitempty" jsonschema:"description=(git repo only) The sub directory to the chart within a git repo,example=charts/your-chart"` + LocalPath string `json:"localPath,omitempty" jsonschema:"description=The path to a local chart's folder or .tgz archive"` + Namespace string `json:"namespace" jsonschema:"description=The namespace to deploy the chart to"` + ReleaseName string `json:"releaseName,omitempty" jsonschema:"description=The name of the Helm release to create (defaults to the Zarf name of the chart)"` + NoWait bool `json:"noWait,omitempty" jsonschema:"description=Whether to not wait for chart resources to be ready before continuing"` + ValuesFiles []string `json:"valuesFiles,omitempty" jsonschema:"description=List of local values file paths or remote URLs to include in the package; these will be merged together when deployed"` + Variables []ZarfChartVariable `json:"variables,omitempty" jsonschema:"description=List of variables to set in the Helm chart"` +} + +// ZarfChartVariable represents a variable that can be set for a Helm chart overrides. +type ZarfChartVariable struct { + Name string `json:"name" jsonschema:"description=The name of the variable"` + Description string `json:"description" jsonschema:"description=A brief description of what the variable controls"` + Path string `json:"path" jsonschema:"description=The path within the Helm chart values where this variable applies"` } // ZarfManifest defines raw manifests Zarf will deploy as a helm chart. From b84c30d0c1ad8a58247911f865287f5137d04df8 Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Mon, 25 Mar 2024 14:52:25 -0500 Subject: [PATCH 02/13] docs: updated the docs Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- docs/3-create-a-zarf-package/4-zarf-schema.md | 117 +++++++++++++++--- zarf.schema.json | 34 +++++ 2 files changed, 135 insertions(+), 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 index e4ff7eb157..c42cc82213 100644 --- 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: +
+ + variables + +  +
+ + ## 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) + + ### ZarfChartVariable + +| | | +| ------------------------- | -------------------------------------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| **Defined in** | #/definitions/ZarfChartVariable | + +
+ + name * + +  +
+ +![Required](https://img.shields.io/badge/Required-red) + +**Description:** The name of the variable + +| | | +| -------- | -------- | +| **Type** | `string` | + +
+
+ +
+ + description * + +  +
+ +![Required](https://img.shields.io/badge/Required-red) + +**Description:** A brief description of what the variable controls + +| | | +| -------- | -------- | +| **Type** | `string` | + +
+
+ +
+ + path * + +  +
+ +![Required](https://img.shields.io/badge/Required-red) + +**Description:** The path within the Helm chart values where this variable applies + +| | | +| -------- | -------- | +| **Type** | `string` | + +
+
+ +
+
+ @@ -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) - ### ZarfDataInjection + ### 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) - ### ZarfFile + ### 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) - ### symlinks items + ### 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) - ### images items + ### 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) - ### repos items + ### 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) - ### valuesFiles items + ### 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) - ### fluxPatchFiles items + ### 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) - ### env items + ### 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) - ### ZarfComponentAction + ### 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) - ### env items + ### 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) - ### ZarfComponentActionSetVariable + ### 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) - ### ZarfComponentAction + ### 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) - ### ZarfComponentAction + ### 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) - ### ZarfComponentAction + ### 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) - ### ZarfPackageConstant + ### 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) - ### ZarfPackageVariable + ### ZarfPackageVariable | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | diff --git a/zarf.schema.json b/zarf.schema.json index f61482b7a4..33a02cca3e 100644 --- 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, From d5d624fc7a1abfaf851239e9cdf30b40af52926f Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Thu, 28 Mar 2024 12:07:39 -0500 Subject: [PATCH 03/13] addressed code review comments. Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- adr/0023-chart-override.md | 2 +- docs/3-create-a-zarf-package/4-zarf-schema.md | 4 ++++ examples/helm-charts/zarf.yaml | 2 +- src/pkg/packager/deploy.go | 5 +---- src/pkg/packager/deploy_test.go | 12 ++++++------ src/types/component.go | 2 +- zarf.schema.json | 1 + 7 files changed, 15 insertions(+), 13 deletions(-) diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md index a9b94072b5..fe05f14a7c 100644 --- a/adr/0023-chart-override.md +++ b/adr/0023-chart-override.md @@ -23,6 +23,6 @@ Key aspects of the proposed implementation include: ## Consequences Adopting this feature would lead to several key improvements: -- **Streamlined Configuration Process**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive command-line arguments. +- **Streamlined Configuration Process**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive custom `###` templating. Ultimately, this feature is aimed at enhancing the deployment workflow by offering a straightforward and efficient means of customizing Helm chart deployments via command-line inputs. diff --git a/docs/3-create-a-zarf-package/4-zarf-schema.md b/docs/3-create-a-zarf-package/4-zarf-schema.md index c42cc82213..b74c2fafdc 100644 --- a/docs/3-create-a-zarf-package/4-zarf-schema.md +++ b/docs/3-create-a-zarf-package/4-zarf-schema.md @@ -1228,6 +1228,10 @@ Must be one of: | -------- | -------- | | **Type** | `string` | +| Restrictions | | +| --------------------------------- | ----------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[A-Z0-9_]+$``` [Test](https://regex101.com/?regex=%5E%5BA-Z0-9_%5D%2B%24) | + diff --git a/examples/helm-charts/zarf.yaml b/examples/helm-charts/zarf.yaml index 7a02b3d8a1..29e6b3435e 100644 --- a/examples/helm-charts/zarf.yaml +++ b/examples/helm-charts/zarf.yaml @@ -19,7 +19,7 @@ components: # Variables are used to override the default values in the chart # This can be overridden by the user at deployment time with the `--set` flag variables: - - name: replicaCount + - name: REPLICA_COUNT description: "Override the number of pod replicas" path: replicaCount value: 2 diff --git a/src/pkg/packager/deploy.go b/src/pkg/packager/deploy.go index 0892297275..d6e7968a86 100644 --- a/src/pkg/packager/deploy.go +++ b/src/pkg/packager/deploy.go @@ -575,10 +575,7 @@ func generateValuesOverrides(chartVariables []types.ZarfChartVariable, // Apply any direct overrides specified in the deployment options for this component and chart if componentOverrides, ok := deployOpts.ValuesOverridesMap[componentName]; ok { if chartSpecificOverrides, ok := componentOverrides[chartName]; ok { - for k, v := range chartSpecificOverrides { - // Directly apply overrides to valuesOverrides to avoid overwriting by path. - valuesOverrides[k] = v - } + valuesOverrides = chartSpecificOverrides } } diff --git a/src/pkg/packager/deploy_test.go b/src/pkg/packager/deploy_test.go index ae244453b9..81766f2277 100644 --- a/src/pkg/packager/deploy_test.go +++ b/src/pkg/packager/deploy_test.go @@ -69,23 +69,23 @@ func TestGenerateValuesOverrides(t *testing.T) { }, }, { - name: "Multiple variables with nested and non-nested paths", + name: "Multiple variables with nested and non-nested paths, distinct values", chartVariables: []types.ZarfChartVariable{ - {Name: "nestedVar.level2", Path: "nestedVar.level2"}, + {Name: "NESTED_VAR_LEVEL2", Path: "nestedVar.level2"}, {Name: "simpleVar", Path: "simpleVar"}, }, setVariableMap: map[string]*types.ZarfSetVariable{ - "nestedVar.level2": {Value: "nestedValue"}, - "simpleVar": {Value: "simpleValue"}, + "NESTED_VAR_LEVEL2": {Value: "distinctNestedValue"}, + "simpleVar": {Value: "distinctSimpleValue"}, }, deployOpts: types.ZarfDeployOptions{}, componentName: "mixedComponent", chartName: "mixedChart", want: map[string]any{ "nestedVar": map[string]any{ - "level2": "nestedValue", + "level2": "distinctNestedValue", }, - "simpleVar": "simpleValue", + "simpleVar": "distinctSimpleValue", }, }, { diff --git a/src/types/component.go b/src/types/component.go index dc2e28319e..b259b4eb13 100644 --- a/src/types/component.go +++ b/src/types/component.go @@ -120,7 +120,7 @@ type ZarfChart struct { // ZarfChartVariable represents a variable that can be set for a Helm chart overrides. type ZarfChartVariable struct { - Name string `json:"name" jsonschema:"description=The name of the variable"` + Name string `json:"name" jsonschema:"description=The name of the variable,pattern=^[A-Z0-9_]+$"` Description string `json:"description" jsonschema:"description=A brief description of what the variable controls"` Path string `json:"path" jsonschema:"description=The path within the Helm chart values where this variable applies"` } diff --git a/zarf.schema.json b/zarf.schema.json index 33a02cca3e..aeee25bf95 100644 --- a/zarf.schema.json +++ b/zarf.schema.json @@ -280,6 +280,7 @@ ], "properties": { "name": { + "pattern": "^[A-Z0-9_]+$", "type": "string", "description": "The name of the variable" }, From e92ef406842819b939ce03b5bf2b05a15b981bed Mon Sep 17 00:00:00 2001 From: Naveen <172697+naveensrinivasan@users.noreply.github.com> Date: Mon, 1 Apr 2024 16:11:22 -0500 Subject: [PATCH 04/13] Update adr/0023-chart-override.md Co-authored-by: Lucas Rodriguez --- adr/0023-chart-override.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md index fe05f14a7c..4661e9957b 100644 --- a/adr/0023-chart-override.md +++ b/adr/0023-chart-override.md @@ -4,7 +4,7 @@ Date: 2024-03-25 ## Status -Proposed +Accepted ## Context From cb1f1aae58e0b9d3e65015f3fc937d431a297d65 Mon Sep 17 00:00:00 2001 From: Naveen <172697+naveensrinivasan@users.noreply.github.com> Date: Mon, 1 Apr 2024 16:11:34 -0500 Subject: [PATCH 05/13] Update adr/0023-chart-override.md Co-authored-by: razzle --- adr/0023-chart-override.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md index 4661e9957b..afc0cea9f1 100644 --- a/adr/0023-chart-override.md +++ b/adr/0023-chart-override.md @@ -9,7 +9,7 @@ Accepted ## Context -The process of deploying applications with Helm charts in Kubernetes environments often necessitates the customization of chart values to align with specific operational or environmental requirements. The current method for customizing these values—either through manual edits or `###`. A more streamlined approach would greatly enhance the deployment experience by offering both flexibility and reliability. +The process of deploying applications with Helm charts in Kubernetes environments often necessitates the customization of chart values to align with specific operational or environmental requirements. The current method for customizing these values—either through manual edits or `###ZARF_VAR_XYZ###`. A more streamlined approach would greatly enhance the deployment experience by offering both flexibility and reliability. ## Decision From f5f9b053b0d672e4abd17f1f68b723837bb7b84d Mon Sep 17 00:00:00 2001 From: Naveen <172697+naveensrinivasan@users.noreply.github.com> Date: Mon, 1 Apr 2024 16:11:46 -0500 Subject: [PATCH 06/13] Update adr/0023-chart-override.md Co-authored-by: razzle --- adr/0023-chart-override.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md index afc0cea9f1..cbd710426b 100644 --- a/adr/0023-chart-override.md +++ b/adr/0023-chart-override.md @@ -23,6 +23,6 @@ Key aspects of the proposed implementation include: ## Consequences Adopting this feature would lead to several key improvements: -- **Streamlined Configuration Process**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive custom `###` templating. +- **Streamlined Configuration Process**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive custom `###ZARF_VAR_XYZ###` templating. Ultimately, this feature is aimed at enhancing the deployment workflow by offering a straightforward and efficient means of customizing Helm chart deployments via command-line inputs. From e37542676ab753be21666ce38760a0054b749f53 Mon Sep 17 00:00:00 2001 From: Naveen <172697+naveensrinivasan@users.noreply.github.com> Date: Mon, 1 Apr 2024 16:11:54 -0500 Subject: [PATCH 07/13] Update adr/0023-chart-override.md Co-authored-by: razzle --- adr/0023-chart-override.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md index cbd710426b..07080915e9 100644 --- a/adr/0023-chart-override.md +++ b/adr/0023-chart-override.md @@ -17,7 +17,7 @@ To address this issue, we propose the introduction of a feature designed to simp Key aspects of the proposed implementation include: - Use existing `--set` flags to specify overrides for chart values. -- The ability to list all overrides in a structured and easily understandable format within the ZarfConfig file. +- The ability to list all overrides in a structured and easily understandable format within `zarf.yaml`. - Ensuring that during deployment, these specified overrides take precedence over the chart's default values, thus facilitating customized deployments without necessitating permanent modifications to the chart. ## Consequences From 38aaa0ddcaa9f45966ee206984e2ac25e08bd403 Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Thu, 4 Apr 2024 13:42:16 -0500 Subject: [PATCH 08/13] some clean up Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- adr/0023-chart-override.md | 37 +++++++++++++++++++++++++++++++++ examples/helm-charts/zarf.yaml | 1 - src/pkg/packager/deploy.go | 27 +----------------------- src/pkg/packager/deploy_test.go | 5 ++++- 4 files changed, 42 insertions(+), 28 deletions(-) diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md index 07080915e9..ad779a1eb2 100644 --- a/adr/0023-chart-override.md +++ b/adr/0023-chart-override.md @@ -26,3 +26,40 @@ Adopting this feature would lead to several key improvements: - **Streamlined Configuration Process**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive custom `###ZARF_VAR_XYZ###` templating. Ultimately, this feature is aimed at enhancing the deployment workflow by offering a straightforward and efficient means of customizing Helm chart deployments via command-line inputs. + +## Example Configuration + +Below is an example of how the `zarf.yaml` configuration file might be structured to utilize the new override feature for Helm chart values: + +```yaml +kind: ZarfPackageConfig +metadata: + name: helm-charts + description: Example showcasing multiple ways to deploy helm charts + version: 0.0.1 + +components: + - name: demo-helm-charts + required: true + charts: + - name: podinfo-local + version: 6.4.0 + namespace: podinfo-from-local-chart + localPath: chart + valuesFiles: + - values.yaml + variables: + - name: REPLICA_COUNT + description: "Override the number of pod replicas" + path: replicaCount +``` +This configuration allows for the specification of default values and descriptions for variables that can be overridden at deployment time. The variables section under each chart specifies the variables that can be overridden, along with a path that indicates where in the values file the variable is located. + +### Command Line Example + +To override the `REPLICA_COUNT` variable at deployment time, the following command can be used: + +```bash +zarf package deploy zarf-package-helm-charts-arm64-0.0.1.tar.zst --set REPLICA_COUNT=5 +``` +This command demonstrates how users can easily customize their Helm chart deployments by specifying overrides for chart values directly via command-line arguments, in line with the proposed feature. diff --git a/examples/helm-charts/zarf.yaml b/examples/helm-charts/zarf.yaml index 29e6b3435e..4c8cbd7040 100644 --- a/examples/helm-charts/zarf.yaml +++ b/examples/helm-charts/zarf.yaml @@ -22,7 +22,6 @@ components: - name: REPLICA_COUNT description: "Override the number of pod replicas" path: replicaCount - value: 2 - name: podinfo-oci version: 6.4.0 diff --git a/src/pkg/packager/deploy.go b/src/pkg/packager/deploy.go index d6e7968a86..67eccff4db 100644 --- a/src/pkg/packager/deploy.go +++ b/src/pkg/packager/deploy.go @@ -566,7 +566,7 @@ func generateValuesOverrides(chartVariables []types.ZarfChartVariable, for _, variable := range chartVariables { if setVar, ok := setVariableMap[variable.Name]; ok && setVar != nil { // Use the variable's path as a key to ensure unique entries for variables with the same name but different paths. - if err := mergePathAndValueIntoMap(chartOverrides, variable.Path, setVar.Value); err != nil { + if err := helpers.MergePathAndValueIntoMap(chartOverrides, variable.Path, setVar.Value); err != nil { return nil, fmt.Errorf("unable to merge path and value into map: %w", err) } } @@ -584,31 +584,6 @@ func generateValuesOverrides(chartVariables []types.ZarfChartVariable, return helpers.MergeMapRecursive(valuesOverrides, chartOverrides), nil } -// mergePathAndValueIntoMap takes a path in dot notation as a string and a value (also as a string for simplicity), -// then merges this into the provided map. The value can be any type. -func mergePathAndValueIntoMap(m map[string]any, path string, value any) error { - pathParts := strings.Split(path, ".") - current := m - for i, part := range pathParts { - if i == len(pathParts)-1 { - // Set the value at the last key in the path. - current[part] = value - } else { - if _, exists := current[part]; !exists { - // If the part does not exist, create a new map for it. - current[part] = make(map[string]any) - } - - nextMap, ok := current[part].(map[string]any) - if !ok { - return fmt.Errorf("conflict at '%s', expected map but got %T", strings.Join(pathParts[:i+1], "."), current[part]) - } - current = nextMap - } - } - return nil -} - // Install all Helm charts and raw k8s manifests into the k8s cluster. func (p *Packager) installChartAndManifests(componentPaths *layout.ComponentPaths, component types.ZarfComponent) (installedCharts []types.InstalledChart, err error) { for _, chart := range component.Charts { diff --git a/src/pkg/packager/deploy_test.go b/src/pkg/packager/deploy_test.go index 81766f2277..2b235b9c56 100644 --- a/src/pkg/packager/deploy_test.go +++ b/src/pkg/packager/deploy_test.go @@ -206,7 +206,10 @@ func TestGenerateValuesOverrides(t *testing.T) { for _, tt := range tests { tt := tt t.Run(tt.name, func(t *testing.T) { - got, _ := generateValuesOverrides(tt.chartVariables, tt.setVariableMap, tt.deployOpts, tt.componentName, tt.chartName) + got, err := generateValuesOverrides(tt.chartVariables, tt.setVariableMap, tt.deployOpts, tt.componentName, tt.chartName) + if err != nil { + t.Errorf("%s: generateValuesOverrides() error = %v", tt.name, err) + } if !reflect.DeepEqual(got, tt.want) { t.Errorf("%s: generateValuesOverrides() got = %v, want %v", tt.name, got, tt.want) } From 62514c8a0d5e76c43d8bac792f2db54b5f5b5646 Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Fri, 5 Apr 2024 09:11:20 -0500 Subject: [PATCH 09/13] updated the wording in the ADR based on feedback. Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- adr/0023-chart-override.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adr/0023-chart-override.md b/adr/0023-chart-override.md index ad779a1eb2..d4fb4661c0 100644 --- a/adr/0023-chart-override.md +++ b/adr/0023-chart-override.md @@ -23,7 +23,7 @@ Key aspects of the proposed implementation include: ## Consequences Adopting this feature would lead to several key improvements: -- **Streamlined Configuration Process**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive custom `###ZARF_VAR_XYZ###` templating. +- **Streamlined Configuration Process**: Allowing helm values overrides in the zarf package schema simplifies the user experience by reducing the reliance on extensive custom `###ZARF_VAR_XYZ###` templating and aligning more closely with standard Helm practices Ultimately, this feature is aimed at enhancing the deployment workflow by offering a straightforward and efficient means of customizing Helm chart deployments via command-line inputs. From 10eab2b7942bc05b318e0b9b50a03ca7a2dceba0 Mon Sep 17 00:00:00 2001 From: Naveen <172697+naveensrinivasan@users.noreply.github.com> Date: Fri, 5 Apr 2024 13:13:13 -0500 Subject: [PATCH 10/13] Update src/types/component.go Co-authored-by: razzle --- src/types/component.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/types/component.go b/src/types/component.go index b259b4eb13..eaeed14bd8 100644 --- a/src/types/component.go +++ b/src/types/component.go @@ -115,7 +115,7 @@ type ZarfChart struct { ReleaseName string `json:"releaseName,omitempty" jsonschema:"description=The name of the Helm release to create (defaults to the Zarf name of the chart)"` NoWait bool `json:"noWait,omitempty" jsonschema:"description=Whether to not wait for chart resources to be ready before continuing"` ValuesFiles []string `json:"valuesFiles,omitempty" jsonschema:"description=List of local values file paths or remote URLs to include in the package; these will be merged together when deployed"` - Variables []ZarfChartVariable `json:"variables,omitempty" jsonschema:"description=List of variables to set in the Helm chart"` + Variables []ZarfChartVariable `json:"variables,omitempty" jsonschema:"description=[alpha] List of variables to set in the Helm chart"` } // ZarfChartVariable represents a variable that can be set for a Helm chart overrides. From 6605c66318a3c212c754e93cff91efe98583cf07 Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Fri, 5 Apr 2024 13:14:33 -0500 Subject: [PATCH 11/13] updated docs Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- docs/2-the-zarf-cli/100-cli-commands/zarf.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md | 2 +- .../100-cli-commands/zarf_completion_powershell.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md | 2 +- .../2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_init.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md | 2 +- .../100-cli-commands/zarf_package_mirror-resources.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md | 2 +- .../100-cli-commands/zarf_tools_archiver_compress.md | 2 +- .../100-cli-commands/zarf_tools_archiver_decompress.md | 2 +- .../100-cli-commands/zarf_tools_archiver_version.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md | 2 +- .../2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_version.md | 2 +- zarf.schema.json | 2 +- 40 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf.md b/docs/2-the-zarf-cli/100-cli-commands/zarf.md index f2794aa98e..43b20a3446 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf.md @@ -15,7 +15,7 @@ zarf COMMAND [flags] ## Options ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") -h, --help help for zarf --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md index 1b14fc043d..9236121c09 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md @@ -18,7 +18,7 @@ See each sub-command's help for details on how to use the generated script. ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md index baa3b56a09..6d3d8f43bc 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md @@ -41,7 +41,7 @@ zarf completion bash ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md index bcdcce8607..0c68f43fbe 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md @@ -32,7 +32,7 @@ zarf completion fish [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md index bd2cd1c5ba..c00cedd6b7 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md @@ -29,7 +29,7 @@ zarf completion powershell [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md index 4f78a06814..5b483ba887 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md @@ -43,7 +43,7 @@ zarf completion zsh [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md index 2bb16dcfdb..3917f21bfb 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md @@ -32,7 +32,7 @@ zarf connect { REGISTRY | LOGGING | GIT | connect-name } [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md index 51d16e44cd..1db2b00fd0 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md @@ -16,7 +16,7 @@ zarf connect list [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md index ae8bb25fd0..8b2aa55c22 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md @@ -28,7 +28,7 @@ zarf destroy --confirm [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md index 7501cb44a7..37750e9e5d 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md @@ -12,7 +12,7 @@ Commands useful for developing packages ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md index cf2ac00723..5bf2136513 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md @@ -30,7 +30,7 @@ zarf dev deploy [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md index 221ee2020a..7855522f01 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md @@ -29,7 +29,7 @@ zarf dev find-images [ PACKAGE ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md index 4005e20995..f69a4a8a19 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md @@ -25,7 +25,7 @@ zarf dev generate-config [ FILENAME ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md index a07e939058..92321202dc 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md @@ -27,7 +27,7 @@ zarf dev generate podinfo --url https://github.com/stefanprodan/podinfo.git --ve ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md index 7ec1068b0b..da0894740f 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md @@ -22,7 +22,7 @@ zarf dev lint [ DIRECTORY ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md index 808df2ba07..37e36e0680 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md @@ -18,7 +18,7 @@ zarf dev patch-git HOST FILE [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md index 4be9cbcd30..4efa8b501d 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md @@ -17,7 +17,7 @@ zarf dev sha256sum { FILE | URL } [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md index b16bbd34f6..4106c2f4fa 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md @@ -80,7 +80,7 @@ $ zarf init --artifact-push-password={PASSWORD} --artifact-push-username={USERNA ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md index 572d0c7dba..18cc066e04 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md @@ -14,7 +14,7 @@ Zarf package commands for creating, deploying, and inspecting packages ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md index 81044a3acc..1f6ca11453 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md @@ -35,7 +35,7 @@ zarf package create [ DIRECTORY ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md index 8b9a1721a3..dc79f9da08 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md @@ -29,7 +29,7 @@ zarf package deploy [ PACKAGE_SOURCE ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md index 2382a7c048..92cc0ecefe 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md @@ -22,7 +22,7 @@ zarf package inspect [ PACKAGE_SOURCE ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md index 2c5b08481e..f7224f7f39 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md @@ -16,7 +16,7 @@ zarf package list [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md index fd658197d4..f0f7df0a29 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md @@ -55,7 +55,7 @@ $ zarf package mirror-resources \ ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md index cd82887e16..86723054db 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md @@ -30,7 +30,7 @@ $ zarf package publish ./path/to/dir oci://my-registry.com/my-namespace ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md index 59d876923c..93aef8d2aa 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md @@ -31,7 +31,7 @@ $ zarf package pull oci://ghcr.io/defenseunicorns/packages/dos-games:1.0.0 -a sk ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md index 3e4a20ae08..5dc4b314bb 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md @@ -18,7 +18,7 @@ zarf package remove { PACKAGE_SOURCE | PACKAGE_NAME } --confirm [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md index 587283fccf..bc45b56cd7 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md @@ -12,7 +12,7 @@ Collection of additional tools to make airgap easier ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md index 1dd729b38a..e1476a9023 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md @@ -12,7 +12,7 @@ Compresses/Decompresses generic archives, including Zarf packages ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md index ecbbe70bf4..84a11c6b2c 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md @@ -16,7 +16,7 @@ zarf tools archiver compress SOURCES ARCHIVE [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md index 53249200d7..d8eb80402c 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md @@ -17,7 +17,7 @@ zarf tools archiver decompress ARCHIVE DESTINATION [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md index 6397622fc4..bde45abf73 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md @@ -16,7 +16,7 @@ zarf tools archiver version [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md index b245fd9bbd..abf704253d 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md @@ -17,7 +17,7 @@ zarf tools clear-cache [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md index c3d90216f8..ec83d0527e 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md @@ -17,7 +17,7 @@ zarf tools download-init [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md index 8b7ea10756..eb12650d67 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md @@ -16,7 +16,7 @@ zarf tools gen-key [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md index 224f09489f..c537e124e6 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md @@ -17,7 +17,7 @@ zarf tools gen-pki HOST [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md index 457acc4756..914368fff2 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md @@ -37,7 +37,7 @@ $ zarf tools get-creds logging ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md index 8dd9cd1610..9c3f374cbb 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md @@ -65,7 +65,7 @@ $ zarf tools update-creds artifact --artifact-push-username={USERNAME} --artifac ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md index 2f83e0e4ac..3cfd724684 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md @@ -21,7 +21,7 @@ zarf version [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages + -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/zarf.schema.json b/zarf.schema.json index aeee25bf95..69f4aae9d0 100644 --- a/zarf.schema.json +++ b/zarf.schema.json @@ -263,7 +263,7 @@ "$ref": "#/definitions/ZarfChartVariable" }, "type": "array", - "description": "List of variables to set in the Helm chart" + "description": "[alpha] List of variables to set in the Helm chart" } }, "additionalProperties": false, From 0534e43376d2dab508576ad3278688fbcc37ab19 Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Mon, 8 Apr 2024 18:22:36 -0500 Subject: [PATCH 12/13] fixed docs Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- docs/3-create-a-zarf-package/4-zarf-schema.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/3-create-a-zarf-package/4-zarf-schema.md b/docs/3-create-a-zarf-package/4-zarf-schema.md index b74c2fafdc..48acf1650a 100644 --- a/docs/3-create-a-zarf-package/4-zarf-schema.md +++ b/docs/3-create-a-zarf-package/4-zarf-schema.md @@ -1194,7 +1194,7 @@ Must be one of: ## components > charts > variables -**Description:** List of variables to set in the Helm chart +**Description:** [alpha] List of variables to set in the Helm chart | | | | -------- | ------- | From 192187523a8813f97350cf2916b5585eb87433fd Mon Sep 17 00:00:00 2001 From: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Date: Tue, 9 Apr 2024 08:44:24 -0500 Subject: [PATCH 13/13] removed the ZARF_ARCHITECTURE Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> --- docs/2-the-zarf-cli/100-cli-commands/zarf.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md | 2 +- .../100-cli-commands/zarf_completion_powershell.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md | 2 +- .../2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_init.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md | 2 +- .../100-cli-commands/zarf_package_mirror-resources.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md | 2 +- .../100-cli-commands/zarf_tools_archiver_compress.md | 2 +- .../100-cli-commands/zarf_tools_archiver_decompress.md | 2 +- .../100-cli-commands/zarf_tools_archiver_version.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md | 2 +- .../2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md | 2 +- docs/2-the-zarf-cli/100-cli-commands/zarf_version.md | 2 +- 39 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf.md b/docs/2-the-zarf-cli/100-cli-commands/zarf.md index 43b20a3446..f2794aa98e 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf.md @@ -15,7 +15,7 @@ zarf COMMAND [flags] ## Options ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages -h, --help help for zarf --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md index 9236121c09..1b14fc043d 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion.md @@ -18,7 +18,7 @@ See each sub-command's help for details on how to use the generated script. ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md index 6d3d8f43bc..baa3b56a09 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_bash.md @@ -41,7 +41,7 @@ zarf completion bash ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md index 0c68f43fbe..bcdcce8607 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_fish.md @@ -32,7 +32,7 @@ zarf completion fish [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md index c00cedd6b7..bd2cd1c5ba 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_powershell.md @@ -29,7 +29,7 @@ zarf completion powershell [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md index 5b483ba887..4f78a06814 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_completion_zsh.md @@ -43,7 +43,7 @@ zarf completion zsh [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md index 3917f21bfb..2bb16dcfdb 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect.md @@ -32,7 +32,7 @@ zarf connect { REGISTRY | LOGGING | GIT | connect-name } [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md index 1db2b00fd0..51d16e44cd 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_connect_list.md @@ -16,7 +16,7 @@ zarf connect list [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md index 8b2aa55c22..ae8bb25fd0 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_destroy.md @@ -28,7 +28,7 @@ zarf destroy --confirm [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md index 37750e9e5d..7501cb44a7 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev.md @@ -12,7 +12,7 @@ Commands useful for developing packages ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md index 5bf2136513..cf2ac00723 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_deploy.md @@ -30,7 +30,7 @@ zarf dev deploy [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md index 7855522f01..221ee2020a 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_find-images.md @@ -29,7 +29,7 @@ zarf dev find-images [ PACKAGE ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md index f69a4a8a19..4005e20995 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate-config.md @@ -25,7 +25,7 @@ zarf dev generate-config [ FILENAME ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md index 92321202dc..a07e939058 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_generate.md @@ -27,7 +27,7 @@ zarf dev generate podinfo --url https://github.com/stefanprodan/podinfo.git --ve ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md index da0894740f..7ec1068b0b 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_lint.md @@ -22,7 +22,7 @@ zarf dev lint [ DIRECTORY ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md index 37e36e0680..808df2ba07 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_patch-git.md @@ -18,7 +18,7 @@ zarf dev patch-git HOST FILE [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md index 4efa8b501d..4be9cbcd30 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_dev_sha256sum.md @@ -17,7 +17,7 @@ zarf dev sha256sum { FILE | URL } [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md index 4106c2f4fa..b16bbd34f6 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_init.md @@ -80,7 +80,7 @@ $ zarf init --artifact-push-password={PASSWORD} --artifact-push-username={USERNA ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md index 18cc066e04..572d0c7dba 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package.md @@ -14,7 +14,7 @@ Zarf package commands for creating, deploying, and inspecting packages ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md index 1f6ca11453..81044a3acc 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_create.md @@ -35,7 +35,7 @@ zarf package create [ DIRECTORY ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md index dc79f9da08..8b9a1721a3 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_deploy.md @@ -29,7 +29,7 @@ zarf package deploy [ PACKAGE_SOURCE ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md index 92cc0ecefe..2382a7c048 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_inspect.md @@ -22,7 +22,7 @@ zarf package inspect [ PACKAGE_SOURCE ] [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md index f7224f7f39..2c5b08481e 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_list.md @@ -16,7 +16,7 @@ zarf package list [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md index f0f7df0a29..fd658197d4 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_mirror-resources.md @@ -55,7 +55,7 @@ $ zarf package mirror-resources \ ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md index 86723054db..cd82887e16 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_publish.md @@ -30,7 +30,7 @@ $ zarf package publish ./path/to/dir oci://my-registry.com/my-namespace ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md index 93aef8d2aa..59d876923c 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_pull.md @@ -31,7 +31,7 @@ $ zarf package pull oci://ghcr.io/defenseunicorns/packages/dos-games:1.0.0 -a sk ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md index 5dc4b314bb..3e4a20ae08 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_package_remove.md @@ -18,7 +18,7 @@ zarf package remove { PACKAGE_SOURCE | PACKAGE_NAME } --confirm [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -k, --key string Path to public key file for validating signed packages -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md index bc45b56cd7..587283fccf 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools.md @@ -12,7 +12,7 @@ Collection of additional tools to make airgap easier ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md index e1476a9023..1dd729b38a 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver.md @@ -12,7 +12,7 @@ Compresses/Decompresses generic archives, including Zarf packages ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md index 84a11c6b2c..ecbbe70bf4 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_compress.md @@ -16,7 +16,7 @@ zarf tools archiver compress SOURCES ARCHIVE [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md index d8eb80402c..53249200d7 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_decompress.md @@ -17,7 +17,7 @@ zarf tools archiver decompress ARCHIVE DESTINATION [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md index bde45abf73..6397622fc4 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_archiver_version.md @@ -16,7 +16,7 @@ zarf tools archiver version [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md index abf704253d..b245fd9bbd 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_clear-cache.md @@ -17,7 +17,7 @@ zarf tools clear-cache [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md index ec83d0527e..c3d90216f8 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_download-init.md @@ -17,7 +17,7 @@ zarf tools download-init [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md index eb12650d67..8b7ea10756 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-key.md @@ -16,7 +16,7 @@ zarf tools gen-key [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md index c537e124e6..224f09489f 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_gen-pki.md @@ -17,7 +17,7 @@ zarf tools gen-pki HOST [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md index 914368fff2..457acc4756 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_get-creds.md @@ -37,7 +37,7 @@ $ zarf tools get-creds logging ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md index 9c3f374cbb..8dd9cd1610 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_tools_update-creds.md @@ -65,7 +65,7 @@ $ zarf tools update-creds artifact --artifact-push-username={USERNAME} --artifac ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output diff --git a/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md b/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md index 3cfd724684..2f83e0e4ac 100644 --- a/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md +++ b/docs/2-the-zarf-cli/100-cli-commands/zarf_version.md @@ -21,7 +21,7 @@ zarf version [flags] ## Options inherited from parent commands ``` - -a, --architecture string Architecture for OCI images and Zarf packages (default "amd64") + -a, --architecture string Architecture for OCI images and Zarf packages --insecure Allow access to insecure registries and disable other recommended security enforcements such as package checksum and signature validation. This flag should only be used if you have a specific reason and accept the reduced security posture. -l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info") --no-color Disable colors in output