Skip to content

Commit

Permalink
[Elastic Agent] Add hint on how to build and test the container for E…
Browse files Browse the repository at this point in the history
…lastic Agent (#25551)

I had this as a local note and used it often. I thought it maybe worth sharing.
  • Loading branch information
ruflin authored May 18, 2021
1 parent 6b61c96 commit a183d65
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
18 changes: 18 additions & 0 deletions x-pack/elastic-agent/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Elastic Agent developer docs

The source files for the general Elastic Agent documentation are currently stored
in the [observability-docs](https://github.com/elastic/observability-docs) repo. The following docs are only focused on getting developers started building code for Elastic Agent.

## Testing docker container

Running Elastic Agent in a docker container is a common use case. To build the Elastic Agent and create a docker image run the following command:

```
DEV=true SNAPSHOT=true PLATFORMS=linux/amd64 TYPES=docker mage package
```

If you are in the 7.13 branch, this will create the `docker.elastic.co/beats/elastic-agent:7.13.0-SNAPSHOT` image in your local environment. Now you can use this to for example test this container with the stack in elastic-package:

```
elastic-package stack up --version=7.13.0-SNAPSHOT -v
```
6 changes: 0 additions & 6 deletions x-pack/elastic-agent/docs/README.md

This file was deleted.

0 comments on commit a183d65

Please sign in to comment.