From 5629c7c284a58ed0483290b5dfb95c515857e726 Mon Sep 17 00:00:00 2001 From: unclegedd Date: Fri, 7 Jun 2024 17:31:26 -0500 Subject: [PATCH 1/8] chore: cleans up lang file and adds more examples to docs --- src/cmd/uds.go | 4 ++-- src/config/lang/lang.go | 9 ++++----- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/cmd/uds.go b/src/cmd/uds.go index 09f7b1b5..65146457 100644 --- a/src/cmd/uds.go +++ b/src/cmd/uds.go @@ -156,7 +156,7 @@ var pullCmd = &cobra.Command{ var logsCmd = &cobra.Command{ Use: "logs", Aliases: []string{"l"}, - Short: "Display log file contents", + Short: lang.CmdBundleLogsShort, Run: func(_ *cobra.Command, _ []string) { logFilePath := filepath.Join(config.CommonOptions.CachePath, config.CachedLogs) @@ -185,7 +185,7 @@ func init() { // create cmd flags rootCmd.AddCommand(createCmd) - createCmd.Flags().BoolVarP(&config.CommonOptions.Confirm, "confirm", "c", false, lang.CmdBundleRemoveFlagConfirm) + createCmd.Flags().BoolVarP(&config.CommonOptions.Confirm, "confirm", "c", false, lang.CmdBundleCreateFlagConfirm) createCmd.Flags().StringVarP(&bundleCfg.CreateOpts.Output, "output", "o", v.GetString(V_BNDL_CREATE_OUTPUT), lang.CmdBundleCreateFlagOutput) createCmd.Flags().StringVarP(&bundleCfg.CreateOpts.SigningKeyPath, "signing-key", "k", v.GetString(V_BNDL_CREATE_SIGNING_KEY), lang.CmdBundleCreateFlagSigningKey) createCmd.Flags().StringVarP(&bundleCfg.CreateOpts.SigningKeyPassword, "signing-key-password", "p", v.GetString(V_BNDL_CREATE_SIGNING_KEY_PASSWORD), lang.CmdBundleCreateFlagSigningKeyPassword) diff --git a/src/config/lang/lang.go b/src/config/lang/lang.go index 77196558..c39f0d08 100644 --- a/src/config/lang/lang.go +++ b/src/config/lang/lang.go @@ -9,7 +9,7 @@ const ( RootCmdShort = "CLI for UDS Bundles" RootCmdFlagSkipLogFile = "Disable log file creation" RootCmdFlagNoProgress = "Disable fancy UI progress bars, spinners, logos, etc" - RootCmdFlagCachePath = "Specify the location of the Zarf cache directory" + RootCmdFlagCachePath = "Specify the location of the UDS cache directory" RootCmdFlagTempDir = "Specify the temporary directory to use for intermediate files" RootCmdFlagInsecure = "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." RootCmdFlagLogLevel = "Log level when running UDS-CLI. Valid options are: warn, info, debug, trace" @@ -20,12 +20,11 @@ const ( CmdBundleLogsShort = "View most recent UDS CLI logs" // bundle - CmdBundleShort = "Commands for creating, deploying, removing, pulling, and inspecting bundles" CmdBundleFlagConcurrency = "Number of concurrent layer operations to perform when interacting with a remote bundle." // bundle create - CmdBundleCreateShort = "Create a bundle from a given directory or the current directory" - //CmdBundleCreateFlagConfirm = "Confirm bundle creation without prompting" + CmdBundleCreateShort = "Create a bundle from a given directory or the current directory" + CmdBundleCreateFlagConfirm = "Confirm bundle creation without prompting" CmdBundleCreateFlagOutput = "Specify the output (an oci:// URL) for the created bundle" CmdBundleCreateFlagSigningKey = "Path to private key file for signing bundles" CmdBundleCreateFlagSigningKeyPassword = "Password to the private key file used for signing bundles" @@ -33,7 +32,7 @@ const ( // bundle deploy CmdBundleDeployShort = "Deploy a bundle from a local tarball or oci:// URL" - CmdBundleDeployFlagConfirm = "Confirms bundle deployment without prompting. ONLY use with bundles you trust. Skips prompts to review SBOM, configure variables, select optional components and review potential breaking changes." + CmdBundleDeployFlagConfirm = "Confirms bundle deployment without prompting. ONLY use with bundles you trust" CmdBundleDeployFlagPackages = "Specify which zarf packages you would like to deploy from the bundle. By default all zarf packages in the bundle are deployed." CmdBundleDeployFlagResume = "Only deploys packages from the bundle which haven't already been deployed" CmdBundleDeployFlagSet = "Specify deployment variables to set on the command line (KEY=value)" From 221ae17bc6acfbb2d1f5b039f7e6e4fd2cbcf38a Mon Sep 17 00:00:00 2001 From: unclegedd Date: Mon, 10 Jun 2024 07:42:35 -0500 Subject: [PATCH 2/8] WIP: PRs for releases --- .github/actions/save-logs/action.yaml | 12 +----------- .github/workflows/release.yaml | 9 +++++---- .github/workflows/test-e2e-pr.yaml | 10 ---------- .goreleaser.yaml | 14 ++++++++++++++ 4 files changed, 20 insertions(+), 25 deletions(-) diff --git a/.github/actions/save-logs/action.yaml b/.github/actions/save-logs/action.yaml index f6bfbc14..aeac93a8 100644 --- a/.github/actions/save-logs/action.yaml +++ b/.github/actions/save-logs/action.yaml @@ -1,20 +1,10 @@ name: save-logs description: "Save debug logs" -inputs: - name: - description: "unique name to put in log file" - required: true - runs: using: composite steps: - - name: Fix log permissions - run: | - sudo chown $USER /tmp/uds-${{ inputs.name }}.log || echo "" - shell: bash - - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 with: name: debug-log - path: /tmp/uds-${{ inputs.name }}.log + path: /tmp/uds-*.log diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 3361bdac..3353b502 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -149,11 +149,12 @@ jobs: - name: Get Brew tap repo token id: brew-tap-token - uses: peter-murray/workflow-application-token-action@dc0413987a085fa17d19df9e47d4677cf81ffef3 # v3.0.0 + uses: actions/create-github-app-token@c8f55efbd427e7465d6da1106e7979bc8aaee856 # v1.10.1 with: - application_id: ${{ secrets.HOMEBREW_TAP_WORKFLOW_GITHUB_APP_ID }} - application_private_key: ${{ secrets.HOMEBREW_TAP_WORKFLOW_GITHUB_APP_SECRET }} - organization: defenseunicorns + app-id: ${{ secrets.HOMEBREW_TAP_WORKFLOW_GITHUB_APP_ID }} + private-key: ${{ secrets.HOMEBREW_TAP_WORKFLOW_GITHUB_APP_SECRET }} + owner: defenseunicorns + repositories: homebrew-tap - name: Run GoReleaser uses: goreleaser/goreleaser-action@5742e2a039330cbb23ebf35f046f814d4c6ff811 # v5.1.0 diff --git a/.github/workflows/test-e2e-pr.yaml b/.github/workflows/test-e2e-pr.yaml index c3312893..ff090444 100644 --- a/.github/workflows/test-e2e-pr.yaml +++ b/.github/workflows/test-e2e-pr.yaml @@ -66,8 +66,6 @@ jobs: - name: Save logs if: always() uses: ./.github/actions/save-logs - with: - name: build test-dev: runs-on: ubuntu-latest @@ -88,8 +86,6 @@ jobs: - name: Save logs if: always() uses: ./.github/actions/save-logs - with: - name: test-dev test-variables: runs-on: ubuntu-latest @@ -110,8 +106,6 @@ jobs: - name: Save logs if: always() uses: ./.github/actions/save-logs - with: - name: test-variables test-optional-bundle: runs-on: ubuntu-latest @@ -132,8 +126,6 @@ jobs: - name: Save logs if: always() uses: ./.github/actions/save-logs - with: - name: test-optional-bundle test-vendor: runs-on: ubuntu-latest @@ -154,5 +146,3 @@ jobs: - name: Save logs if: always() uses: ./.github/actions/save-logs - with: - name: test-vendor diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 6976b929..a49ead12 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -49,6 +49,13 @@ brews: owner: defenseunicorns name: homebrew-tap token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}" + branch: "{{ .ProjectName }}-{{ .Tag }}" + pull_request: + enabled: true + base: + branch: main + owner: defenseunicorns + name: homebrew-tap commit_msg_template: "Brew formula update for {{ .ProjectName }} version {{ .Tag }}" homepage: "https://github.com/defenseunicorns/uds-cli" description: "CLI for Unicorn Delivery Service" @@ -60,6 +67,13 @@ brews: owner: defenseunicorns name: homebrew-tap token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}" + branch: "{{ .ProjectName }}-{{ .Tag }}" + pull_request: + enabled: true + base: + branch: main + owner: defenseunicorns + name: homebrew-tap commit_msg_template: "Brew formula update for {{ .ProjectName }} versioned release {{ .Tag }}" homepage: "https://github.com/defenseunicorns/uds-cli" description: "CLI for Unicorn Delivery Service" From 4db92a756b581a1566a08503fbcb48aff1dc2e7f Mon Sep 17 00:00:00 2001 From: unclegedd Date: Mon, 10 Jun 2024 08:28:17 -0500 Subject: [PATCH 3/8] WIP: bug? --- .github/actions/save-logs/action.yaml | 10 ++++++++++ .github/workflows/test-e2e-pr.yaml | 20 ++++++++++++++----- src/pkg/bundle/deploy.go | 4 ++-- .../bundles/07-helm-overrides/uds-bundle.yaml | 2 +- .../bundles/07-helm-overrides/uds-config.yaml | 3 ++- tasks/tests.yaml | 20 +++++++++---------- 6 files changed, 40 insertions(+), 19 deletions(-) diff --git a/.github/actions/save-logs/action.yaml b/.github/actions/save-logs/action.yaml index aeac93a8..8bd49954 100644 --- a/.github/actions/save-logs/action.yaml +++ b/.github/actions/save-logs/action.yaml @@ -1,9 +1,19 @@ name: save-logs description: "Save debug logs" +inputs: + name: + description: "unique name to put in log file" + required: true + runs: using: composite steps: + - name: Fix log permissions + run: | + sudo chown $USER /tmp/uds-${{ inputs.name }}.log || echo "" + shell: bash + - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 with: name: debug-log diff --git a/.github/workflows/test-e2e-pr.yaml b/.github/workflows/test-e2e-pr.yaml index ff090444..47577a92 100644 --- a/.github/workflows/test-e2e-pr.yaml +++ b/.github/workflows/test-e2e-pr.yaml @@ -61,11 +61,13 @@ jobs: - name: Run e2e bundle tests run: | - build/uds run test:run-bundle-test --no-progress + build/uds run test:bundle --no-progress - name: Save logs if: always() uses: ./.github/actions/save-logs + with: + name: build test-dev: runs-on: ubuntu-latest @@ -81,11 +83,13 @@ jobs: - name: Run e2e dev tests run: | - build/uds run test:run-dev-test --no-progress + build/uds run test:dev --no-progress - name: Save logs if: always() uses: ./.github/actions/save-logs + with: + name: test-dev test-variables: runs-on: ubuntu-latest @@ -101,11 +105,13 @@ jobs: - name: Run e2e variable tests run: | - build/uds run test:run-variable-test --no-progress + build/uds run test:variable --no-progress - name: Save logs if: always() uses: ./.github/actions/save-logs + with: + name: test-variables test-optional-bundle: runs-on: ubuntu-latest @@ -121,11 +127,13 @@ jobs: - name: Run e2e optional bundle tests run: | - build/uds run test:run-optional-bundle-tests --no-progress + build/uds run test:optional-bundle --no-progress - name: Save logs if: always() uses: ./.github/actions/save-logs + with: + name: test-optional-bundle test-vendor: runs-on: ubuntu-latest @@ -141,8 +149,10 @@ jobs: - name: Run e2e vendor tests run: | - build/uds run test:run-vendor-tests --no-progress + build/uds run test:vendor --no-progress - name: Save logs if: always() uses: ./.github/actions/save-logs + with: + name: test-vendor diff --git a/src/pkg/bundle/deploy.go b/src/pkg/bundle/deploy.go index 6f2997e4..a4794f8c 100644 --- a/src/pkg/bundle/deploy.go +++ b/src/pkg/bundle/deploy.go @@ -502,8 +502,8 @@ func setTemplatedVariables(templatedVariables string, pkgVars map[string]string) replacedValue := templatedVarRegex.ReplaceAllStringFunc(templatedVariables, func(match string) string { // returns slice with the templated variable and the variable name variableName := templatedVarRegex.FindStringSubmatch(match)[1] - // If we have a templated variable, get the value from pkgVars - if varValue, ok := pkgVars[variableName]; ok { + // If we have a templated variable, get the value from pkgVars (use uppercase for case-insensitive comparison) + if varValue, ok := pkgVars[strings.ToUpper(variableName)]; ok { return varValue } return fmt.Sprintf("${%s_not_found}", variableName) diff --git a/src/test/bundles/07-helm-overrides/uds-bundle.yaml b/src/test/bundles/07-helm-overrides/uds-bundle.yaml index 3dd87610..9d59de8f 100644 --- a/src/test/bundles/07-helm-overrides/uds-bundle.yaml +++ b/src/test/bundles/07-helm-overrides/uds-bundle.yaml @@ -14,7 +14,7 @@ packages: unicorn-podinfo: values: - path: "podinfo.replicaCount" - value: 2 + value: ${numReplicas} - path: "podinfo.tolerations" value: - key: "unicorn" diff --git a/src/test/bundles/07-helm-overrides/uds-config.yaml b/src/test/bundles/07-helm-overrides/uds-config.yaml index 299679dc..a16b12ae 100644 --- a/src/test/bundles/07-helm-overrides/uds-config.yaml +++ b/src/test/bundles/07-helm-overrides/uds-config.yaml @@ -3,7 +3,8 @@ options: variables: helm-overrides: - # vars can be upper or lowercase + # vars are case-insensitive + numReplicas: 2 ui_color: "green, yellow" UI_MSG: "Hello Unicorn" security_ctx: diff --git a/tasks/tests.yaml b/tasks/tests.yaml index 95916b54..364ab24c 100644 --- a/tasks/tests.yaml +++ b/tasks/tests.yaml @@ -15,38 +15,38 @@ tasks: - name: e2e-no-ghcr-write description: run e2e tests without writing to GHCR actions: - - task: run-bundle-test - - task: run-dev-test - - task: run-variable-test - - task: run-optional-bundle-tests - - task: run-vendor-tests + - task: bundle + - task: dev + - task: variable + - task: optional-bundle + - task: vendor - name: e2e-ghcr description: run e2e tests that write to GHCR actions: - cmd: cd src/test/e2e && go test -failfast -v -timeout 30m -run ".*GHCR.*" - - name: run-bundle-test + - name: bundle description: only run tests in bundle_test.go actions: - cmd: cd src/test/e2e && go test -failfast -v -timeout 30m bundle_test.go commands_test.go main_test.go - - name: run-dev-test + - name: dev description: only run tests in dev.go actions: - cmd: cd src/test/e2e && go test -failfast -v -timeout 30m dev_test.go commands_test.go main_test.go - - name: run-variable-test + - name: variable description: only run tests in variable_test.go actions: - cmd: cd src/test/e2e && go test -failfast -v -timeout 30m variable_test.go commands_test.go main_test.go - - name: run-optional-bundle-tests + - name: optional-bundle description: only run tests in optional_bundle_test.go actions: - cmd: cd src/test/e2e && go test -failfast -v -timeout 30m optional_bundle_test.go commands_test.go main_test.go - - name: run-vendor-tests + - name: vendor description: only run tests in zarf_test.go and runner_test.go actions: - cmd: cd src/test/e2e && go test -failfast -v -timeout 30m zarf_test.go runner_test.go commands_test.go main_test.go From 95e3e40274ff78bd2e1623bdf9cbaa356341a924 Mon Sep 17 00:00:00 2001 From: unclegedd Date: Mon, 10 Jun 2024 08:29:17 -0500 Subject: [PATCH 4/8] WIP --- .github/actions/save-logs/action.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/actions/save-logs/action.yaml b/.github/actions/save-logs/action.yaml index 8bd49954..f6bfbc14 100644 --- a/.github/actions/save-logs/action.yaml +++ b/.github/actions/save-logs/action.yaml @@ -17,4 +17,4 @@ runs: - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 with: name: debug-log - path: /tmp/uds-*.log + path: /tmp/uds-${{ inputs.name }}.log From cbaedef3a9931818cf5a4ce70ee8c9af83b6d2ba Mon Sep 17 00:00:00 2001 From: unclegedd Date: Mon, 10 Jun 2024 08:44:35 -0500 Subject: [PATCH 5/8] more docs --- README.md | 56 ++++++++++++++++------------------------------- docs/overrides.md | 16 ++++++++++++-- 2 files changed, 33 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 5e6742cd..ab0061f5 100644 --- a/README.md +++ b/README.md @@ -7,38 +7,24 @@ ## Table of Contents -- [UDS-CLI](#uds-cli) - - [Table of Contents](#table-of-contents) - - [Install](#install) - - [Contributing](#contributing) - - [Quickstart](#quickstart) - - [Declarative Syntax](#declarative-syntax) - - [First-class UDS Support](#first-class-uds-support) - - [Bundle Create](#bundle-create) - - [Bundle Deploy](#bundle-deploy) - - [Specifying Packages using `--packages`](#specifying-packages-using---packages) - - [Resuming Bundle Deploys using `--resume`](#resuming-bundle-deploys-using---resume) - - [Bundle Inspect](#bundle-inspect) - - [Viewing Images in a Bundle](#viewing-images-in-a-bundle) - - [Viewing SBOMs](#viewing-sboms) - - [Bundle Publish](#bundle-publish) - - [Bundle Remove](#bundle-remove) +1. [Install](#install) +1. [Contributing](CONTRIBUTING.md) +1. [Quickstart](#quickstart) + - [Create](#bundle-create) + - [Deploy](#bundle-deploy) + - [Inspect](#bundle-inspect) + - [Publish](#bundle-publish) + - [Remove](#bundle-remove) - [Logs](#logs) - - [Bundle Architecture and Multi-Arch Support](#bundle-architecture-and-multi-arch-support) - - [Architecture Validation](#architecture-validation) - - [Configuration](#configuration) - - [Sharing Variables](#sharing-variables) - - [Importing/Exporting Variables](#importingexporting-variables) - - [Sharing Variables Across Multiple Packages](#sharing-variables-across-multiple-packages) - - [Variable Precedence and Specificity](#variable-precedence-and-specificity) - - [Duplicate Packages And Naming](#duplicate-packages-and-naming) - - [Zarf Integration](#zarf-integration) - - [Dev Mode](#dev-mode) - - [Scan](#scan) - - [Usage](#usage) - - [Required Parameters](#required-parameters) - - [Optional Parameters](#optional-parameters) - - [Example Usage](#example-usage) +1. [Bundle Architecture and Multi-Arch Support](#bundle-architecture-and-multi-arch-support) +1. [Variables and Configuration](#variables-and-configuration) +1. [Duplicate Packages and Naming](#duplicate-packages-and-naming) +1. [Zarf Integration](#zarf-integration) +1. [Bundle Overrides](docs/overrides.md) +1. [Bundle Anatomy](docs/anatomy.md) +1. [Runner](docs/runner.md) +1. [Dev Mode](#dev-mode) +1. [Scan](#scan) ## Install @@ -208,8 +194,7 @@ If, for example, you have a multi-arch remote bundle that you want to deploy fro e.g. `uds deploy -a amd64 --confirm` -## Configuration - +## Variables and Configuration The UDS CLI can be configured with a `uds-config.yaml` file. This file can be placed in the current working directory or specified with an environment variable called `UDS_CONFIG`. The basic structure of the `uds-config.yaml` is as follows: ```yaml @@ -239,10 +224,7 @@ variables: The `options` key contains UDS CLI options that are not specific to a particular Zarf package. The `variables` key contains variables that are specific to a particular Zarf package. If you want to share insensitive variables across multiple Zarf packages, you can use the `shared` key, where the key is the variable name and the value is the variable value. -## Sharing Variables - -### Importing/Exporting Variables - +### Sharing Variables Zarf package variables can be passed between Zarf packages: ```yaml diff --git a/docs/overrides.md b/docs/overrides.md index 14ba629f..1d618dc7 100644 --- a/docs/overrides.md +++ b/docs/overrides.md @@ -150,7 +150,13 @@ The `value` is the value to set at the `path`. Values can be simple values such value: customAnnotation: "customValue" ``` -If using a variable that has been [exported](../README.md#importingexporting-variables) from another package, that variable can also be used to set a value, using the syntax `${...}`. In the example below the `COLOR` variable is being used to set the `podinfo.ui.color` value. +Zarf variables can be used to set override values and be override variable defaults using the syntax `${...}`. +```yaml +# uds-config.yaml +variables: + helm-overrides-package: + replica_count: 2 +``` ```yaml kind: UDSBundle metadata: @@ -174,11 +180,13 @@ packages: unicorn-podinfo: values: - path: "podinfo.replicaCount" - value: 1 + value: ${REPLICA_COUNT} - path: "podinfo.ui.color" value: ${COLOR} ``` +In the example above `${REPLICA_COUNT}` is set in the `uds-config.yaml` file and `${COLOR}` is set as an export from the `output-var` package. Note that you could also set these values with environment variables prefixed with `UDS_` or with the `--set` flag during deployment. + #### Value Precedence Value precedence is as follows: 1. The `values` in an `overrides` block @@ -206,6 +214,10 @@ packages: path: "ui.color" description: "Set the color for podinfo's UI" default: "purple" + - name: UI_MSG + path: "podinfo.ui.message" + description: "Set the message for podinfo's UI" + default: ${UI_MSG} # templating also works for variable defaults! ``` There are 3 ways to override the `UI_COLOR` variable: From c5b85e63cf26ae9f58cc4b96a222766b838c47b7 Mon Sep 17 00:00:00 2001 From: unclegedd Date: Mon, 10 Jun 2024 08:49:39 -0500 Subject: [PATCH 6/8] more docs --- docs/overrides.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/overrides.md b/docs/overrides.md index 1d618dc7..aedc95dc 100644 --- a/docs/overrides.md +++ b/docs/overrides.md @@ -150,7 +150,9 @@ The `value` is the value to set at the `path`. Values can be simple values such value: customAnnotation: "customValue" ``` -Zarf variables can be used to set override values and be override variable defaults using the syntax `${...}`. + +#### Bundle Variables as Values +Bundle and Zarf variables can be used to set override values and be override variable defaults using the syntax `${...}`. For example: ```yaml # uds-config.yaml variables: @@ -185,7 +187,7 @@ packages: value: ${COLOR} ``` -In the example above `${REPLICA_COUNT}` is set in the `uds-config.yaml` file and `${COLOR}` is set as an export from the `output-var` package. Note that you could also set these values with environment variables prefixed with `UDS_` or with the `--set` flag during deployment. +In the example above `${REPLICA_COUNT}` is set in the `uds-config.yaml` file and `${COLOR}` is set as an export from the `output-var` package. Note that you could also set these values with the `shared` key in a `uds-config.yaml`, environment variables prefixed with `UDS_` or with the `--set` flag during deployment. #### Value Precedence Value precedence is as follows: From f74b00f597aaf89ef4830138a29424d51e6e869c Mon Sep 17 00:00:00 2001 From: unclegedd Date: Mon, 10 Jun 2024 09:18:19 -0500 Subject: [PATCH 7/8] docs correction --- docs/overrides.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/overrides.md b/docs/overrides.md index aedc95dc..9aaf0e1b 100644 --- a/docs/overrides.md +++ b/docs/overrides.md @@ -152,7 +152,7 @@ The `value` is the value to set at the `path`. Values can be simple values such ``` #### Bundle Variables as Values -Bundle and Zarf variables can be used to set override values and be override variable defaults using the syntax `${...}`. For example: +Bundle and Zarf variables can be used to set override values by using the syntax `${...}`. For example: ```yaml # uds-config.yaml variables: @@ -216,10 +216,6 @@ packages: path: "ui.color" description: "Set the color for podinfo's UI" default: "purple" - - name: UI_MSG - path: "podinfo.ui.message" - description: "Set the message for podinfo's UI" - default: ${UI_MSG} # templating also works for variable defaults! ``` There are 3 ways to override the `UI_COLOR` variable: From 4efe03db9349cdf975148e50e50858ee0f97b90b Mon Sep 17 00:00:00 2001 From: unclegedd Date: Mon, 10 Jun 2024 09:20:32 -0500 Subject: [PATCH 8/8] another comment --- src/test/bundles/07-helm-overrides/uds-bundle.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/bundles/07-helm-overrides/uds-bundle.yaml b/src/test/bundles/07-helm-overrides/uds-bundle.yaml index 9d59de8f..b73426a0 100644 --- a/src/test/bundles/07-helm-overrides/uds-bundle.yaml +++ b/src/test/bundles/07-helm-overrides/uds-bundle.yaml @@ -14,7 +14,7 @@ packages: unicorn-podinfo: values: - path: "podinfo.replicaCount" - value: ${numReplicas} + value: ${numReplicas} # set from uds-config.yaml - path: "podinfo.tolerations" value: - key: "unicorn"