Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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).
Expand Down
4 changes: 4 additions & 0 deletions cmd/stack.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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).
Expand Down
8 changes: 8 additions & 0 deletions docs/howto/use_podman.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 2 additions & 0 deletions tools/readme/readme.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down