OpenLiberty / OpenLiberty/ci.docker
Improve current documentation around keys and certificates
Open
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 48
- Forks
- 60
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 3
Description
The existing Security.MD mentions including a keystore but fails to mention sequencing it after any feature.sh and configure.sh call since those overwrite the keystore.
The Security.MD also doesn't mention the container startup will fail if the key file used is encrypted since no method is provided to decrypt it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open Security.MD and compare its keystore guidance with the ordering of feature.sh and configure.sh; start by locating those setup instructions. Document that keystore setup must follow those calls and that encrypted key files prevent container startup; done when both constraints are explicit.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, shell
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100