Skip to content

Commit 3a7d3bb

Browse files
gaurav-nelsongaurav-nelson
committed
fix: update instructions for customizing values-global.yaml
1 parent 4cd38ca commit 3a7d3bb

19 files changed

Lines changed: 196 additions & 164 deletions

File tree

‎content/learn/values-global-configuration.adoc‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
---
2+
menu:
3+
learn:
4+
parent: Validated patterns frameworks
5+
title: Global configuration reference
6+
weight: 55
7+
aliases: /learn/values-global-configuration/
8+
---
9+
10+
:toc:
11+
:imagesdir: /images
12+
:_content-type: ASSEMBLY
13+
include::modules/comm-attributes.adoc[]
14+
15+
[id="values-global-configuration"]
16+
= Global configuration reference
17+
18+
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.
19+
20+
[id="global-section"]
21+
== `global` section
22+
23+
The `global` section contains settings that Helm distributes to all sub-charts in the pattern.
24+
25+
[id="global-pattern"]
26+
=== `global.pattern`
27+
28+
Specifies the name of the validated pattern. The framework uses this value internally to identify the pattern.
29+
30+
[source,yaml]
31+
----
32+
global:
33+
pattern: multicloud-gitops
34+
----
35+
36+
Do not change this value unless you are creating a new pattern.
37+
38+
[id="global-options"]
39+
=== `global.options`
40+
41+
The `options` block sets default behaviors for operator management and ArgoCD synchronization across all clusters.
42+
43+
[source,yaml]
44+
----
45+
global:
46+
options:
47+
useCSV: false
48+
syncPolicy: Automatic
49+
installPlanApproval: Automatic
50+
----
51+
52+
.Options fields
53+
[cols="2,1,5",options="header"]
54+
|===
55+
| Field | Default | Description
56+
57+
| `syncPolicy`
58+
| `Automatic`
59+
| 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.
60+
61+
| `installPlanApproval`
62+
| `Automatic`
63+
| 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.
64+
65+
| `useCSV`
66+
| `false`
67+
| 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.
68+
|===
69+
70+
[id="main-section"]
71+
== `main` section
72+
73+
The `main` section defines settings for the primary cluster that manages the pattern.
74+
75+
[id="main-clustergroupname"]
76+
=== `main.clusterGroupName`
77+
78+
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.
79+
80+
[source,yaml]
81+
----
82+
main:
83+
clusterGroupName: hub
84+
----
85+
86+
The value must match a corresponding `values-<clusterGroupName>.yaml` file in the repository. For example, `clusterGroupName: hub` requires a `values-hub.yaml` file. Most patterns use `hub` for the primary cluster.
87+
88+
For more information about ClusterGroups, see link:/learn/clustergroup-in-values-files/[ClusterGroup in values files].
89+
90+
[id="main-multisourceconfig"]
91+
=== `main.multiSourceConfig`
92+
93+
Controls whether ArgoCD uses multi-source applications, enabling Helm charts to be fetched from external repositories in addition to the local Git repository.
94+
95+
[source,yaml]
96+
----
97+
main:
98+
multiSourceConfig:
99+
enabled: true
100+
----
101+
102+
.multiSourceConfig fields
103+
[cols="2,1,5",options="header"]
104+
|===
105+
| Field | Default | Description
106+
107+
| `enabled`
108+
| `true`
109+
| Enables multi-source ArgoCD applications. This is the recommended setting for most deployments.
110+
111+
| `clusterGroupChartVersion`
112+
| (optional)
113+
| Constrains the version of the ClusterGroup Helm chart to fetch. Accepts semver ranges such as `0.9.*`.
114+
115+
| `helmRepoUrl`
116+
| (optional)
117+
| Overrides the Helm chart repository URL. Use this for disconnected or air-gapped environments where charts are hosted on an internal registry.
118+
|===
119+
120+
For more information about disconnected environments, see link:/learn/disconnected-installation/[Disconnected installation].
121+
122+
[id="example-values-global"]
123+
== Example `values-global.yaml`
124+
125+
The following example shows a typical `values-global.yaml` file for the Multicloud GitOps pattern:
126+
127+
[source,yaml]
128+
----
129+
---
130+
global:
131+
pattern: multicloud-gitops
132+
133+
options:
134+
useCSV: false
135+
syncPolicy: Automatic
136+
installPlanApproval: Automatic
137+
138+
main:
139+
clusterGroupName: hub
140+
141+
multiSourceConfig:
142+
enabled: true
143+
----
144+
145+
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.
146+
147+
[id="additional-resources"]
148+
== Additional resources
149+
150+
* link:/values-files/[Exploring values files]
151+
* link:/learn/clustergroup-in-values-files/[ClusterGroup in values files]
152+
* link:/learn/disconnected-installation/[Disconnected installation]
153+
* link:/learn/vp_add_specific_ops_to_pattern/[Adding a specific operator version to a pattern]

‎content/learn/workflow.adoc‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,26 +38,16 @@ $ cp values-secret.yaml.template ~/values-secret.yaml
3838
$ vi ~/values-secret.yaml
3939
----
4040

41-
. Customize the deployment for your cluster. Customization involves updating the `values-global.yaml` file with configurations specific to your cluster environment.
42-
.. Edit the `values-global.yaml` file:
41+
. 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.
4342
+
44-
[source,terminal]
43+
For a description of each field, see link:/learn/values-global-configuration/[Global configuration reference].
4544
+
46-
----
47-
$ vi values-global.yaml
48-
----
49-
.. Commit the updated `values-global.yaml` file to the repository:
45+
If you make changes, commit and push them:
5046
+
5147
[source,terminal]
52-
+
53-
----
54-
$ git commit values-global.yaml
55-
----
56-
.. Push the committed changes:
57-
+
58-
[source,terminal]
59-
6048
----
49+
$ git add values-global.yaml
50+
$ git commit -m "Customize values-global for my cluster"
6151
$ git push
6252
----
6353

‎content/patterns/ansible-edge-gitops-kasten/getting-started.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,13 +211,12 @@ To install a collection that is not currently installed:
211211
git push origin my-branch
212212
```
213213

214-
1. Customize the deployment for your cluster (Optional - the defaults in values-global.yaml are designed to work in AWS):
214+
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:
215215

216216
```sh
217217
git checkout -b my-branch
218-
vi values-global.yaml
219218
git add values-global.yaml
220-
git commit values-global.yaml
219+
git commit -m "Customize values-global for my cluster"
221220
git push origin my-branch
222221
```
223222

‎content/patterns/ansible-edge-gitops/getting-started.adoc‎

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -182,25 +182,14 @@ This is the username and password that you use to log in to link:https://catalog
182182
$ git checkout -b my-branch
183183
----
184184

185-
. 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:
185+
. 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].
186186
+
187-
[source,terminal]
188-
----
189-
$ vi values-global.yaml
190-
----
191-
192-
. Add the changes to the staging area by running the following command:
187+
If you make changes, stage and commit them:
193188
+
194189
[source,terminal]
195190
----
196191
$ git add values-global.yaml
197-
----
198-
199-
. Commit the changes by running the following command:
200-
+
201-
[source,terminal]
202-
----
203-
$ git commit -m "any updates"
192+
$ git commit -m "Customize values-global for my cluster"
204193
----
205194

206195
. Push the changes to your forked repository:

‎content/patterns/devsecops/getting-started.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,11 @@ When you create a fine-grained token, you must also configure these settings:
114114
vi ~/values-secret.yaml
115115
```
116116

117-
1. Customize the deployment for your cluster. Change the appropriate values in `values-global.yaml`
117+
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:
118118

119119
```sh
120-
vi values-global.yaml
121120
git add values-global.yaml
122-
git commit values-global.yaml
121+
git commit -m "Customize values-global for my cluster"
123122
git push origin my-branch
124123
```
125124

‎content/patterns/federated-edge-observability/getting-started.adoc‎

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -184,25 +184,14 @@ Certificates for the OpenTelemetry collector infrastructure. `Snakeoil` that is,
184184
$ git checkout -b my-branch
185185
----
186186

187-
. 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:
187+
. 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].
188188
+
189-
[source,terminal]
190-
----
191-
$ vi values-global.yaml
192-
----
193-
194-
. Add the changes to the staging area by running the following command:
189+
If you make changes, stage and commit them:
195190
+
196191
[source,terminal]
197192
----
198193
$ git add values-global.yaml
199-
----
200-
201-
. Commit the changes by running the following command:
202-
+
203-
[source,terminal]
204-
----
205-
$ git commit -m "No updates"
194+
$ git commit -m "Customize values-global for my cluster"
206195
----
207196

208197
. Push the changes to your forked repository:

‎content/patterns/gaudi-rag-chat-qna/gaudi-rag-chat-qna-getting-started.adoc‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -103,23 +103,12 @@ If the cluster is behind proxy remember to change proxy values of fields `gaudil
103103
git checkout -b my-branch
104104
----
105105
+
106-
[source,terminal]
107-
----
108-
vi values-global.yaml
109-
----
106+
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:
110107
+
111108
[source,terminal]
112109
----
113110
git add values-global.yaml
114-
----
115-
+
116-
[source,terminal]
117-
----
118-
git commit values-global.yaml
119-
----
120-
+
121-
[source,terminal]
122-
----
111+
git commit -m "Customize values-global for my cluster"
123112
git push origin my-branch
124113
----
125114

‎content/patterns/medical-diagnosis-amx/getting-started.adoc‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,11 @@ By default, Vault password policy generates the passwords for you. However, you
108108
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.
109109
====
110110

111-
. To customize the deployment for your cluster, update the `values-global.yaml` file by running the following commands:
111+
. 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:
112112
+
113113
[source,terminal]
114114
----
115115
$ git checkout -b my-branch
116-
$ vi values-global.yaml
117116
----
118117
+
119118
Replace 'bucketSource' value. User can set any bucket name without special signs (besides '-') and numbers.

‎content/patterns/medical-diagnosis/getting-started.adoc‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -242,12 +242,7 @@ When defining a custom password for the database users, avoid using the `$` spec
242242
$ git checkout -b my-branch
243243
----
244244

245-
. Edit the `values-global.yaml` updating the S3 and datacenter details.
246-
+
247-
[source,terminal]
248-
----
249-
$ vi values-global.yaml
250-
----
245+
. 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].
251246
+
252247
.Example edited `values-global.yaml` file
253248
+

‎content/patterns/multicloud-gitops-Portworx/getting-started.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,12 @@ service](https://console.redhat.com/openshift/create).
4949
vi ~/values-secret-multicloud-gitops-pxe.yaml
5050
```
5151

52-
5. Customize the deployment for your cluster.
52+
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:
5353

5454
```sh
5555
git checkout -b my-branch
56-
vi values-global.yaml
5756
git add values-global.yaml
58-
git commit values-global.yaml
57+
git commit -m "Customize values-global for my cluster"
5958
git push origin my-branch
6059
```
6160

0 commit comments

Comments
 (0)