Skip to content
This repository was archived by the owner on Sep 21, 2023. It is now read-only.

Commit f5b5acf

Browse files
committed
Update README to reflect the new unmanaged mode.
1 parent d3b510a commit f5b5acf

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Data shipper for the Elastic Agent - a single, unified way to add monitoring for
66
other types of data to a host.
77

88
The data shipper is a new process in the Elastic agent system designed to centralize local data
9-
processing, queueuing, and publishing to the target output (Elasticsearch, Logstash, etc.).
9+
processing, queueing, and publishing to the target output (Elasticsearch, Logstash, etc.).
1010

1111
The data shipper is a part of a larger effort to rearchitect the Elastic agent. In the initial Elastic
1212
agent architecture each underlying data collector (e.g. Filebeat) was required to implement its own
@@ -30,10 +30,20 @@ Data shipper clients must implement the shipper [gRPC API](https://github.com/el
3030
The reference client is the [Beats shipper output](https://github.com/elastic/beats/tree/main/libbeat/outputs/shipper), which is
3131
used by Beats like Filebeat and Metricbeat when they are started by Elastic agent integrations.
3232

33-
Data shipper support in the Elastic Agent is under active development. The shipper currently depends on a running Elastic agent instance to
34-
start but it will soon be possible to run the shipper in standalone mode for development: https://github.com/elastic/elastic-agent-shipper/issues/83
33+
Data shipper support in the Elastic Agent is under active development.
3534

36-
The [reference shipper configuration file](https://github.com/elastic/elastic-agent-shipper/blob/main/elastic-agent-shipper.yml) defines the available
35+
The shipper currently can be run in 2 modes:
36+
37+
* Under Elastic agent (managed mode): the main mode for running in production environments
38+
* Using a local config file (unmanaged mode): is supposed to be used for local development and testing
39+
40+
To run the shipper in the unmanaged mode use this flag on the built binary:
41+
42+
```sh
43+
./elastic-agent-shipper run -c elastic-agent-shipper.yml
44+
```
45+
46+
Where `elastic-agent-shipper.yml` is a path to a local configuration file. The [reference shipper configuration file](https://github.com/elastic/elastic-agent-shipper/blob/main/elastic-agent-shipper.yml) defines the available
3747
configuration options.
3848

3949
## Contributing

0 commit comments

Comments
 (0)