document deploy rootless using docker compose#1956
Conversation
|
🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree: I have hereby read the F5 CLA and agree to its terms 2 out of 3 committers have signed the CLA. |
|
I have hereby read the F5 CLA and agree to its terms |
5d74f1f to
d8a39ec
Compare
✅ Deploy Preview will be available once build job completes!
|
d8a39ec to
b768380
Compare
|
recheck |
travisamartin
left a comment
There was a problem hiding this comment.
I opened a PR with my edits. Take a look: #1969
Co-authored-by: Mike Jang <mi.jang@f5.com>
Co-authored-by: Mike Jang <mi.jang@f5.com>
Apply style guide corrections to deploy-nim-rootless-docker-compose.md: - Replace NIM abbreviation with NGINX Instance Manager throughout prose (f5-product-names: never abbreviate NGINX product names) - Fix passive voice constructions to active voice (active-voice) - Replace 'Launch' with 'Start', 'Once' with 'When', 'Modify' with 'Change', 'via' with 'using', 'as' (causal) with 'because' (word-list) - Split 32-word sentence into two shorter sentences (sentence-length) - Rewrite 'No image rebuild required/needed' constructions as 'You don't need to rebuild the image' (active-voice) - Remove parenthetical (NIM) abbreviation introduction (f5-product-names)
Issues addressed in separate PR
Proposed changes
Adds a new how-to guide for deploying F5 NGINX Instance Manager (NIM) in a rootless Docker Compose environment, where all container processes run as the nms non-root user.
What changed and why:
The existing Docker deployment section covers the standard image-based Docker Compose flow. This PR adds a companion guide for teams with security hardening requirements—such as CIS benchmarks or internal least-privilege policies—that prevent running containers as root. The guide also documents the runtime configuration injection pattern used by this deployment, which allows NIM settings to be changed via environment variables and a stack restart, without rebuilding the Docker image. This is distinct from the standard deployment and warrants its own topic.
How the changes were made:
Out of scope / follow-up considerations:
Checklist
Before sharing this pull request, I completed the following checklist: