Selvamohan Neethiraj created KNOX-3299:
------------------------------------------
Summary: Document TRUSTSTORE_IMPORTS environment variable usage
within startup script
Key: KNOX-3299
URL: https://issues.apache.org/jira/browse/KNOX-3299
Project: Apache Knox
Issue Type: Improvement
Components: docker
Reporter: Selvamohan Neethiraj
Assignee: Selvamohan Neethiraj
Following the implementation of $KNOX-3297$, which added support for dynamic
truststore imports via environment variables, there is a need to provide inline
documentation within the script itself. This ensures that users can correctly
configure the variable without referring back to external Jira logs or source
code.
h3. *Technical Details*
The script should be updated to include the definition, format, and an example
of the {{TRUSTSTORE_IMPORTS}} variable.
*Variable Definition:*
{{TRUSTSTORE_IMPORTS}} (Optional): A string containing one or more certificate
import mappings.
*Format:*
{{{aliasIdForImport:PEMEncodedTrustCertificateFileLocation}}} separated by
spaces.
----
h3. *Proposed Script Documentation Block*
{code:java}
# - TRUSTSTORE_IMPORTS - (optional) - a string containing one or more of the
following:
# {aliasIdForImport:PEMEncodedTrustCertificateFileLocation} separated by
space(s).
#
# Example:
# TRUSTSTORE_IMPORTS="myRootCA:/mountedpath/cert.pem
myBizPartnerCA:/path/partner.pem"
#
# Description:
# This will import the specified certificates into the truststore JKS with
the
# provided alias name(s) during the container startup process.{code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
