Difference between revisions of "Draft: PEC-REP/Current/RAAPEGuide/Configure"

From Genesys Documentation
Jump to: navigation, search
(Copied manual)
 
Line 7: Line 7:
 
|sectionHeading=Override Helm chart values
 
|sectionHeading=Override Helm chart values
 
|alignment=Vertical
 
|alignment=Vertical
|structuredtext=<div style="background-color: aliceblue; font-style: italic;">Link to the "suite-level" documentation about how to override Helm chart values: {{SuiteLevelLink|helmoverride}} If there are multiple YAML files (for example, one for each container if your service has multiple containers), you could use a table for each file or use a single table with an extra column for the file name. If the parameter is related to a feature documented elsewhere, you can include a link in the Description column. For example, descriptions for logging setting can link to the Logging page.
+
|structuredtext=Container environment variables are declared in [https://git.scm.genesys.com/Genesys/raa/blob/GCXI-4695/docker/Dockerfile#L98 docker file]. Comment above each variable discovers its purpose. Please request a copy of variables fragment if you have no access.
Note: We are still working on an approach to handle documentation for Helm chart values, so please leave this section until the end.
+
 
</div>
+
RAA helm chart supplied with default [https://git.scm.genesys.com/Genesys/raa/blob/GCXI-4695/helm/gcxi-raa/values.yaml values.yaml]. Each helm value supported by gcxi/raa helm chart have description in comments.  
 +
 
 +
You can override values in the Helm charts to configure Private Edition for their deployment environment. For example GIM database connection parameters can be specified in own yaml file as a json line base64 encoded:
 +
<br />
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
 
{{!}}+
 
{{!}}+

Revision as of 19:08, June 10, 2021

This is a draft page; it has not yet been published.

Learn how to configure <service_name>.

Related documentation:

Override Helm chart values

Container environment variables are declared in docker file. Comment above each variable discovers its purpose. Please request a copy of variables fragment if you have no access.

RAA helm chart supplied with default values.yaml. Each helm value supported by gcxi/raa helm chart have description in comments.

You can override values in the Helm charts to configure Private Edition for their deployment environment. For example GIM database connection parameters can be specified in own yaml file as a json line base64 encoded:

Parameter Description Default Valid values
service.port Designer service to be exposed. 8888 A valid port.
...

Configure Kubernetes

Document the layouts for the following so customers can create them if their Helm chart doesn't include a way to do this:
  • ConfigMaps
  • Secrets

Configure security

List security-related settings, such as how to set up credentials and certificates for third-party services.