Skip to content

Commit ac04437

Browse files
Prepare for docs-assembler (#792)
Restructure content and create `toc.yml` files needed by docs-assembler. ![image](https://github.com/user-attachments/assets/47f6bc05-5c24-4516-8079-e035682b1e7e) cc @Mpdreamz
1 parent 4a1be8e commit ac04437

File tree

467 files changed

+1027
-978
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

467 files changed

+1027
-978
lines changed

deploy-manage/cloud-organization/tools-and-apis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Other Products
3737
* [APM event intake API Reference](/solutions/observability/apps/elastic-apm-events-intake-api.md)
3838
* [App Search API Reference](https://www.elastic.co/guide/en/app-search/current/api-reference.html)
3939
* [Elastic Security APIs](https://www.elastic.co/guide/en/security/current/security-apis.html)
40-
* [Fleet APIs](/reference/ingestion-tools/fleet/fleet-api-docs.md)
40+
* [Fleet APIs](/reference/fleet/fleet-api-docs.md)
4141
* [Logstash APIs](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html)
4242
* [Workplace Search API Reference](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-api-overview.html)
4343

deploy-manage/deploy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Your choice of deployment type determines how you'll set up and manage these cor
2323
This section focuses on deploying and managing {{es}} and {{kib}}, as well as supporting orchestration technologies. However, depending on your use case, you might need to deploy [other {{stack}} components](/get-started/the-stack.md). For example, you might need to add components to ingest logs or metrics.
2424

2525
To learn how to deploy optional {{stack}} components, refer to the following sections:
26-
* [Fleet and Elastic Agent](/reference/ingestion-tools/fleet/index.md)
26+
* [Fleet and Elastic Agent](/reference/fleet/index.md)
2727
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
2828
* [Beats](beats://reference/index.md)
2929
* [Logstash](logstash://reference/index.md)

deploy-manage/deploy/_snippets/installation-order.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ If you're deploying the {{stack}} in a self-managed cluster, then install the {{
33
* {{es}}
44
* {{kib}}
55
* [Logstash](logstash://reference/index.md)
6-
* [{{agent}}](/reference/ingestion-tools/fleet/index.md) or [Beats](beats://reference/index.md)
6+
* [{{agent}}](/reference/fleet/index.md) or [Beats](beats://reference/index.md)
77
* [APM](/solutions/observability/apps/application-performance-monitoring-apm.md)
88
* [Elasticsearch Hadoop](elasticsearch-hadoop://reference/index.md)
99

deploy-manage/deploy/cloud-enterprise/air-gapped-install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Before you start, you must:
1919
* Follow the same prerequisites described in [](./install.md#ece-install-prerequisites). This includes [](./identify-deployment-scenario.md) and [](./prepare-environment.md) steps.
2020
* [Configure your operating system](./configure-operating-system.md) in all ECE hosts.
2121
* Be part of the `docker` group to run the installation script. You should not install Elastic Cloud Enterprise as the `root` user.
22-
* Set up and run a local copy of the Elastic Package Repository, otherwise your deployments with APM server and Elastic agent won’t work. Refer to the [Running EPR in air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-diy-epr) documentation.
22+
* Set up and run a local copy of the Elastic Package Repository, otherwise your deployments with APM server and Elastic agent won’t work. Refer to the [Running EPR in air-gapped environments](/reference/fleet/air-gapped.md#air-gapped-diy-epr) documentation.
2323

2424
When you are ready to install ECE, you can proceed:
2525

deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Users running {{stack}} versions 7.16 or 7.17 need to manually configure TLS. Th
3333

3434
Pick one of the following options:
3535

36-
1. Upload and configure a publicly signed {{es}} TLS certificates. Check [Encrypt traffic in clusters with a self-managed Fleet Server](/reference/ingestion-tools/fleet/secure-connections.md) for details.
36+
1. Upload and configure a publicly signed {{es}} TLS certificates. Check [Encrypt traffic in clusters with a self-managed Fleet Server](/reference/fleet/secure-connections.md) for details.
3737
2. Change the {{es}} hosts where {{agent}}s send data from the default public URL, to the internal URL. In {{kib}}, navigate to **Fleet** and select the **Elastic Cloud agent policy**. Click **Fleet settings** and update the {{es}} hosts URL. For example, if the current URL is `https://123abc.us-central1.gcp.foundit.no:9244`, change it to `http://123abc.containerhost:9244`.
3838

3939

deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_urls:
88

99
# Manage your Integrations Server [ece-manage-integrations-server]
1010

11-
For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/ingestion-tools/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.
11+
For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.
1212

1313
As part of provisioning, the APM Server and Fleet Server are already configured to work with Elasticsearch and Kibana. At the end of provisioning, you are shown the secret token to configure communication between the APM Server and the backend [APM Agents](https://www.elastic.co/guide/en/apm/agent/index.html). The APM Agents get deployed within your services and applications.
1414

deploy-manage/deploy/cloud-on-k8s/configuration-examples-standalone.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_pages:
88

99
# Configuration examples [k8s-elastic-agent-configuration-examples]
1010

11-
This section contains manifests that illustrate common use cases, and can be your starting point in exploring Elastic Agent deployed with ECK. These manifests are self-contained and work out-of-the-box on any non-secured Kubernetes cluster. They all contain a three-node Elasticsearch cluster and a single Kibana instance. Add the corresponding integration package to Kibana to install the dashboards, visualizations and other assets for each of these examples as described in [the Elastic Agent documentation](/reference/ingestion-tools/fleet/install-elastic-agents.md).
11+
This section contains manifests that illustrate common use cases, and can be your starting point in exploring Elastic Agent deployed with ECK. These manifests are self-contained and work out-of-the-box on any non-secured Kubernetes cluster. They all contain a three-node Elasticsearch cluster and a single Kibana instance. Add the corresponding integration package to Kibana to install the dashboards, visualizations and other assets for each of these examples as described in [the Elastic Agent documentation](/reference/fleet/install-elastic-agents.md).
1212

1313
::::{warning}
1414
The examples in this section are for illustration purposes only and should not be considered to be production-ready. Some of these examples use the `node.store.allow_mmap: false` setting which has performance implications and should be tuned for production workloads, as described in [Virtual memory](virtual-memory.md).

deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ mapped_pages:
1010

1111
{{fleet}}-managed {{agents}} must connect to {{fleet-server}} to receive their configurations. You can deploy {{fleet-server}} instances using ECKs Agent CRD with the appropriate configuration, as shown in [Fleet mode and Fleet Server](#k8s-elastic-agent-fleet-configuration-fleet-mode-and-fleet-server).
1212

13-
To know more about {{fleet}} architecture and related components, check the {{fleet}} [documentation](/reference/ingestion-tools/fleet/fleet-server.md).
13+
To know more about {{fleet}} architecture and related components, check the {{fleet}} [documentation](/reference/fleet/fleet-server.md).
1414

1515
## {{fleet}} mode and {{fleet-server}} [k8s-elastic-agent-fleet-configuration-fleet-mode-and-fleet-server]
1616

@@ -241,7 +241,7 @@ spec:
241241
...
242242
```
243243

244-
Please note that the environment variables related to policy selection mentioned in the {{agent}} [docs](/reference/ingestion-tools/fleet/agent-environment-variables.md) like `FLEET_SERVER_POLICY_ID` will be managed by the ECK operator.
244+
Please note that the environment variables related to policy selection mentioned in the {{agent}} [docs](/reference/fleet/agent-environment-variables.md) like `FLEET_SERVER_POLICY_ID` will be managed by the ECK operator.
245245

246246

247247
## Running as a non-root user [k8s-elastic-agent-running-as-a-non-root-user]

deploy-manage/deploy/cloud-on-k8s/configuration-standalone.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ stringData:
108108
period: 10s
109109
```
110110

111-
You can use the Fleet application in Kibana to generate the configuration for Elastic Agent, even when running in standalone mode. Check the [Elastic Agent standalone](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md) documentation. Adding the corresponding integration package to Kibana also adds the related dashboards and visualizations.
111+
You can use the Fleet application in Kibana to generate the configuration for Elastic Agent, even when running in standalone mode. Check the [Elastic Agent standalone](/reference/fleet/install-standalone-elastic-agent.md) documentation. Adding the corresponding integration package to Kibana also adds the related dashboards and visualizations.
112112

113113

114114
## Use multiple Elastic Agent outputs [k8s-elastic-agent-multi-output]

deploy-manage/deploy/cloud-on-k8s/fleet-managed-elastic-agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_pages:
88

99
# Fleet-managed Elastic Agent [k8s-elastic-agent-fleet]
1010

11-
This section describes how to configure and deploy {{agent}} in [{{fleet}}-managed](/reference/ingestion-tools/fleet/install-elastic-agents.md) mode with ECK. Check the [Standalone section](standalone-elastic-agent.md) if you want to run {{agent}} in the [standalone mode](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md).
11+
This section describes how to configure and deploy {{agent}} in [{{fleet}}-managed](/reference/fleet/install-elastic-agents.md) mode with ECK. Check the [Standalone section](standalone-elastic-agent.md) if you want to run {{agent}} in the [standalone mode](/reference/fleet/install-standalone-elastic-agent.md).
1212

1313
* [Quickstart](quickstart-fleet.md)
1414
* [Configuration](configuration-fleet.md)

deploy-manage/deploy/cloud-on-k8s/k8s-openshift-agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_pages:
88

99
# Grant host access permission to Elastic Agent [k8s-openshift-agent]
1010

11-
Deploying Elastic Agent on Openshift may require additional permissions depending on the type of [integration](/reference/ingestion-tools/fleet/index.md) Elastic Agent is supposed to run. In any case, Elastic Agent uses a [hostPath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) volume as its data directory on OpenShift to maintain a stable identity. Therefore, the Service Account used for Elastic Agent needs permissions to use hostPath volumes.
11+
Deploying Elastic Agent on Openshift may require additional permissions depending on the type of [integration](/reference/fleet/index.md) Elastic Agent is supposed to run. In any case, Elastic Agent uses a [hostPath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) volume as its data directory on OpenShift to maintain a stable identity. Therefore, the Service Account used for Elastic Agent needs permissions to use hostPath volumes.
1212

1313
The following example assumes that Elastic Agent is deployed in the Namespace `elastic` with the ServiceAccount `elastic-agent`. You can replace these values according to your environment.
1414

deploy-manage/deploy/cloud-on-k8s/quickstart-fleet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,5 +214,5 @@ ECK automatically configures secure connections between all components. {{fleet}
214214
kubectl logs -f elastic-agent-quickstart-agent-xbcxr
215215
```
216216

217-
4. Configure the policy used by {{agents}}. Check [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md) for more details.
217+
4. Configure the policy used by {{agents}}. Check [{{agent}} policies](/reference/fleet/agent-policy.md) for more details.
218218

deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_pages:
88

99
# Standalone Elastic Agent [k8s-elastic-agent]
1010

11-
This section describes how to configure and deploy Elastic Agent in [standalone mode](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md) with ECK. Check the [Fleet section](fleet-managed-elastic-agent.md) if you want to manage your Elastic Agents with [Fleet](/reference/ingestion-tools/fleet/install-elastic-agents.md).
11+
This section describes how to configure and deploy Elastic Agent in [standalone mode](/reference/fleet/install-standalone-elastic-agent.md) with ECK. Check the [Fleet section](fleet-managed-elastic-agent.md) if you want to manage your Elastic Agents with [Fleet](/reference/fleet/install-elastic-agents.md).
1212

1313
* [Quickstart](quickstart-standalone.md)
1414
* [Configuration](configuration-standalone.md)

deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ $$$azure-integration-vm-extensions$$$How can I monitor my Azure virtual machines
430430

431431
**Managing the Elastic Agent VM extension**
432432

433-
Once installed on the virtual machine, you can manage Elastic Agent either from Fleet or locally on the host where it’s installed. We recommend managing the VM extension through Fleet, because it makes handling and upgrading the agents considerably easier. For more information on the Elastic Agent, check [Manage your Elastic Agents](/reference/ingestion-tools/fleet/install-elastic-agents.md).
433+
Once installed on the virtual machine, you can manage Elastic Agent either from Fleet or locally on the host where it’s installed. We recommend managing the VM extension through Fleet, because it makes handling and upgrading the agents considerably easier. For more information on the Elastic Agent, check [Manage your Elastic Agents](/reference/fleet/install-elastic-agents.md).
434434

435435
**Operating system compatibility matrix**
436436

deploy-manage/deploy/elastic-cloud/heroku-working-with-elasticsearch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,6 @@ In this example, the index `my_index` is created dynamically when the first docu
4343
These examples use the `elastic` user. If you didn’t copy down the password for the `elastic` user, you can [reset the password](/deploy-manage/users-roles/cluster-or-deployment-auth/manage-elastic-user-cloud.md).
4444
:::
4545

46-
For more examples, refer to the [document APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-document). You can also use [clients](/reference/elasticsearch/clients/index.md) to interact with these APIs.
46+
For more examples, refer to the [document APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-document). You can also use [clients](/reference/elasticsearch-clients/index.md) to interact with these APIs.
4747

4848
To learn more about working with data in {{es}}, refer to [](/manage-data/index.md).

deploy-manage/deploy/elastic-cloud/manage-integrations-server.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_pages:
88

99
# Manage your Integrations server [ec-manage-integrations-server]
1010

11-
For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/ingestion-tools/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.
11+
For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.
1212

1313
As part of provisioning, the APM Server and Fleet Server are already configured to work with Elasticsearch and Kibana. At the end of provisioning, you are shown the secret token to configure communication between the APM Server and the backend [APM Agents](https://www.elastic.co/guide/en/apm/agent/index.html). The APM Agents get deployed within your services and applications.
1414

deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ There are situations where you may need or want to move your installed {{agents}
134134

135135
In {{ecloud}}, you can migrate your {{agents}} by taking a snapshot of your source deployment, and restoring it on a target deployment.
136136

137-
To make a seamless migration, after restoring from a snapshot there are some additional steps required, such as updating settings and resetting the agent policy. Check [Migrate Elastic Agents](/reference/ingestion-tools/fleet/migrate-elastic-agent.md) for details.
137+
To make a seamless migration, after restoring from a snapshot there are some additional steps required, such as updating settings and resetting the agent policy. Check [Migrate Elastic Agents](/reference/fleet/migrate-elastic-agent.md) for details.
138138

139139

140140
## Regions and Availability Zones [ec-regions-and-availability-zone]

deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ Beginning with Elastic Stack version 8.0, [Integrations Server](manage-integrati
379379
::::
380380

381381

382-
You have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/ingestion-tools/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.
382+
You have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts.
383383

384384
As part of provisioning, the APM Server and Fleet Server are already configured to work with Elasticsearch and Kibana. At the end of provisioning, you are shown the secret token to configure communication between the APM Server and the backend [APM Agents](https://www.elastic.co/guide/en/apm/agent/index.html). The APM Agents get deployed within your services and applications.
385385

0 commit comments

Comments
 (0)