Skip to content

Commit

Permalink
HPCC-25660 Document LDAP Admin externalization
Browse files Browse the repository at this point in the history
Signed-off-by: g-pan <[email protected]>
  • Loading branch information
g-pan committed Mar 21, 2024
1 parent a289f4e commit d0034b6
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/EN_US/ContainerizedHPCC/ContainerizedMods/CustomConfig.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1014,10 +1014,10 @@ eclagent:
account from a command line interface to Kubernetes, execute a command
similar to the following example. Note the secret name, is
"admincredssecretname" in this example. The HPCC Administrators user
account "username" and "password" key/values are required; and
account "username" and "password" key/values are required, and
additional properties are ignored.</para>

<programlisting>kubectl create secret generic admincredssecretname --from-literal=username=hpcc_admin \
<programlisting lang="bash">kubectl create secret generic admincredssecretname --from-literal=username=hpcc_admin \
--from-literal=password=t0pS3cr3tP@ssw0rd
</programlisting>

Expand All @@ -1026,7 +1026,7 @@ eclagent:
secret you just created by executing the following command on the
Kubernetes command line interface.</para>

<programlisting>kubectl get secret admincredssecretname</programlisting>
<programlisting lang="bash">kubectl get secret admincredssecretname</programlisting>

<para>For more information about Kubernetes see the appropriate
Kubernetes documentation for your implementation.</para>
Expand Down Expand Up @@ -1055,7 +1055,7 @@ eclagent:
referenced in the component's ldap.yaml file. You may override these
and add additional key/values as needed.</para>

<programlisting> secrets:
<programlisting lang="bash"> secrets:
authn:
admincredsmountname: "admincredssecretname" #exernalize HPCC Admin creds
admincredsaltmountname: "admincredsaltsecretname" #exernalize alternate HPCC Admin creds
Expand All @@ -1068,11 +1068,11 @@ eclagent:
<para>In the delivered
HPCC-Platform/esp/applications/common/ldap/ldap.yaml file, the
"ldapAdminSecretKey" is already set to the key mount name illustrated
in the example above. To enable the LDAP authentication and to
override this value, override the ESP/ECLWatch helm component located
in values.yaml as illustrated in the following example:</para>
in the example above. To enable LDAP authentication and to modify this
value, override the ESP/ECLWatch helm component located in values.yaml
as illustrated in the following example:</para>

<programlisting>esp:
<programlisting lang="YAML">esp:
- name: eclwatch
application: eclwatch
auth: ldap
Expand Down Expand Up @@ -1103,7 +1103,7 @@ eclagent:
<para>To verify and confirm the secret values, execute the following
command:</para>

<programlisting> vault kv get secret/authn/myvaultadmincreds</programlisting>
<programlisting lang="bash">vault kv get secret/authn/myvaultadmincreds</programlisting>

<para>For more information about creating secrets for HashiCorp Vault
see the appropriate HashiCorp documentation for your
Expand All @@ -1124,7 +1124,7 @@ eclagent:
this chart in the HPCC-Platform repository under
/helm/examples/secrets/values-secrets.yaml.</para>

<programlisting> vaults:
<programlisting lang="YAML"> vaults:
authn:
- name: my-authn-vault
#The data node in the URL is there for use by the REST API
Expand All @@ -1142,7 +1142,7 @@ eclagent:
must match exactly when using the Vault name set up in the previous
steps.</para>

<programlisting>esp:
<programlisting lang="YAML">esp:
- name: eclwatch
application: eclwatch
auth: ldap
Expand Down

0 comments on commit d0034b6

Please sign in to comment.