Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add functionality to run nvme-spex with docker #47

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Conversation

mbrsamsung
Copy link
Collaborator

  • Add docker entrypoint script
  • Add documentation describing it

@mbrsamsung mbrsamsung requested a review from safl September 23, 2024 11:38
Add new `cmd.sh` script with case matches for subcommands.
This enables the docker contrainer to both serv a webserver and
run nvme-spex directly on files.

Signed-off-by: Morten B. Rasmussen <m.rasmussen@samsung.com>
Copy link
Collaborator

@safl safl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I quick spell-check on the commit message docker contrainer?
A comment inline as well.

docker. For setup of docker on windows we refer to guides from `Docker Desktop

For direct usage of nvme-spex it is possible to run it from docker. For setup of
docker on windows we refer to guides from `Docker Desktop
<https://docs.docker.com/desktop/install/windows-install/>`_ or `Podman
Copy link
Collaborator

@safl safl Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the reference to Podman should be replace with a reference to Podman Desktop: https://podman-desktop.io/downloads On this topic, why propose Docker Desktop? I don't see any value of Docker Desktop over Podman Desktop, more choice usually turns into confusion.
Strike that... let's drop Podman Desktop... otherwise the docker run ... examples becomes confusing as these would then need to be podman ...

Adds instructions to the sphinx documentation, that describes how
it is possible to use nvme-spex directly through docker. Without
starting the webserver.

Signed-off-by: Morten B. Rasmussen <m.rasmussen@samsung.com>
Copy link
Collaborator

@safl safl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@mbrsamsung mbrsamsung merged commit db01c27 into main Sep 26, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants