[
https://issues.apache.org/jira/browse/KNOX-3299?focusedWorklogId=1015740&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1015740
]
ASF GitHub Bot logged work on KNOX-3299:
----------------------------------------
Author: ASF GitHub Bot
Created on: 15/Apr/26 15:46
Start Date: 15/Apr/26 15:46
Worklog Time Spent: 10m
Work Description: sneethiraj opened a new pull request, #1201:
URL: https://github.com/apache/knox/pull/1201
KNOX-3299: adding inline documentation for usage of env. var:
TRUSTSTORE_IMPORTS
## What changes were proposed in this pull request?
added few inline documentation on how to define and use the environment
variable: TRUSTSTORE_IMPORTS
## How was this patch tested?
shellcheck was done - no issues found.
## Integration Tests
No changes to Integration Test suites
## UI changes
No UI Changes
Please review [Knox Contributing
Process](https://cwiki.apache.org/confluence/display/KNOX/Contribution+Process#ContributionProcess-GithubWorkflow)
before opening a pull request.
Issue Time Tracking
-------------------
Worklog Id: (was: 1015740)
Remaining Estimate: 0h
Time Spent: 10m
> 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
> Priority: Minor
> Time Spent: 10m
> Remaining Estimate: 0h
>
> 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)
