Skip to content

Commit d86191c

Browse files
committed
Update documentation to include Podman as an alternative to Docker
1 parent ccaaec6 commit d86191c

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,8 @@ You can run your own custom images for Elasticsearch, Kibana or Elastic Agent, s
490490

491491
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.
492492

493+
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md)
494+
493495
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).
494496

495497
### `elastic-package stack down`
@@ -542,6 +544,8 @@ You can run your own custom images for Elasticsearch, Kibana or Elastic Agent, s
542544

543545
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.
544546

547+
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md)
548+
545549
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.
546550

547551
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).

cmd/stack.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ You can run your own custom images for Elasticsearch, Kibana or Elastic Agent, s
3535
3636
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.
3737
38+
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md)
39+
3840
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).`
3941

4042
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
4547
4648
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.
4749
50+
You can use Podman instead of Docker, see [this document](./docs/howto/use_podman.md)
51+
4852
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.
4953
5054
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).

docs/howto/use_podman.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# How to Develop Using Podman Instead of Docker
22

3-
`elastic-package` runs Docker commands, if you are using Podman instead of Docker you might come accross some errors if Podman is not well configured.
3+
`elastic-package` Docker-based commands should work out of the box using Podman instead of Docker.
44

5-
Podman provides a Docker-compatible CLI. You can setup Podman so it runs whenever the Docker commands are run, [following the migration guide](https://podman-desktop.io/docs/migrating-from-docker/managing-docker-compatibility).
5+
Check you have Podman configured [following the migration guide](https://podman-desktop.io/docs/migrating-from-docker/managing-docker-compatibility)
66

77
- [Podman Official Documentation](https://docs.podman.io/)
88
- [Podman vs Docker Comparison](https://podman.io/getting-started/)

0 commit comments

Comments
 (0)