PrivateEdition/Current/PEGuide/HelmOverrides - Revision history

WikiSysop at 04:01, March 31, 2023

2023-03-31T04:01:58Z

WikiSysop at 10:16, July 25, 2022

2022-07-25T10:16:00Z

Ed.jamer@genesys.com: Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

2021-11-09T21:12:52Z

Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

Uma.jayakumar@genesys.com: Published

2021-06-30T18:51:06Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Overriding Helm chart values
|Context=Override values passed into the Helm chart through the Values.yaml file.
|ComingSoon=No
|Section={{Section
|sectionHeading=The values.yaml file
|anchor=overidehelm
|alignment=Vertical
|structuredtext=The v'''alues.yaml''' file is available for each service as part of the Helm chart. It is a source of content for the '''Values''' built-in object offered by Helm templates. The '''Values''' built-in object provides access to the values passed into a chart. These values control various infrastructure and deployment related settings for the corresponding Genesys Engage services.{{NoteFormat|The name of the service that the file belongs to, is included as part the file name. For example, '''designer-values.yaml''' or '''values_gauth.yaml''' or '''values-gws.yaml'''. Refer to the individual service guides for exact file names.|}}Settings related to the following and more are available in a '''values.yaml''' file: ''replica count'', ''maximum replicas'', ''deployment strategy'', ''image repository'', ''image tag'', ''secrets'', ''health probes'', ''annotations'', ''tolerations'', ''security'', and ''storage''. For a comprehensive list of the settings and their allowed values, refer to the individual service guides.{{NoteFormat|Service-specific parameters and environment variables are stored in ConfigMaps. Each service guide has more information pertaining to its ConfigMaps.|}}
|Status=No
}}{{Section
|sectionHeading=Overriding values
|anchor=overridevals
|alignment=Vertical
|structuredtext=Default values are specified for most settings in a v'''alues.yaml''' file and these values are passed into the chart. For an initial deployment, if you want to change any of the values, you can do so by directly editing the values.yaml file using a plain text editor.

Apart from editing the YAML file directly, there are two methods you can use to override the values that are being passed into the chart from the '''values.yaml''' file. The two methods are as follows:

===Using the --set flag===
You can use a <code>--set</code> flag in your Helm commands to override the value of a setting in the YAML file. Specify the name of the setting and its new value after the <code>--set</code> flag in the Helm command.

Examples:

#If you want to override the deployment strategy specified for a service during installation, you can use the Helm upgrade command with a <code>--set</code> flag as follows: <code>helm upgrade --install <service>-green -f <service>-values.yaml <service>-100.0.112+xxxx.tgz --set <service>.deployment.strategy=blue-green</code> The <code>--set</code> flag in the above command overrides the value for the <code><service>.deployment.strategy</code> setting in the '''values.yaml''' file and sets it to <code>blue-green</code>. So, irrespective of the value in the file for this particular setting, the service is installed using the <code>blue-green</code> strategy.
#If you want to override the version of the service to install during initial deployment, you can use the Helm upgrade command as follows: <code>helm upgrade --install <service> -f <service>-values.yaml <service>-100.0.112+xxxx.tgz --set <service>.image.tag=9.0.1xx.xx.xx</code> The <code>--set</code> flag in the above command overrides the image tag version in the '''values.yaml''' file and provides a new version.

===Using the --values flag===
You can use a <code>--values</code> flag in your Helm commands to override the values in a chart and pass in a new file. Specify the name of the new file after the <code>--values</code> flag in the Helm command.

Example:

*<code>helm upgrade --install <service> -f values.yaml <service>-9.0.xx.tgz --values <new file name>.yaml</code>The <code>--values</code> flag in the above command is passing on a new file with values to override the values in the chart.

{{NoteFormat|For detailed information on settings available in the '''values.yaml''' file, allowed values, default values, and override scenarios, refer to the individual service guides.|}}

 
|Status=No
}}
}}

@@ Line 10: / Line 10: @@
 |structuredtext=The '''values.yaml''' file is available for each service as part of the Helm chart. It is a source of content for the '''Values''' built-in object offered by Helm templates. The '''Values''' built-in object provides access to the values passed into a chart. These values control various infrastructure and deployment related settings for the corresponding Genesys Multicloud CX services.{{NoteFormat|The name of the service that the file belongs to, is included as part the file name. For example, '''designer-values.yaml''' or '''values_gauth.yaml''' or '''values-gws.yaml'''. Refer to the individual service guides for exact file names.|}} Settings related to the following and more are available in a '''values.yaml''' file: ''replica count'', ''maximum replicas'', ''deployment strategy'', ''image repository'', ''image tag'', ''secrets'', ''health probes'', ''annotations'', ''tolerations'', ''security'', and ''storage''. For a comprehensive list of the settings and their allowed values, refer to the individual service guides.{{NoteFormat|
 * Service-specific parameters and environment variables are stored in ConfigMaps. Each service guide has more information pertaining to its ConfigMaps.
-* In OpenShift deployments that use arbitrary UIDs, you must override the securityContext settings.|}}
+|}}
 |Status=No
 }}{{Section

@@ Line 8: / Line 8: @@
 |anchor=overidehelm
 |alignment=Vertical
-|structuredtext=The v'''alues.yaml''' file is available for each service as part of the Helm chart. It is a source of content for the '''Values''' built-in object offered by Helm templates. The '''Values''' built-in object provides access to the values passed into a chart. These values control various infrastructure and deployment related settings for the corresponding Genesys Multicloud CX services.{{NoteFormat|The name of the service that the file belongs to, is included as part the file name. For example, '''designer-values.yaml''' or '''values_gauth.yaml''' or '''values-gws.yaml'''. Refer to the individual service guides for exact file names.|}}Settings related to the following and more are available in a '''values.yaml''' file: ''replica count'', ''maximum replicas'', ''deployment strategy'', ''image repository'', ''image tag'', ''secrets'', ''health probes'', ''annotations'', ''tolerations'', ''security'', and ''storage''. For a comprehensive list of the settings and their allowed values, refer to the individual service guides.{{NoteFormat|Service-specific parameters and environment variables are stored in ConfigMaps. Each service guide has more information pertaining to its ConfigMaps.|}}
+|structuredtext=The '''values.yaml''' file is available for each service as part of the Helm chart. It is a source of content for the '''Values''' built-in object offered by Helm templates. The '''Values''' built-in object provides access to the values passed into a chart. These values control various infrastructure and deployment related settings for the corresponding Genesys Multicloud CX services.{{NoteFormat|The name of the service that the file belongs to, is included as part the file name. For example, '''designer-values.yaml''' or '''values_gauth.yaml''' or '''values-gws.yaml'''. Refer to the individual service guides for exact file names.|}} Settings related to the following and more are available in a '''values.yaml''' file: ''replica count'', ''maximum replicas'', ''deployment strategy'', ''image repository'', ''image tag'', ''secrets'', ''health probes'', ''annotations'', ''tolerations'', ''security'', and ''storage''. For a comprehensive list of the settings and their allowed values, refer to the individual service guides.{{NoteFormat|
 |Status=No
 }}{{Section
@@ Line 25: / Line 27: @@
 #If you want to override the deployment strategy specified for a service during installation, you can use the Helm upgrade command with a <code>--set</code> flag as follows:<br /> <code>helm upgrade --install <service>-green -f <service>-values.yaml <service>-100.0.112+xxxx.tgz --set <service>.deployment.strategy=blue-green</code><br /> The <code>--set</code> flag in the above command overrides the value for the <code><service>.deployment.strategy</code> setting in the '''values.yaml''' file and sets it to <code>blue-green</code>. So, irrespective of the value in the file for this particular setting, the service is installed using the <code>blue-green</code> strategy.
 #If you want to override the version of the service to install during initial deployment, you can use the Helm upgrade command as follows:<br /> <code>helm upgrade --install <service> -f <service>-values.yaml <service>-100.0.112+xxxx.tgz  --set <service>.image.tag=9.0.1xx.xx.xx</code><br /> The <code>--set</code> flag in the above command overrides the image tag version in the '''values.yaml''' file and provides a new version.
 ===Using the --values flag===