-
Notifications
You must be signed in to change notification settings - Fork 127
Add how to develop with Podman instead of Docker #2927
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for confirming that elastic-package can work with podman!
Added some suggestions, I think we should focus the document more on how elastic-package can be used with podman, and less on documenting podman itself.
@@ -0,0 +1,8 @@ | |||
# How to Develop Using Podman Instead of Docker |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could it be linked this document from the main README?
https://github.com/elastic/elastic-package/blob/a4dc5bfc8e2e7d8bee92dca953ff4d533646f5ed/tools/readme/readme.md.tmpl
I don't see any reference that elastic-package
required docker
, but maybe it could be added in the Getting started
section, WDYT?
As an example, this is done in the integrations repo: https://github.com/elastic/integrations/blob/30cbfa897b15730214495befe29929e9d218c122/docs/extend/quick-start.md?plain=1#L33
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i see it in the stack
command is mentioned that is a "docker-based" command https://github.com/elastic/elastic-package/blob/a4dc5bfc8e2e7d8bee92dca953ff4d533646f5ed/README.md#elastic-package-stack perhaps here we could add a line just in case you dont use docker ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i see it in the
stack
command is mentioned that is a "docker-based" command https://github.com/elastic/elastic-package/blob/a4dc5bfc8e2e7d8bee92dca953ff4d533646f5ed/README.md#elastic-package-stack perhaps here we could add a line just in case you dont use docker ?
Maybe the line you added to elastic-package stack up
could be removed in favor of the one in elastic-package stack
.
But a part from the stack
sub-command, other sub-commands also require docker
commands:
- elastic-package test system
- elastic-package service
So, I'm wondering if it would make sense to just add it to a section in the main README.md as Requirements, Pre-Requisites or under "Getting started". WDYT @jsoriano ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add it to getting started section, although adding it to the command description might be useful in case of error, looking for help of the command can be a way to discover this content too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be enough with the mention in the getting started section, but I don't see a problem with the line added to command descriptions, so as you prefer.
1d79a0b
to
d86191c
Compare
@@ -0,0 +1,8 @@ | |||
# How to Develop Using Podman Instead of Docker |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be enough with the mention in the getting started section, but I don't see a problem with the line added to command descriptions, so as you prefer.
@@ -0,0 +1,8 @@ | |||
# How to Develop Using Podman Instead of Docker | |||
|
|||
`elastic-package` Docker-based commands should work out of the box using Podman instead of Docker. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd be great to add a test to prove this 🙂 but we can add it if at some point we see users having problems with Podman.
Following the instructions in the linked pages I was unable to get elastic-package to bring up a stack using podman. |
Could you share what was the error? Thanks |
Co-authored-by: Mario Rodriguez Molins <marrodmo@gmail.com>
cd36ea8
to
f044127
Compare
|
I am currently using Podman to use elastic package commands, so i have been able to make it work. Can you check the active Docker CLI context is correctly selected? For my current setup i use the default one (unix:///var/run/docker.sock) Here you have further details on how to verify your docker migration |
Moving back to draft as there is indeed some missing instructions to make this work without podman desktop. |
@efd6 Hi Dan! I've been around this setup without Podman Desktop i cant seem to make it work. What do you think of adding this small how-to as a reference and keep the issue open? Where you able to make it work with the instructions with Podman Desktop? |
💚 Build Succeeded
History
|
I have not been able to make this work. I'd be reluctant to merge this without significant caveats, I'm not sure it's worth it at this stage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As these instructions require Podman Desktop I would be more specific about this, and keep the issue open for further improvements. When we add support Podman CLI, we can revisit this.
@@ -0,0 +1,8 @@ | |||
# How to Develop Using Podman Instead of Docker |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's be more specific about using Podman Desktop. Podman CLI doens't seem to be enough for the calls to the API as the socket is not exposed.
# How to Develop Using Podman Instead of Docker | |
# How to Develop Using Podman Desktop Instead of Docker |
Be aware that a common issue while trying to boot up the stack is that your Docker environments settings are too low in terms of memory threshold. | ||
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md) | |
You can use Podman Desktop instead of Docker, see [this document](./docs/howto/use_podman.md) |
Be aware that a common issue while trying to boot up the stack is that your Docker environments settings are too low in terms of memory threshold. | ||
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md) | |
You can use Podman Desktop instead of Docker, see [this document](./docs/howto/use_podman.md) |
@@ -0,0 +1,8 @@ | |||
# How to Develop Using Podman Instead of Docker | |||
|
|||
`elastic-package` Docker-based commands should work out of the box using Podman instead of Docker. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`elastic-package` Docker-based commands should work out of the box using Podman instead of Docker. | |
`elastic-package` Docker-based commands should work out of the box using Podman Desktop instead of Docker. |
elastic-package help | ||
``` | ||
|
||
Some sub-commands are Docker-based, check you also have Docker installed. In case you are using Podman, check [this guide](./docs/howto/use_podman.md) to make it compatible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some sub-commands are Docker-based, check you also have Docker installed. In case you are using Podman, check [this guide](./docs/howto/use_podman.md) to make it compatible. | |
Some sub-commands are Docker-based, check you also have Docker installed. In case you are using Podman Desktop, check [this guide](./docs/howto/use_podman.md) to make it compatible. |
Partially Resolves #1748
Adding how-to guide to develop using podman desktop.