From 3a7d3bb0c80a0f9a634b5a0e37818deefbc8b5ac Mon Sep 17 00:00:00 2001 From: Gaurav Nelson <23069445+gaurav-nelson@users.noreply.github.com> Date: Thu, 16 Apr 2026 12:14:32 +1000 Subject: [PATCH] fix: update instructions for customizing values-global.yaml --- .../learn/values-global-configuration.adoc | 153 ++++++++++++++++++ content/learn/workflow.adoc | 20 +-- .../getting-started.md | 5 +- .../ansible-edge-gitops/getting-started.adoc | 17 +- content/patterns/devsecops/getting-started.md | 5 +- .../getting-started.adoc | 17 +- .../gaudi-rag-chat-qna-getting-started.adoc | 15 +- .../getting-started.adoc | 3 +- .../medical-diagnosis/getting-started.adoc | 7 +- .../getting-started.md | 5 +- .../mcg-amx-rhoai-getting-started.adoc | 17 +- .../mcg-amx-getting-started.adoc | 15 +- .../mcg-qat-getting-started.adoc | 17 +- .../mcg-sgx-hello-world-getting-started.adoc | 15 +- .../mcg-sgx-getting-started.adoc | 18 +-- .../getting-started.md | 5 +- modules/edd-deploying-edd-pattern.adoc | 3 +- modules/outline-of-a-basic-values-file.adoc | 2 +- modules/retail-deploying.adoc | 21 +-- 19 files changed, 196 insertions(+), 164 deletions(-) create mode 100644 content/learn/values-global-configuration.adoc diff --git a/content/learn/values-global-configuration.adoc b/content/learn/values-global-configuration.adoc new file mode 100644 index 0000000000..66aff3da31 --- /dev/null +++ b/content/learn/values-global-configuration.adoc @@ -0,0 +1,153 @@ +--- +menu: + learn: + parent: Validated patterns frameworks +title: Global configuration reference +weight: 55 +aliases: /learn/values-global-configuration/ +--- + +:toc: +:imagesdir: /images +:_content-type: ASSEMBLY +include::modules/comm-attributes.adoc[] + +[id="values-global-configuration"] += Global configuration reference + +Every validated pattern includes a `values-global.yaml` file at the repository root. This file defines configuration settings that apply across all clusters and environments in the pattern. + +[id="global-section"] +== `global` section + +The `global` section contains settings that Helm distributes to all sub-charts in the pattern. + +[id="global-pattern"] +=== `global.pattern` + +Specifies the name of the validated pattern. The framework uses this value internally to identify the pattern. + +[source,yaml] +---- +global: + pattern: multicloud-gitops +---- + +Do not change this value unless you are creating a new pattern. + +[id="global-options"] +=== `global.options` + +The `options` block sets default behaviors for operator management and ArgoCD synchronization across all clusters. + +[source,yaml] +---- +global: + options: + useCSV: false + syncPolicy: Automatic + installPlanApproval: Automatic +---- + +.Options fields +[cols="2,1,5",options="header"] +|=== +| Field | Default | Description + +| `syncPolicy` +| `Automatic` +| Sets the default ArgoCD synchronization policy. `Automatic` syncs changes from Git to the cluster without manual intervention. `Manual` requires an administrator to trigger each sync. + +| `installPlanApproval` +| `Automatic` +| Controls how Operator Lifecycle Manager (OLM) handles operator upgrades. With `Automatic`, operators check for and apply updates periodically. `Manual` requires an administrator to approve each upgrade. + +| `useCSV` +| `false` +| Determines whether subscriptions use specific `ClusterServiceVersions` (CSV) for operator installation. When set to `false`, the subscription channel determines which version to install. Set to `true` when you need to pin operators to specific versions. +|=== + +[id="main-section"] +== `main` section + +The `main` section defines settings for the primary cluster that manages the pattern. + +[id="main-clustergroupname"] +=== `main.clusterGroupName` + +Identifies the main ClusterGroup, which acts as the hub or starting point for the pattern. A ClusterGroup represents a set of clusters that share nearly identical configurations and serve a common architectural purpose. + +[source,yaml] +---- +main: + clusterGroupName: hub +---- + +The value must match a corresponding `values-.yaml` file in the repository. For example, `clusterGroupName: hub` requires a `values-hub.yaml` file. Most patterns use `hub` for the primary cluster. + +For more information about ClusterGroups, see link:/learn/clustergroup-in-values-files/[ClusterGroup in values files]. + +[id="main-multisourceconfig"] +=== `main.multiSourceConfig` + +Controls whether ArgoCD uses multi-source applications, enabling Helm charts to be fetched from external repositories in addition to the local Git repository. + +[source,yaml] +---- +main: + multiSourceConfig: + enabled: true +---- + +.multiSourceConfig fields +[cols="2,1,5",options="header"] +|=== +| Field | Default | Description + +| `enabled` +| `true` +| Enables multi-source ArgoCD applications. This is the recommended setting for most deployments. + +| `clusterGroupChartVersion` +| (optional) +| Constrains the version of the ClusterGroup Helm chart to fetch. Accepts semver ranges such as `0.9.*`. + +| `helmRepoUrl` +| (optional) +| Overrides the Helm chart repository URL. Use this for disconnected or air-gapped environments where charts are hosted on an internal registry. +|=== + +For more information about disconnected environments, see link:/learn/disconnected-installation/[Disconnected installation]. + +[id="example-values-global"] +== Example `values-global.yaml` + +The following example shows a typical `values-global.yaml` file for the Multicloud GitOps pattern: + +[source,yaml] +---- +--- +global: + pattern: multicloud-gitops + + options: + useCSV: false + syncPolicy: Automatic + installPlanApproval: Automatic + +main: + clusterGroupName: hub + + multiSourceConfig: + enabled: true +---- + +For most patterns, the default values provide a working configuration. Customize specific fields only when your environment requires different behavior, such as pinning operator versions or deploying in a disconnected environment. + +[id="additional-resources"] +== Additional resources + +* link:/values-files/[Exploring values files] +* link:/learn/clustergroup-in-values-files/[ClusterGroup in values files] +* link:/learn/disconnected-installation/[Disconnected installation] +* link:/learn/vp_add_specific_ops_to_pattern/[Adding a specific operator version to a pattern] diff --git a/content/learn/workflow.adoc b/content/learn/workflow.adoc index 67011f5c21..ead037b458 100644 --- a/content/learn/workflow.adoc +++ b/content/learn/workflow.adoc @@ -38,26 +38,16 @@ $ cp values-secret.yaml.template ~/values-secret.yaml $ vi ~/values-secret.yaml ---- -. Customize the deployment for your cluster. Customization involves updating the `values-global.yaml` file with configurations specific to your cluster environment. -.. Edit the `values-global.yaml` file: +. Optional: Customize the deployment for your cluster. The `values-global.yaml` file contains global settings such as the ArgoCD sync policy, operator install plan approval, and the cluster group name. Review the file and update any values that your environment requires. + -[source,terminal] +For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. + ----- -$ vi values-global.yaml ----- -.. Commit the updated `values-global.yaml` file to the repository: +If you make changes, commit and push them: + [source,terminal] -+ ----- -$ git commit values-global.yaml ----- -.. Push the committed changes: -+ -[source,terminal] - ---- +$ git add values-global.yaml +$ git commit -m "Customize values-global for my cluster" $ git push ---- diff --git a/content/patterns/ansible-edge-gitops-kasten/getting-started.md b/content/patterns/ansible-edge-gitops-kasten/getting-started.md index 833078e40c..7847205056 100644 --- a/content/patterns/ansible-edge-gitops-kasten/getting-started.md +++ b/content/patterns/ansible-edge-gitops-kasten/getting-started.md @@ -211,13 +211,12 @@ To install a collection that is not currently installed: git push origin my-branch ``` -1. Customize the deployment for your cluster (Optional - the defaults in values-global.yaml are designed to work in AWS): +1. Optional: Customize the deployment for your cluster. The defaults in `values-global.yaml` are designed to work in AWS. For a description of each field, see [Global configuration reference](/learn/values-global-configuration/). If you make changes, create a branch, commit, and push: ```sh git checkout -b my-branch - vi values-global.yaml git add values-global.yaml - git commit values-global.yaml + git commit -m "Customize values-global for my cluster" git push origin my-branch ``` diff --git a/content/patterns/ansible-edge-gitops/getting-started.adoc b/content/patterns/ansible-edge-gitops/getting-started.adoc index 05c686112a..7fd400f094 100644 --- a/content/patterns/ansible-edge-gitops/getting-started.adoc +++ b/content/patterns/ansible-edge-gitops/getting-started.adoc @@ -182,25 +182,14 @@ This is the username and password that you use to log in to link:https://catalog $ git checkout -b my-branch ---- -. Edit the `values-global.yaml` file to customize the deployment for your cluster. The defaults in `values-global.yaml` are designed to work in AWS. For example: +. Optional: Edit the `values-global.yaml` file to customize the deployment for your cluster. The defaults are designed to work in AWS. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. + -[source,terminal] ----- -$ vi values-global.yaml ----- - -. Add the changes to the staging area by running the following command: +If you make changes, stage and commit them: + [source,terminal] ---- $ git add values-global.yaml ----- - -. Commit the changes by running the following command: -+ -[source,terminal] ----- -$ git commit -m "any updates" +$ git commit -m "Customize values-global for my cluster" ---- . Push the changes to your forked repository: diff --git a/content/patterns/devsecops/getting-started.md b/content/patterns/devsecops/getting-started.md index 21a48e6dc3..9c6ca2e47b 100644 --- a/content/patterns/devsecops/getting-started.md +++ b/content/patterns/devsecops/getting-started.md @@ -114,12 +114,11 @@ When you create a fine-grained token, you must also configure these settings: vi ~/values-secret.yaml ``` -1. Customize the deployment for your cluster. Change the appropriate values in `values-global.yaml` +1. Optional: Customize the deployment for your cluster. The `values-global.yaml` file contains global settings for the pattern. For a description of each field, see [Global configuration reference](/learn/values-global-configuration/). If you make changes, commit and push them: ```sh - vi values-global.yaml git add values-global.yaml - git commit values-global.yaml + git commit -m "Customize values-global for my cluster" git push origin my-branch ``` diff --git a/content/patterns/federated-edge-observability/getting-started.adoc b/content/patterns/federated-edge-observability/getting-started.adoc index 420c953ce2..e0b16e93f5 100644 --- a/content/patterns/federated-edge-observability/getting-started.adoc +++ b/content/patterns/federated-edge-observability/getting-started.adoc @@ -184,25 +184,14 @@ Certificates for the OpenTelemetry collector infrastructure. `Snakeoil` that is, $ git checkout -b my-branch ---- -. Edit the `values-global.yaml` file to customize the deployment for your cluster. The defaults in `values-global.yaml` are designed to work in AWS. For example: +. Optional: Edit the `values-global.yaml` file to customize the deployment for your cluster. The defaults are designed to work in AWS. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. + -[source,terminal] ----- -$ vi values-global.yaml ----- - -. Add the changes to the staging area by running the following command: +If you make changes, stage and commit them: + [source,terminal] ---- $ git add values-global.yaml ----- - -. Commit the changes by running the following command: -+ -[source,terminal] ----- -$ git commit -m "No updates" +$ git commit -m "Customize values-global for my cluster" ---- . Push the changes to your forked repository: diff --git a/content/patterns/gaudi-rag-chat-qna/gaudi-rag-chat-qna-getting-started.adoc b/content/patterns/gaudi-rag-chat-qna/gaudi-rag-chat-qna-getting-started.adoc index f0bce04a3d..983beb5c83 100644 --- a/content/patterns/gaudi-rag-chat-qna/gaudi-rag-chat-qna-getting-started.adoc +++ b/content/patterns/gaudi-rag-chat-qna/gaudi-rag-chat-qna-getting-started.adoc @@ -103,23 +103,12 @@ If the cluster is behind proxy remember to change proxy values of fields `gaudil git checkout -b my-branch ---- + -[source,terminal] ----- -vi values-global.yaml ----- +For a description of each field in `values-global.yaml`, see link:/learn/values-global-configuration/[Global configuration reference]. Edit the file, then commit and push: + [source,terminal] ---- git add values-global.yaml ----- -+ -[source,terminal] ----- -git commit values-global.yaml ----- -+ -[source,terminal] ----- +git commit -m "Customize values-global for my cluster" git push origin my-branch ---- diff --git a/content/patterns/medical-diagnosis-amx/getting-started.adoc b/content/patterns/medical-diagnosis-amx/getting-started.adoc index f058880d91..11dfba7dd8 100644 --- a/content/patterns/medical-diagnosis-amx/getting-started.adoc +++ b/content/patterns/medical-diagnosis-amx/getting-started.adoc @@ -108,12 +108,11 @@ By default, Vault password policy generates the passwords for you. However, you When defining a custom password for the database users, avoid using the `$` special character as it gets interpreted by the shell and will ultimately set the incorrect desired password. ==== -. To customize the deployment for your cluster, update the `values-global.yaml` file by running the following commands: +. To customize the deployment for your cluster, update the `values-global.yaml` file. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. Run the following command to create a branch: + [source,terminal] ---- $ git checkout -b my-branch -$ vi values-global.yaml ---- + Replace 'bucketSource' value. User can set any bucket name without special signs (besides '-') and numbers. diff --git a/content/patterns/medical-diagnosis/getting-started.adoc b/content/patterns/medical-diagnosis/getting-started.adoc index 1743030a61..4f0714b20b 100644 --- a/content/patterns/medical-diagnosis/getting-started.adoc +++ b/content/patterns/medical-diagnosis/getting-started.adoc @@ -242,12 +242,7 @@ When defining a custom password for the database users, avoid using the `$` spec $ git checkout -b my-branch ---- -. Edit the `values-global.yaml` updating the S3 and datacenter details. -+ -[source,terminal] ----- -$ vi values-global.yaml ----- +. Edit the `values-global.yaml` file to update the S3 and datacenter details. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. + .Example edited `values-global.yaml` file + diff --git a/content/patterns/multicloud-gitops-Portworx/getting-started.md b/content/patterns/multicloud-gitops-Portworx/getting-started.md index d1c3834d75..565f0c20c6 100644 --- a/content/patterns/multicloud-gitops-Portworx/getting-started.md +++ b/content/patterns/multicloud-gitops-Portworx/getting-started.md @@ -49,13 +49,12 @@ service](https://console.redhat.com/openshift/create). vi ~/values-secret-multicloud-gitops-pxe.yaml ``` -5. Customize the deployment for your cluster. +5. Optional: Customize the deployment for your cluster. The `values-global.yaml` file contains global settings for the pattern. For a description of each field, see [Global configuration reference](/learn/values-global-configuration/). If you make changes, create a branch, commit, and push: ```sh git checkout -b my-branch - vi values-global.yaml git add values-global.yaml - git commit values-global.yaml + git commit -m "Customize values-global for my cluster" git push origin my-branch ``` diff --git a/content/patterns/multicloud-gitops-amx-rhoai/mcg-amx-rhoai-getting-started.adoc b/content/patterns/multicloud-gitops-amx-rhoai/mcg-amx-rhoai-getting-started.adoc index 9f52939fbe..7a8dd9c789 100644 --- a/content/patterns/multicloud-gitops-amx-rhoai/mcg-amx-rhoai-getting-started.adoc +++ b/content/patterns/multicloud-gitops-amx-rhoai/mcg-amx-rhoai-getting-started.adoc @@ -51,30 +51,19 @@ cp values-secret.yaml.template ~/values-secret-multicloud-gitops.yaml Do not commit this file. You do not want to push personal credentials to GitHub. ==== -. (Optional) You may customize the deployment for your cluster depending on your needs by editing values-global.yaml and values-hub.yaml. To do this run the following commands: +. Optional: Customize the deployment for your cluster by editing `values-global.yaml` and `values-hub.yaml`. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. To do this, run the following commands: + [source,terminal] ---- git checkout -b my-branch ---- + -[source,terminal] ----- -vi values-global.yaml ----- +Edit the file, then commit and push: + [source,terminal] ---- git add values-global.yaml ----- -+ -[source,terminal] ----- -git commit values-global.yaml ----- -+ -[source,terminal] ----- +git commit -m "Customize values-global for my cluster" git push origin my-branch ---- diff --git a/content/patterns/multicloud-gitops-amx/mcg-amx-getting-started.adoc b/content/patterns/multicloud-gitops-amx/mcg-amx-getting-started.adoc index ef62be466a..ca9db32416 100644 --- a/content/patterns/multicloud-gitops-amx/mcg-amx-getting-started.adoc +++ b/content/patterns/multicloud-gitops-amx/mcg-amx-getting-started.adoc @@ -60,23 +60,12 @@ Do not commit this file. You do not want to push personal credentials to GitHub. git checkout -b my-branch ---- + -[source,terminal] ----- -vi values-global.yaml ----- +For a description of each field in `values-global.yaml`, see link:/learn/values-global-configuration/[Global configuration reference]. Edit the file, then commit and push: + [source,terminal] ---- git add values-global.yaml ----- -+ -[source,terminal] ----- -git commit values-global.yaml ----- -+ -[source,terminal] ----- +git commit -m "Customize values-global for my cluster" git push origin my-branch ---- diff --git a/content/patterns/multicloud-gitops-qat/mcg-qat-getting-started.adoc b/content/patterns/multicloud-gitops-qat/mcg-qat-getting-started.adoc index 96711f1692..c49124c94b 100644 --- a/content/patterns/multicloud-gitops-qat/mcg-qat-getting-started.adoc +++ b/content/patterns/multicloud-gitops-qat/mcg-qat-getting-started.adoc @@ -55,30 +55,19 @@ cp values-secret.yaml.template ~/values-secret-multicloud-gitops.yaml Do not commit this file. You do not want to push personal credentials to GitHub. ==== -. (Optional) You may customize the deployment for your cluster depending on your needs by editing values-global.yaml and values-hub.yaml. To do this run the following commands: +. Optional: Customize the deployment for your cluster by editing `values-global.yaml` and `values-hub.yaml`. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. To do this, run the following commands: + [source,terminal] ---- git checkout -b my-branch ---- + -[source,terminal] ----- -vi values-global.yaml ----- +Edit the file, then commit and push: + [source,terminal] ---- git add values-global.yaml ----- -+ -[source,terminal] ----- -git commit values-global.yaml ----- -+ -[source,terminal] ----- +git commit -m "Customize values-global for my cluster" git push origin my-branch ---- diff --git a/content/patterns/multicloud-gitops-sgx-hello-world/mcg-sgx-hello-world-getting-started.adoc b/content/patterns/multicloud-gitops-sgx-hello-world/mcg-sgx-hello-world-getting-started.adoc index 9aee757376..4d9e213530 100644 --- a/content/patterns/multicloud-gitops-sgx-hello-world/mcg-sgx-hello-world-getting-started.adoc +++ b/content/patterns/multicloud-gitops-sgx-hello-world/mcg-sgx-hello-world-getting-started.adoc @@ -61,23 +61,12 @@ Do not commit this file. You do not want to push personal credentials to GitHub. git checkout -b my-branch ---- + -[source,terminal] ----- -vi values-global.yaml ----- +For a description of each field in `values-global.yaml`, see link:/learn/values-global-configuration/[Global configuration reference]. Edit the file, then commit and push: + [source,terminal] ---- git add values-global.yaml ----- -+ -[source,terminal] ----- -git commit values-global.yaml ----- -+ -[source,terminal] ----- +git commit -m "Customize values-global for my cluster" git push origin my-branch ---- diff --git a/content/patterns/multicloud-gitops-sgx/mcg-sgx-getting-started.adoc b/content/patterns/multicloud-gitops-sgx/mcg-sgx-getting-started.adoc index ef73b1ab82..92f537b389 100644 --- a/content/patterns/multicloud-gitops-sgx/mcg-sgx-getting-started.adoc +++ b/content/patterns/multicloud-gitops-sgx/mcg-sgx-getting-started.adoc @@ -66,31 +66,19 @@ cp values-secret.yaml.template ~/values-secret-multicloud-gitops.yaml Do not commit this file. You do not want to push personal credentials to GitHub. ==== -. (Optional) You may customize the deployment for your cluster depending on your needs by editing values-global.yaml and values-hub.yaml. To do this run the following commands: +. Optional: Customize the deployment for your cluster by editing `values-global.yaml` and `values-hub.yaml`. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. To do this, run the following commands: + [source,terminal] ---- git checkout -b my-branch ---- + -[source,terminal] ----- -vi values-global.yaml ----- +Edit the file, then commit and push: + [source,terminal] ---- git add values-global.yaml ----- -+ -[source,terminal] ----- -git commit values-global.yaml ----- -+ -[source,terminal] ----- -git push origin my-branch +git commit -m "Customize values-global for my cluster" ---- . (Optional) The SGX-protected Vault container image is available as a pre-built image and currently, the pattern is configured to use as is. When there is a need to build it on your own and protect it with SGX, then follow <>. diff --git a/content/patterns/virtualization-starter-kit/getting-started.md b/content/patterns/virtualization-starter-kit/getting-started.md index 1d504573f8..1d9dcd3c50 100644 --- a/content/patterns/virtualization-starter-kit/getting-started.md +++ b/content/patterns/virtualization-starter-kit/getting-started.md @@ -95,13 +95,12 @@ There are no special prerequisites to install this pattern. vi ~/values-secret.yaml ``` -1. Customize the deployment for your cluster (Optional - the defaults in values-global.yaml are designed to work in AWS): +1. Optional: Customize the deployment for your cluster. The defaults in `values-global.yaml` are designed to work in AWS. For a description of each field, see [Global configuration reference](/learn/values-global-configuration/). If you make changes, create a branch, commit, and push: ```sh git checkout -b my-branch - vi values-global.yaml git add values-global.yaml - git commit values-global.yaml + git commit -m "Customize values-global for my cluster" git push origin my-branch ``` diff --git a/modules/edd-deploying-edd-pattern.adoc b/modules/edd-deploying-edd-pattern.adoc index f8e01ecb92..14e4eeb8e5 100644 --- a/modules/edd-deploying-edd-pattern.adoc +++ b/modules/edd-deploying-edd-pattern.adoc @@ -81,12 +81,11 @@ secrets: When you edit the file you can make changes to the various DB and Grafana passwords if you wish. -. Customize the `values-global.yaml` for your deployment +. Customize the `values-global.yaml` for your deployment. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. + [source,terminal] ---- git checkout -b my-branch -vi values-global.yaml ---- *Replace instances of PROVIDE_ with your specific configuration* diff --git a/modules/outline-of-a-basic-values-file.adoc b/modules/outline-of-a-basic-values-file.adoc index 50f7fd61d1..f6926b1018 100644 --- a/modules/outline-of-a-basic-values-file.adoc +++ b/modules/outline-of-a-basic-values-file.adoc @@ -18,7 +18,7 @@ Increasingly, more value files are designed solely for overriding base chart val *Key sections of values files*: Global:: Global values refer to configuration settings shared across multiple charts within a deployment. These values are distributed among various charts to avoid redundancy and configuration setting repetition, promoting consistency. -Each pattern includes a `values-global.yaml` file, which contains configurations that are automatically incorporated into the application specification processed by the GitOps operator. +Each pattern includes a `values-global.yaml` file, which contains configurations that are automatically incorporated into the application specification processed by the GitOps operator. For a detailed description of each field in `values-global.yaml`, see link:/learn/values-global-configuration/[Global configuration reference]. ClusterGroup:: The ClusterGroup holds a specific significance within validated patterns. It defines clusters that are anticipated to share nearly identical configurations, serving a common architectural purpose. A ClusterGroup may consist of one or many members. Conventionally, there is a main ClusterGroup defined in `main.clusterGroupName` in `values-global.yaml`, acting as the hub or starting point for each pattern. Additional ClusterGroups can be managed by the main ClusterGroup through tools like Red Hat Advanced Cluster Management (RHACM). diff --git a/modules/retail-deploying.adoc b/modules/retail-deploying.adoc index c6040ad916..39c6e66bcd 100644 --- a/modules/retail-deploying.adoc +++ b/modules/retail-deploying.adoc @@ -100,29 +100,18 @@ Do not commit this file. You do not want to push personal credentials to GitHub. $ git switch -c my-branch ---- -.. Edit the `values-hub.yaml` file to customize the deployment for your cluster by running the following command: +.. Optional: Edit the `values-global.yaml` file to customize the deployment for your cluster. For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference]. + -[source,terminal] ----- -$ vi values-global.yaml ----- +The defaults should suffice if you want to see the apps running. The values that you might change are under the `imageregistry`, if you copied the images to your own quay account and hostname. You can also change the `git` settings of `account`, `email` and `hostname` to reflect your own account settings. + -The defaults should suffice if you just want to see the apps running. The values that you might change are under the `imageregistry`, if you copied the images to your own quay account and hostname. If you like, you can change the `git` settings of `account`, `email` and `hostname` to reflect your own account settings. -+ -If you plan to customize the build of the applications themselves, there are `revision` and `imageTag` settings for each of them. +If you plan to customize the build of the applications themselves, there are `revision` and `imageTag` settings for each of them. -.. Stage the changes to the `values-hub.yaml` file by running the following commands: +.. If you made changes, stage and commit them by running the following commands: + [source,terminal] ---- $ git add values-global.yaml ----- - -.. Commit the changes to the `values-hub.yaml` file by running the following commands: -+ -[source,terminal] ----- -$ git commit -m "update deployment for my-branch" +$ git commit -m "Customize values-global for my cluster" ---- .. Push the changes to the `values-global.yaml` file by running the following command: