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

dist/docker/debian/README.md is wrong #9263

Closed
nyh opened this issue Aug 29, 2021 · 12 comments
Closed

dist/docker/debian/README.md is wrong #9263

nyh opened this issue Aug 29, 2021 · 12 comments
Assignees

Comments

@nyh
Copy link
Contributor

nyh commented Aug 29, 2021

Almost all steps in the instructions in dist/docker/debian/README.md are wrong or misleading:

  1. Build your own Scylla in whatever build mode you prefer, e.g., dev.
  2. Run ninja dist-deb
  3. Run /dist/docker/debian/build_docker.sh
  4. Finally, run docker build -t .

Step 2 is wrong because it builds all modes again. Should be "dist-dev" (which unfortunately not only builds the deb target, but at least doesn't build all modes! at least not after I sent a patch to fix a bug in that area).

Step 3 is missing "--mode dev" (so uses release mode by default).

Step 4 assumes there is a Dockerfile in the Scylla main source directory, but there isn't. Step 4 probably needs to be replaced by entirely different command, but I can't yet figure out by what and need help.

@nyh nyh self-assigned this Aug 29, 2021
@nyh
Copy link
Contributor Author

nyh commented Aug 29, 2021

CC @yaronkaikov @syuu1228

@yaronkaikov
Copy link
Contributor

@nyh Thanks for openning the issue, i will send a patch soon

@nyh
Copy link
Contributor Author

nyh commented Aug 29, 2021

@yaronkaikov please note that I assigned this to myself because I almost have a patch for it myself - I'm just missing a solution for step 4. Can you please try it yourself and see what is the correct step 4?

@nyh
Copy link
Contributor Author

nyh commented Aug 29, 2021

As @avikivity noted on the mailing list, step 4 became outdated with commit e96ff3d. As that commit suggests that the output of step 3 is just a file, which "can be uploaded into a repository or made available locally with skopeo.". Now I just need to figure out what this sentence means, and how to explain it in the document.

@avikivity
Copy link
Member

@nyh it's my fault for not supplying a good README, I can send something.

@nyh
Copy link
Contributor Author

nyh commented Aug 29, 2021

If you can even write a few lines, I'll complete the text and test it. Right have a file build/dev/dist/docker/scylla-4.6.dev-0.20210829.4009d8b06 but have no idea how to run it with docker. I couldn't yet figure out how to use "skopeo" (or why do I even want to use it). Any hints you can give me would save me a lot of time scratching my head and Googling.

@nyh
Copy link
Contributor Author

nyh commented Aug 29, 2021

@avikivity I couldn't figure out how to use skopeo to run such an archive in docker, or how to run it directly in docker. It seems podman supports it out-of-the-box, though:

podman run oci-archive:build/dev/dist/docker/scylla-4.6.dev-0.20210829.4009d8b06

Seems to work. Do you know to run it in docker instead of podman?

@avikivity
Copy link
Member

I haven't run docker in a while, I expect docker import will import it into local storage.

@yaronkaikov
Copy link
Contributor

@avikivity I couldn't figure out how to use skopeo to run such an archive in docker, or how to run it directly in docker. It seems podman supports it out-of-the-box, though:

podman run oci-archive:build/dev/dist/docker/scylla-4.6.dev-0.20210829.4009d8b06

Seems to work. Do you know to run it in docker instead of podman?

@nyh Same command with docker is working as well , just verified it locally

@nyh
Copy link
Contributor Author

nyh commented Aug 29, 2021

@nyh Same command with docker is working as well , just verified it locally

It doesn't work for me - it tells me "docker: invalid reference format.". It works well in podman. My docker version is 20.10.7.

@yaronkaikov
Copy link
Contributor

@nyh Same command with docker is working as well , just verified it locally

It doesn't work for me - it tells me "docker: invalid reference format.". It works well in podman. My docker version is 20.10.7.

So it's not working for me either (docker command was an alias for podman). Since we are using buildah for build process we can't really run it with docker. The only way is to actually publish the image to docker hub and then pull it again with docker. although it doesn't make sense for me at least :-)

@avikivity
Copy link
Member

Developer documentation, so not backporting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants