Skip to content

Commit 30d6f8d

Browse files
committed
Add links for using Fleet Server with a proxy + small sub fixes
1 parent 8a9483b commit 30d6f8d

14 files changed

+79
-138
lines changed

reference/fleet/add-fleet-server-cloud.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2+
navigation_title: Deploy on Elastic Cloud
23
mapped_pages:
34
- https://www.elastic.co/guide/en/fleet/current/add-fleet-server-cloud.html
45
products:
56
- id: fleet
67
- id: elastic-agent
78
---
89

9-
# Deploy on Elastic Cloud [add-fleet-server-cloud]
10+
# Deploy {{fleet-server}} on {{ecloud}} [add-fleet-server-cloud]
1011

1112
To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts.
1213

@@ -39,20 +40,18 @@ This approach might *not* be right for you if you have restrictions on connectiv
3940

4041
For more information about hosting {{fleet-server}} on {{ece}}, refer to [](/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md).
4142

42-
4343
::::{note}
4444
The TLS certificates used to secure connections between {{agent}} and {{fleet-server}} are managed by {{ecloud}}. You do not need to create a private key or generate certificates.
4545
::::
4646

47-
4847
When {{es}} or {{fleet-server}} are deployed, components communicate over well-defined, pre-allocated ports. You may need to allow access to these ports. See the following table for default port assignments:
4948

5049
| Component communication | Default port |
5150
| --- | --- |
52-
| Elastic Agent → {{fleet-server}} | 443 |
53-
| Elastic Agent → {{es}} | 443 |
54-
| Elastic Agent → Logstash | 5044 |
55-
| Elastic Agent → {{kib}} ({{fleet}}) | 443 |
51+
| {{agent}} → {{fleet-server}} | 443 |
52+
| {{agent}} → {{es}} | 443 |
53+
| {{agent}} → {{ls}} | 5044 |
54+
| {{agent}} → {{kib}} ({{fleet}}) | 443 |
5655
| {{fleet-server}} → {{kib}} ({{fleet}}) | 443 |
5756
| {{fleet-server}} → {{es}} | 443 |
5857

@@ -61,7 +60,6 @@ If you do not specify the port for {{es}} as 443, the {{agent}} defaults to 9200
6160
::::
6261

6362

64-
6563
## Setup [add-fleet-server-cloud-set-up]
6664

6765
To confirm that an {{integrations-server}} is available in your deployment:
@@ -80,7 +78,6 @@ Don’t see the agent? Make sure your deployment includes an {{integrations-serv
8078
:::::
8179

8280

83-
8481
## Next steps [add-fleet-server-cloud-next]
8582

8683
Now you’re ready to add {{agent}}s to your host systems. To learn how, see [Install {{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md).

reference/fleet/add-fleet-server-kubernetes.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2+
navigation_title: Deploy on Kubernetes
23
mapped_pages:
34
- https://www.elastic.co/guide/en/fleet/current/add-fleet-server-kubernetes.html
45
products:
56
- id: fleet
67
- id: elastic-agent
78
---
89

9-
# Deploy Fleet Server on Kubernetes [add-fleet-server-kubernetes]
10+
# Deploy {{fleet-server}} on Kubernetes [add-fleet-server-kubernetes]
1011

1112
::::{note}
1213
If your {{stack}} is orchestrated by [ECK](/deploy-manage/deploy/cloud-on-k8s.md), we recommend to deploy the {{fleet-server}} through the operator. That simplifies the process, as the operator automatically handles most of the resources configuration and setup steps.
@@ -29,7 +30,7 @@ You can deploy {{fleet-server}} on Kubernetes and manage it yourself. In this de
2930
To deploy a {{fleet-server}} on Kubernetes and register it into {{fleet}} you will need the following details:
3031

3132
* The **Policy ID** of a {{fleet}} policy configured with the {{fleet-server}} integration.
32-
* A **Service token**, used to authenticate {{fleet-server}} with Elasticsearch.
33+
* A **Service token**, used to authenticate {{fleet-server}} with {{es}}.
3334
* For outgoing traffic:
3435

3536
* The **{{es}} endpoint URL** where the {{fleet-server}} should connect to, configured also in the {{es}} output associated to the policy.
@@ -61,7 +62,6 @@ This document walks you through the complete setup process, organized into the f
6162
* {{kib}} should be on the same minor version as {{es}}.
6263

6364

64-
6565
## Prerequisites [add-fleet-server-kubernetes-prereq]
6666

6767
Before deploying {{fleet-server}}, you need to:
@@ -86,7 +86,6 @@ A {{fleet-server}} certificate is not required when installing the server using
8686

8787
::::
8888

89-
9089
If your organization already uses the {{stack}}, you may have a CA certificate that could be used to generate the new cert for the {{fleet-server}}. If you do not have a CA certificate, refer to [Generate a custom certificate and private key for {{fleet-server}}](/reference/fleet/secure-connections.md#generate-fleet-server-certs) for an example to generate a CA and a server certificate using the `elasticsearch-certutil` tool.
9190

9291
::::{important}
@@ -95,7 +94,6 @@ Before creating the certificate, you need to know and plan in advance the [hostn
9594
::::
9695

9796

98-
9997
#### [{{fleet-server}} → {{es}} output] outbound traffic flow [add-fleet-server-kubernetes-cert-outbound]
10098

10199
In this flow, {{fleet-server}} acts as the client and {{es}} acts as the HTTPS server. For the communication to succeed, {{fleet-server}} needs to trust the CA certificate used to sign the {{es}} certificate. If your {{es}} cluster uses certificates signed by a corporate CA or multiple intermediate CAs you will need to use them during the {{fleet-server}} setup.
@@ -105,7 +103,6 @@ If your {{es}} cluster is on Elastic Cloud or if it uses a certificate signed by
105103

106104
::::
107105

108-
109106
In summary, you need:
110107

111108
* A **server certificate and key**, valid for the {{fleet-server}} URL. The CA used to sign this certificate will be needed by the {{agent}} clients and the {{fleet-server}} itself.
@@ -122,7 +119,7 @@ When {{es}} or {{fleet-server}} are deployed, components communicate over well-d
122119
| {{fleet-server}} → {{es}} | 9200 |
123120
| {{fleet-server}} → {{kib}} (optional, for {{fleet}} setup) | 5601 |
124121
| {{agent}} → {{es}} | 9200 |
125-
| {{agent}} → Logstash | 5044 |
122+
| {{agent}} → {{ls}} | 5044 |
126123
| {{agent}} → {{kib}} (optional, for {{fleet}} setup) | 5601 |
127124

128125
In Kubernetes environments, you can adapt these ports without modifying the listening ports of the {{fleet-server}} or other applications, as traffic is managed by Kubernetes `Services`. This guide includes an example where {{agent}}s connect to the {{fleet-server}} through port `443` instead of the default `8220`.
@@ -142,7 +139,6 @@ The `service token` required by the {{fleet-server}} is different from the `enro
142139

143140
::::
144141

145-
146142
1. In {{kib}}, open **{{fleet}} → Settings** and ensure the **Elasticsearch output** that will be used by the {{fleet-server}} policy is correctly configured, paying special attention that:
147143

148144
* The **hosts** field includes a valid URL that will be reachable by the {{fleet-server}} Pod(s).
@@ -197,7 +193,6 @@ The `service token` required by the {{fleet-server}} is different from the `enro
197193
When the {{fleet-server}} installation has succeeded, the **Confirm Connection** UI will show a **Connected** status.
198194

199195

200-
201196
### {{fleet-server}} installation [add-fleet-server-kubernetes-install]
202197

203198

@@ -207,8 +202,8 @@ To deploy {{fleet-server}} on Kubernetes and enroll it into {{fleet}} you need t
207202

208203
* **Policy ID** of the {{fleet}} policy configured with the {{fleet-server}} integration.
209204
* **Service token**, that you can generate following the [{{fleet}} preparations](#add-fleet-server-kubernetes-preparations) or manually using the [{{es}}-service-tokens command](elasticsearch://reference/elasticsearch/command-line-tools/service-tokens-command.md).
210-
* **{{es}} endpoint URL**, configured in both the {{es}} output associated to the policy and in the Fleet Server as an environment variable.
211-
* **{{es}} CA certificate file**, configured in both the {{es}} output associated to the policy and in the Fleet Server.
205+
* **{{es}} endpoint URL**, configured in both the {{es}} output associated to the policy and in the {{fleet-server}} as an environment variable.
206+
* **{{es}} CA certificate file**, configured in both the {{es}} output associated to the policy and in the {{fleet-server}}.
212207
* {{fleet-server}} **certificate and key** (for **Production** deployment mode only).
213208
* {{fleet-server}} **CA certificate file** (for **Production** deployment mode only).
214209
* {{fleet-server}} URL (for **Production** deployment mode only).
@@ -228,12 +223,12 @@ Adapt and change the suggested manifests and deployment strategy to your needs,
228223

229224
* CPU and memory `requests` and `limits`. Refer to [{{fleet-server}} scalability](/reference/fleet/fleet-server-scalability.md) for more information about {{fleet-server}} resources utilization.
230225
* Scheduling configuration, such as `affinity rules` or `tolerations`, if needed in your environment.
231-
* Number of replicas, to scale the Fleet Server horizontally.
226+
* Number of replicas, to scale the {{fleet-server}} horizontally.
232227
* Use an {{es}} CA fingerprint instead of a CA file.
233228
* Configure other [Environment variables](/reference/fleet/agent-environment-variables.md).
234229

235230

236-
#### Installation Steps [add-fleet-server-kubernetes-install-steps]
231+
#### Installation steps [add-fleet-server-kubernetes-install-steps]
237232

238233
1. Create the Secret for the {{fleet-server}} configuration.
239234

@@ -558,7 +553,6 @@ The following issues may occur when {{fleet-server}} settings are missing or con
558553
As a workaround, consider using `https://localhost:8220` as the `FLEET_URL` for the {{fleet-server}} configuration, and ensure that `localhost` is included in the certificate’s SAN.
559554

560555

561-
562556
## Next steps [add-fleet-server-kubernetes-next]
563557

564558
Now you’re ready to add {{agent}}s to your host systems. To learn how, refer to [Install {{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md), or [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) if your {{agent}}s will also run on Kubernetes.

reference/fleet/add-fleet-server-mixed.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ products:
66
- id: elastic-agent
77
---
88

9-
# Deploy Fleet Server on-premises and Elasticsearch on Cloud [add-fleet-server-mixed]
9+
# Deploy {{fleet-server}} on-premises and {{es}} on {{ecloud}} [add-fleet-server-mixed]
1010

1111
To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts.
1212

@@ -44,7 +44,6 @@ To deploy a self-managed {{fleet-server}} on-premises to work with an {{ech}} de
4444
For more information about hosting {{fleet-server}} on {{ece}}, refer to [](/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md).
4545

4646

47-
4847
## Prerequisites [add-fleet-server-mixed-prereq]
4948

5049
Before deploying, you need to:
@@ -64,17 +63,16 @@ This is not required when testing and iterating using the **Quick start** option
6463
::::
6564

6665

67-
6866
### Default port assignments [default-port-assignments-mixed]
6967

7068
When {{es}} or {{fleet-server}} are deployed, components communicate over well-defined, pre-allocated ports. You may need to allow access to these ports. See the following table for default port assignments:
7169

7270
| Component communication | Default port |
7371
| --- | --- |
74-
| Elastic Agent → {{fleet-server}} | 8220 |
75-
| Elastic Agent → {{es}} | 443 |
76-
| Elastic Agent → Logstash | 5044 |
77-
| Elastic Agent → {{kib}} ({{fleet}}) | 443 |
72+
| {{agent}} → {{fleet-server}} | 8220 |
73+
| {{agent}} → {{es}} | 443 |
74+
| {{agent}} → {{ls}} | 5044 |
75+
| {{agent}} → {{kib}} ({{fleet}}) | 443 |
7876
| {{fleet-server}} → {{kib}} ({{fleet}}) | 443 |
7977
| {{fleet-server}} → {{es}} | 443 |
8078

@@ -83,7 +81,6 @@ If you do not specify the port for {{es}} as 443, the {{agent}} defaults to 9200
8381
::::
8482

8583

86-
8784
## Create a {{fleet-server}} policy [fleet-server-create-policy]
8885

8986
First, create a {{fleet-server}} policy. The {{fleet-server}} policy manages and configures the {{agent}} running on the {{fleet-server}} host to launch a {{fleet-server}} process.
@@ -105,7 +102,6 @@ To create a {{fleet-server}} policy:
105102
2. It’s recommended that you also enter the *Max agents* you intend to support with this {{fleet-server}}. This can also be modified at a later stage. This will allow the {{fleet-server}} to handle the load and frequency of updates being sent to the agent and ensure a smooth operation in a bursty environment.
106103

107104

108-
109105
## Add {{fleet-server}}s [fleet-server-add-server]
110106

111107
Now that the policy exists, you can add {{fleet-server}}s.

reference/fleet/add-fleet-server-on-prem.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2+
navigation_title: Deploy on-premises and self-managed
23
mapped_pages:
34
- https://www.elastic.co/guide/en/fleet/current/add-fleet-server-on-prem.html
45
products:
56
- id: fleet
67
- id: elastic-agent
78
---
89

9-
# Deploy on-premises and self-managed [add-fleet-server-on-prem]
10+
# Deploy on-premises and self-managed {{fleet-server}} [add-fleet-server-on-prem]
1011

1112
To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts.
1213

@@ -32,7 +33,6 @@ You can install only a single {{agent}} per host, which means you cannot run {{f
3233
::::
3334

3435

35-
3636
## Compatibility [add-fleet-server-on-prem-compatibility]
3737

3838
{{fleet-server}} is compatible with the following Elastic products:
@@ -50,7 +50,6 @@ You can install only a single {{agent}} per host, which means you cannot run {{f
5050
For more information about hosting {{fleet-server}} on {{ece}}, refer to [](/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md).
5151

5252

53-
5453
## Prerequisites [add-fleet-server-on-prem-prereq]
5554

5655
Before deploying, you need to:
@@ -70,17 +69,16 @@ This is not required when testing and iterating using the **Quick start** option
7069
::::
7170

7271

73-
7472
### Default port assignments [default-port-assignments-on-prem]
7573

7674
When {{es}} or {{fleet-server}} are deployed, components communicate over well-defined, pre-allocated ports. You may need to allow access to these ports. Refer to the following table for default port assignments:
7775

7876
| Component communication | Default port |
7977
| --- | --- |
80-
| Elastic Agent → {{fleet-server}} | 8220 |
81-
| Elastic Agent → {{es}} | 9200 |
82-
| Elastic Agent → Logstash | 5044 |
83-
| Elastic Agent → {{kib}} ({{fleet}}) | 5601 |
78+
| {{agent}} → {{fleet-server}} | 8220 |
79+
| {{agent}} → {{es}} | 9200 |
80+
| {{agent}} → {{ls}} | 5044 |
81+
| {{agent}} → {{kib}} ({{fleet}}) | 5601 |
8482
| {{fleet-server}} → {{kib}} ({{fleet}}) | 5601 |
8583
| {{fleet-server}} → {{es}} | 9200 |
8684

@@ -89,7 +87,6 @@ Connectivity to {{kib}} on port 5601 is optional and not required at all times.
8987
::::
9088

9189

92-
9390
## Add {{fleet-server}} [add-fleet-server-on-prem-add-server]
9491

9592
A {{fleet-server}} is an {{agent}} that is enrolled in a {{fleet-server}} policy. The policy configures the agent to operate in a special mode to serve as a {{fleet-server}} in your deployment.
@@ -135,7 +132,6 @@ To add a {{fleet-server}}:
135132

136133
::::
137134

138-
139135
At the **Install Fleet Server to a centralized host** step, the `elastic-agent install` command installs an {{agent}} as a managed service and enrolls it in a {{fleet-server}} policy. For more {{fleet-server}} commands, refer to the [{{agent}} command reference](/reference/fleet/agent-command-reference.md).
140136

141137
5. If installation is successful, a confirmation indicates that {{fleet-server}} is set up and connected.

0 commit comments

Comments
 (0)