diff --git a/README.md b/README.md index 0dbdab90a4..e23361b7a1 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ Run the `help` command and see available commands: elastic-package help ``` +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. + ## Development Even though the project is "go-gettable", there is the [`Makefile`](./Makefile) present, which can be used to build, @@ -490,6 +492,8 @@ You can run your own custom images for Elasticsearch, Kibana or Elastic Agent, s 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 Desktop instead of Docker, see [this document](./docs/howto/use_podman.md) + For details on how to connect the service with the Elastic stack, see the [service command](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-service). ### `elastic-package stack down` @@ -542,6 +546,8 @@ You can run your own custom images for Elasticsearch, Kibana or Elastic Agent, s 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 Desktop instead of Docker, see [this document](./docs/howto/use_podman.md) + To expose local packages in the Package Registry, build them first and boot up the stack from inside of the Git repository containing the package (e.g. elastic/integrations). They will be copied to the development stack (~/.elastic-package/stack/development) and used to build a custom Docker image of the Package Registry. Starting with Elastic stack version >= 8.7.0, it is not mandatory to be available local packages in the Package Registry to run the tests. For details on how to connect the service with the Elastic stack, see the [service command](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-service). diff --git a/cmd/stack.go b/cmd/stack.go index 420770df89..b24164ad84 100644 --- a/cmd/stack.go +++ b/cmd/stack.go @@ -35,6 +35,8 @@ You can run your own custom images for Elasticsearch, Kibana or Elastic Agent, s 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 Desktop instead of Docker, see [this document](./docs/howto/use_podman.md) + For details on how to connect the service with the Elastic stack, see the [service command](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-service).` const stackUpLongDescription = `Use this command to boot up the stack locally. @@ -45,6 +47,8 @@ You can run your own custom images for Elasticsearch, Kibana or Elastic Agent, s 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 Desktop instead of Docker, see [this document](./docs/howto/use_podman.md) + To expose local packages in the Package Registry, build them first and boot up the stack from inside of the Git repository containing the package (e.g. elastic/integrations). They will be copied to the development stack (~/.elastic-package/stack/development) and used to build a custom Docker image of the Package Registry. Starting with Elastic stack version >= 8.7.0, it is not mandatory to be available local packages in the Package Registry to run the tests. For details on how to connect the service with the Elastic stack, see the [service command](https://github.com/elastic/elastic-package/blob/main/README.md#elastic-package-service). diff --git a/docs/howto/use_podman.md b/docs/howto/use_podman.md new file mode 100644 index 0000000000..04cfdb806a --- /dev/null +++ b/docs/howto/use_podman.md @@ -0,0 +1,8 @@ +# How to Develop Using Podman Desktop Instead of Docker + +`elastic-package` Docker-based commands should work out of the box using Podman Desktop instead of Docker. + +Check you have **Podman Desktop Desktop** configured [following the migration guide](https://podman-desktop.io/docs/migrating-from-docker/managing-docker-compatibility) + +- [Podman Desktop](https://podman-desktop.io/) +- [Podman Desktop Docs](https://podman-desktop.io/docs/intro) diff --git a/tools/readme/readme.md.tmpl b/tools/readme/readme.md.tmpl index 49bb18bdf5..004858eaec 100644 --- a/tools/readme/readme.md.tmpl +++ b/tools/readme/readme.md.tmpl @@ -39,6 +39,8 @@ Run the `help` command and see available commands: elastic-package help ``` +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. + ## Development Even though the project is "go-gettable", there is the [`Makefile`](./Makefile) present, which can be used to build,