Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HPCC-25946 Add environment variables helm chart setting to doc #16539

Merged
merged 3 commits into from Sep 23, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 34 additions & 9 deletions docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml
Expand Up @@ -888,22 +888,23 @@
embedded code, you can have that defined in the code sign sections. If
you have information that you don't want public but need to run it you
could use secrets. There is a category named "eclUser" which is where
you would put secrets that you want to be readable directly from ECL code.
Other secret categories, including the "ecl" category, are read internally
by system components and not exposed directly to ECL code.</para>
you would put secrets that you want to be readable directly from ECL
code. Other secret categories, including the "ecl" category, are read
internally by system components and not exposed directly to ECL
code.</para>
</sect3>

<sect3>
<title>Vaults</title>

<para>Vaults is another way to do Secrets. The vaults section mirrors
the secret section but leverages <emphasis>HashiCorp Vault</emphasis>
for the storage of secrets. There is a category for vaults named "eclUser".
The intent of the eclUser vault category is to be readable directly from ECL
code. Only add vault configurations to the "eclUser" category that you want
ECL users to be able to access. Other vault categories, including the "ecl"
category, are read internally by system components and not exposed directly
to ECL code.</para>
for the storage of secrets. There is a category for vaults named
"eclUser". The intent of the eclUser vault category is to be readable
directly from ECL code. Only add vault configurations to the "eclUser"
category that you want ECL users to be able to access. Other vault
categories, including the "ecl" category, are read internally by
system components and not exposed directly to ECL code.</para>
</sect3>
</sect2>

Expand Down Expand Up @@ -1040,6 +1041,30 @@
on appropriate nodes.</para>
</sect4>
</sect3>

<sect3 id="ENV_values_yaml">
<title>Environment Values</title>

<para>You can define environment variables in a YAML file. The
environment values are defined under the
<emphasis>global.env</emphasis> portion of the provided HPCC Systems
values.yaml file. These values are specified as a list of name value
pairs as illustrated below.</para>

<programlisting>global:
env:
- name: SMTPserver
value: mysmtpserver</programlisting>

<para>The global.env section of the supplied values.yaml file adds
default environment variables for all components. You can also specify
environment variables for the individual components. Refer to the
schema for setting this value for individual components.</para>

<para>To add environment values you can insert them into your
customization configuration YAML file when you deploy your
containerized HPCC Systems.</para>
</sect3>
</sect2>
</sect1>

Expand Down