Skip to content

Commit 747b1a5

Browse files
committed
Adjust private location docs to support base elastic-agent image
1 parent d92b0a8 commit 747b1a5

File tree

4 files changed

+43
-17
lines changed

4 files changed

+43
-17
lines changed

reference/fleet/elastic-agent-container.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ docker pull docker.elastic.co/elastic-agent/elastic-agent-wolfi:{{version.stack}
6969

7070
### Complete flavor
7171

72-
If you want to run Synthetics tests, run the docker pull command to fetch the elastic-agent-complete image:
72+
If you want to run Synthetics Browser tests, run the docker pull command to fetch the elastic-agent-complete image:
7373

7474
```terminal subs=true
7575
docker pull docker.elastic.co/elastic-agent/elastic-agent-complete:{{version.stack}}
@@ -137,8 +137,7 @@ docker run \
137137
1. Set to 1 to enroll the {{agent}} into {{fleet-server}}.
138138
2. URL to enroll the {{fleet-server}} into. You can find it in {{kib}}. Select **Management → {{fleet}} → Fleet Settings**, and copy the {{fleet-server}} host URL.
139139
3. The token to use for enrollment. Close the flyout panel and select **Enrollment tokens**. Find the Agent policy you want to enroll {{agent}} into, and display and copy the secret token. To learn how to create a policy, refer to [Create an agent policy without using the UI](/reference/fleet/create-policy-no-ui.md).
140-
4. If you want to run **elastic-agent-complete** image, replace `elastic-agent` to `elastic-agent-complete`. Use the `elastic-agent` user instead of root to run Synthetics Browser tests. Synthetic tests cannot run under the root user. Refer to [Synthetics {{fleet}} Quickstart](/solutions/observability/synthetics/get-started.md) for more information.
141-
140+
4. Switch `elastic-agent` to `elastic-agent-complete` if you intend to use the complete version. Use the `elastic-agent` user instead of root to run Synthetics Browser tests. Synthetic tests cannot run under the root user. Refer to [Synthetics {{fleet}} Quickstart](/solutions/observability/synthetics/get-started.md) for more information.
142141
Refer to [Environment variables](/reference/fleet/agent-environment-variables.md) for all available options.
143142
:::
144143

@@ -161,8 +160,7 @@ docker run \
161160
3. The {{fleet}} service token. [Generate one in the {{fleet}} UI](/reference/fleet/fleet-enrollment-tokens.md#create-fleet-enrollment-tokens) if you don’t have one already.
162161
4. ID of the {{fleet-server}} policy. We recommend only having one fleet-server policy. To learn how to create a policy, refer to [Create an agent policy without using the UI](/reference/fleet/create-policy-no-ui.md).
163162
5. publish container port 8220 to host.
164-
6. If you want to run the **elastic-agent-complete** image, replace `elastic-agent` with `elastic-agent-complete`. Use the `elastic-agent` user instead of root to run Synthetics Browser tests. Synthetic tests cannot run under the root user. Refer to [Synthetics {{fleet}} Quickstart](/solutions/observability/synthetics/get-started.md) for more information.
165-
163+
6. Switch `elastic-agent` to `elastic-agent-complete` if you intend to use the complete version. Use the `elastic-agent` user instead of root to run Synthetics Browser tests. Synthetic tests cannot run under the root user. Refer to [Synthetics {{fleet}} Quickstart](/solutions/observability/synthetics/get-started.md) for more information.
166164
Refer to [Environment variables](/reference/fleet/agent-environment-variables.md) for all available options.
167165
:::
168166

@@ -244,7 +242,6 @@ services:
244242
- FLEET_ENROLL=1
245243
- FLEET_URL=<fleet-server-url>
246244
```
247-
248245
1. Switch `elastic-agent` to `elastic-agent-complete` if you intend to use the complete version. Use the `elastic-agent` user instead of root to run Synthetics Browser tests. Synthetic tests cannot run under the root user. Refer to [Synthetics {{fleet}} Quickstart](/solutions/observability/synthetics/get-started.md) for more information.
249246
2. Synthetic browser monitors require this set to `elastic-agent`.
250247

solutions/observability/synthetics/migrate-from-elastic-synthetics-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Find more details in [Use the {{synthetics-app}}](/solutions/observability/synth
8484

8585
## Where monitors run [synthetics-migrate-integration-location]
8686

87-
If you want to continue hosting on your infrastructure, you will need to create a {{private-location}} before creating monitors. If you have already have an {{agent}} running using `elastic-agent-complete`, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}. To create a new {{private-location}} from scratch, follow all instructions in [Monitor resources on private networks](/solutions/observability/synthetics/monitor-resources-on-private-networks.md).
87+
If you want to continue hosting on your infrastructure, you will need to create a {{private-location}} before creating monitors. If you already have an {{agent}} container running using `elastic-agent` or any of its variants, you can [add it as a new {{private-location}}](/solutions/observability/synthetics/monitor-resources-on-private-networks.md#synthetics-private-location-add) in the {{synthetics-app}}. To create a new {{private-location}} from scratch, follow all instructions in [Monitor resources on private networks](/solutions/observability/synthetics/monitor-resources-on-private-networks.md).
8888

8989
Alternatively, you can start hosting on Elastic’s global managed infrastructure. With Elastic’s global managed testing infrastructure, you can create and run monitors in multiple locations without having to manage your own infrastructure. Elastic takes care of software updates and capacity planning for you.
9090

solutions/observability/synthetics/monitor-resources-on-private-networks.md

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,42 +56,63 @@ By default {{private-location}}s are configured to allow two simultaneous browse
5656

5757
After setting up {{fleet}}, you’ll connect {{fleet}} to the {{stack}} or your Observability Serverless project and enroll an {{agent}} in {{fleet}}.
5858

59-
Elastic provides Docker images that you can use to run {{fleet}} and an {{agent}} more easily. For monitors running on {{private-location}}s, you *must* use the `elastic-agent-complete` Docker image to create a self-hosted {{agent}} node. The standard {{ecloud}} or self-hosted {{agent}} will not work.
60-
59+
Elastic provides Docker images that you can use to run {{fleet}} and an {{agent}} more easily. For running browser monitors on {{private-location}}s, you *must* use one of the `elastic-agent-complete` Docker image variants, as it includes the required dependencies. The standard {{agent}} variant only supports TCP, ICMP and HTTP monitors.
6160
::::{important}
62-
The `elastic-agent-complete` Docker image is the only way to have all available options that you see in the UI.
61+
The `elastic-agent` Docker image variants are the only way to have all available options that you see in the UI.
6362

6463
::::
6564

6665
To pull the Docker image run:
6766

6867
::::{tab-set}
6968
:group: docker
70-
:::{tab-item} Latest
69+
:::{tab-item} `elastic-agent`
7170
:sync: latest
7271

7372
```shell subs=true
74-
docker pull docker.elastic.co/elastic-agent/elastic-agent-complete:{{version.stack}}
73+
# Supports TCP, ICMP and HTTP monitors
74+
docker pull docker.elastic.co/elastic-agent/elastic-agent:{{version.stack}}
7575
```
7676

7777
:::
7878

79-
:::{tab-item} Specific version
79+
:::{tab-item} `elastic-agent-complete`
8080
:sync: specific
8181

8282
```sh subs=true
83-
docker pull docker.elastic.co/elastic-agent/elastic-agent-complete:<SPECIFIC.VERSION.NUMBER>
83+
# Supports all monitor types: TCP, ICMP, HTTP and Browser
84+
docker pull docker.elastic.co/elastic-agent/elastic-agent-complete:{{version.stack}}
8485
```
8586

86-
You can download and install a specific version of the {{stack}} by replacing `<SPECIFIC.VERSION.NUMBER>` with the version number you want. For example, you can replace `<SPECIFIC.VERSION.NUMBER>` with {{version.stack.base}}.
8787
:::
8888

8989
::::
9090

91+
You can download and install a specific version of the {{stack}} by replacing `{{version.stack}}` with the version number you want. For example, you can replace `{{version.stack}}` with {{version.stack.base}}.
92+
9193
Then enroll and run an {{agent}}. You’ll need an enrollment token and the URL of the {{fleet-server}}. You can use the default enrollment token for your policy or create new policies and [enrollment tokens](/reference/fleet/fleet-enrollment-tokens.md) as needed.
9294

9395
For more information on running {{agent}} with Docker, refer to [Run {{agent}} in a container](/reference/fleet/elastic-agent-container.md).
9496

97+
::::{tab-set}
98+
:group: docker
99+
:::{tab-item} `elastic-agent`
100+
:sync: latest
101+
102+
```shell subs=true
103+
docker run \
104+
--env FLEET_ENROLL=1 \
105+
--env FLEET_URL={fleet_server_host_url} \
106+
--env FLEET_ENROLLMENT_TOKEN={enrollment_token} \
107+
--cap-add=NET_RAW \
108+
--cap-add=SETUID \
109+
--rm docker.elastic.co/elastic-agent/elastic-agent:{{version.stack}}
110+
```
111+
112+
:::
113+
114+
:::{tab-item} `elastic-agent-complete`
115+
:sync: specific
95116

96117
```shell subs=true
97118
docker run \
@@ -103,8 +124,12 @@ docker run \
103124
--rm docker.elastic.co/elastic-agent/elastic-agent-complete:{{version.stack}}
104125
```
105126

127+
:::
128+
129+
::::
130+
106131
::::{important}
107-
The `elastic-agent-complete` Docker image requires additional capabilities to operate correctly. Ensure `NET_RAW` and `SETUID` are enabled on the container.
132+
The `elastic-agent`/`elastic-agent-complete` container requires additional capabilities to operate correctly. Ensure `NET_RAW` and `SETUID` are enabled on the container.
108133

109134
::::
110135

solutions/observability/synthetics/support-matrix.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,11 @@ There are various components that make up the Synthetics solution, which are sup
4141

4242
* Any *inline* or *Zip URL* monitors configured with the beta Synthetics integration prior to 1.0.0, are not supported and will stop running in the future
4343

44-
* Shipped as the `elastic-agent-complete` Docker image
44+
* Shipped as multiple `elastic-agent` Docker image variants:
45+
46+
* `elastic-agent-complete`, which includes all dependencies required to support browser monitors.
47+
* `elastic-agent` which only supports TCP, HTTP and ICMP monitors.
48+
4549
* Must have a direct connection to {{es}}
4650

4751
* Do not configure any ingest pipelines or Logstash output

0 commit comments

Comments
 (0)