swagger-api / swagger-api/swagger-ui

Launch container image with read-only filesystem

Open
#5,699 10 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: docker type: enhancement type: question
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
  • OS: Fedora 30, Centos 7, probably most others
  • Browser: Any
  • Version: Any
  • Method of installation: docker image pull
  • Swagger-UI version: 3.24.2
  • Swagger/OpenAPI version: N/A
Content & configuration

Example Swagger/OpenAPI definition: N/A
Swagger-UI configuration options: default

Describe the bug you're encountering

Cannot launch container image when filesystem is read-only. This problem was initially detected in a Kubernetes cluster where the default PodSecurityPolicy has readOnlyRootFilesystem set as true. Can be reproduced directly with docker.

To reproduce...

docker run --publish 8080:8080 --rm --read-only docker.io/swaggerapi/swagger-ui:v3.24.2

Expected behavior

Able to launch with a readonly filesystem.

Additional context or thoughts

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the documented command, docker run --publish 8080:8080 --rm --read-only docker.io/swaggerapi/swagger-ui:v3.24.2, and inspect how the Swagger UI container starts. Identify the filesystem write that prevents startup and verify that the image launches successfully with a read-only root filesystem.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
devops, infrastructure
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.