diff --git a/deploy-manage/cloud-organization/tools-and-apis.md b/deploy-manage/cloud-organization/tools-and-apis.md index f60417d4f6..b39d9839a3 100644 --- a/deploy-manage/cloud-organization/tools-and-apis.md +++ b/deploy-manage/cloud-organization/tools-and-apis.md @@ -37,7 +37,7 @@ Other Products * [APM event intake API Reference](/solutions/observability/apps/elastic-apm-events-intake-api.md) * [App Search API Reference](https://www.elastic.co/guide/en/app-search/current/api-reference.html) * [Elastic Security APIs](https://www.elastic.co/guide/en/security/current/security-apis.html) - * [Fleet APIs](/reference/ingestion-tools/fleet/fleet-api-docs.md) + * [Fleet APIs](/reference/fleet/fleet-api-docs.md) * [Logstash APIs](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html) * [Workplace Search API Reference](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-api-overview.html) diff --git a/deploy-manage/deploy.md b/deploy-manage/deploy.md index 03524a7ad2..dfb46c83f4 100644 --- a/deploy-manage/deploy.md +++ b/deploy-manage/deploy.md @@ -23,7 +23,7 @@ Your choice of deployment type determines how you'll set up and manage these cor 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. To learn how to deploy optional {{stack}} components, refer to the following sections: -* [Fleet and Elastic Agent](/reference/ingestion-tools/fleet/index.md) +* [Fleet and Elastic Agent](/reference/fleet/index.md) * [APM](/solutions/observability/apps/application-performance-monitoring-apm.md) * [Beats](beats://reference/index.md) * [Logstash](logstash://reference/index.md) diff --git a/deploy-manage/deploy/_snippets/installation-order.md b/deploy-manage/deploy/_snippets/installation-order.md index 7af01f006c..e5d0845417 100644 --- a/deploy-manage/deploy/_snippets/installation-order.md +++ b/deploy-manage/deploy/_snippets/installation-order.md @@ -3,7 +3,7 @@ If you're deploying the {{stack}} in a self-managed cluster, then install the {{ * {{es}} * {{kib}} * [Logstash](logstash://reference/index.md) -* [{{agent}}](/reference/ingestion-tools/fleet/index.md) or [Beats](beats://reference/index.md) +* [{{agent}}](/reference/fleet/index.md) or [Beats](beats://reference/index.md) * [APM](/solutions/observability/apps/application-performance-monitoring-apm.md) * [Elasticsearch Hadoop](elasticsearch-hadoop://reference/index.md) diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index b7c33e1f44..884bec3b10 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -19,7 +19,7 @@ Before you start, you must: * Follow the same prerequisites described in [](./install.md#ece-install-prerequisites). This includes [](./identify-deployment-scenario.md) and [](./prepare-environment.md) steps. * [Configure your operating system](./configure-operating-system.md) in all ECE hosts. * Be part of the `docker` group to run the installation script. You should not install Elastic Cloud Enterprise as the `root` user. -* 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. +* 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. When you are ready to install ECE, you can proceed: diff --git a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md index 020ad34113..43f17daf3e 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md @@ -33,7 +33,7 @@ Users running {{stack}} versions 7.16 or 7.17 need to manually configure TLS. Th Pick one of the following options: -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. +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. 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`. diff --git a/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md b/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md index f4c9973410..8ddf737e60 100644 --- a/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md +++ b/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md @@ -8,7 +8,7 @@ mapped_urls: # Manage your Integrations Server [ece-manage-integrations-server] -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. +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. 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. diff --git a/deploy-manage/deploy/cloud-on-k8s/configuration-examples-standalone.md b/deploy-manage/deploy/cloud-on-k8s/configuration-examples-standalone.md index 342cc86bd8..89f2a372b1 100644 --- a/deploy-manage/deploy/cloud-on-k8s/configuration-examples-standalone.md +++ b/deploy-manage/deploy/cloud-on-k8s/configuration-examples-standalone.md @@ -8,7 +8,7 @@ mapped_pages: # Configuration examples [k8s-elastic-agent-configuration-examples] -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). +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). ::::{warning} 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). diff --git a/deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md b/deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md index 05dd88bd1e..a30c5d11dd 100644 --- a/deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md +++ b/deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md @@ -10,7 +10,7 @@ mapped_pages: {{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). -To know more about {{fleet}} architecture and related components, check the {{fleet}} [documentation](/reference/ingestion-tools/fleet/fleet-server.md). +To know more about {{fleet}} architecture and related components, check the {{fleet}} [documentation](/reference/fleet/fleet-server.md). ## {{fleet}} mode and {{fleet-server}} [k8s-elastic-agent-fleet-configuration-fleet-mode-and-fleet-server] @@ -241,7 +241,7 @@ spec: ... ``` -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. +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. ## Running as a non-root user [k8s-elastic-agent-running-as-a-non-root-user] diff --git a/deploy-manage/deploy/cloud-on-k8s/configuration-standalone.md b/deploy-manage/deploy/cloud-on-k8s/configuration-standalone.md index 645e90b236..9376978361 100644 --- a/deploy-manage/deploy/cloud-on-k8s/configuration-standalone.md +++ b/deploy-manage/deploy/cloud-on-k8s/configuration-standalone.md @@ -108,7 +108,7 @@ stringData: period: 10s ``` -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. +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. ## Use multiple Elastic Agent outputs [k8s-elastic-agent-multi-output] diff --git a/deploy-manage/deploy/cloud-on-k8s/fleet-managed-elastic-agent.md b/deploy-manage/deploy/cloud-on-k8s/fleet-managed-elastic-agent.md index 2f018e7938..445bbe1afa 100644 --- a/deploy-manage/deploy/cloud-on-k8s/fleet-managed-elastic-agent.md +++ b/deploy-manage/deploy/cloud-on-k8s/fleet-managed-elastic-agent.md @@ -8,7 +8,7 @@ mapped_pages: # Fleet-managed Elastic Agent [k8s-elastic-agent-fleet] -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). +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). * [Quickstart](quickstart-fleet.md) * [Configuration](configuration-fleet.md) diff --git a/deploy-manage/deploy/cloud-on-k8s/k8s-openshift-agent.md b/deploy-manage/deploy/cloud-on-k8s/k8s-openshift-agent.md index 055bbe4279..8f09e96c9d 100644 --- a/deploy-manage/deploy/cloud-on-k8s/k8s-openshift-agent.md +++ b/deploy-manage/deploy/cloud-on-k8s/k8s-openshift-agent.md @@ -8,7 +8,7 @@ mapped_pages: # Grant host access permission to Elastic Agent [k8s-openshift-agent] -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. +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. 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. diff --git a/deploy-manage/deploy/cloud-on-k8s/quickstart-fleet.md b/deploy-manage/deploy/cloud-on-k8s/quickstart-fleet.md index c9bd8b6145..da13892510 100644 --- a/deploy-manage/deploy/cloud-on-k8s/quickstart-fleet.md +++ b/deploy-manage/deploy/cloud-on-k8s/quickstart-fleet.md @@ -214,5 +214,5 @@ ECK automatically configures secure connections between all components. {{fleet} kubectl logs -f elastic-agent-quickstart-agent-xbcxr ``` -4. Configure the policy used by {{agents}}. Check [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md) for more details. +4. Configure the policy used by {{agents}}. Check [{{agent}} policies](/reference/fleet/agent-policy.md) for more details. diff --git a/deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md b/deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md index 7b1bc3251b..35d9ae3751 100644 --- a/deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md +++ b/deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md @@ -8,7 +8,7 @@ mapped_pages: # Standalone Elastic Agent [k8s-elastic-agent] -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). +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). * [Quickstart](quickstart-standalone.md) * [Configuration](configuration-standalone.md) diff --git a/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md b/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md index 9265b0cf2c..c5a8e9dae1 100644 --- a/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md +++ b/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md @@ -430,7 +430,7 @@ $$$azure-integration-vm-extensions$$$How can I monitor my Azure virtual machines **Managing the Elastic Agent VM extension** - 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). + 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). **Operating system compatibility matrix** diff --git a/deploy-manage/deploy/elastic-cloud/heroku-working-with-elasticsearch.md b/deploy-manage/deploy/elastic-cloud/heroku-working-with-elasticsearch.md index 8605e0ade2..f33b945c08 100644 --- a/deploy-manage/deploy/elastic-cloud/heroku-working-with-elasticsearch.md +++ b/deploy-manage/deploy/elastic-cloud/heroku-working-with-elasticsearch.md @@ -43,6 +43,6 @@ In this example, the index `my_index` is created dynamically when the first docu 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). ::: -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. +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. To learn more about working with data in {{es}}, refer to [](/manage-data/index.md). \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md b/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md index 45289da533..f739ef60b2 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md +++ b/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md @@ -8,7 +8,7 @@ mapped_pages: # Manage your Integrations server [ec-manage-integrations-server] -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. +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. 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. diff --git a/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md b/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md index 61bb7c45b5..d224c4b883 100644 --- a/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md +++ b/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md @@ -134,7 +134,7 @@ There are situations where you may need or want to move your installed {{agents} In {{ecloud}}, you can migrate your {{agents}} by taking a snapshot of your source deployment, and restoring it on a target deployment. -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. +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. ## Regions and Availability Zones [ec-regions-and-availability-zone] diff --git a/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md b/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md index ff58f95d24..7d8ceb694d 100644 --- a/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md +++ b/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md @@ -379,7 +379,7 @@ Beginning with Elastic Stack version 8.0, [Integrations Server](manage-integrati :::: -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. +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. 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. diff --git a/deploy-manage/deploy/self-managed/air-gapped-install.md b/deploy-manage/deploy/self-managed/air-gapped-install.md index 14c25878db..ac497f9000 100644 --- a/deploy-manage/deploy/self-managed/air-gapped-install.md +++ b/deploy-manage/deploy/self-managed/air-gapped-install.md @@ -52,14 +52,14 @@ Air-gapped install of {{agent}} depends on the [{{package-registry}}](/deploy-ma Additionally, if the {{agent}} {{elastic-defend}} integration is used, then access to the [Elastic Endpoint Artifact Repository](/deploy-manage/deploy/self-managed/air-gapped-install.md#air-gapped-elastic-endpoint-artifact-repository) is necessary in order to deploy updates for some of the detection and prevention capabilities. -To learn more about install and configuration, refer to the [{{agent}} install documentation](/reference/ingestion-tools/fleet/install-elastic-agents.md). Make sure to check the requirements specific to running {{agents}} in an [air-gapped environment](/reference/ingestion-tools/fleet/air-gapped.md). +To learn more about install and configuration, refer to the [{{agent}} install documentation](/reference/fleet/install-elastic-agents.md). Make sure to check the requirements specific to running {{agents}} in an [air-gapped environment](/reference/fleet/air-gapped.md). ## {{fleet-server}} [air-gapped-fleet] {{fleet-server}} is a required middleware component for any scalable deployment of the {{agent}}. The air-gapped dependencies of {{fleet-server}} are the same as those of the [{{agent}}](/deploy-manage/deploy/self-managed/air-gapped-install.md#air-gapped-elastic-agent). -To learn more about installing {{fleet-server}}, refer to the [{{fleet-server}} set up documentation](/reference/ingestion-tools/fleet/fleet-server.md). +To learn more about installing {{fleet-server}}, refer to the [{{fleet-server}} set up documentation](/reference/fleet/fleet-server.md). ## Elastic APM [air-gapped-elastic-apm] @@ -77,7 +77,7 @@ Refer to [Connect to {{ems}}](../../../explore-analyze/visualize/maps/maps-conne ## {{package-registry}} [air-gapped-elastic-package-registry] -Air-gapped install of the EPR is possible using any OCI-compatible runtime like Podman (a typical choice for RHEL-like Linux systems) or Docker. Links to the official container image and usage guide is available on the [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md) page in the {{fleet}} and {{agent}} Guide. +Air-gapped install of the EPR is possible using any OCI-compatible runtime like Podman (a typical choice for RHEL-like Linux systems) or Docker. Links to the official container image and usage guide is available on the [Air-gapped environments](/reference/fleet/air-gapped.md) page in the {{fleet}} and {{agent}} Guide. ::::{note} Besides setting up the EPR service, you also need to [configure {{kib}}](/deploy-manage/deploy/self-managed/air-gapped-install.md#air-gapped-kibana) to use this service. If using TLS with the EPR service, it is also necessary to set up {{kib}} to trust the certificate presented by the EPR. @@ -160,7 +160,7 @@ WantedBy=default.target ## {{artifact-registry}} [air-gapped-elastic-artifact-registry] -Air-gapped install of the {{artifact-registry}} is necessary in order to enable {{agent}} deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn more, refer to [Host your own artifact registry for binary downloads](/reference/ingestion-tools/fleet/air-gapped.md#host-artifact-registry) in the {{fleet}} and {{elastic-agent}} Guide. +Air-gapped install of the {{artifact-registry}} is necessary in order to enable {{agent}} deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn more, refer to [Host your own artifact registry for binary downloads](/reference/fleet/air-gapped.md#host-artifact-registry) in the {{fleet}} and {{elastic-agent}} Guide. ::::{note} When setting up own web server, such as NGINX, to function as the {{artifact-registry}}, it is recommended not to use TLS as there are, currently, no direct ways to establish certificate trust between {{agents}} and this service. diff --git a/deploy-manage/deploy/self-managed/tools-apis.md b/deploy-manage/deploy/self-managed/tools-apis.md index 08c13abeed..98b4472670 100644 --- a/deploy-manage/deploy/self-managed/tools-apis.md +++ b/deploy-manage/deploy/self-managed/tools-apis.md @@ -11,7 +11,7 @@ Review key resources that can be used to interact with and manage self-managed c ## APIs * [{{es}} API](https://www.elastic.co/docs/api/doc/elasticsearch/): The core API for interacting with a self-managed {{es}} cluster, or any cluster running {{stack}}. Configure {{es}} functionality and settings, query your data, and more. - + Refer to [REST APIs](elasticsearch://reference/elasticsearch/rest-apis/index.md) to learn about API conventions and view API usage examples. * [{{kib}} API](https://www.elastic.co/docs/api/doc/kibana/): manage {{kib}} resources such as connectors, data views, and saved objects. @@ -21,7 +21,7 @@ Learn how to [generate API keys for your self-managed cluster](/deploy-manage/ap ## Clients -* [{{es}} clients](/reference/elasticsearch/clients/index.md): Interact with {{es}} programmatically to integrate {{es}} into your app or website. +* [{{es}} clients](/reference/elasticsearch-clients/index.md): Interact with {{es}} programmatically to integrate {{es}} into your app or website. ## Other diff --git a/deploy-manage/monitor/logging-configuration.md b/deploy-manage/monitor/logging-configuration.md index 5ce3b1cfa0..d0c2a4660f 100644 --- a/deploy-manage/monitor/logging-configuration.md +++ b/deploy-manage/monitor/logging-configuration.md @@ -10,12 +10,12 @@ applies_to: You can configure several types of logs in {{stack}} that can help you to gain insight into {{stack}} operations, diagnose issues, and track certain types of events. -The following logging features are available: +The following logging features are available: ## For {{es}} [extra-logging-features-elasticsearch] -* **Application and component logging**: Logs messages related to running {{es}}. - +* **Application and component logging**: Logs messages related to running {{es}}. + You can [configure the log level for {{es}}](/deploy-manage/monitor/logging-configuration/update-elasticsearch-logging-levels.md), and, in self-managed clusters, [configure underlying Log4j settings](/deploy-manage/monitor/logging-configuration/elasticsearch-log4j-configuration-self-managed.md) to customize logging behavior. * [Deprecation logging](/deploy-manage/monitor/logging-configuration/elasticsearch-deprecation-logs.md): Deprecation logs record a message to the {{es}} log directory when you use deprecated {{es}} functionality. You can use the deprecation logs to update your application before upgrading {{es}} to a new major version. * [Audit logging](/deploy-manage/security/logging-configuration/enabling-audit-logs.md): Logs security-related events on your deployment. @@ -23,8 +23,8 @@ The following logging features are available: ## For {{kib}} [extra-logging-features-kibana] -* **Application and component logging**: Logs messages related to running {{kib}}. - +* **Application and component logging**: Logs messages related to running {{kib}}. + You can [configure the log level for {{kib}}](/deploy-manage/monitor/logging-configuration/kibana-log-levels.md), and, in self-managed, ECE, or ECK deployments, [configure advanced settings](/deploy-manage/monitor/logging-configuration/kib-advanced-logging.md) to customize logging behavior. * [Audit logging](/deploy-manage/security/logging-configuration/enabling-audit-logs.md): Logs security-related events on your deployment. @@ -35,7 +35,7 @@ The way that you access your logs differs depending on your deployment method. ### Orchestrated deployments -Access your logs using one of the following options: +Access your logs using one of the following options: * All orchestrated deployments: [](/deploy-manage/monitor/stack-monitoring.md) * {{ech}}: [Preconfigured logs and metrics](/deploy-manage/monitor/cloud-health-perf.md#ec-es-health-preconfigured) @@ -115,7 +115,7 @@ You can also collect and index the following types of logs from other components * `apm*.log*` -[**Fleet and Elastic Agent**](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) +[**Fleet and Elastic Agent**](/reference/fleet/monitor-elastic-agent.md) * `fleet-server-json.log-*` * `elastic-agent-json.log-*` diff --git a/deploy-manage/monitor/stack-monitoring.md b/deploy-manage/monitor/stack-monitoring.md index 1364b8399e..f25c4c01e5 100644 --- a/deploy-manage/monitor/stack-monitoring.md +++ b/deploy-manage/monitor/stack-monitoring.md @@ -26,7 +26,7 @@ Each monitored {{stack}} component is considered unique in the cluster based on Monitoring documents are just ordinary JSON documents built by monitoring each {{stack}} component at a specified collection interval. If you want to alter how these documents are structured or stored, refer to [Configuring data streams/indices for monitoring](/deploy-manage/monitor/monitoring-data/configuring-data-streamsindices-for-monitoring.md). -You can use {{agent}} or {{metricbeat}} to collect monitoring data and to ship it directly to the monitoring cluster. +You can use {{agent}} or {{metricbeat}} to collect monitoring data and to ship it directly to the monitoring cluster. In {{ech}}, {{ece}}, and {{eck}}, Elastic manages the installation and configuration of the monitoring agent for you. @@ -48,7 +48,7 @@ In general, the monitoring cluster and the clusters being monitored should be ru ## Configure and use stack monitoring -Refer to the following topics to learn how to configure stack monitoring: +Refer to the following topics to learn how to configure stack monitoring: ### Configure for ECH, ECE, and ECK deployments @@ -61,7 +61,7 @@ Refer to the following topics to learn how to configure stack monitoring: * **{{es}}**: * [](/deploy-manage/monitor/stack-monitoring/collecting-monitoring-data-with-elastic-agent.md) (recommended): Uses a single agent to gather logs and metrics. Can be managed from a central location in {{fleet}}. * [](/deploy-manage/monitor/stack-monitoring/collecting-monitoring-data-with-metricbeat.md): Uses a lightweight {{beats}} shipper to gather metrics. May be preferred if you have an existing investment in {{beats}} or are not yet ready to use {{agent}}. - * [](/deploy-manage/monitor/stack-monitoring/collecting-log-data-with-filebeat.md): Uses a lightweight {{beats}} shipper to gather logs. + * [](/deploy-manage/monitor/stack-monitoring/collecting-log-data-with-filebeat.md): Uses a lightweight {{beats}} shipper to gather logs. * [](/deploy-manage/monitor/stack-monitoring/es-legacy-collection-methods.md): Uses internal exporters to gather metrics. Not recommended. If you have previously configured legacy collection methods, you should migrate to using {{agent}} or {{metricbeat}}. * **{{kib}}**: * [](/deploy-manage/monitor/stack-monitoring/kibana-monitoring-elastic-agent.md) (recommended): Uses a single agent to gather logs and metrics. Can be managed from a central location in {{fleet}}. @@ -89,13 +89,13 @@ Most of these methods require that you configure monitoring of {{es}} before mon * [**APM Server**](/solutions/observability/apps/monitor-apm-server.md) -* **{{agent}}s**: - * [{{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) - * [Standalone {{agent}}s](/reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md) +* **{{agent}}s**: + * [{{fleet}}-managed {{agent}}s](/reference/fleet/monitor-elastic-agent.md) + * [Standalone {{agent}}s](/reference/fleet/elastic-agent-monitoring-configuration.md) ### Access, view, and use monitoring data * [](/deploy-manage/monitor/stack-monitoring/kibana-monitoring-data.md): After you collect monitoring data for one or more products in the {{stack}}, configure {{kib}} to retrieve that information and display it in on the **Stack Monitoring** page. * [](/deploy-manage/monitor/monitoring-data/visualizing-monitoring-data.md): View health and performance data for {{stack}} components in real time, as well as analyze past performance. * [](/deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts.md): Configure alerts that trigger based on stack monitoring metrics. -* [](/deploy-manage/monitor/monitoring-data/configuring-data-streamsindices-for-monitoring.md): Adjust the data streams and indices used by stack monitoring. +* [](/deploy-manage/monitor/monitoring-data/configuring-data-streamsindices-for-monitoring.md): Adjust the data streams and indices used by stack monitoring. diff --git a/deploy-manage/monitor/stack-monitoring/es-self-monitoring-prod.md b/deploy-manage/monitor/stack-monitoring/es-self-monitoring-prod.md index 657de84557..8a6f461398 100644 --- a/deploy-manage/monitor/stack-monitoring/es-self-monitoring-prod.md +++ b/deploy-manage/monitor/stack-monitoring/es-self-monitoring-prod.md @@ -47,7 +47,7 @@ To store monitoring data in a separate cluster: :::: - * If you plan to use {{agent}}, create a user that has the `remote_monitoring_collector` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md#built-in-roles-remote-monitoring-agent) and that the monitoring related [integration assets have been installed](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md#install-integration-assets) on the remote monitoring cluster. + * If you plan to use {{agent}}, create a user that has the `remote_monitoring_collector` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md#built-in-roles-remote-monitoring-agent) and that the monitoring related [integration assets have been installed](/reference/fleet/install-uninstall-integration-assets.md#install-integration-assets) on the remote monitoring cluster. * If you plan to use {{metricbeat}}, create a user that has the `remote_monitoring_collector` built-in role and a user that has the `remote_monitoring_agent` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md#built-in-roles-remote-monitoring-agent). Alternatively, use the `remote_monitoring_user` [built-in user](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md). * If you plan to use HTTP exporters to route data through your production cluster, create a user that has the `remote_monitoring_agent` [built-in role](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md#built-in-roles-remote-monitoring-agent). diff --git a/deploy-manage/security/install-stack-demo-secure.md b/deploy-manage/security/install-stack-demo-secure.md index cfa523849f..c486865bb4 100644 --- a/deploy-manage/security/install-stack-demo-secure.md +++ b/deploy-manage/security/install-stack-demo-secure.md @@ -636,7 +636,7 @@ Congratulations! You’ve successfully updated the SSL certificates between {{es Now that {{kib}} is up and running, you can proceed to install {{fleet-server}}, which will manage the {{agent}} that we’ll set up in a later step. -If you’d like to learn more about these steps, refer to [Deploy on-premises and self-managed](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md) in the {{fleet}} and {{agent}} Guide. You can find detailed steps to generate and configure certificates in [Configure SSL/TLS for self-managed Fleet Servers](/reference/ingestion-tools/fleet/secure-connections.md). +If you’d like to learn more about these steps, refer to [Deploy on-premises and self-managed](/reference/fleet/add-fleet-server-on-prem.md) in the {{fleet}} and {{agent}} Guide. You can find detailed steps to generate and configure certificates in [Configure SSL/TLS for self-managed Fleet Servers](/reference/fleet/secure-connections.md). 1. Log in to the first {{es}} node and use the certificate utility to generate a certificate bundle for {{fleet-server}}. In the command, replace `` and `IP address` with the name and IP address of your {{fleet-server}} host: @@ -696,7 +696,7 @@ If you’d like to learn more about these steps, refer to [Deploy on-premises an The URL is the inet value that you copied from the `ifconfig` output. - For details about default port assignments, refer to [Default port assignments](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md#default-port-assignments-on-prem) in the on-premises {{fleet-server}} install documentation. + For details about default port assignments, refer to [Default port assignments](/reference/fleet/add-fleet-server-on-prem.md#default-port-assignments-on-prem) in the on-premises {{fleet-server}} install documentation. 3. Click **Add host**. @@ -743,7 +743,7 @@ If you’d like to learn more about these steps, refer to [Deploy on-premises an --fleet-server-port=8220 ``` - For details about all of the install command options, refer to [`elastic-agent install`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) in the {{agent}} command reference. + For details about all of the install command options, refer to [`elastic-agent install`](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) in the {{agent}} command reference. 19. After you’ve made the required updates, run the `elastic-agent install` command to install {{fleet-server}}. @@ -754,7 +754,7 @@ If you’d like to learn more about these steps, refer to [Deploy on-premises an ``` ::::{tip} - Wondering why the command refers to {{agent}} rather than {{fleet-server}}? {{fleet-server}} is actually a subprocess that runs inside {{agent}} with a special {{fleet-server}} policy. Refer to [What is {{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) to learn more. + Wondering why the command refers to {{agent}} rather than {{fleet-server}}? {{fleet-server}} is actually a subprocess that runs inside {{agent}} with a special {{fleet-server}} policy. Refer to [What is {{fleet-server}}](/reference/fleet/fleet-server.md) to learn more. :::: 20. Return to the {{kib}} **Add a Fleet Server** flyout and wait for confirmation that {{fleet-server}} has connected. @@ -793,7 +793,7 @@ Before proceeding to install {{agent}}, there are a few steps needed to update t ## Step 7: Install {{agent}} [install-stack-demo-secure-agent] -Next, we’ll install {{agent}} on another host and use the System integration to monitor system logs and metrics. You can find additional details about these steps in [Configure SSL/TLS for self-managed Fleet Servers](/reference/ingestion-tools/fleet/secure-connections.md). +Next, we’ll install {{agent}} on another host and use the System integration to monitor system logs and metrics. You can find additional details about these steps in [Configure SSL/TLS for self-managed Fleet Servers](/reference/fleet/secure-connections.md). 1. Log in to the host where you’d like to set up {{agent}}. 2. Create a directory for the {{es}} certificate file: diff --git a/deploy-manage/security/secure-clients-integrations.md b/deploy-manage/security/secure-clients-integrations.md index 475e691218..6b6ed82527 100644 --- a/deploy-manage/security/secure-clients-integrations.md +++ b/deploy-manage/security/secure-clients-integrations.md @@ -6,7 +6,7 @@ mapped_pages: # Secure clients and integrations [security-clients-integrations] :::{warning} -**This page is a work in progress.** +**This page is a work in progress.** ::: @@ -17,7 +17,7 @@ The {{es}} {{security-features}} enable you to secure your {{es}} cluster. But { * [Apache Hadoop](elasticsearch-hadoop://reference/security.md) * [Auditbeat](beats://reference/auditbeat/securing-auditbeat.md) * [Filebeat](beats://reference/filebeat/securing-filebeat.md) -* [{{fleet}} & {{agent}}](/reference/ingestion-tools/fleet/secure.md) +* [{{fleet}} & {{agent}}](/reference/fleet/secure.md) * [Heartbeat](beats://reference/heartbeat/securing-heartbeat.md) * [{{kib}}](../security.md) * [Logstash](logstash://reference/secure-connection.md) diff --git a/docset.yml b/docset.yml index 568d15bd57..e171c85d27 100644 --- a/docset.yml +++ b/docset.yml @@ -69,7 +69,25 @@ toc: in_nav: true - toc: troubleshoot - toc: release-notes - - toc: reference + - file: reference/index.md + in_nav: true + children: + - toc: reference/security + - toc: reference/observability + - toc: reference/search + - toc: reference/elasticsearch + # The next one should be child of ☝️ + - toc: reference/elasticsearch-clients + - toc: reference/ingestion-tools + # The next two should be children of ☝️ + - toc: reference/fleet + - toc: reference/apm + # The next one should be child of ☝️ + - toc: reference/apm-agents + - toc: reference/ecs + - toc: reference/data-analysis + - toc: reference/cloud + - toc: reference/glossary - toc: extend - toc: raw-migrated-files - hidden: 404.md diff --git a/explore-analyze/visualize/maps/asset-tracking-tutorial.md b/explore-analyze/visualize/maps/asset-tracking-tutorial.md index aa9100579c..394f717a80 100644 --- a/explore-analyze/visualize/maps/asset-tracking-tutorial.md +++ b/explore-analyze/visualize/maps/asset-tracking-tutorial.md @@ -32,7 +32,7 @@ When you complete this tutorial, you’ll have a map that looks like this: * If you don’t already have {{kib}}, sign up for [a free Elastic Cloud trial](https://www.elastic.co/cloud/elasticsearch-service/signup?baymax=docs-body&elektra=docs) and create a hosted deployment. When creating it, download the deployment credentials. * Obtain an API key for [TriMet web services](https://developer.trimet.org/) at [https://developer.trimet.org/appid/registration/](https://developer.trimet.org/appid/registration/). -* [Fleet](/reference/ingestion-tools/fleet/index.md) is enabled on your cluster, and one or more [{{agent}}s](/reference/ingestion-tools/fleet/install-elastic-agents.md) is enrolled. +* [Fleet](/reference/fleet/index.md) is enabled on your cluster, and one or more [{{agent}}s](/reference/fleet/install-elastic-agents.md) is enrolled. ## Part 1: Ingest the Portland public transport data [_part_1_ingest_the_portland_public_transport_data] diff --git a/get-started/the-stack.md b/get-started/the-stack.md index d6d3bfe158..4aded15071 100644 --- a/get-started/the-stack.md +++ b/get-started/the-stack.md @@ -42,7 +42,7 @@ $$$stack-components-agent$$$ {{fleet}} enables you to centrally manage {{agents}} and their policies. Use {{fleet}} to monitor the state of all your {{agents}}, manage agent policies, and upgrade {{agent}} binaries or integrations. - [Learn more about {{fleet}} and {{agent}}](/reference/ingestion-tools/fleet/index.md). + [Learn more about {{fleet}} and {{agent}}](/reference/fleet/index.md). $$$stack-components-apm$$$ diff --git a/manage-data/data-store/data-streams/set-up-data-stream.md b/manage-data/data-store/data-streams/set-up-data-stream.md index dc1c0be0ae..4fbd22defe 100644 --- a/manage-data/data-store/data-streams/set-up-data-stream.md +++ b/manage-data/data-store/data-streams/set-up-data-stream.md @@ -21,7 +21,7 @@ You can also [convert an index alias to a data stream](#convert-index-alias-to-d ::::{important} If you use {{fleet}}, {{agent}}, or {{ls}}, skip this tutorial. They all set up data streams for you. -For {{fleet}} and {{agent}}, check out this [data streams documentation](/reference/ingestion-tools/fleet/data-streams.md). For {{ls}}, check out the [data streams settings](logstash://reference/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-data_stream) for the `elasticsearch output` plugin. +For {{fleet}} and {{agent}}, check out this [data streams documentation](/reference/fleet/data-streams.md). For {{ls}}, check out the [data streams settings](logstash://reference/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-data_stream) for the `elasticsearch output` plugin. :::: @@ -150,7 +150,7 @@ PUT _component_template/my-settings Use your component templates to create an index template. Specify: -* One or more index patterns that match the data stream’s name. We recommend using our [data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). +* One or more index patterns that match the data stream’s name. We recommend using our [data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). * That the template is data stream enabled. * Any component templates that contain your mappings and index settings. * A priority higher than `200` to avoid collisions with built-in templates. See [Avoid index pattern collisions](../templates.md#avoid-index-pattern-collisions). diff --git a/manage-data/data-store/data-streams/set-up-tsds.md b/manage-data/data-store/data-streams/set-up-tsds.md index 6035713f63..3f132801b6 100644 --- a/manage-data/data-store/data-streams/set-up-tsds.md +++ b/manage-data/data-store/data-streams/set-up-tsds.md @@ -93,7 +93,7 @@ PUT _ilm/policy/my-weather-sensor-lifecycle-policy To setup a TSDS create an index template with the following details: -* One or more index patterns that match the TSDS’s name. We recommend using our [data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). +* One or more index patterns that match the TSDS’s name. We recommend using our [data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). * Enable data streams. * Specify a mapping that defines your dimensions and metrics: diff --git a/manage-data/data-store/templates.md b/manage-data/data-store/templates.md index d06b40eb33..5e45117adb 100644 --- a/manage-data/data-store/templates.md +++ b/manage-data/data-store/templates.md @@ -37,7 +37,7 @@ The following conditions apply to index templates: * `profiling-*` * `security_solution-*-*` -[{{agent}}](/reference/ingestion-tools/fleet/index.md) uses these templates to create data streams. Index templates created by {{fleet}} integrations use similar overlapping index patterns and have a priority up to `200`. +[{{agent}}](/reference/fleet/index.md) uses these templates to create data streams. Index templates created by {{fleet}} integrations use similar overlapping index patterns and have a priority up to `200`. If you use {{fleet}} or {{agent}}, assign your index templates a priority lower than `100` to avoid overriding these templates. Otherwise, to avoid accidentally applying the templates, do one or more of the following: diff --git a/manage-data/ingest/ingest-reference-architectures/agent-es-airgapped.md b/manage-data/ingest/ingest-reference-architectures/agent-es-airgapped.md index 8a0291684d..3ad049d674 100644 --- a/manage-data/ingest/ingest-reference-architectures/agent-es-airgapped.md +++ b/manage-data/ingest/ingest-reference-architectures/agent-es-airgapped.md @@ -25,5 +25,5 @@ Use when Info for air-gapped environments: * [Installing the {{stack}} in an air-gapped environment](../../../deploy-manage/deploy/cloud-enterprise/air-gapped-install.md) -* [Using a proxy server with Elastic Agent and Fleet](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md) +* [Using a proxy server with Elastic Agent and Fleet](/reference/fleet/fleet-agent-proxy-support.md) diff --git a/manage-data/ingest/ingest-reference-architectures/agent-ls-airgapped.md b/manage-data/ingest/ingest-reference-architectures/agent-ls-airgapped.md index d64df0bd4a..3ffb00369b 100644 --- a/manage-data/ingest/ingest-reference-architectures/agent-ls-airgapped.md +++ b/manage-data/ingest/ingest-reference-architectures/agent-ls-airgapped.md @@ -25,7 +25,7 @@ Use when Info for air-gapped environments: * [Installing the {{stack}} in an air-gapped environment](../../../deploy-manage/deploy/cloud-enterprise/air-gapped-install.md) -* [Using a proxy server with Elastic Agent and Fleet](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md) +* [Using a proxy server with Elastic Agent and Fleet](/reference/fleet/fleet-agent-proxy-support.md) ## Geoip database management in air-gapped environments [ls-geoip] diff --git a/manage-data/ingest/ingest-reference-architectures/agent-proxy.md b/manage-data/ingest/ingest-reference-architectures/agent-proxy.md index 0a7cb57491..00e9ae8d1f 100644 --- a/manage-data/ingest/ingest-reference-architectures/agent-proxy.md +++ b/manage-data/ingest/ingest-reference-architectures/agent-proxy.md @@ -39,7 +39,7 @@ Info on {{agent}} and agent integrations: Info on using a proxy server: -* [Using a proxy server with {{agent}} and {{fleet}}](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md) +* [Using a proxy server with {{agent}} and {{fleet}}](/reference/fleet/fleet-agent-proxy-support.md) Info on {{es}}: diff --git a/manage-data/ingest/ingest-reference-architectures/ls-enrich.md b/manage-data/ingest/ingest-reference-architectures/ls-enrich.md index d5548641a3..a475c79f90 100644 --- a/manage-data/ingest/ingest-reference-architectures/ls-enrich.md +++ b/manage-data/ingest/ingest-reference-architectures/ls-enrich.md @@ -31,7 +31,7 @@ Examples Info on configuring {{agent}}: * [Fleet and Elastic Agent Guide](https://www.elastic.co/guide/en/fleet/current) -* [Configuring outputs for {{agent}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md) +* [Configuring outputs for {{agent}}](/reference/fleet/elastic-agent-output-configuration.md) For info on {{ls}} for enriching data, check out these sections in the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current): diff --git a/manage-data/ingest/ingest-reference-architectures/ls-multi.md b/manage-data/ingest/ingest-reference-architectures/ls-multi.md index 3052d541b3..0753b7e46f 100644 --- a/manage-data/ingest/ingest-reference-architectures/ls-multi.md +++ b/manage-data/ingest/ingest-reference-architectures/ls-multi.md @@ -57,7 +57,7 @@ output { Info on configuring {{agent}}: * [Fleet and Elastic Agent Guide](https://www.elastic.co/guide/en/fleet/current) -* [Configuring outputs for {{agent}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md) +* [Configuring outputs for {{agent}}](/reference/fleet/elastic-agent-output-configuration.md) Info on {{ls}} and {{ls}} outputs: diff --git a/manage-data/ingest/ingest-reference-architectures/ls-networkbridge.md b/manage-data/ingest/ingest-reference-architectures/ls-networkbridge.md index 1f20ef243b..63587b3153 100644 --- a/manage-data/ingest/ingest-reference-architectures/ls-networkbridge.md +++ b/manage-data/ingest/ingest-reference-architectures/ls-networkbridge.md @@ -24,7 +24,7 @@ Example Info on configuring {{agent}}: * [Fleet and Elastic Agent Guide](https://www.elastic.co/guide/en/fleet/current) -* [Configuring outputs for {{agent}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md) +* [Configuring outputs for {{agent}}](/reference/fleet/elastic-agent-output-configuration.md) Info on {{ls}} and {{ls}} plugins: diff --git a/manage-data/ingest/ingest-reference-architectures/lspq.md b/manage-data/ingest/ingest-reference-architectures/lspq.md index 0c4a8dc624..39906ebf61 100644 --- a/manage-data/ingest/ingest-reference-architectures/lspq.md +++ b/manage-data/ingest/ingest-reference-architectures/lspq.md @@ -21,7 +21,7 @@ Use when Info on configuring {{agent}}: * [Fleet and Elastic Agent Guide](https://www.elastic.co/guide/en/fleet/current) -* [Configuring outputs for {{agent}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md) +* [Configuring outputs for {{agent}}](/reference/fleet/elastic-agent-output-configuration.md) For info on {{ls}} plugins: diff --git a/manage-data/ingest/ingesting-data-for-elastic-solutions.md b/manage-data/ingest/ingesting-data-for-elastic-solutions.md index 96a77720ce..9db4b3fa07 100644 --- a/manage-data/ingest/ingesting-data-for-elastic-solutions.md +++ b/manage-data/ingest/ingesting-data-for-elastic-solutions.md @@ -17,7 +17,7 @@ To use [Elastic Agent](https://www.elastic.co/guide/en/fleet/current) and [Elast 1. Create an [{{ecloud}}](https://www.elastic.co/cloud) deployment for your solution. If you don’t have an {{ecloud}} account, you can sign up for a [free trial](https://cloud.elastic.co/registration) to get started. 2. Add the [Elastic integration](https://docs.elastic.co/en/integrations) for your data source to the deployment. -3. [Install {{agent}}](/reference/ingestion-tools/fleet/install-elastic-agents.md) on the systems whose data you want to collect. +3. [Install {{agent}}](/reference/fleet/install-elastic-agents.md) on the systems whose data you want to collect. :::: @@ -34,7 +34,7 @@ To use [Elastic Agent](https://www.elastic.co/guide/en/fleet/current) and [Elast **Resources** -* [Install {{agent}}](/reference/ingestion-tools/fleet/install-elastic-agents.md) +* [Install {{agent}}](/reference/fleet/install-elastic-agents.md) * [Elastic Search for integrations](https://www.elastic.co/integrations/data-integrations?solution=search) * [{{es}} Guide](https://www.elastic.co/guide/en/elasticsearch/reference/current) @@ -67,7 +67,7 @@ With [Elastic Observability](https://www.elastic.co/observability), you can moni **Resources** -* [Install {{agent}}](/reference/ingestion-tools/fleet/install-elastic-agents.md) +* [Install {{agent}}](/reference/fleet/install-elastic-agents.md) * [Elastic Observability integrations](https://www.elastic.co/integrations/data-integrations?solution=observability) @@ -82,7 +82,7 @@ You can detect and respond to threats when you use [Elastic Security](https://ww **Resources** -* [Install {{agent}}](/reference/ingestion-tools/fleet/install-elastic-agents.md) +* [Install {{agent}}](/reference/fleet/install-elastic-agents.md) * [Elastic Security integrations](https://www.elastic.co/integrations/data-integrations?solution=search) * [Elastic Security documentation](/solutions/security.md) @@ -95,7 +95,7 @@ Bring your ideas and use {{es}} and the {{stack}} to store, search, and visualiz **Resources** -* [Install {{agent}}](/reference/ingestion-tools/fleet/install-elastic-agents.md) +* [Install {{agent}}](/reference/fleet/install-elastic-agents.md) * [{{es}} Guide](https://www.elastic.co/guide/en/elasticsearch/reference/current) * [{{es}} document APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-document) diff --git a/manage-data/ingest/ingesting-timeseries-data.md b/manage-data/ingest/ingesting-timeseries-data.md index c6dc86a030..d82a5af2e4 100644 --- a/manage-data/ingest/ingesting-timeseries-data.md +++ b/manage-data/ingest/ingesting-timeseries-data.md @@ -20,13 +20,13 @@ In this section, we’ll help you determine which option is best for you. ## {{agent}} and Elastic integrations [ingest-ea] -A single [{{agent}}](https://www.elastic.co/guide/en/fleet/current) can collect multiple types of data when it is [installed](/reference/ingestion-tools/fleet/install-elastic-agents.md) on a host computer. You can use standalone {{agent}}s and manage them locally on the systems where they are installed, or you can manage all of your agents and policies with the [Fleet UI in {{kib}}](/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md). +A single [{{agent}}](https://www.elastic.co/guide/en/fleet/current) can collect multiple types of data when it is [installed](/reference/fleet/install-elastic-agents.md) on a host computer. You can use standalone {{agent}}s and manage them locally on the systems where they are installed, or you can manage all of your agents and policies with the [Fleet UI in {{kib}}](/reference/fleet/manage-elastic-agents-in-fleet.md). Use {{agent}} with one of hundreds of [Elastic integrations](https://docs.elastic.co/en/integrations) to simplify collecting, transforming, and visualizing data. Integrations include default ingestion rules, dashboards, and visualizations to help you start analyzing your data right away. Check out the [Integration quick reference](https://docs.elastic.co/en/integrations/all_integrations) to search for available integrations that can reduce your time to value. -{{agent}} is the best option for collecting timestamped data for most data sources and use cases. If your data requires additional processing before going to {{es}}, you can use [{{agent}} processors](/reference/ingestion-tools/fleet/agent-processors.md), [{{ls}}](https://www.elastic.co/guide/en/logstash/current), or additional processing features in {{es}}. Check out [additional processing](/manage-data/ingest/transform-enrich.md) to see options. +{{agent}} is the best option for collecting timestamped data for most data sources and use cases. If your data requires additional processing before going to {{es}}, you can use [{{agent}} processors](/reference/fleet/agent-processors.md), [{{ls}}](https://www.elastic.co/guide/en/logstash/current), or additional processing features in {{es}}. Check out [additional processing](/manage-data/ingest/transform-enrich.md) to see options. -Ready to try [{{agent}}](https://www.elastic.co/guide/en/fleet/current)? Check out the [installation instructions](/reference/ingestion-tools/fleet/install-elastic-agents.md). +Ready to try [{{agent}}](https://www.elastic.co/guide/en/fleet/current)? Check out the [installation instructions](/reference/fleet/install-elastic-agents.md). ## {{beats}} [ingest-beats] @@ -35,7 +35,7 @@ Ready to try [{{agent}}](https://www.elastic.co/guide/en/fleet/current)? Check o Beats require that you install a separate Beat for each type of data you want to collect. A single Elastic Agent installed on a host can collect and transport multiple types of data. -**Best practice:** Use [{{agent}}](https://www.elastic.co/guide/en/fleet/current) whenever possible. If your data source is not yet supported by {{agent}}, use {{beats}}. Check out the {{beats}} and {{agent}} [comparison](/manage-data/ingest/tools.md#additional-capabilities-beats-and-agent) for more info. When you are ready to upgrade, check out [Migrate from {{beats}} to {{agent}}](/reference/ingestion-tools/fleet/migrate-from-beats-to-elastic-agent.md). +**Best practice:** Use [{{agent}}](https://www.elastic.co/guide/en/fleet/current) whenever possible. If your data source is not yet supported by {{agent}}, use {{beats}}. Check out the {{beats}} and {{agent}} [comparison](/manage-data/ingest/tools.md#additional-capabilities-beats-and-agent) for more info. When you are ready to upgrade, check out [Migrate from {{beats}} to {{agent}}](/reference/fleet/migrate-from-beats-to-elastic-agent.md). ## OpenTelemetry (OTel) collectors [ingest-otel] diff --git a/manage-data/ingest/tools.md b/manage-data/ingest/tools.md index 69a3d8118c..9459e99c55 100644 --- a/manage-data/ingest/tools.md +++ b/manage-data/ingest/tools.md @@ -45,7 +45,7 @@ Depending on the type of data you want to ingest, you have a number of methods a | File upload | Upload data from a file and inspect it before importing it into {{es}}. | [Upload data files](/manage-data/ingest/upload-data-files.md) | | APIs | Ingest data through code by using the APIs of one of the language clients or the {{es}} HTTP APIs. | [Document APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-document) | | OpenTelemetry | Collect and send your telemetry data to Elastic Observability | [Elastic Distributions of OpenTelemetry](https://github.com/elastic/opentelemetry?tab=readme-ov-file#elastic-distributions-of-opentelemetry) | -| Fleet and Elastic Agent | Add monitoring for logs, metrics, and other types of data to a host using Elastic Agent, and centrally manage it using Fleet. | [Fleet and {{agent}} overview](/reference/ingestion-tools/fleet/index.md)
[{{fleet}} and {{agent}} restrictions (Serverless)](/reference/ingestion-tools/fleet/fleet-agent-serverless-restrictions.md)
[{{beats}} and {{agent}} capabilities](/manage-data/ingest/tools.md)|| +| Fleet and Elastic Agent | Add monitoring for logs, metrics, and other types of data to a host using Elastic Agent, and centrally manage it using Fleet. | [Fleet and {{agent}} overview](/reference/fleet/index.md)
[{{fleet}} and {{agent}} restrictions (Serverless)](/reference/fleet/fleet-agent-serverless-restrictions.md)
[{{beats}} and {{agent}} capabilities](/manage-data/ingest/tools.md)|| | {{elastic-defend}} | {{elastic-defend}} provides organizations with prevention, detection, and response capabilities with deep visibility for EPP, EDR, SIEM, and Security Analytics use cases across Windows, macOS, and Linux operating systems running on both traditional endpoints and public cloud environments. | [Configure endpoint protection with {{elastic-defend}}](/solutions/security/configure-elastic-defend.md) | | {{ls}} | Dynamically unify data from a wide variety of data sources and normalize it into destinations of your choice with {{ls}}. | [Logstash (Serverless)](logstash://reference/index.md)
[Logstash pipelines](/manage-data/ingest/transform-enrich/logstash-pipelines.md) | | {{beats}} | Use {{beats}} data shippers to send operational data to Elasticsearch directly or through Logstash. | [{{beats}} (Serverless)](beats://reference/index.md)
[What are {{beats}}?](beats://reference/index.md)
[{{beats}} and {{agent}} capabilities](/manage-data/ingest/tools.md)| diff --git a/manage-data/ingest/transform-enrich.md b/manage-data/ingest/transform-enrich.md index 29d04b06ea..c8b286845c 100644 --- a/manage-data/ingest/transform-enrich.md +++ b/manage-data/ingest/transform-enrich.md @@ -19,7 +19,7 @@ According to your use case, you may want to control the structure of your ingest Finally, to help ensure optimal query results, you may want to customize how text is analyzed and how text fields are defined inside {{es}}. {{agent}} processors -: You can use [{{agent}} processors](/reference/ingestion-tools/fleet/agent-processors.md) to sanitize or enrich raw data at the source. Use {{agent}} processors if you need to control what data is sent across the wire, or if you need to enrich the raw data with information available on the host. +: You can use [{{agent}} processors](/reference/fleet/agent-processors.md) to sanitize or enrich raw data at the source. Use {{agent}} processors if you need to control what data is sent across the wire, or if you need to enrich the raw data with information available on the host. {{es}} ingest pipelines : You can use [{{es}} ingest pipelines](transform-enrich/ingest-pipelines.md) to enrich incoming data or normalize field data before the data is indexed. {{es}} ingest pipelines enable you to manipulate the data as it comes in. This approach helps you avoid adding processing overhead to the hosts from which you’re collecting data. diff --git a/manage-data/ingest/transform-enrich/ingest-pipelines.md b/manage-data/ingest/transform-enrich/ingest-pipelines.md index 9d0663efc2..02a321917a 100644 --- a/manage-data/ingest/transform-enrich/ingest-pipelines.md +++ b/manage-data/ingest/transform-enrich/ingest-pipelines.md @@ -249,9 +249,9 @@ output.elasticsearch: ## Pipelines for {{fleet}} and {{agent}} [pipelines-for-fleet-elastic-agent] -{{agent}} integrations ship with default ingest pipelines that preprocess and enrich data before indexing. [{{fleet}}](/reference/ingestion-tools/fleet/index.md) applies these pipelines using [index templates](../../data-store/templates.md) that include [pipeline index settings](ingest-pipelines.md#set-default-pipeline). {{es}} matches these templates to your {{fleet}} data streams based on the [stream’s naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). +{{agent}} integrations ship with default ingest pipelines that preprocess and enrich data before indexing. [{{fleet}}](/reference/fleet/index.md) applies these pipelines using [index templates](../../data-store/templates.md) that include [pipeline index settings](ingest-pipelines.md#set-default-pipeline). {{es}} matches these templates to your {{fleet}} data streams based on the [stream’s naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). -Each default integration pipeline calls a nonexistent, unversioned `*@custom` ingest pipeline. If unaltered, this pipeline call has no effect on your data. However, you can modify this call to create custom pipelines for integrations that persist across upgrades. Refer to [Tutorial: Transform data with custom ingest pipelines](/reference/ingestion-tools/fleet/data-streams-pipeline-tutorial.md) to learn more. +Each default integration pipeline calls a nonexistent, unversioned `*@custom` ingest pipeline. If unaltered, this pipeline call has no effect on your data. However, you can modify this call to create custom pipelines for integrations that persist across upgrades. Refer to [Tutorial: Transform data with custom ingest pipelines](/reference/fleet/data-streams-pipeline-tutorial.md) to learn more. {{fleet}} doesn’t provide a default ingest pipeline for the **Custom logs** integration, but you can specify a pipeline for this integration using an [index template](ingest-pipelines.md#pipeline-custom-logs-index-template) or a [custom configuration](ingest-pipelines.md#pipeline-custom-logs-configuration). @@ -345,7 +345,7 @@ $$$pipeline-custom-logs-configuration$$$ **{{agent}} standalone** -If you run {{agent}} standalone, you can apply pipelines using an [index template](../../data-store/templates.md) that includes the [`index.default_pipeline`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-default-pipeline) or [`index.final_pipeline`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-final-pipeline) index setting. Alternatively, you can specify the `pipeline` policy setting in your `elastic-agent.yml` configuration. See [Install standalone {{agent}}s](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md). +If you run {{agent}} standalone, you can apply pipelines using an [index template](../../data-store/templates.md) that includes the [`index.default_pipeline`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-default-pipeline) or [`index.final_pipeline`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#index-final-pipeline) index setting. Alternatively, you can specify the `pipeline` policy setting in your `elastic-agent.yml` configuration. See [Install standalone {{agent}}s](/reference/fleet/install-standalone-elastic-agent.md). ## Pipelines for search indices [pipelines-in-enterprise-search] diff --git a/manage-data/use-case-use-elasticsearch-to-manage-time-series-data.md b/manage-data/use-case-use-elasticsearch-to-manage-time-series-data.md index c43b4185cb..d86b16b54d 100644 --- a/manage-data/use-case-use-elasticsearch-to-manage-time-series-data.md +++ b/manage-data/use-case-use-elasticsearch-to-manage-time-series-data.md @@ -307,7 +307,7 @@ PUT _component_template/my-settings Use your component templates to create an index template. Specify: -* One or more index patterns that match the data stream’s name. We recommend using our [data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). +* One or more index patterns that match the data stream’s name. We recommend using our [data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). * That the template is data stream enabled. * Any component templates that contain your mappings and index settings. * A priority higher than `200` to avoid collisions with built-in templates. See [Avoid index pattern collisions](data-store/templates.md#avoid-index-pattern-collisions). diff --git a/raw-migrated-files/docs-content/serverless/observability-plaintext-application-logs.md b/raw-migrated-files/docs-content/serverless/observability-plaintext-application-logs.md index 4b3949c896..883d6b39e9 100644 --- a/raw-migrated-files/docs-content/serverless/observability-plaintext-application-logs.md +++ b/raw-migrated-files/docs-content/serverless/observability-plaintext-application-logs.md @@ -276,7 +276,7 @@ PUT _ingest/pipeline/filebeat* <1> } ``` -1. `_ingest/pipeline/filebeat*`: The name of the pipeline. Update the pipeline name to match the name of your data stream. For more information, refer to [Data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). +1. `_ingest/pipeline/filebeat*`: The name of the pipeline. Update the pipeline name to match the name of your data stream. For more information, refer to [Data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). 2. `processors.dissect`: Adds a [dissect processor](elasticsearch://reference/ingestion-tools/enrich-processor/dissect-processor.md) to extract structured fields from your log message. 3. `field`: The field you’re extracting data from, `message` in this case. 4. `pattern`: The pattern of the elements in your log data. The pattern varies depending on your log format. `%{@timestamp}`, `%{log.level}`, `%{host.ip}`, and `%{{message}}` are common [ECS](ecs://reference/index.md) fields. This pattern would match a log file in this format: `2023-11-07T09:39:01.012Z ERROR 192.168.1.110 Server hardware failure detected.` diff --git a/raw-migrated-files/docs-content/serverless/observability-stream-log-files.md b/raw-migrated-files/docs-content/serverless/observability-stream-log-files.md index 52938950ec..09493e7560 100644 --- a/raw-migrated-files/docs-content/serverless/observability-stream-log-files.md +++ b/raw-migrated-files/docs-content/serverless/observability-stream-log-files.md @@ -466,7 +466,7 @@ If you’re not seeing your log files in your project, verify the following in t * The path to your logs file under `paths` is correct. * Your API key is in `:` format. If not, your API key may be in an unsupported format, and you’ll need to create an API key in **Beats** format. -If you’re still running into issues, refer to [{{agent}} troubleshooting](../../../troubleshoot/ingest/fleet/common-problems.md) and [Configure standalone Elastic Agents](/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md). +If you’re still running into issues, refer to [{{agent}} troubleshooting](../../../troubleshoot/ingest/fleet/common-problems.md) and [Configure standalone Elastic Agents](/reference/fleet/configure-standalone-elastic-agents.md). ## Next steps [observability-stream-log-files-next-steps] diff --git a/raw-migrated-files/stack-docs/elastic-stack/installing-stack-demo-self.md b/raw-migrated-files/stack-docs/elastic-stack/installing-stack-demo-self.md index d1a12e4012..c9d0c8c291 100644 --- a/raw-migrated-files/stack-docs/elastic-stack/installing-stack-demo-self.md +++ b/raw-migrated-files/stack-docs/elastic-stack/installing-stack-demo-self.md @@ -489,7 +489,7 @@ After new security certificates are configured any {{agent}}s would need to be r ## Step 7: Install {{fleet-server}} [install-stack-self-fleet-server] -Now that {{kib}} is up and running, you can install {{fleet-server}}, which will manage the {{agent}} that you’ll set up in a later step. If you need more detail about these steps, refer to [Deploy on-premises and self-managed](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md) in the {{fleet}} and {{agent}} Guide. +Now that {{kib}} is up and running, you can install {{fleet-server}}, which will manage the {{agent}} that you’ll set up in a later step. If you need more detail about these steps, refer to [Deploy on-premises and self-managed](/reference/fleet/add-fleet-server-on-prem.md) in the {{fleet}} and {{agent}} Guide. 1. Log in to the host where you’d like to set up {{fleet-server}}. 2. Create a working directory for the installation package: @@ -511,7 +511,7 @@ Now that {{kib}} is up and running, you can install {{fleet-server}}, which will 8. Specify a name for your {{fleet-server}} host, for example `Fleet Server`. 9. Specify the host URL where {{agents}} will reach {{fleet-server}}, for example: `http://10.128.0.203:8220`. This is the inet value that you copied from the `ifconfig` output. - Be sure to include the port number. Port `8220` is the default used by {{fleet-server}} in an on-premises environment. Refer to [Default port assignments](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md#default-port-assignments-on-prem) in the on-premises {{fleet-server}} install documentation for a list of port assignments. + Be sure to include the port number. Port `8220` is the default used by {{fleet-server}} in an on-premises environment. Refer to [Default port assignments](/reference/fleet/add-fleet-server-on-prem.md#default-port-assignments-on-prem) in the on-premises {{fleet-server}} install documentation for a list of port assignments. 10. Click **Generate Fleet Server policy**. A policy is created that contains all of the configuration settings for the {{fleet-server}} instance. 11. On the **Install Fleet Server to a centralized host** step, for this example we select the **Linux Tar** tab, but you can instead select the tab appropriate to the host operating system where you’re setting up {{fleet-server}}. @@ -527,7 +527,7 @@ Now that {{kib}} is up and running, you can install {{fleet-server}}, which will 3. Change into the directory containing the install binaries. 4. Install {{fleet-server}}. - If you’d like to learn about the install command options, refer to [`elastic-agent install`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) in the {{agent}} command reference. + If you’d like to learn about the install command options, refer to [`elastic-agent install`](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) in the {{agent}} command reference. 13. At the prompt, enter `Y` to install {{agent}} and run it as a service. Wait for the installation to complete. 14. In the {{kib}} **Add a Fleet Server** flyout, wait for confirmation that {{fleet-server}} has connected. diff --git a/redirects.yml b/redirects.yml index 316c0f61c0..9bbe46850d 100644 --- a/redirects.yml +++ b/redirects.yml @@ -63,3 +63,22 @@ redirects: 'reference/security/elastic-defend/uninstall-agent.md': 'solutions/security/configure-elastic-defend/uninstall-elastic-agent.md' 'reference/security/fields-and-object-schemas/runtime-fields.md': 'solutions/security/get-started/create-runtime-fields-in-elastic-security.md' 'reference/security/prebuilt-anomaly-detection-jobs.md': 'reference/data-analysis/machine-learning/ootb-ml-jobs-siem.md' + + # Related to https://github.com/elastic/docs-content/pull/792 + 'reference/elasticsearch.md': 'reference/index.md' + 'reference/elasticsearch/clients/index.md': 'reference/elasticsearch-clients/index.md' + 'reference/ingestion-tools/apm/apm-agents.md': 'reference/apm-agents/index.md' + 'reference/ingestion-tools/fleet/add-integration-to-policy.md': 'reference/fleet/add-integration-to-policy.md' + 'reference/ingestion-tools/fleet/agent-policy.md': 'reference/fleet/agent-policy.md' + 'reference/ingestion-tools/fleet/air-gapped.md': 'reference/fleet/air-gapped.md' + 'reference/ingestion-tools/fleet/data-streams-pipeline-tutorial.md': 'reference/fleet/data-streams-pipeline-tutorial.md' + 'reference/ingestion-tools/fleet/data-streams.md': 'reference/fleet/data-streams.md' + 'reference/ingestion-tools/fleet/fleet-server.md': 'reference/fleet/fleet-server.md' + 'reference/ingestion-tools/fleet/fleet-settings.md': 'reference/fleet/fleet-settings.md' + 'reference/ingestion-tools/fleet/index.md': 'reference/fleet/index.md' + 'reference/ingestion-tools/fleet/install-elastic-agents.md': 'reference/fleet/install-elastic-agents.md' + 'reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md': 'reference/fleet/install-fleet-managed-elastic-agent.md' + 'reference/ingestion-tools/fleet/install-standalone-elastic-agent.md': 'reference/fleet/install-standalone-elastic-agent.md' + 'reference/ingestion-tools/observability/apm.md': 'reference/apm/observability/apm.md' + 'reference/ingestion-tools/observability/apm-settings.md': 'reference/apm/observability/apm-settings.md' + 'reference/ingestion-tools/fleet/migrate-from-beats-to-elastic-agent.md': 'reference/fleet/migrate-from-beats-to-elastic-agent.md' diff --git a/reference/ingestion-tools/apm/apm-agents.md b/reference/apm-agents/index.md similarity index 100% rename from reference/ingestion-tools/apm/apm-agents.md rename to reference/apm-agents/index.md diff --git a/reference/apm-agents/toc.yml b/reference/apm-agents/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/apm-agents/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/ingestion-tools/cloud-enterprise/apm-settings.md b/reference/apm/cloud-enterprise/apm-settings.md similarity index 98% rename from reference/ingestion-tools/cloud-enterprise/apm-settings.md rename to reference/apm/cloud-enterprise/apm-settings.md index 25e9bf76d6..866eb63891 100644 --- a/reference/ingestion-tools/cloud-enterprise/apm-settings.md +++ b/reference/apm/cloud-enterprise/apm-settings.md @@ -29,7 +29,7 @@ Users running {{stack}} versions 7.16 or 7.17 need to manually configure TLS. Th Pick one of the following options: -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. +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. 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`. diff --git a/reference/ingestion-tools/cloud/apm-settings.md b/reference/apm/cloud/apm-settings.md similarity index 100% rename from reference/ingestion-tools/cloud/apm-settings.md rename to reference/apm/cloud/apm-settings.md diff --git a/reference/ingestion-tools/observability/apm-settings.md b/reference/apm/observability/apm-settings.md similarity index 95% rename from reference/ingestion-tools/observability/apm-settings.md rename to reference/apm/observability/apm-settings.md index ff5c417bfa..1f5e422d42 100644 --- a/reference/ingestion-tools/observability/apm-settings.md +++ b/reference/apm/observability/apm-settings.md @@ -9,7 +9,7 @@ How you configure the APM Server depends on your deployment method. * **APM Server binary** users need to edit the `apm-server.yml` configuration file. The location of the file varies by platform. To locate the file, see [Installation layout](/solutions/observability/apps/installation-layout.md). * **Fleet-managed** users configure the APM Server directly in {{kib}}. Each configuration page describes the specific location. -* **Elastic cloud** users should see [Add APM user settings](/reference/ingestion-tools/cloud/apm-settings.md) for information on how to configure Elastic APM. +* **Elastic cloud** users should see [Add APM user settings](/reference/apm/cloud/apm-settings.md) for information on how to configure Elastic APM. The following topics describe how to configure APM Server: diff --git a/reference/ingestion-tools/observability/apm.md b/reference/apm/observability/apm.md similarity index 100% rename from reference/ingestion-tools/observability/apm.md rename to reference/apm/observability/apm.md diff --git a/reference/apm/toc.yml b/reference/apm/toc.yml new file mode 100644 index 0000000000..beb514a60e --- /dev/null +++ b/reference/apm/toc.yml @@ -0,0 +1,5 @@ +toc: + - file: observability/apm.md + - file: observability/apm-settings.md + - file: cloud/apm-settings.md + - file: cloud-enterprise/apm-settings.md \ No newline at end of file diff --git a/reference/cloud/index.md b/reference/cloud/index.md new file mode 100644 index 0000000000..65ec314b85 --- /dev/null +++ b/reference/cloud/index.md @@ -0,0 +1,6 @@ +--- +navigation_title: Cloud +--- + +# Elastic Cloud + diff --git a/reference/cloud/toc.yml b/reference/cloud/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/cloud/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/data-analysis/toc.yml b/reference/data-analysis/toc.yml new file mode 100644 index 0000000000..a43f6ed396 --- /dev/null +++ b/reference/data-analysis/toc.yml @@ -0,0 +1,31 @@ +toc: + - file: index.md + - file: machine-learning/supplied-anomaly-detection-configurations.md + children: + - file: machine-learning/ootb-ml-jobs-apache.md + - file: machine-learning/ootb-ml-jobs-apm.md + - file: machine-learning/ootb-ml-jobs-auditbeat.md + - file: machine-learning/ootb-ml-jobs-logs-ui.md + - file: machine-learning/ootb-ml-jobs-metricbeat.md + - file: machine-learning/ootb-ml-jobs-metrics-ui.md + - file: machine-learning/ootb-ml-jobs-nginx.md + - file: machine-learning/ootb-ml-jobs-siem.md + - file: machine-learning/ootb-ml-jobs-uptime.md + - file: machine-learning/machine-learning-functions.md + children: + - file: machine-learning/ml-count-functions.md + - file: machine-learning/ml-geo-functions.md + - file: machine-learning/ml-info-functions.md + - file: machine-learning/ml-metric-functions.md + - file: machine-learning/ml-rare-functions.md + - file: machine-learning/ml-sum-functions.md + - file: machine-learning/ml-time-functions.md + - file: observability/index.md + children: + - file: observability/observability-host-metrics.md + - file: observability/observability-container-metrics.md + - file: observability/observability-kubernetes-pod-metrics.md + - file: observability/observability-aws-metrics.md + - file: kibana/canvas-functions.md + children: + - file: kibana/tinymath-functions.md \ No newline at end of file diff --git a/reference/ecs.md b/reference/ecs/index.md similarity index 100% rename from reference/ecs.md rename to reference/ecs/index.md diff --git a/reference/ecs/toc.yml b/reference/ecs/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/ecs/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/elasticsearch/clients/index.md b/reference/elasticsearch-clients/index.md similarity index 100% rename from reference/elasticsearch/clients/index.md rename to reference/elasticsearch-clients/index.md diff --git a/reference/elasticsearch-clients/toc.yml b/reference/elasticsearch-clients/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/elasticsearch-clients/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/elasticsearch.md b/reference/elasticsearch/index.md similarity index 100% rename from reference/elasticsearch.md rename to reference/elasticsearch/index.md diff --git a/reference/elasticsearch/toc.yml b/reference/elasticsearch/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/elasticsearch/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/ingestion-tools/fleet/_agent_configuration_encryption.md b/reference/fleet/_agent_configuration_encryption.md similarity index 100% rename from reference/ingestion-tools/fleet/_agent_configuration_encryption.md rename to reference/fleet/_agent_configuration_encryption.md diff --git a/reference/ingestion-tools/fleet/add-cloud-metadata-processor.md b/reference/fleet/add-cloud-metadata-processor.md similarity index 91% rename from reference/ingestion-tools/fleet/add-cloud-metadata-processor.md rename to reference/fleet/add-cloud-metadata-processor.md index 2775044934..921814c748 100644 --- a/reference/ingestion-tools/fleet/add-cloud-metadata-processor.md +++ b/reference/fleet/add-cloud-metadata-processor.md @@ -42,7 +42,7 @@ The metadata that is added to events varies by hosting provider. For examples, r ## Configuration settings [_configuration_settings] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -54,7 +54,7 @@ The metadata that is added to events varies by hosting provider. For examples, r The `add_cloud_metadata` processor supports SSL options to configure the http client used to query cloud metadata. -For more information, refer to [SSL/TLS](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). +For more information, refer to [SSL/TLS](/reference/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). ## Provider-specific metadata examples [provider-specific-examples] diff --git a/reference/ingestion-tools/fleet/add-fleet-server-cloud.md b/reference/fleet/add-fleet-server-cloud.md similarity index 94% rename from reference/ingestion-tools/fleet/add-fleet-server-cloud.md rename to reference/fleet/add-fleet-server-cloud.md index dafe974b71..d2f4d90909 100644 --- a/reference/ingestion-tools/fleet/add-fleet-server-cloud.md +++ b/reference/fleet/add-fleet-server-cloud.md @@ -5,7 +5,7 @@ mapped_pages: # Deploy on Elastic Cloud [add-fleet-server-cloud] -To use {{fleet}} for central management, a [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) must be running and accessible to your hosts. +To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts. {{fleet-server}} can be provisioned and hosted on {{ecloud}}. When the Cloud deployment is created, a highly available set of {{fleet-server}}s is provisioned automatically. @@ -80,4 +80,4 @@ Don’t see the agent? Make sure your deployment includes an {{integrations-serv ## Next steps [add-fleet-server-cloud-next] -Now you’re ready to add {{agent}}s to your host systems. To learn how, see [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). +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). diff --git a/reference/ingestion-tools/fleet/add-fleet-server-kubernetes.md b/reference/fleet/add-fleet-server-kubernetes.md similarity index 92% rename from reference/ingestion-tools/fleet/add-fleet-server-kubernetes.md rename to reference/fleet/add-fleet-server-kubernetes.md index 6f77691b87..9a2fe03bb7 100644 --- a/reference/ingestion-tools/fleet/add-fleet-server-kubernetes.md +++ b/reference/fleet/add-fleet-server-kubernetes.md @@ -19,7 +19,7 @@ This guide assumes familiarity with Kubernetes concepts and resources, such as ` :::: -To use {{fleet}} for central management, a [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) must be running and accessible to your hosts. +To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts. You can deploy {{fleet-server}} on Kubernetes and manage it yourself. In this deployment model, you are responsible for high-availability, fault-tolerance, and lifecycle management of the {{fleet-server}}. @@ -36,7 +36,7 @@ To deploy a {{fleet-server}} on Kubernetes and register it into {{fleet}} you wi * A **TLS/SSL certificate and key** for the {{fleet-server}} HTTPS endpoint, used to encrypt the traffic from the {{agent}}s. This certificate has to be valid for the **{{fleet-server}} Host URL** that {{agent}}s use when connecting to the {{fleet-server}}. -* Extra TLS/SSL certificates and configuration parameters in case of requiring [mutual TLS](/reference/ingestion-tools/fleet/mutual-tls.md) (not covered in this document). +* Extra TLS/SSL certificates and configuration parameters in case of requiring [mutual TLS](/reference/fleet/mutual-tls.md) (not covered in this document). This document walks you through the complete setup process, organized into the following sections: @@ -63,13 +63,13 @@ This document walks you through the complete setup process, organized into the f Before deploying {{fleet-server}}, you need to: -* Prepare the SSL/TLS configuration, server certificate, [{{fleet-server}} host settings](/reference/ingestion-tools/fleet/fleet-settings.md#fleet-server-hosts-setting), and needed Certificate Authorities (CAs). +* Prepare the SSL/TLS configuration, server certificate, [{{fleet-server}} host settings](/reference/fleet/fleet-settings.md#fleet-server-hosts-setting), and needed Certificate Authorities (CAs). * Ensure components have access to the ports needed for communication. ### {{fleet-server}} and SSL/TLS certificates considerations [add-fleet-server-kubernetes-cert-prereq] -This section shows the minimum requirements in terms of Transport Layer Security (TLS) certificates for the {{fleet-server}}, assuming no mutual TLS (mTLS) is needed. Refer to [One-way and mutual TLS certifications flow](/reference/ingestion-tools/fleet/tls-overview.md) and [{{agent}} deployment models with mutual TLS](/reference/ingestion-tools/fleet/mutual-tls.md) for more information about the configuration needs of both approaches. +This section shows the minimum requirements in terms of Transport Layer Security (TLS) certificates for the {{fleet-server}}, assuming no mutual TLS (mTLS) is needed. Refer to [One-way and mutual TLS certifications flow](/reference/fleet/tls-overview.md) and [{{agent}} deployment models with mutual TLS](/reference/fleet/mutual-tls.md) for more information about the configuration needs of both approaches. There are two main traffic flows for {{fleet-server}}, each with different TLS requirements: @@ -84,10 +84,10 @@ A {{fleet-server}} certificate is not required when installing the server using :::: -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/ingestion-tools/fleet/secure-connections.md#generate-fleet-server-certs) for an example to generate a CA and a server certificate using the `elasticsearch-certutil` tool. +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. ::::{important} -Before creating the certificate, you need to know and plan in advance the [hostname / URL](/reference/ingestion-tools/fleet/fleet-settings.md#fleet-server-hosts-setting) that the {{agent}} clients will use to access the {{fleet-server}}. This is important because the **hostname** part of the URL needs to be included in the server certificate as an `x.509 Subject Alternative Name (SAN)`. If you plan to make your {{fleet-server}} accessible through **multiple hostnames** or **FQDNs**, add all of them to the server certificate, and take in mind that the **{{fleet-server}} also needs to access the {{fleet}} URL during its bootstrap process**. +Before creating the certificate, you need to know and plan in advance the [hostname / URL](/reference/fleet/fleet-settings.md#fleet-server-hosts-setting) that the {{agent}} clients will use to access the {{fleet-server}}. This is important because the **hostname** part of the URL needs to be included in the server certificate as an `x.509 Subject Alternative Name (SAN)`. If you plan to make your {{fleet-server}} accessible through **multiple hostnames** or **FQDNs**, add all of them to the server certificate, and take in mind that the **{{fleet-server}} also needs to access the {{fleet}} URL during its bootstrap process**. :::: @@ -143,7 +143,7 @@ Also note that the `service token` required by the {{fleet-server}} is different 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: * The **hosts** field includes a valid URL that will be reachable by the {{fleet-server}} Pod(s). - * If your {{es}} cluster uses certificates signed by private or intermediate CAs not publicly trusted, you have added the trust information in the **Elasticsearch CA trusted fingerprint** field or in the **advanced configuration** section through the `ssl.certificate_authorities` setting. For an example, refer to [Secure Connections](/reference/ingestion-tools/fleet/secure-connections.md#_encrypt_traffic_between_agents_fleet_server_and_es) documentation. + * If your {{es}} cluster uses certificates signed by private or intermediate CAs not publicly trusted, you have added the trust information in the **Elasticsearch CA trusted fingerprint** field or in the **advanced configuration** section through the `ssl.certificate_authorities` setting. For an example, refer to [Secure Connections](/reference/fleet/secure-connections.md#_encrypt_traffic_between_agents_fleet_server_and_es) documentation. ::::{important} This validation step is critical. The {{es}} host URL and CA information has to be added **in both the {{es}} output and the environment variables** provided to the {{fleet-server}}. It’s a common mistake to ignore the output settings believing that the environment variables will prevail, when the environment variables are only used during the bootstrap of the {{fleet-server}}. @@ -164,7 +164,7 @@ Also note that the `service token` required by the {{fleet-server}} is different * Search for and select the {{fleet-server}} integration. * Select **Add {{fleet-server}}** to add the integration to the {{agent}} policy. - At this point you can configure the integration settings per [{{fleet-server}} scalability](/reference/ingestion-tools/fleet/fleet-server-scalability.md). + At this point you can configure the integration settings per [{{fleet-server}} scalability](/reference/fleet/fleet-server-scalability.md). * When done, select **Save and continue**. Do not add an {{agent}} at this stage. @@ -223,11 +223,11 @@ The suggested deployment method for the {{fleet-server}} consists of: Adapt and change the suggested manifests and deployment strategy to your needs, ensuring you feed the {{fleet-server}} with the needed configuration and certificates. For example, you can customize: -* CPU and memory `requests` and `limits`. Refer to [{{fleet-server}} scalability](/reference/ingestion-tools/fleet/fleet-server-scalability.md) for more information about {{fleet-server}} resources utilization. +* 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. * Scheduling configuration, such as `affinity rules` or `tolerations`, if needed in your environment. * Number of replicas, to scale the Fleet Server horizontally. * Use an {{es}} CA fingerprint instead of a CA file. -* Configure other [Environment variables](/reference/ingestion-tools/fleet/agent-environment-variables.md). +* Configure other [Environment variables](/reference/fleet/agent-environment-variables.md). #### Installation Steps [add-fleet-server-kubernetes-install-steps] @@ -463,8 +463,8 @@ Adapt and change the suggested manifests and deployment strategy to your needs, * If your {{es}} cluster runs on Elastic Cloud or if it uses a publicly trusted CA, remove the `ELASTICSEARCH_CA` environment variable from the manifest. * Check the `image` version to ensure its aligned with the rest of your {{stack}}. - * Keep `automountServiceAccountToken` set to `false` to disable the [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md). - * Consider configuring requests and limits always as a best practice. Refer to [{{fleet-server}} scalability](/reference/ingestion-tools/fleet/fleet-server-scalability.md) for more information about resources utilization of the {{fleet-server}}. + * Keep `automountServiceAccountToken` set to `false` to disable the [Kubernetes Provider](/reference/fleet/kubernetes-provider.md). + * Consider configuring requests and limits always as a best practice. Refer to [{{fleet-server}} scalability](/reference/fleet/fleet-server-scalability.md) for more information about resources utilization of the {{fleet-server}}. * You can change the listening `port` of the service to any port of your choice, but do not change the `targetPort`, as the {{fleet-server}} Pods will listen on port 8220. * If you want to expose the {{fleet-server}} externally, consider changing the service type to `LoadBalancer`. @@ -558,6 +558,6 @@ The following issues may occur when {{fleet-server}} settings are missing or con ## Next steps [add-fleet-server-kubernetes-next] -Now you’re ready to add {{agent}}s to your host systems. To learn how, refer to [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md), or [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) if your {{agent}}s will also run on Kubernetes. +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. When you connect {{agent}}s to {{fleet-server}}, remember to use the `--insecure` flag if the **quick start** mode was used, or to provide to the {{agent}}s the CA certificate associated to the {{fleet-server}} certificate if **production** mode was used. diff --git a/reference/ingestion-tools/fleet/add-fleet-server-mixed.md b/reference/fleet/add-fleet-server-mixed.md similarity index 92% rename from reference/ingestion-tools/fleet/add-fleet-server-mixed.md rename to reference/fleet/add-fleet-server-mixed.md index eaa2b972ff..cf93fe92c0 100644 --- a/reference/ingestion-tools/fleet/add-fleet-server-mixed.md +++ b/reference/fleet/add-fleet-server-mixed.md @@ -5,9 +5,9 @@ mapped_pages: # Deploy Fleet Server on-premises and Elasticsearch on Cloud [add-fleet-server-mixed] -To use {{fleet}} for central management, a [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) must be running and accessible to your hosts. +To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts. -Another approach is to deploy a cluster of {{fleet-server}}s on-premises and connect them back to {{ecloud}} with access to {{es}} and {{kib}}. In this [deployment model](/reference/ingestion-tools/fleet/deployment-models.md), you are responsible for high-availability, fault-tolerance, and lifecycle management of {{fleet-server}}. +Another approach is to deploy a cluster of {{fleet-server}}s on-premises and connect them back to {{ecloud}} with access to {{es}} and {{kib}}. In this [deployment model](/reference/fleet/deployment-models.md), you are responsible for high-availability, fault-tolerance, and lifecycle management of {{fleet-server}}. This approach might be right for you if you would like to limit the control plane traffic out of your data center. For example, you might take this approach if you are a managed service provider or a larger enterprise that segregates its networks. @@ -54,7 +54,7 @@ Before deploying, you need to: Before setting up {{fleet-server}} using this approach, you will need a CA certificate to configure Transport Layer Security (TLS) to encrypt traffic between the {{fleet-server}}s and the {{stack}}. -If your organization already uses the {{stack}}, you may already have a CA certificate. If you do not have a CA certificate, you can read more about generating one in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). +If your organization already uses the {{stack}}, you may already have a CA certificate. If you do not have a CA certificate, you can read more about generating one in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). ::::{note} This is not required when testing and iterating using the **Quick start** option, but should always be used for production deployments. @@ -148,11 +148,11 @@ You can update your {{fleet-server}} configuration in {{kib}} at any time by goi ## Next steps [fleet-server-install-agents] -Now you’re ready to add {{agent}}s to your host systems. To learn how, see [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). +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). ::::{note} For on-premises deployments, you can dedicate a policy to all the agents in the network boundary and configure that policy to include a specific {{fleet-server}} (or a cluster of {{fleet-server}}s). -Read more in [Add a {{fleet-server}} to a policy](/reference/ingestion-tools/fleet/agent-policy.md#add-fleet-server-to-policy). +Read more in [Add a {{fleet-server}} to a policy](/reference/fleet/agent-policy.md#add-fleet-server-to-policy). :::: diff --git a/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md b/reference/fleet/add-fleet-server-on-prem.md similarity index 89% rename from reference/ingestion-tools/fleet/add-fleet-server-on-prem.md rename to reference/fleet/add-fleet-server-on-prem.md index 51add6fb49..5a8e5a12f0 100644 --- a/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md +++ b/reference/fleet/add-fleet-server-on-prem.md @@ -5,9 +5,9 @@ mapped_pages: # Deploy on-premises and self-managed [add-fleet-server-on-prem] -To use {{fleet}} for central management, a [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) must be running and accessible to your hosts. +To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts. -You can deploy {{fleet-server}} on-premises and manage it yourself. In this [deployment model](/reference/ingestion-tools/fleet/deployment-models.md), you are responsible for high-availability, fault-tolerance, and lifecycle management of {{fleet-server}}. +You can deploy {{fleet-server}} on-premises and manage it yourself. In this [deployment model](/reference/fleet/deployment-models.md), you are responsible for high-availability, fault-tolerance, and lifecycle management of {{fleet-server}}. This approach might be right for you if you would like to limit the control plane traffic out of your data center or have requirements for fully air-gapped operations. For example, you might take this approach if you need to satisfy data governance requirements or you want agents to only have access to a private segmented network. @@ -60,7 +60,7 @@ Before deploying, you need to: Before setting up {{fleet-server}} using this approach, you will need a CA certificate to configure Transport Layer Security (TLS) to encrypt traffic between the {{fleet-server}}s and the {{stack}}. -If your organization already uses the {{stack}}, you may already have a CA certificate. If you do not have a CA certificate, you can read more about generating one in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). +If your organization already uses the {{stack}}, you may already have a CA certificate. If you do not have a CA certificate, you can read more about generating one in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). ::::{note} This is not required when testing and iterating using the **Quick start** option, but should always be used for production deployments. @@ -106,8 +106,8 @@ To add a {{fleet-server}}: * Use **Advanced** if you want to either: - * **Use your own {{fleet-server}} policy.** {{fleet-server}} policies manage and configure the {{agent}} running on {{fleet-server}} hosts to launch a {{fleet-server}} process. You can create a new {{fleet-server}} policy or select an existing one. Alternatively you can [create a {{fleet-server}} policy without using the UI](/reference/ingestion-tools/fleet/create-policy-no-ui.md), and then select the policy here. - * **Use your own TLS certificates.** TLS certificates encrypt traffic between {{agent}}s and {{fleet-server}}. To learn how to generate certs, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). + * **Use your own {{fleet-server}} policy.** {{fleet-server}} policies manage and configure the {{agent}} running on {{fleet-server}} hosts to launch a {{fleet-server}} process. You can create a new {{fleet-server}} policy or select an existing one. Alternatively you can [create a {{fleet-server}} policy without using the UI](/reference/fleet/create-policy-no-ui.md), and then select the policy here. + * **Use your own TLS certificates.** TLS certificates encrypt traffic between {{agent}}s and {{fleet-server}}. To learn how to generate certs, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). ::::{note} If you are providing your own certificates: @@ -128,12 +128,12 @@ To add a {{fleet-server}}: ::::{note} * The fields to configure {{fleet-server}} hosts are not available if the hosts are already configured outside of {{fleet}}. For more information, refer to [{{fleet}} settings in {{kib}}](kibana://reference/configuration-reference/fleet-settings.md). * When using the **Advanced** option, it’s recommended to generate a unique service token for each {{fleet-server}}. For other ways to generate service tokens, refer to [`elasticsearch-service-tokens`](elasticsearch://reference/elasticsearch/command-line-tools/service-tokens-command.md). - * If you’ve configured a non-default port for {{fleet-server}} in the {{fleet-server}} integration, you need to include the `--fleet-server-host` and `--fleet-server-port` options in the `elastic-agent install` command. Refer to the [install command documentation](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) for details. + * If you’ve configured a non-default port for {{fleet-server}} in the {{fleet-server}} integration, you need to include the `--fleet-server-host` and `--fleet-server-port` options in the `elastic-agent install` command. Refer to the [install command documentation](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) for details. :::: - 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/ingestion-tools/fleet/agent-command-reference.md). + 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). 5. If installation is successful, a confirmation indicates that {{fleet-server}} is set up and connected. @@ -156,11 +156,11 @@ If you’re unable to add a {{fleet}}-managed agent, click the **Agents** tab an ## Next steps [add-fleet-server-on-prem-next] -Now you’re ready to add {{agent}}s to your host systems. To learn how, see [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). +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). ::::{note} For on-premises deployments, you can dedicate a policy to all the agents in the network boundary and configure that policy to include a specific {{fleet-server}} (or a cluster of {{fleet-server}}s). -Read more in [Add a {{fleet-server}} to a policy](/reference/ingestion-tools/fleet/agent-policy.md#add-fleet-server-to-policy). +Read more in [Add a {{fleet-server}} to a policy](/reference/fleet/agent-policy.md#add-fleet-server-to-policy). :::: diff --git a/reference/ingestion-tools/fleet/add-integration-to-policy.md b/reference/fleet/add-integration-to-policy.md similarity index 88% rename from reference/ingestion-tools/fleet/add-integration-to-policy.md rename to reference/fleet/add-integration-to-policy.md index c9c9c28fa7..d8299c54c3 100644 --- a/reference/ingestion-tools/fleet/add-integration-to-policy.md +++ b/reference/fleet/add-integration-to-policy.md @@ -7,7 +7,7 @@ mapped_pages: # Add an integration to an {{agent}} policy [add-integration-to-policy] -An [{{agent}} policy](/reference/ingestion-tools/fleet/agent-policy.md) consists of one or more integrations that are applied to the agents enrolled in that policy. When you add an integration, the policy created for that integration can be shared with multiple {{agent}} policies. This reduces the number of integrations policies that you need to actively manage. +An [{{agent}} policy](/reference/fleet/agent-policy.md) consists of one or more integrations that are applied to the agents enrolled in that policy. When you add an integration, the policy created for that integration can be shared with multiple {{agent}} policies. This reduces the number of integrations policies that you need to actively manage. To add a new integration to one or more {{agent}} policies: diff --git a/reference/ingestion-tools/fleet/add_cloudfoundry_metadata-processor.md b/reference/fleet/add_cloudfoundry_metadata-processor.md similarity index 86% rename from reference/ingestion-tools/fleet/add_cloudfoundry_metadata-processor.md rename to reference/fleet/add_cloudfoundry_metadata-processor.md index cb3fb2afa7..1726286f82 100644 --- a/reference/ingestion-tools/fleet/add_cloudfoundry_metadata-processor.md +++ b/reference/fleet/add_cloudfoundry_metadata-processor.md @@ -47,7 +47,7 @@ For efficient annotation, application metadata retrieved by the Cloud Foundry cl ## Configuration settings [_configuration_settings_2] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -61,5 +61,5 @@ For efficient annotation, application metadata retrieved by the Cloud Foundry cl | `client_secret` | Yes | | Client Secret to authenticate with Cloud Foundry. | | `cache_duration` | No | `120s` | Maximum amount of time to cache an application’s metadata. | | `cache_retry_delay` | No | `20s` | Time to wait before trying to obtain an application’s metadata again in case of error. | -| `ssl` | No | | SSL configuration to use when connecting to Cloud Foundry. For a list ofavailable settings, refer to [SSL/TLS](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md), specificallythe settings under [Table 7, Common configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). | +| `ssl` | No | | SSL configuration to use when connecting to Cloud Foundry. For a list ofavailable settings, refer to [SSL/TLS](/reference/fleet/elastic-agent-ssl-configuration.md), specificallythe settings under [Table 7, Common configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). | diff --git a/reference/ingestion-tools/fleet/add_docker_metadata-processor.md b/reference/fleet/add_docker_metadata-processor.md similarity index 89% rename from reference/ingestion-tools/fleet/add_docker_metadata-processor.md rename to reference/fleet/add_docker_metadata-processor.md index 54624b19af..b0c0446c5e 100644 --- a/reference/ingestion-tools/fleet/add_docker_metadata-processor.md +++ b/reference/fleet/add_docker_metadata-processor.md @@ -62,14 +62,14 @@ If the Docker daemon is restarted, the mounted socket will become invalid, and m ## Configuration settings [_configuration_settings_3] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: | Name | Required | Default | Description | | --- | --- | --- | --- | | `host` | No | `unix:///var/run/docker.sock` | Docker socket (UNIX or TCP socket). | -| `ssl` | No | | SSL configuration to use when connecting to the Docker socket. For a list ofavailable settings, refer to [SSL/TLS](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md), specificallythe settings under [Table 7, Common configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). | +| `ssl` | No | | SSL configuration to use when connecting to the Docker socket. For a list ofavailable settings, refer to [SSL/TLS](/reference/fleet/elastic-agent-ssl-configuration.md), specificallythe settings under [Table 7, Common configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). | | `match_fields` | No | | List of fields to match a container ID. At least one of the fields most hold a container ID to get the event enriched. | | `match_pids` | No | `["process.pid", "process.parent.pid"]` | List of fields that contain process IDs. If the process is running in Docker, the event will be enriched. | | `match_source` | No | `true` | Whether to match the container ID from a log path present in the `log.file.path` field. | diff --git a/reference/ingestion-tools/fleet/add_fields-processor.md b/reference/fleet/add_fields-processor.md similarity index 94% rename from reference/ingestion-tools/fleet/add_fields-processor.md rename to reference/fleet/add_fields-processor.md index 5b85386d81..fcd1982e53 100644 --- a/reference/ingestion-tools/fleet/add_fields-processor.md +++ b/reference/fleet/add_fields-processor.md @@ -48,7 +48,7 @@ When the event is ingested by {{es}}, the document will have `op_type: "index"` ## Configuration settings [_configuration_settings_4] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_host_metadata-processor.md b/reference/fleet/add_host_metadata-processor.md similarity index 92% rename from reference/ingestion-tools/fleet/add_host_metadata-processor.md rename to reference/fleet/add_host_metadata-processor.md index ebd64ad687..a186401f66 100644 --- a/reference/ingestion-tools/fleet/add_host_metadata-processor.md +++ b/reference/fleet/add_host_metadata-processor.md @@ -15,7 +15,7 @@ Inputs that collect logs and metrics use this processor by default, so you do no The `add_host_metadata` processor annotates each event with relevant metadata from the host machine. ::::{note} -If you are using {{agent}} to monitor external system, use the [`add_observer_metadata`](/reference/ingestion-tools/fleet/add_observer_metadata-processor.md) processor instead of `add_host_metadata`. +If you are using {{agent}} to monitor external system, use the [`add_observer_metadata`](/reference/fleet/add_observer_metadata-processor.md) processor instead of `add_host_metadata`. :::: @@ -71,7 +71,7 @@ The fields added to the event look like this: ## Configuration settings [_configuration_settings_5] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_id-processor.md b/reference/fleet/add_id-processor.md similarity index 89% rename from reference/ingestion-tools/fleet/add_id-processor.md rename to reference/fleet/add_id-processor.md index b6dc2bb377..425fecce6c 100644 --- a/reference/ingestion-tools/fleet/add_id-processor.md +++ b/reference/fleet/add_id-processor.md @@ -20,7 +20,7 @@ The `add_id` processor generates a unique ID for an event. ## Configuration settings [_configuration_settings_6] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_kubernetes_metadata-processor.md b/reference/fleet/add_kubernetes_metadata-processor.md similarity index 99% rename from reference/ingestion-tools/fleet/add_kubernetes_metadata-processor.md rename to reference/fleet/add_kubernetes_metadata-processor.md index 170225524e..e39d3def6e 100644 --- a/reference/ingestion-tools/fleet/add_kubernetes_metadata-processor.md +++ b/reference/fleet/add_kubernetes_metadata-processor.md @@ -94,7 +94,7 @@ This configuration disables the default indexers and matchers, and then enables ## Configuration settings [_configuration_settings_7] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_labels-processor.md b/reference/fleet/add_labels-processor.md similarity index 92% rename from reference/ingestion-tools/fleet/add_labels-processor.md rename to reference/fleet/add_labels-processor.md index 63196bf03c..c81f6ef031 100644 --- a/reference/ingestion-tools/fleet/add_labels-processor.md +++ b/reference/fleet/add_labels-processor.md @@ -46,7 +46,7 @@ Adds these fields to every event: ## Configuration settings [_configuration_settings_8] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_locale-processor.md b/reference/fleet/add_locale-processor.md similarity index 92% rename from reference/ingestion-tools/fleet/add_locale-processor.md rename to reference/fleet/add_locale-processor.md index 33fed145b6..d9556eea85 100644 --- a/reference/ingestion-tools/fleet/add_locale-processor.md +++ b/reference/fleet/add_locale-processor.md @@ -34,7 +34,7 @@ The `add_locale` processor differentiates between daylight savings time (DST) an ## Configuration settings [_configuration_settings_9] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_network_direction-processor.md b/reference/fleet/add_network_direction-processor.md similarity index 83% rename from reference/ingestion-tools/fleet/add_network_direction-processor.md rename to reference/fleet/add_network_direction-processor.md index 5c6f5de0ba..375d126b67 100644 --- a/reference/ingestion-tools/fleet/add_network_direction-processor.md +++ b/reference/fleet/add_network_direction-processor.md @@ -24,7 +24,7 @@ The `add_network_direction` processor attempts to compute the perimeter-based ne ## Configuration settings [_configuration_settings_10] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -33,5 +33,5 @@ The `add_network_direction` processor attempts to compute the perimeter-based ne | `source` | Yes | | Source IP. | | `destination` | Yes | | Destination IP. | | `target` | Yes | | Target field where the network direction will be written. | -| `internal_networks` | Yes | | List of internal networks. The value can contain either CIDR blocks or a list of special values enumerated in the network section of [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions). | +| `internal_networks` | Yes | | List of internal networks. The value can contain either CIDR blocks or a list of special values enumerated in the network section of [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions). | diff --git a/reference/ingestion-tools/fleet/add_nomad_metadata-processor.md b/reference/fleet/add_nomad_metadata-processor.md similarity index 98% rename from reference/ingestion-tools/fleet/add_nomad_metadata-processor.md rename to reference/fleet/add_nomad_metadata-processor.md index 305de98330..852c75220b 100644 --- a/reference/ingestion-tools/fleet/add_nomad_metadata-processor.md +++ b/reference/fleet/add_nomad_metadata-processor.md @@ -32,7 +32,7 @@ Each event is annotated with the following information: ## Configuration settings [_configuration_settings_11] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_observer_metadata-processor.md b/reference/fleet/add_observer_metadata-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/add_observer_metadata-processor.md rename to reference/fleet/add_observer_metadata-processor.md index a382642d87..9c2bdb59b1 100644 --- a/reference/ingestion-tools/fleet/add_observer_metadata-processor.md +++ b/reference/fleet/add_observer_metadata-processor.md @@ -62,7 +62,7 @@ The fields added to the event look like this: ## Configuration settings [_configuration_settings_12] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_process_metadata-processor.md b/reference/fleet/add_process_metadata-processor.md similarity index 97% rename from reference/ingestion-tools/fleet/add_process_metadata-processor.md rename to reference/fleet/add_process_metadata-processor.md index 49a790566e..faf6984fa2 100644 --- a/reference/ingestion-tools/fleet/add_process_metadata-processor.md +++ b/reference/fleet/add_process_metadata-processor.md @@ -58,7 +58,7 @@ Optionally, the process environment can be included, too: ## Configuration settings [_configuration_settings_13] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/add_tags-processor.md b/reference/fleet/add_tags-processor.md similarity index 90% rename from reference/ingestion-tools/fleet/add_tags-processor.md rename to reference/fleet/add_tags-processor.md index ee10babe4b..0c98850b52 100644 --- a/reference/ingestion-tools/fleet/add_tags-processor.md +++ b/reference/fleet/add_tags-processor.md @@ -32,7 +32,7 @@ Adds the `environment` field to every event: ## Configuration settings [_configuration_settings_14] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/advanced-kubernetes-managed-by-fleet.md b/reference/fleet/advanced-kubernetes-managed-by-fleet.md similarity index 88% rename from reference/ingestion-tools/fleet/advanced-kubernetes-managed-by-fleet.md rename to reference/fleet/advanced-kubernetes-managed-by-fleet.md index 09789303d2..054e1f7be2 100644 --- a/reference/ingestion-tools/fleet/advanced-kubernetes-managed-by-fleet.md +++ b/reference/fleet/advanced-kubernetes-managed-by-fleet.md @@ -5,16 +5,16 @@ mapped_pages: # Advanced Elastic Agent configuration managed by Fleet [advanced-kubernetes-managed-by-fleet] -For basic {{agent}} managed by {{fleet}} scenarios follow the steps in [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md). +For basic {{agent}} managed by {{fleet}} scenarios follow the steps in [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md). -On managed {{agent}} installations it can be useful to provide the ability to configure more advanced options, such as the configuration of providers during the startup. Refer to [Providers](/reference/ingestion-tools/fleet/providers.md) for more details. +On managed {{agent}} installations it can be useful to provide the ability to configure more advanced options, such as the configuration of providers during the startup. Refer to [Providers](/reference/fleet/providers.md) for more details. Following steps demonstrate above scenario: ## Step 1: Download the {{agent}} manifest [_step_1_download_the_agent_manifest_2] -It is advisable to follow the steps of [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md) with Kubernetes Integration installed in your policy and download the {{agent}} manifest from Kibana UI +It is advisable to follow the steps of [Install {{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md) with Kubernetes Integration installed in your policy and download the {{agent}} manifest from Kibana UI :::{image} images/k8skibanaUI.png :alt: {{agent}} with K8s Package manifest @@ -65,7 +65,7 @@ data: --- ``` -1. Find more information about [Enrollment Tokens](/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md). +1. Find more information about [Enrollment Tokens](/reference/fleet/fleet-enrollment-tokens.md). ## Step 3: Configure Daemonset [_step_3_configure_daemonset] diff --git a/reference/ingestion-tools/fleet/agent-command-reference.md b/reference/fleet/agent-command-reference.md similarity index 96% rename from reference/ingestion-tools/fleet/agent-command-reference.md rename to reference/fleet/agent-command-reference.md index 730115ddb1..4d0dab4292 100644 --- a/reference/ingestion-tools/fleet/agent-command-reference.md +++ b/reference/fleet/agent-command-reference.md @@ -7,7 +7,7 @@ mapped_pages: # {{agent}} command reference [elastic-agent-cmd-options] -{{agent}} provides commands for running {{agent}}, managing {{fleet-server}}, and doing common tasks. The commands listed here apply to both [{{fleet}}-managed](/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md) and [standalone](/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md) {{agent}}. +{{agent}} provides commands for running {{agent}}, managing {{fleet-server}}, and doing common tasks. The commands listed here apply to both [{{fleet}}-managed](/reference/fleet/manage-elastic-agents-in-fleet.md) and [standalone](/reference/fleet/configure-standalone-elastic-agents.md) {{agent}}. ::::{admonition} Restrictions :class: important @@ -119,10 +119,10 @@ To enroll an {{agent}} *and* install it as a service, use the [`install` command We recommend that you run the `enroll` (or `install`) command as the root user because some integrations require root privileges to collect sensitive data. This command overwrites the `elastic-agent.yml` file in the agent directory. -This command includes optional flags to set up [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md). +This command includes optional flags to set up [{{fleet-server}}](/reference/fleet/fleet-server.md). ::::{important} -This command enrolls the {{agent}} in {{fleet}}; it does not start the agent. To start the agent, either [start the service](/reference/ingestion-tools/fleet/start-stop-elastic-agent.md#start-elastic-agent-service), if one exists, or use the [`run` command](#elastic-agent-run-command) to start the agent from a terminal. +This command enrolls the {{agent}} in {{fleet}}; it does not start the agent. To start the agent, either [start the service](/reference/fleet/start-stop-elastic-agent.md#start-elastic-agent-service), if one exists, or use the [`run` command](#elastic-agent-run-command) to start the agent from a terminal. :::: @@ -196,7 +196,7 @@ elastic-agent enroll --fleet-server-es 3. Required when enrolling in a {{fleet-server}} with custom certificates. The URL must match the DNS name used to generate the certificate specified by `--fleet-server-cert`. -For more information about custom certificates, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). +For more information about custom certificates, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). ### Options [_options_2] @@ -461,7 +461,7 @@ elastic-agent inspect components log-default Run {{agent}} with full superuser privileges. This is the usual, default running mode for {{agent}}. The `privileged` command allows you to switch back to running an agent with full administrative privileges when you have been running it in `unprivileged` mode. -Refer to [Run {{agent}} without administrative privileges](/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md) for more detail. +Refer to [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md) for more detail. ### Examples [_examples_13] @@ -483,7 +483,7 @@ If you installed {{agent}} from a DEB or RPM package, the `install` command will You must run this command as the root user (or Administrator on Windows) to write files to the correct locations. This command overwrites the `elastic-agent.yml` file in the agent directory. -The syntax for running this command varies by platform. For platform-specific examples, refer to [*Install {{agent}}s*](/reference/ingestion-tools/fleet/install-elastic-agents.md). +The syntax for running this command varies by platform. For platform-specific examples, refer to [*Install {{agent}}s*](/reference/fleet/install-elastic-agents.md). ### Synopsis [_synopsis_5] @@ -563,13 +563,13 @@ elastic-agent install --fleet-server-es 3. Required when enrolling in a {{fleet-server}} with custom certificates. The URL must match the DNS name used to generate the certificate specified by `--fleet-server-cert`. -For more information about custom certificates, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). +For more information about custom certificates, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). ### Options [_options_5] `--base-path ` -: Install {{agent}} in a location other than the [default](/reference/ingestion-tools/fleet/installation-layout.md). Specify the custom base path for the install. +: Install {{agent}} in a location other than the [default](/reference/fleet/installation-layout.md). Specify the custom base path for the install. The `--base-path` option is not currently supported with [{{elastic-defend}}](/solutions/security/configure-elastic-defend/install-elastic-defend.md). @@ -685,7 +685,7 @@ For more information about custom certificates, refer to [Configure SSL/TLS for `--privileged` : Run {{agent}} with full superuser privileges. This is the usual, default running mode for {{agent}}. The `--privileged` option allows you to switch back to running an agent with full administrative privileges when you have been running it in `unprivileged`. -See the `--unprivileged` option and [Run {{agent}} without administrative privileges](/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md) for more detail. +See the `--unprivileged` option and [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md) for more detail. `--proxy-disabled` : Disable proxy support including environment variables. @@ -708,7 +708,7 @@ See the `--unprivileged` option and [Run {{agent}} without administrative privil `--unprivileged` -: Run {{agent}} without full superuser privileges. This option is useful in organizations that limit `root` access on Linux or macOS systems, or `admin` access on Windows systems. For details and limitations for running {{agent}} in this mode, refer to [Run {{agent}} without administrative privileges](/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md). +: Run {{agent}} without full superuser privileges. This option is useful in organizations that limit `root` access on Linux or macOS systems, or `admin` access on Windows systems. For details and limitations for running {{agent}} in this mode, refer to [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md). Note that changing to `unprivileged` mode is prevented if the agent is currently enrolled in a policy that includes an integration that requires administrative access, such as the {{elastic-defend}} integration. @@ -786,7 +786,7 @@ This functionality is in technical preview and may be changed or removed in a fu :::: -Run {{agent}} as an [OpenTelemetry Collector](/reference/ingestion-tools/fleet/otel-agent.md). +Run {{agent}} as an [OpenTelemetry Collector](/reference/fleet/otel-agent.md). ### Synopsis [_synopsis_6] @@ -1049,7 +1049,7 @@ elastic-agent uninstall ## elastic-agent unprivileged [elastic-agent-unprivileged-command] -Run {{agent}} without full superuser privileges. This is useful in organizations that limit `root` access on Linux or macOS systems, or `admin` access on Windows systems. For details and limitations for running {{agent}} in this mode, refer to [Run {{agent}} without administrative privileges](/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md). +Run {{agent}} without full superuser privileges. This is useful in organizations that limit `root` access on Linux or macOS systems, or `admin` access on Windows systems. For details and limitations for running {{agent}} in this mode, refer to [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md). Note that changing a running {{agent}} to `unprivileged` mode is prevented if the agent is currently enrolled with a policy that contains the {{elastic-defend}} integration. @@ -1110,7 +1110,7 @@ elastic-agent upgrade [--source-uri ] [--help] [flags] `--help` : Show help for the `upgrade` command. -For details about using the `--skip-verify`, `--pgp-path `, and `--pgp-uri ` package verification options, refer to [Verifying {{agent}} package signatures](/reference/ingestion-tools/fleet/upgrade-standalone.md#upgrade-standalone-verify-package). +For details about using the `--skip-verify`, `--pgp-path `, and `--pgp-uri ` package verification options, refer to [Verifying {{agent}} package signatures](/reference/fleet/upgrade-standalone.md#upgrade-standalone-verify-package). For more flags, see [Global flags](#elastic-agent-global-flags). diff --git a/reference/ingestion-tools/fleet/agent-environment-variables.md b/reference/fleet/agent-environment-variables.md similarity index 99% rename from reference/ingestion-tools/fleet/agent-environment-variables.md rename to reference/fleet/agent-environment-variables.md index 3597d0b456..45eca433cf 100644 --- a/reference/ingestion-tools/fleet/agent-environment-variables.md +++ b/reference/fleet/agent-environment-variables.md @@ -32,7 +32,7 @@ These common variables are useful, for example, when using the same {{es}} and { | $$$env=common-kibana-username$$$
`KIBANA_USERNAME`
| (string) The basic authentication username used to connect to {{kib}} to retrieve a `service_token`.

**Default:** `elastic`
| | $$$env=common-kibana-password$$$
`KIBANA_PASSWORD`
| (string) The basic authentication password used to connect to {{kib}} to retrieve a `service_token`.

**Default:** `changeme`
| | $$$env-common-kibana-ca$$$
`KIBANA_CA`
| (string) The path to a certificate authority.

By default, {{agent}} uses the list of trusted certificate authorities (CA) from the operating system where it is running. If the certificate authority that signed your node certificates is not in the host system’s trusted certificate authorities list, use this config to add the path to the `.pem` file that contains your CA’s certificate.

**Default:** `""`
| -| $$$env-common-elastic-netinfo$$$
`ELASTIC_NETINFO`
| (bool) When `false`, disables `netinfo.enabled` parameter of `add_host_metadata` processor. Setting this to `false` is recommended for large scale setups where the host.ip and host.mac fields index size increases.

By default, {{agent}} initializes the `add_host_metadata` processor. The `netinfo.enabled` parameter defines ingestion of IP addresses and MAC addresses as fields `host.ip` and `host.mac`. For more information see [add_host_metadata](/reference/ingestion-tools/fleet/add_host_metadata-processor.md)

**Default:** `"false"`
| +| $$$env-common-elastic-netinfo$$$
`ELASTIC_NETINFO`
| (bool) When `false`, disables `netinfo.enabled` parameter of `add_host_metadata` processor. Setting this to `false` is recommended for large scale setups where the host.ip and host.mac fields index size increases.

By default, {{agent}} initializes the `add_host_metadata` processor. The `netinfo.enabled` parameter defines ingestion of IP addresses and MAC addresses as fields `host.ip` and `host.mac`. For more information see [add_host_metadata](/reference/fleet/add_host_metadata-processor.md)

**Default:** `"false"`
| ## Prepare {{kib}} for {{fleet}} [env-prepare-kibana-for-fleet] diff --git a/reference/ingestion-tools/fleet/agent-health-status.md b/reference/fleet/agent-health-status.md similarity index 82% rename from reference/ingestion-tools/fleet/agent-health-status.md rename to reference/fleet/agent-health-status.md index c65fe21c77..9a99353b25 100644 --- a/reference/ingestion-tools/fleet/agent-health-status.md +++ b/reference/fleet/agent-health-status.md @@ -5,7 +5,7 @@ mapped_pages: # Elastic Agent health status [agent-health-status] -The {{agent}} [monitoring documentation](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) describes the features available through the {{fleet}} UI for you to view {{agent}} status and activity, access metrics and diagnostics, enable alerts, and more. +The {{agent}} [monitoring documentation](/reference/fleet/monitor-elastic-agent.md) describes the features available through the {{fleet}} UI for you to view {{agent}} status and activity, access metrics and diagnostics, enable alerts, and more. For details about how the {{agent}} status is monitored by {{fleet}}, including connectivity, check-in frequency, and similar, see the following: @@ -42,12 +42,12 @@ No. The health monitoring of {{agent}} and its inputs, as reported in {{fleet}}, ## If {{agent}} goes down, is an alert generated by {{fleet}}? [agent-health-status-outage] -No. Alerts would have to be created in {{kib}} on the indices that show the total count of agents at each specific state. Refer to [Enable alerts and ML jobs based on {{fleet}} and {{agent}} status](/reference/ingestion-tools/fleet/monitor-elastic-agent.md#fleet-alerting) in the {{agent}} monitoring documentation for the steps to configure alerting. Generating alerts on status change on individual agents is currently planned for a future release. +No. Alerts would have to be created in {{kib}} on the indices that show the total count of agents at each specific state. Refer to [Enable alerts and ML jobs based on {{fleet}} and {{agent}} status](/reference/fleet/monitor-elastic-agent.md#fleet-alerting) in the {{agent}} monitoring documentation for the steps to configure alerting. Generating alerts on status change on individual agents is currently planned for a future release. ## How long does it take for {{agent}} to report a status change? [agent-health-status-report-timing] -Some {{agent}} states are reported immediately, such as when the agent has become `Unhealthy`. Some other states are derived after a certain criteria is met. Refer to [View agent status overview](/reference/ingestion-tools/fleet/monitor-elastic-agent.md#view-agent-status) in the {{agent}} monitoring documentation for details about monitoring agent status. +Some {{agent}} states are reported immediately, such as when the agent has become `Unhealthy`. Some other states are derived after a certain criteria is met. Refer to [View agent status overview](/reference/fleet/monitor-elastic-agent.md#view-agent-status) in the {{agent}} monitoring documentation for details about monitoring agent status. -Transition from an `Offline` state to an `Inactive` state is configurable by the user and that transition can be fine tuned by [Setting the inactivity timeout parameter](/reference/ingestion-tools/fleet/set-inactivity-timeout.md). +Transition from an `Offline` state to an `Inactive` state is configurable by the user and that transition can be fine tuned by [Setting the inactivity timeout parameter](/reference/fleet/set-inactivity-timeout.md). diff --git a/reference/ingestion-tools/fleet/agent-policy.md b/reference/fleet/agent-policy.md similarity index 96% rename from reference/ingestion-tools/fleet/agent-policy.md rename to reference/fleet/agent-policy.md index a55bc608e1..2ec9151e57 100644 --- a/reference/ingestion-tools/fleet/agent-policy.md +++ b/reference/fleet/agent-policy.md @@ -77,7 +77,7 @@ In {{fleet}}, open the **Agent policies** tab and click **Create agent policy**. * To use the {{fleet}} API, click **Preview API request** and run the request. -Also see [Create an agent policy without using the UI](/reference/ingestion-tools/fleet/create-policy-no-ui.md). +Also see [Create an agent policy without using the UI](/reference/fleet/create-policy-no-ui.md). ## Add an integration to a policy [add-integration] @@ -244,7 +244,7 @@ When you enable this setting, you need to provide the host URL and port where th When the HTTP monitoring endpoint is enabled you can also select to **Enable profiling at `/debug/pprof`**. This controls whether the {{agent}} exposes the `/debug/pprof/` endpoints together with the monitoring endpoints. -The heap profiles available from `/debug/pprof/` are included in [{{agent}} diagnostics](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-diagnostics-command) by default. CPU profiles are also included when the `--cpu-profile` option is included. For full details about the profiles exposed by `/debug/pprof/` refer to the [pprof package documentation](https://pkg.go.dev/net/http/pprof). +The heap profiles available from `/debug/pprof/` are included in [{{agent}} diagnostics](/reference/fleet/agent-command-reference.md#elastic-agent-diagnostics-command) by default. CPU profiles are also included when the `--cpu-profile` option is included. For full details about the profiles exposed by `/debug/pprof/` refer to the [pprof package documentation](https://pkg.go.dev/net/http/pprof). Profiling at `/debug/pprof` is disabled by default. Data produced by these endpoints can be useful for debugging but present a security risk. It’s recommended to leave this option disabled if the monitoring endpoint is accessible over a network. @@ -261,7 +261,7 @@ This setting configures retries for the file upload client handling diagnostics Assuming your [{{stack}} subscription level](https://www.elastic.co/subscriptions) supports per-policy outputs, you can change the output of a policy to send data to a different output. -1. In {{fleet}}, click **Settings** and view the list of available outputs. If necessary, click **Add output** to add a new output with the settings you require. For more information, refer to [Output settings](/reference/ingestion-tools/fleet/fleet-settings.md#output-settings). +1. In {{fleet}}, click **Settings** and view the list of available outputs. If necessary, click **Add output** to add a new output with the settings you require. For more information, refer to [Output settings](/reference/fleet/fleet-settings.md#output-settings). 2. Click **Agent policies**. Click the name of the policy you want to change, then click **Settings**. 3. Set **Output for integrations** and (optionally) **Output for agent monitoring** to use a different output, for example, {{ls}}. You might need to scroll down to see these options. @@ -348,18 +348,18 @@ You can also set the log level for an individual agent: {{agent}}s must be able to access the {{artifact-registry}} to download binaries during upgrades. By default {{agent}}s download artifacts from the artifact registry at `https://artifacts.elastic.co/downloads/`. -For {{agent}}s that cannot access the internet, you can specify agent binary download settings, and then configure agents to download their artifacts from the alternate location. For more information about running {{agent}}s in a restricted environment, refer to [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +For {{agent}}s that cannot access the internet, you can specify agent binary download settings, and then configure agents to download their artifacts from the alternate location. For more information about running {{agent}}s in a restricted environment, refer to [Air-gapped environments](/reference/fleet/air-gapped.md). To change the binary download location: 1. In {{fleet}}, click **Agent policies**. Select the name of the policy you want to edit. 2. Click the **Settings** tab and scroll to **Agent binary download**. -3. Specify the address where you are hosting the artifacts repository or select the default to use the location specified in the {{fleet}} [agent binary download settings](/reference/ingestion-tools/fleet/fleet-settings.md#fleet-agent-binary-download-settings). +3. Specify the address where you are hosting the artifacts repository or select the default to use the location specified in the {{fleet}} [agent binary download settings](/reference/fleet/fleet-settings.md#fleet-agent-binary-download-settings). ## Set the {{agent}} host name format [fleet-agent-hostname-format-settings] -The **Host name format** setting controls the format of information provided about the current host through the [host.name](/reference/ingestion-tools/fleet/host-provider.md) key, in events produced by {{agent}}. +The **Host name format** setting controls the format of information provided about the current host through the [host.name](/reference/fleet/host-provider.md) key, in events produced by {{agent}}. 1. In {{fleet}}, click **Agent policies**. Select the name of the policy you want to edit. 2. Click the **Settings** tab and scroll to **Host name format**. diff --git a/reference/ingestion-tools/fleet/agent-processors.md b/reference/fleet/agent-processors.md similarity index 100% rename from reference/ingestion-tools/fleet/agent-processors.md rename to reference/fleet/agent-processors.md diff --git a/reference/ingestion-tools/fleet/agent-provider.md b/reference/fleet/agent-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/agent-provider.md rename to reference/fleet/agent-provider.md diff --git a/reference/ingestion-tools/fleet/air-gapped.md b/reference/fleet/air-gapped.md similarity index 95% rename from reference/ingestion-tools/fleet/air-gapped.md rename to reference/fleet/air-gapped.md index a6f8172aa1..a56a4d938f 100644 --- a/reference/ingestion-tools/fleet/air-gapped.md +++ b/reference/fleet/air-gapped.md @@ -89,13 +89,13 @@ If you can route traffic to the public endpoint of the {{package-registry}} thro xpack.fleet.registryProxyUrl: your-nat-gateway.corp.net ``` -For more information, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md). +For more information, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/fleet/fleet-agent-proxy-support.md). ## Host your own {{package-registry}} [air-gapped-diy-epr] ::::{note} -The {{package-registry}} packages include signatures used in [package verification](/reference/ingestion-tools/fleet/package-signatures.md). By default, {{fleet}} uses the Elastic public GPG key to verify package signatures. If you ever need to change this GPG key, use the `xpack.fleet.packageVerification.gpgKeyPath` setting in `kibana.yml`. For more information, refer to [{{fleet}} settings](kibana://reference/configuration-reference/fleet-settings.md). +The {{package-registry}} packages include signatures used in [package verification](/reference/fleet/package-signatures.md). By default, {{fleet}} uses the Elastic public GPG key to verify package signatures. If you ever need to change this GPG key, use the `xpack.fleet.packageVerification.gpgKeyPath` setting in `kibana.yml`. For more information, refer to [{{fleet}} settings](kibana://reference/configuration-reference/fleet-settings.md). :::: @@ -286,7 +286,7 @@ To make binaries available in an air-gapped environment, you can host your own c 2. Add the agent binary download location to {{fleet}} settings: 1. Open **{{fleet}} → Settings**. - 2. Under **Agent Binary Download**, click **Add agent binary source** to add the location of your artifact registry. For more detail about these settings, refer to [Agent binary download settings](/reference/ingestion-tools/fleet/fleet-settings.md#fleet-agent-binary-download-settings). If you want all {{agent}}s to download binaries from this location, set it as the default. + 2. Under **Agent Binary Download**, click **Add agent binary source** to add the location of your artifact registry. For more detail about these settings, refer to [Agent binary download settings](/reference/fleet/fleet-settings.md#fleet-agent-binary-download-settings). If you want all {{agent}}s to download binaries from this location, set it as the default. 3. If your artifact registry is not the default, edit your agent policies to override the default: @@ -297,4 +297,4 @@ To make binaries available in an air-gapped environment, you can host your own c When you trigger an upgrade for any {{agent}}s enrolled in the policy, the binaries are downloaded from your artifact registry instead of the public repository. -**Not using {{fleet}}?** For standalone {{agent}}s, you can set the binary download location under `agent.download.sourceURI` in the [`elastic-agent.yml`](/reference/ingestion-tools/fleet/elastic-agent-reference-yaml.md) file, or run the [`elastic-agent upgrade`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-upgrade-command) command with the `--source-uri` flag specified. +**Not using {{fleet}}?** For standalone {{agent}}s, you can set the binary download location under `agent.download.sourceURI` in the [`elastic-agent.yml`](/reference/fleet/elastic-agent-reference-yaml.md) file, or run the [`elastic-agent upgrade`](/reference/fleet/agent-command-reference.md#elastic-agent-upgrade-command) command with the `--source-uri` flag specified. diff --git a/reference/ingestion-tools/fleet/certificates-rotation.md b/reference/fleet/certificates-rotation.md similarity index 92% rename from reference/ingestion-tools/fleet/certificates-rotation.md rename to reference/fleet/certificates-rotation.md index 62968310c7..43b9b8f392 100644 --- a/reference/ingestion-tools/fleet/certificates-rotation.md +++ b/reference/fleet/certificates-rotation.md @@ -22,7 +22,7 @@ Using this method, the {{agent}} with an old or expiring CA configured will be r 1. Update the {{agent}} with the new {{fleet-server}} CA: - The {{agent}} should already have a CA configured. Use the [`elastic-agent enroll`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-enroll-command) command to re-enroll the agent with an updated, comma separated set of CAs to use. + The {{agent}} should already have a CA configured. Use the [`elastic-agent enroll`](/reference/fleet/agent-command-reference.md#elastic-agent-enroll-command) command to re-enroll the agent with an updated, comma separated set of CAs to use. ```shell elastic-agent enroll \ @@ -138,13 +138,13 @@ To update the {{agent}} and {{fleet-server}} configurations: ## Rotating an {{es}} CA for connections from {{fleet-server}} [certificates-rotation-fs-es] -{{fleet-server}} communicates with {{es}} to send status information to {{fleet}} about {{agent}}s and to retrieve updated policies to ship out to all {{agent}}s enrolled in a given policy. If you have {{fleet-server}} [deployed on-premise](/reference/ingestion-tools/fleet/deployment-models.md), you may wish to rotate your configured CA certificate, for instance if the certificate is due to expire. +{{fleet-server}} communicates with {{es}} to send status information to {{fleet}} about {{agent}}s and to retrieve updated policies to ship out to all {{agent}}s enrolled in a given policy. If you have {{fleet-server}} [deployed on-premise](/reference/fleet/deployment-models.md), you may wish to rotate your configured CA certificate, for instance if the certificate is due to expire. To rotate a CA certificate on {{es}} for connections from {{fleet-server}}: 1. Update the {{fleet-server}} with the new {{fleet-server}} CA: - The {{agent}} running {{fleet-server}} should already have a CA configured. Use the [`elastic-agent enroll`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-enroll-command) command to re-enroll the agent running {{fleet-server}} with an updated, comma separated set of CAs to use. + The {{agent}} running {{fleet-server}} should already have a CA configured. Use the [`elastic-agent enroll`](/reference/fleet/agent-command-reference.md#elastic-agent-enroll-command) command to re-enroll the agent running {{fleet-server}} with an updated, comma separated set of CAs to use. ```shell elastic-agent enroll \ diff --git a/reference/ingestion-tools/fleet/community_id-processor.md b/reference/fleet/community_id-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/community_id-processor.md rename to reference/fleet/community_id-processor.md index 2ae10d6228..8f02a480d0 100644 --- a/reference/ingestion-tools/fleet/community_id-processor.md +++ b/reference/fleet/community_id-processor.md @@ -42,7 +42,7 @@ If the necessary fields are not present in the event, the processor silently con ## Configuration settings [_configuration_settings_15] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/conditions-based-autodiscover.md b/reference/fleet/conditions-based-autodiscover.md similarity index 92% rename from reference/ingestion-tools/fleet/conditions-based-autodiscover.md rename to reference/fleet/conditions-based-autodiscover.md index 8410eb6987..397b410111 100644 --- a/reference/ingestion-tools/fleet/conditions-based-autodiscover.md +++ b/reference/fleet/conditions-based-autodiscover.md @@ -5,14 +5,14 @@ mapped_pages: # Conditions based autodiscover [conditions-based-autodiscover] -You can define autodiscover conditions in each input to allow {{agent}} to automatically identify Pods and start monitoring them using predefined integrations. Refer to [Inputs](/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md) to get an idea. +You can define autodiscover conditions in each input to allow {{agent}} to automatically identify Pods and start monitoring them using predefined integrations. Refer to [Inputs](/reference/fleet/elastic-agent-input-configuration.md) to get an idea. ::::{important} Condition definition is supported both in **{{agent}} managed by {{fleet}}** and in **standalone** scenarios. :::: -For more information about variables and conditions in input configurations, refer to [Variables and conditions in input configurations](/reference/ingestion-tools/fleet/dynamic-input-configuration.md). You can find available variables of autodiscovery in [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md). +For more information about variables and conditions in input configurations, refer to [Variables and conditions in input configurations](/reference/fleet/dynamic-input-configuration.md). You can find available variables of autodiscovery in [Kubernetes Provider](/reference/fleet/kubernetes-provider.md). ## Example: Target Pods by label [_example_target_pods_by_label] @@ -45,7 +45,7 @@ To automatically identify a Redis Pod and monitor it with the Redis integration, The condition `${kubernetes.labels.app} == 'redis'` will make the {{agent}} look for a Pod with the label `app:redis` within the scope defined in its manifest. -For a list of provider fields that you can use in conditions, refer to [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md). Some examples of conditions usage are: +For a list of provider fields that you can use in conditions, refer to [Kubernetes Provider](/reference/fleet/kubernetes-provider.md). Some examples of conditions usage are: 1. For a pod with label `app.kubernetes.io/name=ingress-nginx` the condition should be `condition: ${kubernetes.labels.app.kubernetes.io/name} == "ingress-nginx"`. 2. For a pod with annotation `prometheus.io/scrape: "true"` the condition should be `${kubernetes.annotations.prometheus.io/scrape} == "true"`. @@ -77,7 +77,7 @@ spec: You should now be able to see Redis data flowing in on index `metrics-redis.info-default`. Make sure the port in your Redis manifest file matches the port used in the Redis input. ::::{note} -All assets (dashboards, ingest pipelines, and so on) related to the Redis integration are not installed. You need to explicitly [install them through {{kib}}](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md). +All assets (dashboards, ingest pipelines, and so on) related to the Redis integration are not installed. You need to explicitly [install them through {{kib}}](/reference/fleet/install-uninstall-integration-assets.md). :::: @@ -98,7 +98,7 @@ Conditions can also be used in inputs configuration in order to set the target h ``` ::::{note} -Pods' labels and annotations can be used in autodiscover conditions. In the case of labels or annotations that include dots(`.`), they can be used in conditions exactly as they are defined in the pods. For example `condition: ${kubernetes.labels.app.kubernetes.io/name} == 'ingress-nginx'`. This should not be confused with the dedoted (by default) labels and annotations stored into Elasticsearch([Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md)). +Pods' labels and annotations can be used in autodiscover conditions. In the case of labels or annotations that include dots(`.`), they can be used in conditions exactly as they are defined in the pods. For example `condition: ${kubernetes.labels.app.kubernetes.io/name} == 'ingress-nginx'`. This should not be confused with the dedoted (by default) labels and annotations stored into Elasticsearch([Kubernetes Provider](/reference/fleet/kubernetes-provider.md)). :::: @@ -122,7 +122,7 @@ kubectl exec -n kube-system --stdin --tty elastic-agent-standalone-id -- /bin/ba Do not forget to change the `elastic-agent-standalone-id` to your {{agent}} Pod’s name. Moreover, make sure that your Pod is inside `kube-system`. If not, change `-n kube-system` to the correct namespace. -Inside the container [inspect the output](/reference/ingestion-tools/fleet/agent-command-reference.md) of the configuration file you used for the {{agent}}: +Inside the container [inspect the output](/reference/fleet/agent-command-reference.md) of the configuration file you used for the {{agent}}: ```sh elastic-agent inspect --variables --variables-wait 1s -c /etc/elastic-agent/agent.yml diff --git a/reference/ingestion-tools/fleet/config-file-example-apache.md b/reference/fleet/config-file-example-apache.md similarity index 74% rename from reference/ingestion-tools/fleet/config-file-example-apache.md rename to reference/fleet/config-file-example-apache.md index 0056d080b0..cb350497d1 100644 --- a/reference/ingestion-tools/fleet/config-file-example-apache.md +++ b/reference/fleet/config-file-example-apache.md @@ -65,16 +65,16 @@ inputs: <7> - add_locale: null ``` -1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md). -2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/ingestion-tools/fleet/elasticsearch-output.md). +1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/fleet/elastic-agent-output-configuration.md). +2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/fleet/elasticsearch-output.md). 3. The URL of the Elasticsearch cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -4. An [API key](/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. -5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/ingestion-tools/fleet/elastic-agent-standalone-download.md). -6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md). -7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md). +4. An [API key](/reference/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. +5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/fleet/elastic-agent-standalone-download.md). +6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/fleet/elastic-agent-monitoring-configuration.md). +7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/fleet/elastic-agent-input-configuration.md). 8. Specify a unique ID for the input. -9. For available input types, refer to [{{agent}} inputs](/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md). -10. Learn about [Data streams](/reference/ingestion-tools/fleet/data-streams.md) for time series data. +9. For available input types, refer to [{{agent}} inputs](/reference/fleet/elastic-agent-inputs-list.md). +10. Learn about [Data streams](/reference/fleet/data-streams.md) for time series data. 11. Specify a unique ID for each individual input stream. Naming the ID by appending the associated `data_stream` dataset (for example `{{user-defined-unique-id}}-apache.access` or `{{user-defined-unique-id}}-apache.error`) is a recommended practice, but any unique ID will work. 12. Refer to [Logs](integration-docs://reference/apache/index.md) in the Apache HTTP Server integration documentation for the logs available to ingest and exported fields. 13. Path to the log files to be monitored. @@ -117,15 +117,15 @@ inputs: <7> server_status_path: /server-status ``` -1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md). -2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/ingestion-tools/fleet/elasticsearch-output.md). +1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/fleet/elastic-agent-output-configuration.md). +2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/fleet/elasticsearch-output.md). 3. The URL of the Elasticsearch cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -4. An [API key](/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. -5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/ingestion-tools/fleet/elastic-agent-standalone-download.md). -6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md). -7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md). -8. For available input types, refer to [{{agent}} inputs](/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md). -9. Learn about [Data streams](/reference/ingestion-tools/fleet/data-streams.md) for time series data. +4. An [API key](/reference/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. +5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/fleet/elastic-agent-standalone-download.md). +6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/fleet/elastic-agent-monitoring-configuration.md). +7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/fleet/elastic-agent-input-configuration.md). +8. For available input types, refer to [{{agent}} inputs](/reference/fleet/elastic-agent-inputs-list.md). +9. Learn about [Data streams](/reference/fleet/data-streams.md) for time series data. 10. Specify a unique ID for each individual input stream. Naming the ID by appending the associated `data_stream` dataset (for example `{{user-defined-unique-id}}-apache.status`) is a recommended practice, but any unique ID will work. 11. A user-defined dataset. You can specify anything that makes sense to signify the source of the data. 12. Refer to [Metrics](integration-docs://reference/apache/index.md) in the Apache HTTP Server integration documentation for the type of metrics collected and exported fields. diff --git a/reference/ingestion-tools/fleet/config-file-example-nginx.md b/reference/fleet/config-file-example-nginx.md similarity index 75% rename from reference/ingestion-tools/fleet/config-file-example-nginx.md rename to reference/fleet/config-file-example-nginx.md index 43d3011b7a..fadb5d3acc 100644 --- a/reference/ingestion-tools/fleet/config-file-example-nginx.md +++ b/reference/fleet/config-file-example-nginx.md @@ -70,16 +70,16 @@ inputs: <7> - add_locale: null ``` -1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md). -2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/ingestion-tools/fleet/elasticsearch-output.md). +1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/fleet/elastic-agent-output-configuration.md). +2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/fleet/elasticsearch-output.md). 3. The URL of the {{es}} cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -4. An [API key](/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. -5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/ingestion-tools/fleet/elastic-agent-standalone-download.md). -6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md). -7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md). +4. An [API key](/reference/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. +5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/fleet/elastic-agent-standalone-download.md). +6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/fleet/elastic-agent-monitoring-configuration.md). +7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/fleet/elastic-agent-input-configuration.md). 8. A user-defined ID to uniquely identify the input stream. -9. For available input types, refer to [{{agent}} inputs](/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md). -10. Learn about [Data streams](/reference/ingestion-tools/fleet/data-streams.md) for time series data. +9. For available input types, refer to [{{agent}} inputs](/reference/fleet/elastic-agent-inputs-list.md). +10. Learn about [Data streams](/reference/fleet/data-streams.md) for time series data. 11. Specify a unique ID for each individual input stream. Naming the ID by appending the associated `data_stream` dataset (for example `{{user-defined-unique-id}}-nginx.access` or `{{user-defined-unique-id}}-nginx.error`) is a recommended practice, but any unique ID will work. 12. Refer to [Logs reference](integration-docs://reference/nginx/index.md#logs-reference) in the Nginx HTTP integration documentation for the logs available to ingest and exported fields. 13. Path to the log files to be monitored. @@ -123,16 +123,16 @@ inputs: <7> server_status_path: /nginx_status ``` -1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md). -2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/ingestion-tools/fleet/elasticsearch-output.md). +1. For available output settings, refer to [Configure outputs for standalone {{agents}}](/reference/fleet/elastic-agent-output-configuration.md). +2. For settings specific to the {{es}} output, refer to [Configure the {{es}} output](/reference/fleet/elasticsearch-output.md). 3. The URL of the Elasticsearch cluster where output should be sent, including the port number. For example `https://12345ab6789cd12345ab6789cd.us-central1.gcp.cloud.es.io:443`. -4. An [API key](/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. -5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/ingestion-tools/fleet/elastic-agent-standalone-download.md). -6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md). -7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md). +4. An [API key](/reference/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) used to authenticate with the {{es}} cluster. +5. For available download settings, refer to [Configure download settings for standalone Elastic Agent upgrades](/reference/fleet/elastic-agent-standalone-download.md). +6. For available monitoring settings, refer to [Configure monitoring for standalone {{agents}}](/reference/fleet/elastic-agent-monitoring-configuration.md). +7. For available input settings, refer to [Configure inputs for standalone {{agents}}](/reference/fleet/elastic-agent-input-configuration.md). 8. A user-defined ID to uniquely identify the input stream. -9. For available input types, refer to [{{agent}} inputs](/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md). -10. Learn about [Data streams](/reference/ingestion-tools/fleet/data-streams.md) for time series data. +9. For available input types, refer to [{{agent}} inputs](/reference/fleet/elastic-agent-inputs-list.md). +10. Learn about [Data streams](/reference/fleet/data-streams.md) for time series data. 11. Specify a unique ID for each individual input stream. Naming the ID by appending the associated `data_stream` dataset (for example `{{user-defined-unique-id}}-nginx.stubstatus`) is a recommended practice, but any unique ID will work. 12. A user-defined dataset. You can specify anything that makes sense to signify the source of the data. 13. Refer to [Metrics reference](integration-docs://reference/nginx/index.md#metrics-reference) in the Nginx integration documentation for the type of metrics collected and exported fields. diff --git a/reference/ingestion-tools/fleet/config-file-examples.md b/reference/fleet/config-file-examples.md similarity index 50% rename from reference/ingestion-tools/fleet/config-file-examples.md rename to reference/fleet/config-file-examples.md index 586cdc5933..a54933b4b1 100644 --- a/reference/ingestion-tools/fleet/config-file-examples.md +++ b/reference/fleet/config-file-examples.md @@ -5,10 +5,10 @@ mapped_pages: # Config file examples [config-file-examples] -These examples show a basic, sample configuration to include in a standalone {{agent}} `elastic-agent.yml` [configuration file](/reference/ingestion-tools/fleet/structure-config-file.md) to gather data from various source types. +These examples show a basic, sample configuration to include in a standalone {{agent}} `elastic-agent.yml` [configuration file](/reference/fleet/structure-config-file.md) to gather data from various source types. -* [Apache HTTP Server](/reference/ingestion-tools/fleet/config-file-example-apache.md) -* [Nginx HTTP Server](/reference/ingestion-tools/fleet/config-file-example-apache.md) +* [Apache HTTP Server](/reference/fleet/config-file-example-apache.md) +* [Nginx HTTP Server](/reference/fleet/config-file-example-apache.md) diff --git a/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md b/reference/fleet/configure-standalone-elastic-agents.md similarity index 79% rename from reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md rename to reference/fleet/configure-standalone-elastic-agents.md index 36aa27da5a..39922d565e 100644 --- a/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md +++ b/reference/fleet/configure-standalone-elastic-agents.md @@ -6,15 +6,15 @@ mapped_pages: # Configure standalone Elastic Agents [elastic-agent-configuration] ::::{tip} -To get started quickly, use {{kib}} to create and download a standalone policy file. You’ll still need to deploy and manage the file, though. For more information, refer to [Create a standalone {{agent}} policy](/reference/ingestion-tools/fleet/create-standalone-agent-policy.md) or try out our example: [Use standalone {{agent}} to monitor nginx](/reference/ingestion-tools/fleet/example-standalone-monitor-nginx.md). +To get started quickly, use {{kib}} to create and download a standalone policy file. You’ll still need to deploy and manage the file, though. For more information, refer to [Create a standalone {{agent}} policy](/reference/fleet/create-standalone-agent-policy.md) or try out our example: [Use standalone {{agent}} to monitor nginx](/reference/fleet/example-standalone-monitor-nginx.md). :::: Standalone {{agent}}s are manually configured and managed locally on the systems where they are installed. They are useful when you are not interested in centrally managing agents in {{fleet}}, either due to your company’s security requirements, or because you prefer to use another configuration management system. -To configure standalone {{agent}}s, specify settings in the `elastic-agent.yml` policy file deployed with the agent. Prior to installation, the file is located in the extracted {{agent}} package. After installation, the file is copied to the directory described in [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md). To apply changes after installation, you must modify the installed file. +To configure standalone {{agent}}s, specify settings in the `elastic-agent.yml` policy file deployed with the agent. Prior to installation, the file is located in the extracted {{agent}} package. After installation, the file is copied to the directory described in [Installation layout](/reference/fleet/installation-layout.md). To apply changes after installation, you must modify the installed file. -For installation details, refer to [Install standalone {{agent}}s](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md). +For installation details, refer to [Install standalone {{agent}}s](/reference/fleet/install-standalone-elastic-agent.md). Alternatively, you can put input configurations in YAML files into the folder `{path.config}/inputs.d` to separate your configuration into multiple smaller files. The YAML files in the `inputs.d` folder should contain input configurations only. Any other configurations are ignored. The files are reloaded at the same time as the standalone configuration. @@ -40,7 +40,7 @@ inputs: data_stream.dataset: system.cpu ``` -The following sections describe some settings you might need to configure to run an {{agent}} standalone. For a full reference example, refer to the [elastic-agent.reference.yml](/reference/ingestion-tools/fleet/elastic-agent-reference-yaml.md) file. +The following sections describe some settings you might need to configure to run an {{agent}} standalone. For a full reference example, refer to the [elastic-agent.reference.yml](/reference/fleet/elastic-agent-reference-yaml.md) file. The settings described here are available for standalone {{agent}}s. Settings for {{fleet}}-managed agents are specified through the UI. You do not set them explicitly in a policy file. diff --git a/reference/ingestion-tools/fleet/configuring-kubernetes-metadata.md b/reference/fleet/configuring-kubernetes-metadata.md similarity index 78% rename from reference/ingestion-tools/fleet/configuring-kubernetes-metadata.md rename to reference/fleet/configuring-kubernetes-metadata.md index 757175eb5e..d4dcc3d23b 100644 --- a/reference/ingestion-tools/fleet/configuring-kubernetes-metadata.md +++ b/reference/fleet/configuring-kubernetes-metadata.md @@ -9,21 +9,21 @@ Kubernetes [metadata](/solutions/observability/infra-and-hosts/tutorial-observe- When the {{agent}}'s policy includes the [{{k8s}} Integration](integration-docs://reference/kubernetes/index.md) which configures the collection of Kubernetes related metrics and container logs, the mechanisms used for the metadata enrichment are: -* [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) for log collection +* [Kubernetes Provider](/reference/fleet/kubernetes-provider.md) for log collection * Kubernetes metadata enrichers for metrics -In case the {{agent}}'s policy does not include the Kubernetes integration, but {{agent}} runs inside a Kubernetes environment, the Kubernetes metadata are collected by the [add_kubernetes_metadata](/reference/ingestion-tools/fleet/add_kubernetes_metadata-processor.md). The processor is configurable when {{agent}} is managed by {{fleet}}. +In case the {{agent}}'s policy does not include the Kubernetes integration, but {{agent}} runs inside a Kubernetes environment, the Kubernetes metadata are collected by the [add_kubernetes_metadata](/reference/fleet/add_kubernetes_metadata-processor.md). The processor is configurable when {{agent}} is managed by {{fleet}}. ## Kubernetes Logs [_kubernetes_logs] -When it comes to container logs collection, the [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) is used. It monitors for pod resources in the cluster and associates each container log file with a corresponding pod’s container object. That way, when a log file is parsed and an event is ready to be published to {{es}}, the internal mechanism knows to which actual container this log file belongs. The linkage is established by the container’s ID, which forms an integral part of the filename for the log. The Kubernetes autodiscover provider has already collected all the metadata for that container, leveraging pod, namespace and node watchers. Thus, the events are enriched with the relevant metadata. +When it comes to container logs collection, the [Kubernetes Provider](/reference/fleet/kubernetes-provider.md) is used. It monitors for pod resources in the cluster and associates each container log file with a corresponding pod’s container object. That way, when a log file is parsed and an event is ready to be published to {{es}}, the internal mechanism knows to which actual container this log file belongs. The linkage is established by the container’s ID, which forms an integral part of the filename for the log. The Kubernetes autodiscover provider has already collected all the metadata for that container, leveraging pod, namespace and node watchers. Thus, the events are enriched with the relevant metadata. -In order to configure the metadata collection, the Kubernetes provider needs to be configured. All the available configuration options of the **Kubernetes provider** can be found in the [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) documentation. +In order to configure the metadata collection, the Kubernetes provider needs to be configured. All the available configuration options of the **Kubernetes provider** can be found in the [Kubernetes Provider](/reference/fleet/kubernetes-provider.md) documentation. * For **Standalone {{agent}} configuration:** -Follow information of `add_resource_metadata` parameter of [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) +Follow information of `add_resource_metadata` parameter of [Kubernetes Provider](/reference/fleet/kubernetes-provider.md) ```yaml apiVersion: v1 @@ -54,7 +54,7 @@ data: * **Managed {{agent}} configuration**: -The Kubernetes provider can be configured following the steps in [Advanced {{agent}} configuration managed by {{fleet}}](/reference/ingestion-tools/fleet/advanced-kubernetes-managed-by-fleet.md). +The Kubernetes provider can be configured following the steps in [Advanced {{agent}} configuration managed by {{fleet}}](/reference/fleet/advanced-kubernetes-managed-by-fleet.md). ## Kubernetes metrics [_kubernetes_metrics] @@ -105,7 +105,7 @@ add_resource_metadata block needs to be configured to all datasets that are enab #cronjob: false ``` -The `add_resource_metadata` block configures the watcher’s enrichment functionality. See [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) for full description of add_resource_metadata. Same configuration parameters apply. +The `add_resource_metadata` block configures the watcher’s enrichment functionality. See [Kubernetes Provider](/reference/fleet/kubernetes-provider.md) for full description of add_resource_metadata. Same configuration parameters apply. ## Note [_note] diff --git a/reference/ingestion-tools/fleet/convert-processor.md b/reference/fleet/convert-processor.md similarity index 97% rename from reference/ingestion-tools/fleet/convert-processor.md rename to reference/fleet/convert-processor.md index 874e68845f..5349359e90 100644 --- a/reference/ingestion-tools/fleet/convert-processor.md +++ b/reference/fleet/convert-processor.md @@ -29,7 +29,7 @@ The `ip` type is effectively an alias for `string`, but with an added validation ## Configuration settings [_configuration_settings_16] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/copy_fields-processor.md b/reference/fleet/copy_fields-processor.md similarity index 85% rename from reference/ingestion-tools/fleet/copy_fields-processor.md rename to reference/fleet/copy_fields-processor.md index bc53d43eda..4a08031125 100644 --- a/reference/ingestion-tools/fleet/copy_fields-processor.md +++ b/reference/fleet/copy_fields-processor.md @@ -9,7 +9,7 @@ mapped_pages: The `copy_fields` processor takes the value of a field and copies it to a new field. -You cannot use this processor to replace an existing field. If the target field already exists, you must [drop](/reference/ingestion-tools/fleet/drop_fields-processor.md) or [rename](/reference/ingestion-tools/fleet/rename-processor.md) the field before using `copy_fields`. +You cannot use this processor to replace an existing field. If the target field already exists, you must [drop](/reference/fleet/drop_fields-processor.md) or [rename](/reference/fleet/rename-processor.md) the field before using `copy_fields`. ## Example [_example_14] @@ -40,7 +40,7 @@ Copies the original `message` field to `event.original`: ## Configuration settings [_configuration_settings_17] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/create-policy-no-ui.md b/reference/fleet/create-policy-no-ui.md similarity index 98% rename from reference/ingestion-tools/fleet/create-policy-no-ui.md rename to reference/fleet/create-policy-no-ui.md index 206ee72dbe..cfdb91c2da 100644 --- a/reference/ingestion-tools/fleet/create-policy-no-ui.md +++ b/reference/fleet/create-policy-no-ui.md @@ -23,7 +23,7 @@ In this API call: * `sys_monitoring=true` adds the system integration to the agent policy * `monitoring_enabled` turns on {{agent}} monitoring -For more information, refer to [{{kib}} {{fleet}} APIs](/reference/ingestion-tools/fleet/fleet-api-docs.md). +For more information, refer to [{{kib}} {{fleet}} APIs](/reference/fleet/fleet-api-docs.md). ## Option 2. Create agent policies with preconfiguration [use-preconfiguration-to-create-policy] diff --git a/reference/ingestion-tools/fleet/create-standalone-agent-policy.md b/reference/fleet/create-standalone-agent-policy.md similarity index 96% rename from reference/ingestion-tools/fleet/create-standalone-agent-policy.md rename to reference/fleet/create-standalone-agent-policy.md index 5f262cfcb5..416cc50aa2 100644 --- a/reference/ingestion-tools/fleet/create-standalone-agent-policy.md +++ b/reference/fleet/create-standalone-agent-policy.md @@ -55,7 +55,7 @@ The downloaded policy already contains a default {{es}} address and port for you If you need to add integrations to the policy *after* deploying it, you’ll need to run through these steps again and re-deploy the updated policy to the host where {{agent}} is running. -For detailed information about starting the agent, including the permissions needed for the {{es}} user, refer to [Install standalone {{agent}}s](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md). +For detailed information about starting the agent, including the permissions needed for the {{es}} user, refer to [Install standalone {{agent}}s](/reference/fleet/install-standalone-elastic-agent.md). ## Upgrade standalone agent policies after upgrading an integration [update-standalone-policies] @@ -70,5 +70,5 @@ To update your standalone policy, use the same steps you used to create and down 2. Either use the new policy and apply your customizations to it, or update your old policy to include changes, such as field changes, added by the upgrade. ::::{important} -Make sure you update the standalone agent policy in the directory where {{agent}} is running, not the directory where you downloaded the installation package. Refer to [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md) for the location of installed {{agent}} files. +Make sure you update the standalone agent policy in the directory where {{agent}} is running, not the directory where you downloaded the installation package. Refer to [Installation layout](/reference/fleet/installation-layout.md) for the location of installed {{agent}} files. :::: diff --git a/reference/ingestion-tools/fleet/data-streams-advanced-features.md b/reference/fleet/data-streams-advanced-features.md similarity index 96% rename from reference/ingestion-tools/fleet/data-streams-advanced-features.md rename to reference/fleet/data-streams-advanced-features.md index 164fdf4502..00a58a8267 100644 --- a/reference/ingestion-tools/fleet/data-streams-advanced-features.md +++ b/reference/fleet/data-streams-advanced-features.md @@ -15,7 +15,7 @@ mapped_pages: These features can be enabled and disabled for {{fleet}}-managed data streams by using the index template API and a few key settings. Note that in versions 8.17.0 and later, Synthetic `_source` requires an Enterprise license. ::::{note} -If you are already making use of `@custom` component templates for ingest or retention customization (as shown for example in [Tutorial: Customize data retention policies](/reference/ingestion-tools/fleet/data-streams-ilm-tutorial.md)), exercise care to ensure you don’t overwrite your customizations when making these requests. +If you are already making use of `@custom` component templates for ingest or retention customization (as shown for example in [Tutorial: Customize data retention policies](/reference/fleet/data-streams-ilm-tutorial.md)), exercise care to ensure you don’t overwrite your customizations when making these requests. :::: diff --git a/reference/ingestion-tools/fleet/data-streams-ilm-tutorial.md b/reference/fleet/data-streams-ilm-tutorial.md similarity index 67% rename from reference/ingestion-tools/fleet/data-streams-ilm-tutorial.md rename to reference/fleet/data-streams-ilm-tutorial.md index adeb76b45d..01a803a53f 100644 --- a/reference/ingestion-tools/fleet/data-streams-ilm-tutorial.md +++ b/reference/fleet/data-streams-ilm-tutorial.md @@ -21,6 +21,6 @@ For certain features you’ll need to use a slightly different procedure to mana How you apply an ILM policy depends on your use case. Choose a scenario for the detailed steps. -* **[Scenario 1](/reference/ingestion-tools/fleet/data-streams-scenario1.md)**: You want to apply an ILM policy to all logs or metrics data streams across all namespaces. -* **[Scenario 2](/reference/ingestion-tools/fleet/data-streams-scenario2.md)**: You want to apply an ILM policy to selected data streams in an integration. -* **[Scenario 3](/reference/ingestion-tools/fleet/data-streams-scenario3.md)**: You want apply an ILM policy for data streams in a selected namespace in an integration. +* **[Scenario 1](/reference/fleet/data-streams-scenario1.md)**: You want to apply an ILM policy to all logs or metrics data streams across all namespaces. +* **[Scenario 2](/reference/fleet/data-streams-scenario2.md)**: You want to apply an ILM policy to selected data streams in an integration. +* **[Scenario 3](/reference/fleet/data-streams-scenario3.md)**: You want apply an ILM policy for data streams in a selected namespace in an integration. diff --git a/reference/ingestion-tools/fleet/data-streams-pipeline-tutorial.md b/reference/fleet/data-streams-pipeline-tutorial.md similarity index 98% rename from reference/ingestion-tools/fleet/data-streams-pipeline-tutorial.md rename to reference/fleet/data-streams-pipeline-tutorial.md index 81767bbf64..046f6db458 100644 --- a/reference/ingestion-tools/fleet/data-streams-pipeline-tutorial.md +++ b/reference/fleet/data-streams-pipeline-tutorial.md @@ -206,4 +206,4 @@ Let’s create a new custom ingest pipeline `logs@custom` that processes all log With the new pipeline applied, this query should return at least one document. -You can modify your pipeline API request as needed to apply custom processing at various levels. Refer to [Ingest pipelines](/reference/ingestion-tools/fleet/data-streams.md#data-streams-pipelines) to learn more. +You can modify your pipeline API request as needed to apply custom processing at various levels. Refer to [Ingest pipelines](/reference/fleet/data-streams.md#data-streams-pipelines) to learn more. diff --git a/reference/ingestion-tools/fleet/data-streams-scenario1.md b/reference/fleet/data-streams-scenario1.md similarity index 100% rename from reference/ingestion-tools/fleet/data-streams-scenario1.md rename to reference/fleet/data-streams-scenario1.md diff --git a/reference/ingestion-tools/fleet/data-streams-scenario2.md b/reference/fleet/data-streams-scenario2.md similarity index 100% rename from reference/ingestion-tools/fleet/data-streams-scenario2.md rename to reference/fleet/data-streams-scenario2.md diff --git a/reference/ingestion-tools/fleet/data-streams-scenario3.md b/reference/fleet/data-streams-scenario3.md similarity index 92% rename from reference/ingestion-tools/fleet/data-streams-scenario3.md rename to reference/fleet/data-streams-scenario3.md index 692c7912f2..19504971cb 100644 --- a/reference/ingestion-tools/fleet/data-streams-scenario3.md +++ b/reference/fleet/data-streams-scenario3.md @@ -25,7 +25,7 @@ The **Data Streams** view in {{kib}} shows you the data streams, index templates 1. Navigate to **{{stack-manage-app}}** > **Index Management** > **Data Streams**. 2. Search for `system` to see all data streams associated with the System integration. -3. Select the `metrics-system.network-{{namespace}}` data stream to view its associated index template and {{ilm-init}} policy. As you can see, the data stream follows the [Data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme) and starts with its type, `metrics-`. +3. Select the `metrics-system.network-{{namespace}}` data stream to view its associated index template and {{ilm-init}} policy. As you can see, the data stream follows the [Data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme) and starts with its type, `metrics-`. :::{image} images/data-stream-info.png :alt: Data streams info @@ -75,9 +75,9 @@ metrics-system.network-production@custom Now that you’ve created a component template, you need to create an index template to apply the changes to the correct data stream. The easiest way to do this is to duplicate and modify the integration’s existing index template. ::::{warning} -Please note the following: * When duplicating the index template, do not change or remove any managed properties. This may result in problems when upgrading. Cloning the index template of an integration package involves some risk as any changes made to the original index template when it is upgraded will not be propagated to the cloned version. * These steps assume that you want to have a namespace specific ILM policy, which requires index template cloning. Cloning the index template of an integration package involves some risk because any changes made to the original index template as part of package upgrades are not propagated to the cloned version. See [Cloning the index template of an integration package](/reference/ingestion-tools/fleet/integrations-assets-best-practices.md#assets-restrictions-cloning-index-template) for details. +Please note the following: * When duplicating the index template, do not change or remove any managed properties. This may result in problems when upgrading. Cloning the index template of an integration package involves some risk as any changes made to the original index template when it is upgraded will not be propagated to the cloned version. * These steps assume that you want to have a namespace specific ILM policy, which requires index template cloning. Cloning the index template of an integration package involves some risk because any changes made to the original index template as part of package upgrades are not propagated to the cloned version. See [Cloning the index template of an integration package](/reference/fleet/integrations-assets-best-practices.md#assets-restrictions-cloning-index-template) for details. -+ If you want to change the ILM Policy, the number of shards, or other settings for the datastreams of one or more integrations, but **the changes do not need to be specific to a given namespace**, it’s strongly recommended to use a `@custom` component template, as described in [Scenario 1](/reference/ingestion-tools/fleet/data-streams-scenario1.md) and [Scenario 2](/reference/ingestion-tools/fleet/data-streams-scenario2.md), so as to avoid the problems mentioned above. See the [ILM](/reference/ingestion-tools/fleet/data-streams.md#data-streams-ilm) section for details. ++ If you want to change the ILM Policy, the number of shards, or other settings for the datastreams of one or more integrations, but **the changes do not need to be specific to a given namespace**, it’s strongly recommended to use a `@custom` component template, as described in [Scenario 1](/reference/fleet/data-streams-scenario1.md) and [Scenario 2](/reference/fleet/data-streams-scenario2.md), so as to avoid the problems mentioned above. See the [ILM](/reference/fleet/data-streams.md#data-streams-ilm) section for details. :::: diff --git a/reference/ingestion-tools/fleet/data-streams.md b/reference/fleet/data-streams.md similarity index 98% rename from reference/ingestion-tools/fleet/data-streams.md rename to reference/fleet/data-streams.md index ba37329619..866dd4a8f0 100644 --- a/reference/ingestion-tools/fleet/data-streams.md +++ b/reference/fleet/data-streams.md @@ -135,7 +135,7 @@ Use the [index lifecycle management](/manage-data/lifecycle/index-lifecycle-mana Installed integrations may have one or many associated data streams—​each with an associated {{ilm-init}} policy. By default, these data streams use an {{ilm-init}} policy that matches their data type. For example, the data stream `metrics-system.logs-*`, uses the metrics {{ilm-init}} policy as defined in the `metrics-system.logs` index template. -Want to customize your index lifecycle management? See [Tutorials: Customize data retention policies](/reference/ingestion-tools/fleet/data-streams-ilm-tutorial.md). +Want to customize your index lifecycle management? See [Tutorials: Customize data retention policies](/reference/fleet/data-streams-ilm-tutorial.md). ## Ingest pipelines [data-streams-pipelines] @@ -255,4 +255,4 @@ Refer to the breaking change in the 8.12.0 Release Notes for more detail and wor :::: -See [Tutorial: Transform data with custom ingest pipelines](/reference/ingestion-tools/fleet/data-streams-pipeline-tutorial.md) to get started. +See [Tutorial: Transform data with custom ingest pipelines](/reference/fleet/data-streams-pipeline-tutorial.md) to get started. diff --git a/reference/ingestion-tools/fleet/debug-standalone-agents.md b/reference/fleet/debug-standalone-agents.md similarity index 88% rename from reference/ingestion-tools/fleet/debug-standalone-agents.md rename to reference/fleet/debug-standalone-agents.md index 2a27f38475..12bf22188f 100644 --- a/reference/ingestion-tools/fleet/debug-standalone-agents.md +++ b/reference/fleet/debug-standalone-agents.md @@ -41,14 +41,14 @@ Components: By default, this command returns the status in human-readable format. Use the `--output` flag to change it to `json` or `yaml`. -For more information about this command, refer to [elastic-agent status](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-status-command). +For more information about this command, refer to [elastic-agent status](/reference/fleet/agent-command-reference.md#elastic-agent-status-command). ## Inspect {{agent}} and related logs [inspect-standalone-agent-logs] If the {{agent}} status is unhealthy, or behaving unexpectedly, inspect the logs of the running {{agent}}. -The log location varies by platform. {{agent}} logs are in the folders described in [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md). {{beats}} and {{fleet-server}} logs are in folders named for the output (for example, `default`). +The log location varies by platform. {{agent}} logs are in the folders described in [Installation layout](/reference/fleet/installation-layout.md). {{beats}} and {{fleet-server}} logs are in folders named for the output (for example, `default`). Start by investigating any errors you see in the {{agent}} and related logs. Also look for repeated lines that might indicate problems like connection issues. If the {{agent}} and related logs look clean, check the host operating system logs for out of memory (OOM) errors related to the {{agent}} or any of its processes. @@ -73,14 +73,14 @@ agent.logging.files: permissions: 0600 ``` -For other log settings, refer to [Logging](/reference/ingestion-tools/fleet/elastic-agent-standalone-logging-config.md). +For other log settings, refer to [Logging](/reference/fleet/elastic-agent-standalone-logging-config.md). ## Expose /debug/pprof/ endpoints with the monitoring endpoint [expose-debug-endpoint] Profiling data produced by the `/debug/pprof/` endpoints can be useful for debugging, but presents a security risk. Do not expose these endpoints if the monitoring endpoint is accessible over a network. (By default, the monitoring endpoint is bound to a local Unix socket or Windows npipe and not accessible over a network.) -To expose the `/debug/pprof/` endpoints, set `agent.monitoring.pprof: true` in the `elastic-agent.yml` file. For more information about monitoring settings, refer to [Monitoring](/reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md). +To expose the `/debug/pprof/` endpoints, set `agent.monitoring.pprof: true` in the `elastic-agent.yml` file. For more information about monitoring settings, refer to [Monitoring](/reference/fleet/elastic-agent-monitoring-configuration.md). After exposing the endpoints, you can access the HTTP handler bound to a socket for {{beats}} or the {{agent}}. For example: @@ -179,7 +179,7 @@ Returns something like: ## Inspect the {{agent}} configuration [inspect-configuration] -To inspect the running {{agent}} configuration use the [elastic-agent inspect](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-inspect-command) command. +To inspect the running {{agent}} configuration use the [elastic-agent inspect](/reference/fleet/agent-command-reference.md#elastic-agent-inspect-command) command. To analyze the current state of the agent, inspect log files, and see the configuration of {{agent}} and the sub-processes it starts, run the `diagnostics` command. For example: @@ -187,5 +187,5 @@ To analyze the current state of the agent, inspect log files, and see the config elastic-agent diagnostics ``` -For more information about this command, refer to [elastic-agent diagnostics](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-diagnostics-command). +For more information about this command, refer to [elastic-agent diagnostics](/reference/fleet/agent-command-reference.md#elastic-agent-diagnostics-command). diff --git a/reference/ingestion-tools/fleet/decode-json-fields.md b/reference/fleet/decode-json-fields.md similarity index 97% rename from reference/ingestion-tools/fleet/decode-json-fields.md rename to reference/fleet/decode-json-fields.md index 2bc78badae..a3e0b08fd7 100644 --- a/reference/ingestion-tools/fleet/decode-json-fields.md +++ b/reference/fleet/decode-json-fields.md @@ -26,7 +26,7 @@ The `decode_json_fields` processor decodes fields containing JSON strings and re ## Configuration settings [_configuration_settings_22] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/decode_base64_field-processor.md b/reference/fleet/decode_base64_field-processor.md similarity index 89% rename from reference/ingestion-tools/fleet/decode_base64_field-processor.md rename to reference/fleet/decode_base64_field-processor.md index e00d9b5144..f2990396d8 100644 --- a/reference/ingestion-tools/fleet/decode_base64_field-processor.md +++ b/reference/fleet/decode_base64_field-processor.md @@ -29,7 +29,7 @@ In this example, `field1` is decoded in `field2`. ## Configuration settings [_configuration_settings_18] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -39,5 +39,5 @@ In this example, `field1` is decoded in `field2`. | `ignore_missing` | No | `false` | Whether to ignore missing keys. If `true`, missing keys that should be base64 decoded are ignored and no error is logged. If `false`, an error is logged and the behavior of `fail_on_error` is applied. | | `fail_on_error` | No | `true` | Whether to fail if an error occurs. If `true` and an error occurs, an error is logged and the event is dropped. If `false`, an error is logged, but the event is not modified. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. diff --git a/reference/ingestion-tools/fleet/decode_cef-processor.md b/reference/fleet/decode_cef-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/decode_cef-processor.md rename to reference/fleet/decode_cef-processor.md index 090bc00bca..94f369ea3f 100644 --- a/reference/ingestion-tools/fleet/decode_cef-processor.md +++ b/reference/fleet/decode_cef-processor.md @@ -31,7 +31,7 @@ In this example, the `message` field is decoded as CEF after it is renamed to `e ## Configuration settings [_configuration_settings_19] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/decode_csv_fields-processor.md b/reference/fleet/decode_csv_fields-processor.md similarity index 97% rename from reference/ingestion-tools/fleet/decode_csv_fields-processor.md rename to reference/fleet/decode_csv_fields-processor.md index 59cd5dad5e..c57129039d 100644 --- a/reference/ingestion-tools/fleet/decode_csv_fields-processor.md +++ b/reference/fleet/decode_csv_fields-processor.md @@ -37,7 +37,7 @@ This processor only works with log inputs. ## Configuration settings [_configuration_settings_20] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/decode_duration-processor.md b/reference/fleet/decode_duration-processor.md similarity index 100% rename from reference/ingestion-tools/fleet/decode_duration-processor.md rename to reference/fleet/decode_duration-processor.md diff --git a/reference/ingestion-tools/fleet/decode_xml-processor.md b/reference/fleet/decode_xml-processor.md similarity index 94% rename from reference/ingestion-tools/fleet/decode_xml-processor.md rename to reference/fleet/decode_xml-processor.md index dc7c0f9192..9dad5555d9 100644 --- a/reference/ingestion-tools/fleet/decode_xml-processor.md +++ b/reference/fleet/decode_xml-processor.md @@ -73,7 +73,7 @@ Will produce the following output: ## Configuration settings [_configuration_settings_23] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -87,5 +87,5 @@ Will produce the following output: | `ignore_missing` | No | `false` | Whether to return an error if a specified field does not exist. | | `ignore_failure` | No | `false` | Whether to ignore all errors produced by the processor. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. diff --git a/reference/ingestion-tools/fleet/decode_xml_wineventlog-processor.md b/reference/fleet/decode_xml_wineventlog-processor.md similarity index 98% rename from reference/ingestion-tools/fleet/decode_xml_wineventlog-processor.md rename to reference/fleet/decode_xml_wineventlog-processor.md index 3580d531ac..bd37420bf0 100644 --- a/reference/ingestion-tools/fleet/decode_xml_wineventlog-processor.md +++ b/reference/fleet/decode_xml_wineventlog-processor.md @@ -83,13 +83,13 @@ Will produce the following output: } ``` -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. ## Configuration settings [_configuration_settings_24] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/decompress_gzip_field-processor.md b/reference/fleet/decompress_gzip_field-processor.md similarity index 89% rename from reference/ingestion-tools/fleet/decompress_gzip_field-processor.md rename to reference/fleet/decompress_gzip_field-processor.md index f8510ca159..0fda133eef 100644 --- a/reference/ingestion-tools/fleet/decompress_gzip_field-processor.md +++ b/reference/fleet/decompress_gzip_field-processor.md @@ -29,7 +29,7 @@ In this example, `field1` is decompressed in `field2`. ## Configuration settings [_configuration_settings_25] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -39,5 +39,5 @@ In this example, `field1` is decompressed in `field2`. | `ignore_missing` | No | `false` | Whether to ignore missing keys. If `true`, no error is logged if a key that should be decompressed is missing. | | `fail_on_error` | No | `true` | If `true` and an error occurs, decompression of fields is stopped, and the original event is returned. If `false`, decompression continues even if an error occurs during decoding. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. diff --git a/reference/ingestion-tools/fleet/deployment-models.md b/reference/fleet/deployment-models.md similarity index 70% rename from reference/ingestion-tools/fleet/deployment-models.md rename to reference/fleet/deployment-models.md index 77cd70c20f..fddf8d836c 100644 --- a/reference/ingestion-tools/fleet/deployment-models.md +++ b/reference/fleet/deployment-models.md @@ -7,7 +7,7 @@ mapped_pages: There are various models for setting up {{agents}} to work with {{es}}. The recommended approach is to use {{fleet}}, a web-based UI in Kibana, to centrally manage all of your {{agents}} and their policies. Using {{fleet}} requires having an instance of {{fleet-server}} that acts as the interface between the {{fleet}} UI and your {{agents}}. -For an overview of {{fleet-server}}, including details about how it communicates with {{es}}, how to ensure high availability, and more, refer to [What is {{fleet-server}}?](/reference/ingestion-tools/fleet/fleet-server.md). +For an overview of {{fleet-server}}, including details about how it communicates with {{es}}, how to ensure high availability, and more, refer to [What is {{fleet-server}}?](/reference/fleet/fleet-server.md). The requirements for setting up {{fleet-server}} differ, depending on your particular deployment model: @@ -15,19 +15,19 @@ The requirements for setting up {{fleet-server}} differ, depending on your parti : In a [{{serverless-short}}](/deploy-manage/deploy/elastic-cloud/serverless.md) environment, {{fleet-server}} is offered as a service, it is configured and scaled automatically without the need for any user intervention. {{ech}} -: If you’re running {{es}} and {{kib}} with [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md), no extra setup is required unless you want to scale your deployment. {{ech}} runs a hosted version of {{integrations-server}} that includes {{fleet-server}}. For details about this deployment model, refer to [Deploy on {{ecloud}}](/reference/ingestion-tools/fleet/add-fleet-server-cloud.md). +: If you’re running {{es}} and {{kib}} with [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md), no extra setup is required unless you want to scale your deployment. {{ech}} runs a hosted version of {{integrations-server}} that includes {{fleet-server}}. For details about this deployment model, refer to [Deploy on {{ecloud}}](/reference/fleet/add-fleet-server-cloud.md). {{ech}} with {{fleet-server}} on-premise -: When you use an {{ech}} deployment you may still choose to run {{fleet-server}} on-premise. For details about this deployment model and set up instructions, refer to [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/ingestion-tools/fleet/add-fleet-server-mixed.md). +: When you use an {{ech}} deployment you may still choose to run {{fleet-server}} on-premise. For details about this deployment model and set up instructions, refer to [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/fleet/add-fleet-server-mixed.md). Docker and Kubernetes -: You can deploy {{fleet}}-managed {{agent}} in Docker or on Kubernetes. Refer to [Run {{agent}} in a container](/reference/ingestion-tools/fleet/elastic-agent-container.md) or [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) for all of the configuration instructions. For a Kubernetes install we also have a [Helm chart](/reference/ingestion-tools/fleet/install-on-kubernetes-using-helm.md) available to simplify the installation. Details for configuring {{fleet-server}} are included with the {{agent}} install steps. +: You can deploy {{fleet}}-managed {{agent}} in Docker or on Kubernetes. Refer to [Run {{agent}} in a container](/reference/fleet/elastic-agent-container.md) or [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) for all of the configuration instructions. For a Kubernetes install we also have a [Helm chart](/reference/fleet/install-on-kubernetes-using-helm.md) available to simplify the installation. Details for configuring {{fleet-server}} are included with the {{agent}} install steps. {{eck}} : You can deploy {{fleet}}-managed {{agent}} in an {{ecloud}} Kubernetes environment that provides configuration and management capabilities for the full {{stack}}. For details, refer to [Run {{fleet}}-managed {{agent}} on ECK](/deploy-manage/deploy/cloud-on-k8s/fleet-managed-elastic-agent.md). Self-managed -: For self-managed deployments, you must install and host {{fleet-server}} yourself. For details about this deployment model and set up instructions, refer to [Deploy on-premises and self-managed](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md). +: For self-managed deployments, you must install and host {{fleet-server}} yourself. For details about this deployment model and set up instructions, refer to [Deploy on-premises and self-managed](/reference/fleet/add-fleet-server-on-prem.md). diff --git a/reference/ingestion-tools/fleet/detect_mime_type-processor.md b/reference/fleet/detect_mime_type-processor.md similarity index 86% rename from reference/ingestion-tools/fleet/detect_mime_type-processor.md rename to reference/fleet/detect_mime_type-processor.md index 70059fefb0..acc8b2b042 100644 --- a/reference/ingestion-tools/fleet/detect_mime_type-processor.md +++ b/reference/fleet/detect_mime_type-processor.md @@ -24,7 +24,7 @@ In this example, `http.request.body.content` is used as the source, and `http.re ## Configuration settings [_configuration_settings_26] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -33,5 +33,5 @@ In this example, `http.request.body.content` is used as the source, and `http.re | `field` | Yes | | Field used as the data source. | | `target` | Yes | | Field to populate with the detected type. You can use the `@metadata.` prefixto set the value in the event metadata instead of fields. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. diff --git a/reference/ingestion-tools/fleet/dissect-processor.md b/reference/fleet/dissect-processor.md similarity index 95% rename from reference/ingestion-tools/fleet/dissect-processor.md rename to reference/fleet/dissect-processor.md index 98a060a7b0..415cc3967f 100644 --- a/reference/ingestion-tools/fleet/dissect-processor.md +++ b/reference/fleet/dissect-processor.md @@ -25,7 +25,7 @@ For a full example, see [Dissect example](#dissect-example). ## Configuration settings [_configuration_settings_27] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -46,7 +46,7 @@ A key can contain any characters except reserved suffix or prefix modifiers: `/ :::: -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. ## Dissect example [dissect-example] diff --git a/reference/ingestion-tools/fleet/dns-processor.md b/reference/fleet/dns-processor.md similarity index 98% rename from reference/ingestion-tools/fleet/dns-processor.md rename to reference/fleet/dns-processor.md index b09bf01fdc..156dc166a4 100644 --- a/reference/ingestion-tools/fleet/dns-processor.md +++ b/reference/fleet/dns-processor.md @@ -55,7 +55,7 @@ This examples shows all configuration options. ## Configuration settings [_configuration_settings_28] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/docker-provider.md b/reference/fleet/docker-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/docker-provider.md rename to reference/fleet/docker-provider.md diff --git a/reference/ingestion-tools/fleet/drop_event-processor.md b/reference/fleet/drop_event-processor.md similarity index 73% rename from reference/ingestion-tools/fleet/drop_event-processor.md rename to reference/fleet/drop_event-processor.md index b5c3206b17..4de5daacb9 100644 --- a/reference/ingestion-tools/fleet/drop_event-processor.md +++ b/reference/fleet/drop_event-processor.md @@ -18,10 +18,10 @@ The `drop_event` processor drops the entire event if the associated condition is condition ``` -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/drop_fields-processor.md b/reference/fleet/drop_fields-processor.md similarity index 88% rename from reference/ingestion-tools/fleet/drop_fields-processor.md rename to reference/fleet/drop_fields-processor.md index 227f0121ff..49d2f395e8 100644 --- a/reference/ingestion-tools/fleet/drop_fields-processor.md +++ b/reference/fleet/drop_fields-processor.md @@ -29,7 +29,7 @@ If you define an empty list of fields under `drop_fields`, no fields are dropped ## Configuration settings [_configuration_settings_29] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -38,5 +38,5 @@ If you define an empty list of fields under `drop_fields`, no fields are dropped | `fields` | Yes | | If non-empty, a list of matching field names will be removed. Any element in array can contain a regular expression delimited by two slashes (*/reg_exp/*), in order to match (name) and remove more than one field. | | `ignore_missing` | No | `false` | If `true`, the processor ignores missing fields and does not return an error. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. diff --git a/reference/ingestion-tools/fleet/dynamic-input-configuration.md b/reference/fleet/dynamic-input-configuration.md similarity index 99% rename from reference/ingestion-tools/fleet/dynamic-input-configuration.md rename to reference/fleet/dynamic-input-configuration.md index adacac3b45..63c266b442 100644 --- a/reference/ingestion-tools/fleet/dynamic-input-configuration.md +++ b/reference/fleet/dynamic-input-configuration.md @@ -53,7 +53,7 @@ The syntax for variable substitution is `${var}`, where `var` is the name of a v All providers are enabled by default when {{agent}} starts. If a provider cannot be configured, its variables are ignored. -Refer to [Providers](/reference/ingestion-tools/fleet/providers.md) for more detail. +Refer to [Providers](/reference/fleet/providers.md) for more detail. The following agent policy uses a custom key named `foo` to resolve a value defined by a local provider: diff --git a/reference/ingestion-tools/fleet/edit-delete-integration-policy.md b/reference/fleet/edit-delete-integration-policy.md similarity index 100% rename from reference/ingestion-tools/fleet/edit-delete-integration-policy.md rename to reference/fleet/edit-delete-integration-policy.md diff --git a/reference/ingestion-tools/fleet/elastic-agent-container.md b/reference/fleet/elastic-agent-container.md similarity index 95% rename from reference/ingestion-tools/fleet/elastic-agent-container.md rename to reference/fleet/elastic-agent-container.md index ad8b3c8e66..bbc150c6c2 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-container.md +++ b/reference/fleet/elastic-agent-container.md @@ -115,10 +115,10 @@ docker run \ 1. Set to 1 to enroll the {{agent}} into {{fleet-server}}. 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. -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/ingestion-tools/fleet/create-policy-no-ui.md). +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). 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/apps/get-started.md) for more information. -Refer to [Environment variables](/reference/ingestion-tools/fleet/agent-environment-variables.md) for all available options. +Refer to [Environment variables](/reference/fleet/agent-environment-variables.md) for all available options. ::: :::{tab-item} Self-managed @@ -137,12 +137,12 @@ docker run \ 1. Set to 1 to bootstrap Fleet Server on this Elastic Agent. 2. Your cluster’s {{es}} host URL. -3. The {{fleet}} service token. [Generate one in the {{fleet}} UI](/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md#create-fleet-enrollment-tokens) if you don’t have one already. -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/ingestion-tools/fleet/create-policy-no-ui.md). +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. +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). 5. publish container port 8220 to host. 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/apps/get-started.md) for more information. -Refer to [Environment variables](/reference/ingestion-tools/fleet/agent-environment-variables.md) for all available options. +Refer to [Environment variables](/reference/fleet/agent-environment-variables.md) for all available options. ::: :::: @@ -203,7 +203,7 @@ You can also add `type=tmpfs` to the mount parameter (`--mount type=tmpfs,destin ::: 3. To view data flowing in, go to **Analytics → Discover** and select the index `metrics-*`, or even more specific, `metrics-kubernetes.*`. If you can’t see these indexes, [create a data view](/explore-analyze/find-and-organize/data-views.md) for them. -4. To view predefined dashboards, either select **Analytics→Dashboard** or [install assets through an integration](/reference/ingestion-tools/fleet/view-integration-assets.md). +4. To view predefined dashboards, either select **Analytics→Dashboard** or [install assets through an integration](/reference/fleet/view-integration-assets.md). ## Docker compose [_docker_compose] @@ -236,7 +236,7 @@ If you need to run {{fleet-server}} as well, adjust the docker-compose file abov - FLEET_SERVER_SERVICE_TOKEN= ``` -Refer to [Environment variables](/reference/ingestion-tools/fleet/agent-environment-variables.md) for all available options. +Refer to [Environment variables](/reference/fleet/agent-environment-variables.md) for all available options. ## Logs [_logs] diff --git a/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md b/reference/fleet/elastic-agent-input-configuration.md similarity index 90% rename from reference/ingestion-tools/fleet/elastic-agent-input-configuration.md rename to reference/fleet/elastic-agent-input-configuration.md index ca1198c3ef..d797b28d6b 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md +++ b/reference/fleet/elastic-agent-input-configuration.md @@ -37,7 +37,7 @@ By default {{agent}} collects system metrics, such as CPU, memory, network, and data_stream.dataset: system.filesystem ``` -1. The name of the input. Refer to [{{agent}} inputs](/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md) for the list of what’s available. +1. The name of the input. Refer to [{{agent}} inputs](/reference/fleet/elastic-agent-inputs-list.md) for the list of what’s available. 2. A unique ID for the input. 3. A user-defined namespace. 4. The name of the `output` to use. If not specified, `default` will be used. @@ -62,10 +62,10 @@ To enable {{agent}} to collect log files, you can use a configuration like the f - /var/log/*.log ``` -1. The name of the input. Refer to [{{agent}} inputs](/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md) for the list of what’s available. +1. The name of the input. Refer to [{{agent}} inputs](/reference/fleet/elastic-agent-inputs-list.md) for the list of what’s available. 2. A unique ID for the input. 3. A unique ID for the data stream to track the state of the ingested files. -4. The streams block is required only if multiple streams are used on the same input. Refer to the {{filebeat}} [filestream](beats://reference/filebeat/filebeat-input-filestream.md) documentation for a list of available options. Also, specifically for the `filestream` input type, refer to the [simplified log ingestion](/reference/ingestion-tools/fleet/elastic-agent-simplified-input-configuration.md) for an example of ingesting a set of logs specified as an array. +4. The streams block is required only if multiple streams are used on the same input. Refer to the {{filebeat}} [filestream](beats://reference/filebeat/filebeat-input-filestream.md) documentation for a list of available options. Also, specifically for the `filestream` input type, refer to the [simplified log ingestion](/reference/fleet/elastic-agent-simplified-input-configuration.md) for an example of ingesting a set of logs specified as an array. The input in this example harvests all files in the path `/var/log/*.log`, that is, all logs in the directory `/var/log/` that end with `.log`. All patterns supported by [Go Glob](https://golang.org/pkg/path/filepath/#Glob) are also supported here. diff --git a/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md b/reference/fleet/elastic-agent-inputs-list.md similarity index 98% rename from reference/ingestion-tools/fleet/elastic-agent-inputs-list.md rename to reference/fleet/elastic-agent-inputs-list.md index 585a98f3bc..b016521346 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-inputs-list.md +++ b/reference/fleet/elastic-agent-inputs-list.md @@ -5,7 +5,7 @@ mapped_pages: # Elastic Agent inputs [elastic-agent-inputs-list] -When you [configure inputs](/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md) for standalone {{agents}}, the following values are supported for the input `type` parameter. +When you [configure inputs](/reference/fleet/elastic-agent-input-configuration.md) for standalone {{agents}}, the following values are supported for the input `type` parameter. **Expand any section to view the available inputs:** diff --git a/reference/ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md b/reference/fleet/elastic-agent-kubernetes-autodiscovery.md similarity index 83% rename from reference/ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md rename to reference/fleet/elastic-agent-kubernetes-autodiscovery.md index 437d690284..805b89c1e4 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md +++ b/reference/fleet/elastic-agent-kubernetes-autodiscovery.md @@ -7,12 +7,12 @@ mapped_pages: When you run applications on containers, they become moving targets to the monitoring system. Autodiscover allows you to track them and adapt settings as changes happen. By defining configuration templates, the autodiscover subsystem can monitor services as they start running. -To use autodiscover, you will need to modify the manifest file of the {{agent}}. Refer to [Run {{agent}} Standalone on Kubernetes](/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md) to learn how to retrieve and configure it. +To use autodiscover, you will need to modify the manifest file of the {{agent}}. Refer to [Run {{agent}} Standalone on Kubernetes](/reference/fleet/running-on-kubernetes-standalone.md) to learn how to retrieve and configure it. There are two different ways to use autodiscover: -* [Conditions based autodiscover](/reference/ingestion-tools/fleet/conditions-based-autodiscover.md) -* [Hints annotations based autodiscover](/reference/ingestion-tools/fleet/hints-annotations-autodiscovery.md) +* [Conditions based autodiscover](/reference/fleet/conditions-based-autodiscover.md) +* [Hints annotations based autodiscover](/reference/fleet/hints-annotations-autodiscovery.md) ## How to configure autodiscover [_how_to_configure_autodiscover] @@ -26,11 +26,11 @@ There are two different ways to use autodiscover: * Always define alternatives and default values to your variables that are used in conditions or [hint templates](eg. See `auth.basic` set as `auth.basic.user: ${kubernetes.hints.nginx.access.username|kubernetes.hints.nginx.username|''}`` in [nginx.yml](https://github.com/elastic/elastic-agent/blob/main/deploy/kubernetes/elastic-agent-standalone/templates.d/nginx.yml#L8))) ::::{important} -When an input uses a variable substitution that is not present in the current key/value mappings being evaluated, the input is removed in the result. (See more information in [Variables and conditions in input configurations](/reference/ingestion-tools/fleet/dynamic-input-configuration.md)) +When an input uses a variable substitution that is not present in the current key/value mappings being evaluated, the input is removed in the result. (See more information in [Variables and conditions in input configurations](/reference/fleet/dynamic-input-configuration.md)) :::: -* To debug configurations that include variable substitution and conditions, use the inspect command of {{agent}}. (See more information in [Variables and conditions in input configurations](/reference/ingestion-tools/fleet/dynamic-input-configuration.md) in **Debugging** Section) +* To debug configurations that include variable substitution and conditions, use the inspect command of {{agent}}. (See more information in [Variables and conditions in input configurations](/reference/fleet/dynamic-input-configuration.md) in **Debugging** Section) * In Condition Based autodiscover is advisable to define a generic last condition that will act as your default condition and will be validated when all others fail or don’t apply. If applicable, such conditions might help to identify processing and troubleshoot possible problems. diff --git a/reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md b/reference/fleet/elastic-agent-monitoring-configuration.md similarity index 100% rename from reference/ingestion-tools/fleet/elastic-agent-monitoring-configuration.md rename to reference/fleet/elastic-agent-monitoring-configuration.md diff --git a/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md b/reference/fleet/elastic-agent-output-configuration.md similarity index 81% rename from reference/ingestion-tools/fleet/elastic-agent-output-configuration.md rename to reference/fleet/elastic-agent-output-configuration.md index e5128874a6..627977d58e 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md +++ b/reference/fleet/elastic-agent-output-configuration.md @@ -33,9 +33,9 @@ A default output configuration is required. {{agent}} currently supports these outputs: -* [{{es}}](/reference/ingestion-tools/fleet/elasticsearch-output.md) -* [Kafka](/reference/ingestion-tools/fleet/kafka-output.md) -* [{{ls}}](/reference/ingestion-tools/fleet/logstash-output.md) +* [{{es}}](/reference/fleet/elasticsearch-output.md) +* [Kafka](/reference/fleet/kafka-output.md) +* [{{ls}}](/reference/fleet/logstash-output.md) diff --git a/reference/ingestion-tools/fleet/elastic-agent-proxy-config.md b/reference/fleet/elastic-agent-proxy-config.md similarity index 91% rename from reference/ingestion-tools/fleet/elastic-agent-proxy-config.md rename to reference/fleet/elastic-agent-proxy-config.md index d0996b784d..5125cb8a0c 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-proxy-config.md +++ b/reference/fleet/elastic-agent-proxy-config.md @@ -7,7 +7,7 @@ mapped_pages: Configure proxy settings for {{agent}} when it must connect through a proxy server to: -* Download artifacts from `artifacts.elastic.co` for subprocesses or binary upgrades (use [Agent binary download settings](/reference/ingestion-tools/fleet/fleet-settings.md#fleet-agent-binary-download-settings)) +* Download artifacts from `artifacts.elastic.co` for subprocesses or binary upgrades (use [Agent binary download settings](/reference/fleet/fleet-settings.md#fleet-agent-binary-download-settings)) * Send data to {es} * Retrieve agent policies from {fleet-server} * Retrieve agent policies from {{es}} (only needed for agents running {{fleet-server}}) diff --git a/reference/ingestion-tools/fleet/elastic-agent-reference-yaml.md b/reference/fleet/elastic-agent-reference-yaml.md similarity index 99% rename from reference/ingestion-tools/fleet/elastic-agent-reference-yaml.md rename to reference/fleet/elastic-agent-reference-yaml.md index 952e7c4460..f6277801b4 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-reference-yaml.md +++ b/reference/fleet/elastic-agent-reference-yaml.md @@ -9,7 +9,7 @@ The {{agent}} installation includes an `elastic-agent.reference.yml` file that d To ensure that you’re accessing the latest version, refer to the original [`elastic-agent.reference.yml` file](https://github.com/elastic/elastic-agent/blob/main/elastic-agent.reference.yml) in the `elastic/elastic-agent` repository. A copy is included here for your convenience. -Each section of the file and available settings are also described in [Structure of a config file](/reference/ingestion-tools/fleet/structure-config-file.md). +Each section of the file and available settings are also described in [Structure of a config file](/reference/fleet/structure-config-file.md). ```yaml ## Agent Configuration Example ######################### diff --git a/reference/ingestion-tools/fleet/elastic-agent-simplified-input-configuration.md b/reference/fleet/elastic-agent-simplified-input-configuration.md similarity index 100% rename from reference/ingestion-tools/fleet/elastic-agent-simplified-input-configuration.md rename to reference/fleet/elastic-agent-simplified-input-configuration.md diff --git a/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md b/reference/fleet/elastic-agent-ssl-configuration.md similarity index 99% rename from reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md rename to reference/fleet/elastic-agent-ssl-configuration.md index 8ea7325291..b58b5ae72d 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md +++ b/reference/fleet/elastic-agent-ssl-configuration.md @@ -14,7 +14,7 @@ There are a number of SSL configuration settings available depending on whether * [Table 9, Server configuration options](#server-ssl-options) ::::{tip} -For more information about using certificates, refer to [Secure connections](/reference/ingestion-tools/fleet/secure.md). +For more information about using certificates, refer to [Secure connections](/reference/fleet/secure.md). :::: diff --git a/reference/ingestion-tools/fleet/elastic-agent-standalone-download.md b/reference/fleet/elastic-agent-standalone-download.md similarity index 100% rename from reference/ingestion-tools/fleet/elastic-agent-standalone-download.md rename to reference/fleet/elastic-agent-standalone-download.md diff --git a/reference/ingestion-tools/fleet/elastic-agent-standalone-feature-flags.md b/reference/fleet/elastic-agent-standalone-feature-flags.md similarity index 82% rename from reference/ingestion-tools/fleet/elastic-agent-standalone-feature-flags.md rename to reference/fleet/elastic-agent-standalone-feature-flags.md index c842be0720..6056d85ccc 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-standalone-feature-flags.md +++ b/reference/fleet/elastic-agent-standalone-feature-flags.md @@ -23,7 +23,7 @@ agent.features: You can specify the following settings in the Feature Flag section of the `elastic-agent.yml` config file. Fully qualified domain name (FQDN) -: When enabled, information provided about the current host through the [host.name](/reference/ingestion-tools/fleet/host-provider.md) key, in events produced by {{agent}}, is in FQDN format (`somehost.example.com` rather than `somehost`). This helps you to distinguish between hosts on different domains that have similar names. With `fqdn` enabled, the fully qualified hostname allows each host to be more easily identified when viewed in {{kib}}. +: When enabled, information provided about the current host through the [host.name](/reference/fleet/host-provider.md) key, in events produced by {{agent}}, is in FQDN format (`somehost.example.com` rather than `somehost`). This helps you to distinguish between hosts on different domains that have similar names. With `fqdn` enabled, the fully qualified hostname allows each host to be more easily identified when viewed in {{kib}}. ::::{note} FQDN reporting is not currently supported in APM. diff --git a/reference/ingestion-tools/fleet/elastic-agent-standalone-logging-config.md b/reference/fleet/elastic-agent-standalone-logging-config.md similarity index 100% rename from reference/ingestion-tools/fleet/elastic-agent-standalone-logging-config.md rename to reference/fleet/elastic-agent-standalone-logging-config.md diff --git a/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md b/reference/fleet/elastic-agent-unprivileged.md similarity index 99% rename from reference/ingestion-tools/fleet/elastic-agent-unprivileged.md rename to reference/fleet/elastic-agent-unprivileged.md index 3a467ef97a..c518b5851c 100644 --- a/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md +++ b/reference/fleet/elastic-agent-unprivileged.md @@ -23,7 +23,7 @@ Refer to [Agent and dashboard behaviors in unprivileged mode](#unprivileged-comm ## Run {{agent}} in `unprivileged` mode [unprivileged-running] -To run {{agent}} without administrative privileges you use exactly the same commands that you use for {{agent}} otherwise, with one exception. When you run the [`elastic-agent install`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) command, add the `--unprivileged` flag. For example: +To run {{agent}} without administrative privileges you use exactly the same commands that you use for {{agent}} otherwise, with one exception. When you run the [`elastic-agent install`](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) command, add the `--unprivileged` flag. For example: ```shell elastic-agent install \ diff --git a/reference/ingestion-tools/fleet/elasticsearch-output.md b/reference/fleet/elasticsearch-output.md similarity index 94% rename from reference/ingestion-tools/fleet/elasticsearch-output.md rename to reference/fleet/elasticsearch-output.md index cd4806a015..5250fa2533 100644 --- a/reference/ingestion-tools/fleet/elasticsearch-output.md +++ b/reference/fleet/elasticsearch-output.md @@ -114,7 +114,7 @@ outputs: ssl.key: "/etc/pki/client/cert.key" ``` -For a list of available settings, refer to [SSL/TLS](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). +For a list of available settings, refer to [SSL/TLS](/reference/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). ### Kerberos [output-elasticsearch-kerberos-authentication-settings] @@ -234,7 +234,7 @@ The performance tuning `preset` values take precedence over any settings that ma | $$$output-elasticsearch-bulk_max_size-setting$$$
`bulk_max_size`
| (int) The maximum number of events to bulk in a single {{es}} bulk API index request.

Events can be collected into batches. {{agent}} will split batches larger than `bulk_max_size` into multiple batches.

Specifying a larger batch size can improve performance by lowering the overhead of sending events. However big batch sizes can also increase processing times, which might result in API errors, killed connections, timed-out publishing requests, and, ultimately, lower throughput.

Setting `bulk_max_size` to values less than or equal to 0 turns off the splitting of batches. When splitting is disabled, the queue decides on the number of events to be contained in a batch.

**Default:** `1600`
| | $$$output-elasticsearch-compression_level-setting$$$
`compression_level`
| (int) The gzip compression level. Set this value to `0` to disable compression. The compression level must be in the range of `1` (best speed) to `9` (best compression).

Increasing the compression level reduces network usage but increases CPU usage.

**Default:** `1`
| | $$$output-elasticsearch-max_retries-setting$$$
`max_retries`
| (int) The number of times to retry publishing an event after a publishing failure. After the specified number of retries, the events are typically dropped.

Set `max_retries` to a value less than 0 to retry until all events are published.

**Default:** `3`
| -| $$$output-elasticsearch-preset-setting$$$
`preset`
| Configures the full group of [performance tuning settings](#output-elasticsearch-performance-tuning-settings) to optimize your {{agent}} performance when sending data to an {{es}} output.

Refer to [Performance tuning settings](/reference/ingestion-tools/fleet/es-output-settings.md#es-output-settings-performance-tuning-settings) for a table showing the group of values associated with any preset, and another table showing EPS (events per second) results from testing the different preset options.

Performance tuning preset settings:

**`balanced`**
: Configure the default tuning setting values for "out-of-the-box" performance.

**`throughput`**
: Optimize the {{es}} output for throughput.

**`scale`**
: Optimize the {{es}} output for scale.

**`latency`**
: Optimize the {{es}} output to reduce latence.

**`custom`**
: Use the `custom` option to fine-tune the performance tuning settings individually.

**Default:** `balanced`
| +| $$$output-elasticsearch-preset-setting$$$
`preset`
| Configures the full group of [performance tuning settings](#output-elasticsearch-performance-tuning-settings) to optimize your {{agent}} performance when sending data to an {{es}} output.

Refer to [Performance tuning settings](/reference/fleet/es-output-settings.md#es-output-settings-performance-tuning-settings) for a table showing the group of values associated with any preset, and another table showing EPS (events per second) results from testing the different preset options.

Performance tuning preset settings:

**`balanced`**
: Configure the default tuning setting values for "out-of-the-box" performance.

**`throughput`**
: Optimize the {{es}} output for throughput.

**`scale`**
: Optimize the {{es}} output for scale.

**`latency`**
: Optimize the {{es}} output to reduce latence.

**`custom`**
: Use the `custom` option to fine-tune the performance tuning settings individually.

**Default:** `balanced`
| | $$$output-elasticsearch-timeout-setting$$$
`timeout`
| (string) The HTTP request timeout in seconds for the {{es}} request.

**Default:** `90s`
| | $$$output-elasticsearch-worker-setting$$$
`worker`
| (int) The number of workers per configured host publishing events. Example: If you have two hosts and three workers, in total six workers are started (three for each host).

**Default:** `1`
| diff --git a/reference/ingestion-tools/fleet/enable-custom-policy-settings.md b/reference/fleet/enable-custom-policy-settings.md similarity index 100% rename from reference/ingestion-tools/fleet/enable-custom-policy-settings.md rename to reference/fleet/enable-custom-policy-settings.md diff --git a/reference/ingestion-tools/fleet/enrollment-handling-containerized-agent.md b/reference/fleet/enrollment-handling-containerized-agent.md similarity index 100% rename from reference/ingestion-tools/fleet/enrollment-handling-containerized-agent.md rename to reference/fleet/enrollment-handling-containerized-agent.md diff --git a/reference/ingestion-tools/fleet/env-provider.md b/reference/fleet/env-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/env-provider.md rename to reference/fleet/env-provider.md diff --git a/reference/ingestion-tools/fleet/epr-proxy-setting.md b/reference/fleet/epr-proxy-setting.md similarity index 100% rename from reference/ingestion-tools/fleet/epr-proxy-setting.md rename to reference/fleet/epr-proxy-setting.md diff --git a/reference/ingestion-tools/fleet/es-output-settings.md b/reference/fleet/es-output-settings.md similarity index 94% rename from reference/ingestion-tools/fleet/es-output-settings.md rename to reference/fleet/es-output-settings.md index 1c37ed540b..346d721b09 100644 --- a/reference/ingestion-tools/fleet/es-output-settings.md +++ b/reference/fleet/es-output-settings.md @@ -5,16 +5,16 @@ mapped_pages: # Elasticsearch output settings [es-output-settings] -Specify these settings to send data over a secure connection to {{es}}. In the {{fleet}} [Output settings](/reference/ingestion-tools/fleet/fleet-settings.md#output-settings), make sure that {{es}} output type is selected. +Specify these settings to send data over a secure connection to {{es}}. In the {{fleet}} [Output settings](/reference/fleet/fleet-settings.md#output-settings), make sure that {{es}} output type is selected. | | | | --- | --- | -| $$$es-output-hosts-setting$$$
**Hosts**
| The {{es}} URLs where {{agent}}s will send data. By default, {{es}} is exposed on the following ports:

`9200`
: Default {{es}} port for self-managed clusters

`443`
: Default {{es}} port for {{ecloud}}

**Examples:**

* `https://192.0.2.0:9200`
* `https://1d7a52f5eb344de18ea04411fe09e564.fleet.eu-west-1.aws.qa.cld.elstc.co:443`
* `https://[2001:db8::1]:9200`

Refer to the [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) documentation for default ports and other configuration details.
| +| $$$es-output-hosts-setting$$$
**Hosts**
| The {{es}} URLs where {{agent}}s will send data. By default, {{es}} is exposed on the following ports:

`9200`
: Default {{es}} port for self-managed clusters

`443`
: Default {{es}} port for {{ecloud}}

**Examples:**

* `https://192.0.2.0:9200`
* `https://1d7a52f5eb344de18ea04411fe09e564.fleet.eu-west-1.aws.qa.cld.elstc.co:443`
* `https://[2001:db8::1]:9200`

Refer to the [{{fleet-server}}](/reference/fleet/fleet-server.md) documentation for default ports and other configuration details.
| | $$$es-trusted-fingerprint-yaml-setting$$$
**{{es}} CA trusted fingerprint**
| HEX encoded SHA-256 of a CA certificate. If this certificate is present in the chain during the handshake, it will be added to the `certificate_authorities` list and the handshake will continue normally. To learn more about trusted fingerprints, refer to the [{{es}} security documentation](/deploy-manage/deploy/self-managed/installing-elasticsearch.md).
| -| $$$es-agent-proxy-output$$$
**Proxy**
| Select a proxy URL for {{agent}} to connect to {{es}}. To learn about proxy configuration, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md).
| +| $$$es-agent-proxy-output$$$
**Proxy**
| Select a proxy URL for {{agent}} to connect to {{es}}. To learn about proxy configuration, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/fleet/fleet-agent-proxy-support.md).
| | $$$es-output-advanced-yaml-setting$$$
**Advanced YAML configuration**
| YAML settings that will be added to the {{es}} output section of each policy that uses this output. Make sure you specify valid YAML. The UI does not currently provide validation.

See [Advanced YAML configuration](#es-output-settings-yaml-config) for descriptions of the available settings.
| -| $$$es-agent-integrations-output$$$
**Make this output the default for agent integrations**
| When this setting is on, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md).
| -| $$$es-agent-monitoring-output$$$
**Make this output the default for agent monitoring**
| When this setting is on, {{agent}}s use this output to send [agent monitoring data](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) if no other output is set in the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md).
| +| $$$es-agent-integrations-output$$$
**Make this output the default for agent integrations**
| When this setting is on, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/fleet/agent-policy.md).
| +| $$$es-agent-monitoring-output$$$
**Make this output the default for agent monitoring**
| When this setting is on, {{agent}}s use this output to send [agent monitoring data](/reference/fleet/monitor-elastic-agent.md) if no other output is set in the [agent policy](/reference/fleet/agent-policy.md).
| | $$$es-agent-performance-tuning$$$
**Performance tuning**
| Choose one of the menu options to tune your {{agent}} performance when sending data to an {{es}} output. You can optimize for throughput, scale, latency, or you can choose a balanced (the default) set of performance specifications. Refer to [Performance tuning settings](#es-output-settings-performance-tuning-settings) for details about the setting values and their potential impact on performance.

You can also use the [Advanced YAML configuration](#es-output-settings-yaml-config) field to set custom values. Note that if you adjust any of the performance settings described in the following **Advanced YAML configuration*** section, the ***Performance tuning*** option automatically changes to `Custom` and cannot be changed.

Performance tuning preset values take precedence over any settings that may be defined separately. If you want to change any setting, you need to use the `Custom` ***Performance tuning*** option and specify the settings in the ***Advanced YAML configuration*** field.

For example, if you would like to use the balanced preset values except that you prefer a higher compression level, you can do so as follows:

1. In {{fleet}}, open the ***Settings*** tab.
2. In the ***Outputs*** section, select ***Add output*** to create a new output, or select the edit icon to edit an existing output.
3. In the ***Add new output*** or the ***Edit output*** flyout, set ***Performance tuning** to `Custom`.
4. Refer to the list of [performance tuning preset values](#es-output-settings-performance-tuning-settings), and add the settings you prefer into the **Advanced YAML configuration** field. For the `balanced` presets, the yaml configuration would be as shown:

```yaml
bulk_max_size: 1600
worker: 1
queue.mem.events: 3200
queue.mem.flush.min_events: 1600
queue.mem.flush.timeout: 10s
compression_level: 1
idle_connection_timeout: 3s
```

5. Adjust any settings as preferred. For example, you can update the `compression_level` setting to `4`.

When you create an {{agent}} policy using this output, the output will use the balanced preset options except with the higher compression level, as specified.
| ## Advanced YAML configuration [es-output-settings-yaml-config] diff --git a/reference/ingestion-tools/fleet/example-kubernetes-fleet-managed-agent-helm.md b/reference/fleet/example-kubernetes-fleet-managed-agent-helm.md similarity index 98% rename from reference/ingestion-tools/fleet/example-kubernetes-fleet-managed-agent-helm.md rename to reference/fleet/example-kubernetes-fleet-managed-agent-helm.md index 8775efc4b6..28d9f18db2 100644 --- a/reference/ingestion-tools/fleet/example-kubernetes-fleet-managed-agent-helm.md +++ b/reference/fleet/example-kubernetes-fleet-managed-agent-helm.md @@ -12,7 +12,7 @@ This functionality is in technical preview and may be changed or removed in a fu This example demonstrates how to install {{fleet}}-managed {{agent}} on a {{k8s}} system using a Helm chart, gather {{k8s}} metrics and send them to an {{es}} cluster in {{ecloud}}, and then view visualizations of those metrics in {{kib}}. -For an overview of the {{agent}} Helm chart and its benefits, refer to [Install {{agent}} on Kubernetes using Helm](/reference/ingestion-tools/fleet/install-on-kubernetes-using-helm.md). +For an overview of the {{agent}} Helm chart and its benefits, refer to [Install {{agent}} on Kubernetes using Helm](/reference/fleet/install-on-kubernetes-using-helm.md). This guide takes you through these steps: diff --git a/reference/ingestion-tools/fleet/example-kubernetes-standalone-agent-helm.md b/reference/fleet/example-kubernetes-standalone-agent-helm.md similarity index 98% rename from reference/ingestion-tools/fleet/example-kubernetes-standalone-agent-helm.md rename to reference/fleet/example-kubernetes-standalone-agent-helm.md index 2e1a8c9909..b6d9f153ee 100644 --- a/reference/ingestion-tools/fleet/example-kubernetes-standalone-agent-helm.md +++ b/reference/fleet/example-kubernetes-standalone-agent-helm.md @@ -12,7 +12,7 @@ This functionality is in technical preview and may be changed or removed in a fu This example demonstrates how to install standalone {{agent}} on a Kubernetes system using a Helm chart, gather Kubernetes metrics and send them to an {{es}} cluster in {{ecloud}}, and then view visualizations of those metrics in {{kib}}. -For an overview of the {{agent}} Helm chart and its benefits, refer to [Install {{agent}} on Kubernetes using Helm](/reference/ingestion-tools/fleet/install-on-kubernetes-using-helm.md). +For an overview of the {{agent}} Helm chart and its benefits, refer to [Install {{agent}} on Kubernetes using Helm](/reference/fleet/install-on-kubernetes-using-helm.md). This guide takes you through these steps: @@ -28,7 +28,7 @@ To get started, you need: * A local install of the [Helm](https://helm.sh/) {{k8s}} package manager. * An [{{ecloud}}](https://cloud.elastic.co/registration?page=docs&placement=docs-body) hosted {{es}} cluster on version 8.16 or higher. -* An [{{es}} API key](/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent). +* An [{{es}} API key](/reference/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent). * An active {{k8s}} cluster. * A local clone of the [elastic/elastic-agent](https://github.com/elastic/elastic-agent/tree/8.16) GitHub repository. Make sure to use the `8.16` branch to ensure that {{agent}} has full compatibility with the Helm chart. diff --git a/reference/ingestion-tools/fleet/example-standalone-monitor-nginx-serverless.md b/reference/fleet/example-standalone-monitor-nginx-serverless.md similarity index 96% rename from reference/ingestion-tools/fleet/example-standalone-monitor-nginx-serverless.md rename to reference/fleet/example-standalone-monitor-nginx-serverless.md index ddab9ab2c7..6596c5fd13 100644 --- a/reference/ingestion-tools/fleet/example-standalone-monitor-nginx-serverless.md +++ b/reference/fleet/example-standalone-monitor-nginx-serverless.md @@ -162,7 +162,7 @@ Rather than opt for {{fleet}} to centrally manage {{agent}}, you’ll configure ::: ::::{note} - {{agent}} commands should be run as `root`. You can prefix each agent command with `sudo` or you can start a new shell as `root` by running `sudo su`. If you need to run {{agent}} commands without `root` access, refer to [Run {{agent}} without administrative privileges](/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md). + {{agent}} commands should be run as `root`. You can prefix each agent command with `sudo` or you can start a new shell as `root` by running `sudo su`. If you need to run {{agent}} commands without `root` access, refer to [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md). :::: @@ -200,7 +200,7 @@ Rather than opt for {{fleet}} to centrally manage {{agent}}, you’ll configure where `your-api-key` is the API key that you generated in [Step 3: Create an {{es}} API key](#nginx-guide-create-api-key-serverless). -9. Find the location of the default `elastic-agent.yml` policy file that is included in your {{agent}} install. Install directories for each platform are described in [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md). In our example Ubuntu image the default policy file can be found in `/etc/elastic-agent/elastic-agent.yml`. +9. Find the location of the default `elastic-agent.yml` policy file that is included in your {{agent}} install. Install directories for each platform are described in [Installation layout](/reference/fleet/installation-layout.md). In our example Ubuntu image the default policy file can be found in `/etc/elastic-agent/elastic-agent.yml`. 10. Replace the default policy file with the version that you downloaded and updated. For example: ```sh @@ -214,7 +214,7 @@ Rather than opt for {{fleet}} to centrally manage {{agent}}, you’ll configure By default, {{agent}} monitors the configuration file and reloads the configuration automatically when `elastic-agent.yml` is updated. -11. Run the `status` command again, this time with the `--output yaml` option which provides structured and much more detailed output. See the [`elastic-agent status`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-status-command) command documentation for more details. +11. Run the `status` command again, this time with the `--output yaml` option which provides structured and much more detailed output. See the [`elastic-agent status`](/reference/fleet/agent-command-reference.md#elastic-agent-status-command) command documentation for more details. ```shell elastic-agent status --output yaml @@ -310,5 +310,5 @@ Congratulations! You have successfully set up monitoring for nginx using standal ## What’s next? [_whats_next] -* Learn more about [{{fleet}} and {{agent}}](/reference/ingestion-tools/fleet/index.md). +* Learn more about [{{fleet}} and {{agent}}](/reference/fleet/index.md). * Learn more about [{{integrations}}](integration-docs://reference/index.md). diff --git a/reference/ingestion-tools/fleet/example-standalone-monitor-nginx.md b/reference/fleet/example-standalone-monitor-nginx.md similarity index 96% rename from reference/ingestion-tools/fleet/example-standalone-monitor-nginx.md rename to reference/fleet/example-standalone-monitor-nginx.md index 6722e91959..c6c8a3d688 100644 --- a/reference/ingestion-tools/fleet/example-standalone-monitor-nginx.md +++ b/reference/fleet/example-standalone-monitor-nginx.md @@ -161,7 +161,7 @@ Rather than opt for {{fleet}} to centrally manage {{agent}}, you’ll configure ::: ::::{note} - {{agent}} commands should be run as `root`. You can prefix each agent command with `sudo` or you can start a new shell as `root` by running `sudo su`. If you need to run {{agent}} commands without `root` access, refer to [Run {{agent}} without administrative privileges](/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md). + {{agent}} commands should be run as `root`. You can prefix each agent command with `sudo` or you can start a new shell as `root` by running `sudo su`. If you need to run {{agent}} commands without `root` access, refer to [Run {{agent}} without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md). :::: @@ -199,7 +199,7 @@ Rather than opt for {{fleet}} to centrally manage {{agent}}, you’ll configure where `your-api-key` is the API key that you generated in [Step 3: Create an {{es}} API key](#nginx-guide-create-api-key-ess). -9. Find the location of the default `elastic-agent.yml` policy file that is included in your {{agent}} install. Install directories for each platform are described in [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md). In our example Ubuntu image the default policy file can be found in `/etc/elastic-agent/elastic-agent.yml`. +9. Find the location of the default `elastic-agent.yml` policy file that is included in your {{agent}} install. Install directories for each platform are described in [Installation layout](/reference/fleet/installation-layout.md). In our example Ubuntu image the default policy file can be found in `/etc/elastic-agent/elastic-agent.yml`. 10. Replace the default policy file with the version that you downloaded and updated. For example: ```sh @@ -213,7 +213,7 @@ Rather than opt for {{fleet}} to centrally manage {{agent}}, you’ll configure By default, {{agent}} monitors the configuration file and reloads the configuration automatically when `elastic-agent.yml` is updated. -11. Run the `status` command again, this time with the `--output yaml` option which provides structured and much more detailed output. See the [`elastic-agent status`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-status-command) command documentation for more details. +11. Run the `status` command again, this time with the `--output yaml` option which provides structured and much more detailed output. See the [`elastic-agent status`](/reference/fleet/agent-command-reference.md#elastic-agent-status-command) command documentation for more details. ```shell elastic-agent status --output yaml @@ -309,5 +309,5 @@ Congratulations! You have successfully set up monitoring for nginx using standal ## What’s next? [_whats_next_2] -* Learn more about [{{fleet}} and {{agent}}](/reference/ingestion-tools/fleet/index.md). +* Learn more about [{{fleet}} and {{agent}}](/reference/fleet/index.md). * Learn more about [{{integrations}}](integration-docs://reference/index.md). diff --git a/reference/ingestion-tools/fleet/extract_array-processor.md b/reference/fleet/extract_array-processor.md similarity index 97% rename from reference/ingestion-tools/fleet/extract_array-processor.md rename to reference/fleet/extract_array-processor.md index d0a64e4690..4300b77efd 100644 --- a/reference/ingestion-tools/fleet/extract_array-processor.md +++ b/reference/fleet/extract_array-processor.md @@ -32,7 +32,7 @@ The following example populates `source.ip` with the first element of the `my_ar ## Configuration settings [_configuration_settings_30] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/filesource-provider.md b/reference/fleet/filesource-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/filesource-provider.md rename to reference/fleet/filesource-provider.md diff --git a/reference/ingestion-tools/fleet/filter-agent-list-by-tags.md b/reference/fleet/filter-agent-list-by-tags.md similarity index 92% rename from reference/ingestion-tools/fleet/filter-agent-list-by-tags.md rename to reference/fleet/filter-agent-list-by-tags.md index 4c0623eee0..7bc2537c24 100644 --- a/reference/ingestion-tools/fleet/filter-agent-list-by-tags.md +++ b/reference/fleet/filter-agent-list-by-tags.md @@ -63,7 +63,7 @@ sudo ./elastic-agent install \ --tag macOS,staging ``` -For the full command synopsis, refer to [elastic-agent install](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) and [elastic-agent enroll](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-enroll-command). +For the full command synopsis, refer to [elastic-agent install](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) and [elastic-agent enroll](/reference/fleet/agent-command-reference.md#elastic-agent-enroll-command). The following command applies the `docker` and `dev` tags to {{agent}} running in a Docker container: @@ -76,4 +76,4 @@ docker run \ --rm docker.elastic.co/elastic-agent/elastic-agent:9.0.0-beta1 ``` -For more information about running on containers, refer to the guides under [Install {{agent}}s in a containerized environment](/reference/ingestion-tools/fleet/install-elastic-agents-in-containers.md). +For more information about running on containers, refer to the guides under [Install {{agent}}s in a containerized environment](/reference/fleet/install-elastic-agents-in-containers.md). diff --git a/reference/ingestion-tools/fleet/fingerprint-processor.md b/reference/fleet/fingerprint-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/fingerprint-processor.md rename to reference/fleet/fingerprint-processor.md index a88fcdf96b..da62e3a9f5 100644 --- a/reference/ingestion-tools/fleet/fingerprint-processor.md +++ b/reference/fleet/fingerprint-processor.md @@ -25,7 +25,7 @@ Nested fields are supported in the following format: `"field1.field2"`, for exam ## Configuration settings [_configuration_settings_31] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/fleet-agent-environment-variables.md b/reference/fleet/fleet-agent-environment-variables.md similarity index 71% rename from reference/ingestion-tools/fleet/fleet-agent-environment-variables.md rename to reference/fleet/fleet-agent-environment-variables.md index 77a70b0445..2c5296cf45 100644 --- a/reference/ingestion-tools/fleet/fleet-agent-environment-variables.md +++ b/reference/fleet/fleet-agent-environment-variables.md @@ -7,5 +7,5 @@ mapped_pages: As an advanced use case, you may wish to configure environment variables in your {{agent}} policy. This is useful, for example, if there are configuration details about the system on which {{agent}} is running that you may not know in advance. As a solution, you may want to configure environment variables to be interpreted by {{agent}} at runtime, using information from the running environment. -For {{fleet}}-managed {{agents}}, you can configure environment variables using the [Env Provider](/reference/ingestion-tools/fleet/env-provider.md). Refer to [Variables and conditions in input configurations](/reference/ingestion-tools/fleet/dynamic-input-configuration.md) in the standalone {{agent}} documentation for more detail. +For {{fleet}}-managed {{agents}}, you can configure environment variables using the [Env Provider](/reference/fleet/env-provider.md). Refer to [Variables and conditions in input configurations](/reference/fleet/dynamic-input-configuration.md) in the standalone {{agent}} documentation for more detail. diff --git a/reference/ingestion-tools/fleet/fleet-agent-proxy-managed.md b/reference/fleet/fleet-agent-proxy-managed.md similarity index 98% rename from reference/ingestion-tools/fleet/fleet-agent-proxy-managed.md rename to reference/fleet/fleet-agent-proxy-managed.md index 4f3d81f362..a2c260a3d9 100644 --- a/reference/ingestion-tools/fleet/fleet-agent-proxy-managed.md +++ b/reference/fleet/fleet-agent-proxy-managed.md @@ -128,7 +128,7 @@ If the initial agent communication with {{fleet}} (i.e control plane) needs to t ::::{note} -If {{kib}} is behind a proxy server, you’ll still need to [configure {{kib}} settings](/reference/ingestion-tools/fleet/epr-proxy-setting.md) to access the package registry. +If {{kib}} is behind a proxy server, you’ll still need to [configure {{kib}} settings](/reference/fleet/epr-proxy-setting.md) to access the package registry. :::: @@ -198,5 +198,5 @@ Currently {{agents}} will not present a certificate for Control Plane traffic to ::::{note} -In case {{kib}} is behind a proxy server or is otherwise unable to access the {{package-registry}} to download package metadata and content, refer to [Set the proxy URL of the {{package-registry}}](/reference/ingestion-tools/fleet/epr-proxy-setting.md). +In case {{kib}} is behind a proxy server or is otherwise unable to access the {{package-registry}} to download package metadata and content, refer to [Set the proxy URL of the {{package-registry}}](/reference/fleet/epr-proxy-setting.md). :::: diff --git a/reference/ingestion-tools/fleet/fleet-agent-proxy-standalone.md b/reference/fleet/fleet-agent-proxy-standalone.md similarity index 95% rename from reference/ingestion-tools/fleet/fleet-agent-proxy-standalone.md rename to reference/fleet/fleet-agent-proxy-standalone.md index 87834aaa31..96cabfcfd4 100644 --- a/reference/ingestion-tools/fleet/fleet-agent-proxy-standalone.md +++ b/reference/fleet/fleet-agent-proxy-standalone.md @@ -30,5 +30,5 @@ outputs: type: elasticsearch ``` -For more information, refer to [*Configure standalone {{agent}}s*](/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md). +For more information, refer to [*Configure standalone {{agent}}s*](/reference/fleet/configure-standalone-elastic-agents.md). diff --git a/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md b/reference/fleet/fleet-agent-proxy-support.md similarity index 81% rename from reference/ingestion-tools/fleet/fleet-agent-proxy-support.md rename to reference/fleet/fleet-agent-proxy-support.md index 606d925856..cb219ae18d 100644 --- a/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md +++ b/reference/fleet/fleet-agent-proxy-support.md @@ -16,11 +16,11 @@ Some environments require users to authenticate with the proxy. There are no exp :::: -Refer to [When to configure proxy settings](/reference/ingestion-tools/fleet/elastic-agent-proxy-config.md) for more detail, or jump into one of the following guides: +Refer to [When to configure proxy settings](/reference/fleet/elastic-agent-proxy-config.md) for more detail, or jump into one of the following guides: -* [Proxy Server connectivity using default host variables](/reference/ingestion-tools/fleet/host-proxy-env-vars.md) -* [Fleet managed {{agent}} connectivity using a proxy server](/reference/ingestion-tools/fleet/fleet-agent-proxy-managed.md) -* [Standalone {{agent}} connectivity using a proxy server](/reference/ingestion-tools/fleet/fleet-agent-proxy-standalone.md) +* [Proxy Server connectivity using default host variables](/reference/fleet/host-proxy-env-vars.md) +* [Fleet managed {{agent}} connectivity using a proxy server](/reference/fleet/fleet-agent-proxy-managed.md) +* [Standalone {{agent}} connectivity using a proxy server](/reference/fleet/fleet-agent-proxy-standalone.md) diff --git a/reference/ingestion-tools/fleet/fleet-agent-serverless-restrictions.md b/reference/fleet/fleet-agent-serverless-restrictions.md similarity index 100% rename from reference/ingestion-tools/fleet/fleet-agent-serverless-restrictions.md rename to reference/fleet/fleet-agent-serverless-restrictions.md diff --git a/reference/ingestion-tools/fleet/fleet-api-docs.md b/reference/fleet/fleet-api-docs.md similarity index 100% rename from reference/ingestion-tools/fleet/fleet-api-docs.md rename to reference/fleet/fleet-api-docs.md diff --git a/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md b/reference/fleet/fleet-enrollment-tokens.md similarity index 96% rename from reference/ingestion-tools/fleet/fleet-enrollment-tokens.md rename to reference/fleet/fleet-enrollment-tokens.md index d45ad2e643..696c6c6280 100644 --- a/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md +++ b/reference/fleet/fleet-enrollment-tokens.md @@ -51,10 +51,10 @@ To create an enrollment token: All {{agent}}s enrolled through this token will use the selected policy unless you assign or enroll them in a different policy. -To learn how to install {{agent}}s and enroll them in {{fleet}}, refer to [*Install {{agent}}s*](/reference/ingestion-tools/fleet/install-elastic-agents.md). +To learn how to install {{agent}}s and enroll them in {{fleet}}, refer to [*Install {{agent}}s*](/reference/fleet/install-elastic-agents.md). ::::{tip} -You can use the {{fleet}} API to get a list of enrollment tokens. For more information, refer to [{{kib}} {{fleet}} APIs](/reference/ingestion-tools/fleet/fleet-api-docs.md). +You can use the {{fleet}} API to get a list of enrollment tokens. For more information, refer to [{{kib}} {{fleet}} APIs](/reference/fleet/fleet-api-docs.md). :::: diff --git a/reference/ingestion-tools/fleet/fleet-roles-privileges.md b/reference/fleet/fleet-roles-privileges.md similarity index 100% rename from reference/ingestion-tools/fleet/fleet-roles-privileges.md rename to reference/fleet/fleet-roles-privileges.md diff --git a/reference/ingestion-tools/fleet/fleet-server-monitoring.md b/reference/fleet/fleet-server-monitoring.md similarity index 100% rename from reference/ingestion-tools/fleet/fleet-server-monitoring.md rename to reference/fleet/fleet-server-monitoring.md diff --git a/reference/ingestion-tools/fleet/fleet-server-scalability.md b/reference/fleet/fleet-server-scalability.md similarity index 100% rename from reference/ingestion-tools/fleet/fleet-server-scalability.md rename to reference/fleet/fleet-server-scalability.md diff --git a/reference/ingestion-tools/fleet/fleet-server-secrets.md b/reference/fleet/fleet-server-secrets.md similarity index 80% rename from reference/ingestion-tools/fleet/fleet-server-secrets.md rename to reference/fleet/fleet-server-secrets.md index 35d5323dd1..d519e255c0 100644 --- a/reference/ingestion-tools/fleet/fleet-server-secrets.md +++ b/reference/fleet/fleet-server-secrets.md @@ -7,7 +7,7 @@ mapped_pages: {{fleet-server}} configuration can contain secret values. You may specify these values directly in the configuration or through secret files. You can use command line arguments to pass the values or file paths when you are running under {{agent}}, or you can use environment variables if {{agent}} is running in a container. -For examples of how to deploy secret files, refer to our [Secret files guide](/reference/ingestion-tools/fleet/secret-files-guide.md). +For examples of how to deploy secret files, refer to our [Secret files guide](/reference/fleet/secret-files-guide.md). ::::{note} Stand-alone {{fleet-server}} is under active development. @@ -36,13 +36,13 @@ Note that the configuration fragments shown below are specified either in the UI output.elasticsearch.service_token_path: /path/to/token-file ``` - When you are running {{fleet-server}} under {{agent}}, you can specify it with either the `--fleet-server-service-token` or the `--fleet-server-service-token-path` flag. See [{{agent}} command reference](/reference/ingestion-tools/fleet/agent-command-reference.md) for more details. + When you are running {{fleet-server}} under {{agent}}, you can specify it with either the `--fleet-server-service-token` or the `--fleet-server-service-token-path` flag. See [{{agent}} command reference](/reference/fleet/agent-command-reference.md) for more details. - If you are [running {{fleet-server}} under {{agent}} in a container](/reference/ingestion-tools/fleet/elastic-agent-container.md), you can use the environment variables `FLEET_SERVER_SERVICE_TOKEN` or `FLEET_SERVER_SERVICE_TOKEN_PATH`. + If you are [running {{fleet-server}} under {{agent}} in a container](/reference/fleet/elastic-agent-container.md), you can use the environment variables `FLEET_SERVER_SERVICE_TOKEN` or `FLEET_SERVER_SERVICE_TOKEN_PATH`. TLS private key -: Use the TLS private key to encrypt communications between {{fleet-server}} and {{agent}}. See [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md) for more details. +: Use the TLS private key to encrypt communications between {{fleet-server}} and {{agent}}. See [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md) for more details. Although it is not recommended, you may specify the private key directly in the configuration as: @@ -63,9 +63,9 @@ TLS private key ssl.key: /path/to/cert.key ``` - When you are running {{fleet-server}} under {{agent}}, you can provide the private key path using with the `--fleet-server-cert-key` flag. See [{{agent}} command reference](/reference/ingestion-tools/fleet/agent-command-reference.md) for more details. + When you are running {{fleet-server}} under {{agent}}, you can provide the private key path using with the `--fleet-server-cert-key` flag. See [{{agent}} command reference](/reference/fleet/agent-command-reference.md) for more details. - If you are [running {{fleet-server}} under {{agent}} in a container](/reference/ingestion-tools/fleet/elastic-agent-container.md), you can use the environment variable `FLEET_SERVER_CERT_KEY` to specify the private key path. + If you are [running {{fleet-server}} under {{agent}} in a container](/reference/fleet/elastic-agent-container.md), you can use the environment variable `FLEET_SERVER_CERT_KEY` to specify the private key path. TLS private key passphrase @@ -79,9 +79,9 @@ TLS private key passphrase ssl.key_passphrase_path: /path/to/passphrase ``` - When you are running {{fleet-server}} under {{agent}}, you can provide the passphrase path using the `--fleet-server-cert-key-passphrase` flag. See [{{agent}} command reference](/reference/ingestion-tools/fleet/agent-command-reference.md) for more details. + When you are running {{fleet-server}} under {{agent}}, you can provide the passphrase path using the `--fleet-server-cert-key-passphrase` flag. See [{{agent}} command reference](/reference/fleet/agent-command-reference.md) for more details. - If you are [running {{fleet-server}} under {{agent}} in a container](/reference/ingestion-tools/fleet/elastic-agent-container.md), you can use the environment variable `FLEET_SERVER_CERT_KEY_PASSPHRASE` to specify the file path. + If you are [running {{fleet-server}} under {{agent}} in a container](/reference/fleet/elastic-agent-container.md), you can use the environment variable `FLEET_SERVER_CERT_KEY_PASSPHRASE` to specify the file path. APM API Key diff --git a/reference/ingestion-tools/fleet/fleet-server.md b/reference/fleet/fleet-server.md similarity index 82% rename from reference/ingestion-tools/fleet/fleet-server.md rename to reference/fleet/fleet-server.md index edbe1e963f..35a47ecd73 100644 --- a/reference/ingestion-tools/fleet/fleet-server.md +++ b/reference/fleet/fleet-server.md @@ -37,7 +37,7 @@ The following diagram shows how {{agent}}s communicate with {{fleet-server}} to {{fleet-server}} uses a service token to communicate with {{es}}, which contains a `fleet-server` service account. Each {{fleet-server}} can use its own service token, and you can share it across multiple servers (not recommended). The advantage of using a separate token for each server is that you can invalidate each one separately. -You can create a service token by either using the {{fleet}} UI or the {{es}} API. For more information, refer to [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/ingestion-tools/fleet/add-fleet-server-mixed.md) or [Deploy on-premises and self-managed](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md), depending on your deployment model. +You can create a service token by either using the {{fleet}} UI or the {{es}} API. For more information, refer to [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/fleet/add-fleet-server-mixed.md) or [Deploy on-premises and self-managed](/reference/fleet/add-fleet-server-on-prem.md), depending on your deployment model. ## {{fleet-server}} High-availability operations [fleet-server-HA-operations] @@ -51,13 +51,13 @@ How you handle high-availability, fault-tolerance, and lifecycle management of { To learn more about deploying and scaling {{fleet-server}}, refer to: -* [Deploy on {{ecloud}}](/reference/ingestion-tools/fleet/add-fleet-server-cloud.md) -* [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/ingestion-tools/fleet/add-fleet-server-mixed.md) -* [Deploy on-premises and self-managed](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md) -* [{{fleet-server}} scalability](/reference/ingestion-tools/fleet/fleet-server-scalability.md) -* [Monitor a self-managed {{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server-monitoring.md) +* [Deploy on {{ecloud}}](/reference/fleet/add-fleet-server-cloud.md) +* [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/fleet/add-fleet-server-mixed.md) +* [Deploy on-premises and self-managed](/reference/fleet/add-fleet-server-on-prem.md) +* [{{fleet-server}} scalability](/reference/fleet/fleet-server-scalability.md) +* [Monitor a self-managed {{fleet-server}}](/reference/fleet/fleet-server-monitoring.md) ## {{fleet-server}} secrets configuration [fleet-server-secrets-config] -Secrets used to configure {{fleet-server}} can either be directly specified in configuration or provided through secret files. See [{{fleet-server}} Secrets](/reference/ingestion-tools/fleet/fleet-server-secrets.md) for more information. +Secrets used to configure {{fleet-server}} can either be directly specified in configuration or provided through secret files. See [{{fleet-server}} Secrets](/reference/fleet/fleet-server-secrets.md) for more information. diff --git a/reference/ingestion-tools/fleet/fleet-settings-changing-outputs.md b/reference/fleet/fleet-settings-changing-outputs.md similarity index 85% rename from reference/ingestion-tools/fleet/fleet-settings-changing-outputs.md rename to reference/fleet/fleet-settings-changing-outputs.md index 7c2b1efe2a..f9003a6ee3 100644 --- a/reference/ingestion-tools/fleet/fleet-settings-changing-outputs.md +++ b/reference/fleet/fleet-settings-changing-outputs.md @@ -5,7 +5,7 @@ mapped_pages: # Considerations when changing outputs [fleet-settings-changing-outputs] -{{fleet}} provides the capability to update your [output settings](/reference/ingestion-tools/fleet/fleet-settings.md#output-settings) to add new outputs, and then to assign those new outputs to an {{agent}} policy. However, changing outputs should be done with caution. +{{fleet}} provides the capability to update your [output settings](/reference/fleet/fleet-settings.md#output-settings) to add new outputs, and then to assign those new outputs to an {{agent}} policy. However, changing outputs should be done with caution. When you change the output configuration within a policy applied to one or more agents, there’s a high likelihood of those agents re-ingesting previously processed logs: diff --git a/reference/ingestion-tools/fleet/fleet-settings.md b/reference/fleet/fleet-settings.md similarity index 89% rename from reference/ingestion-tools/fleet/fleet-settings.md rename to reference/fleet/fleet-settings.md index ed5de6b314..9d780d51c1 100644 --- a/reference/ingestion-tools/fleet/fleet-settings.md +++ b/reference/fleet/fleet-settings.md @@ -22,7 +22,7 @@ If the **Edit hosts** option is grayed out, {{fleet-server}} hosts are configure :::: -Not sure if {{fleet-server}} is running? Refer to [What is {{fleet-server}}?](/reference/ingestion-tools/fleet/fleet-server.md). +Not sure if {{fleet-server}} is running? Refer to [What is {{fleet-server}}?](/reference/fleet/fleet-server.md). On self-managed clusters, you must specify one or more URLs. @@ -62,7 +62,7 @@ When a {{fleet-server}} is added or removed from the list, all agent policies ar Add or edit output settings to specify where {{agent}}s send data. {{agent}}s use the default output if you don’t select an output in the agent policy. ::::{tip} -If you have an `Enterprise` [{{stack}} subscription](https://www.elastic.co/subscriptions), you can configure {{agent}} to [send data to different outputs for different integration policies](/reference/ingestion-tools/fleet/integration-level-outputs.md). +If you have an `Enterprise` [{{stack}} subscription](https://www.elastic.co/subscriptions), you can configure {{agent}} to [send data to different outputs for different integration policies](/reference/fleet/integration-level-outputs.md). :::: @@ -85,10 +85,10 @@ To add or edit an output: 3. Set the output name and type. 4. Specify settings for the output type you selected: - * [{{es}} output settings](/reference/ingestion-tools/fleet/es-output-settings.md) - * [{{ls}} output settings](/reference/ingestion-tools/fleet/ls-output-settings.md) - * [Kafka output settings](/reference/ingestion-tools/fleet/kafka-output-settings.md) - * [Remote {{es}} output](/reference/ingestion-tools/fleet/remote-elasticsearch-output.md) + * [{{es}} output settings](/reference/fleet/es-output-settings.md) + * [{{ls}} output settings](/reference/fleet/ls-output-settings.md) + * [Kafka output settings](/reference/fleet/kafka-output-settings.md) + * [Remote {{es}} output](/reference/fleet/remote-elasticsearch-output.md) 5. Click **Save and apply settings**. @@ -102,7 +102,7 @@ If the options for editing an output are grayed out, outputs are configured outs {{agent}}s must be able to access the {{artifact-registry}} to download binaries during upgrades. By default {{agent}}s download artifacts from the artifact registry at `https://artifacts.elastic.co/downloads/`. -For {{agent}}s that cannot access the internet, you can specify agent binary download settings, and then configure agents to download their artifacts from the alternate location. For more information about running {{agent}}s in a restricted environment, refer to [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +For {{agent}}s that cannot access the internet, you can specify agent binary download settings, and then configure agents to download their artifacts from the alternate location. For more information about running {{agent}}s in a restricted environment, refer to [Air-gapped environments](/reference/fleet/air-gapped.md). To add or edit the source of binary downloads: @@ -115,7 +115,7 @@ To add or edit the source of binary downloads: ## Proxies [proxy-settings] -You can specify a proxy server to be used in {{fleet-server}}, {{agent}} outputs, or for any agent binary download sources. For full details about proxy configuration refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md). +You can specify a proxy server to be used in {{fleet-server}}, {{agent}} outputs, or for any agent binary download sources. For full details about proxy configuration refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/fleet/fleet-agent-proxy-support.md). ## Delete unenrolled agents [delete-unenrolled-agents-setting] diff --git a/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md b/reference/fleet/grant-access-to-elasticsearch.md similarity index 96% rename from reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md rename to reference/fleet/grant-access-to-elasticsearch.md index 3a5e23834a..98183247a1 100644 --- a/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md +++ b/reference/fleet/grant-access-to-elasticsearch.md @@ -12,13 +12,13 @@ You can use either API keys or user credentials to grant standalone {{agent}}s a It’s recommended that you use API keys to avoid exposing usernames and passwords in configuration files. -If you’re using {{fleet}}, refer to [{{fleet}} enrollment tokens](/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md). +If you’re using {{fleet}}, refer to [{{fleet}} enrollment tokens](/reference/fleet/fleet-enrollment-tokens.md). ## Create API keys for standalone agents [create-api-key-standalone-agent] ::::{note} -API keys are sent as plain-text, so they only provide security when used in combination with Transport Layer Security (TLS). [{{ecloud}}](https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body) provides secure, encrypted connections out of the box! For self-managed {{es}} clusters, refer to [Public Key Infrastructure (PKI) certificates](/reference/ingestion-tools/fleet/elasticsearch-output.md#output-elasticsearch-pki-certs-authentication-settings). +API keys are sent as plain-text, so they only provide security when used in combination with Transport Layer Security (TLS). [{{ecloud}}](https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body) provides secure, encrypted connections out of the box! For self-managed {{es}} clusters, refer to [Public Key Infrastructure (PKI) certificates](/reference/fleet/elasticsearch-output.md#output-elasticsearch-pki-certs-authentication-settings). :::: diff --git a/reference/ingestion-tools/fleet/hints-annotations-autodiscovery.md b/reference/fleet/hints-annotations-autodiscovery.md similarity index 92% rename from reference/ingestion-tools/fleet/hints-annotations-autodiscovery.md rename to reference/fleet/hints-annotations-autodiscovery.md index f4d2a6d7cf..c1d6148bbe 100644 --- a/reference/ingestion-tools/fleet/hints-annotations-autodiscovery.md +++ b/reference/fleet/hints-annotations-autodiscovery.md @@ -20,7 +20,7 @@ Hints autodiscovery only works with {{agent}} Standalone. :::: -Standalone {{agent}} supports autodiscover based on hints from the [provider](/reference/ingestion-tools/fleet/kubernetes-provider.md). The hints mechanism looks for hints in Kubernetes Pod annotations that have the prefix `co.elastic.hints`. As soon as the container starts, {{agent}} checks it for hints and launches the proper configuration for the container. Hints tell {{agent}} how to monitor the container by using the proper integration. This is the full list of supported hints: +Standalone {{agent}} supports autodiscover based on hints from the [provider](/reference/fleet/kubernetes-provider.md). The hints mechanism looks for hints in Kubernetes Pod annotations that have the prefix `co.elastic.hints`. As soon as the container starts, {{agent}} checks it for hints and launches the proper configuration for the container. Hints tell {{agent}} how to monitor the container by using the proper integration. This is the full list of supported hints: ## Required hints: [_required_hints] @@ -93,7 +93,7 @@ If the specified package has no logs support, a generic container’s logs input ### `co.elastic.hints/processors` [_co_elastic_hintsprocessors] -Define a processor to be added to the input configuration. See [*Define processors*](/reference/ingestion-tools/fleet/agent-processors.md) for the list of supported processors. +Define a processor to be added to the input configuration. See [*Define processors*](/reference/fleet/agent-processors.md) for the list of supported processors. If the processors configuration uses list data structure, object fields must be enumerated. For example, hints for the rename processor configuration below @@ -195,7 +195,7 @@ initContainers: ``` ::::{note} -The {{agent}} can load multiple configuration files from `{path.config}/inputs.d` and finally produce a unified one (refer to [*Configure standalone {{agent}}s*](/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md)). Users have the ability to manually mount their own templates under `/usr/share/elastic-agent/state/inputs.d` **if they want to skip enabling initContainers section**. +The {{agent}} can load multiple configuration files from `{path.config}/inputs.d` and finally produce a unified one (refer to [*Configure standalone {{agent}}s*](/reference/fleet/configure-standalone-elastic-agents.md)). Users have the ability to manually mount their own templates under `/usr/share/elastic-agent/state/inputs.d` **if they want to skip enabling initContainers section**. :::: @@ -227,7 +227,7 @@ metadata: After deploying this Pod, the data will start flowing in automatically. You can find it on the index `metrics-redis.info-default`. ::::{note} -All assets (dashboards, ingest pipelines, and so on) related to the Redis integration are not installed. You need to explicitly [install them through {{kib}}](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md). +All assets (dashboards, ingest pipelines, and so on) related to the Redis integration are not installed. You need to explicitly [install them through {{kib}}](/reference/fleet/install-uninstall-integration-assets.md). :::: @@ -337,7 +337,7 @@ providers: ### Hints autodiscovery for kubernetes logs with JSON decoding [_hints_autodiscovery_for_kubernetes_logs_with_json_decoding] -Based on the previous example, users might want to perform extra processing on specific logs, for example to decode specific fields containing JSON strings. Use of [decode_json_fields](/reference/ingestion-tools/fleet/decode-json-fields.md) is advisable as follows: +Based on the previous example, users might want to perform extra processing on specific logs, for example to decode specific fields containing JSON strings. Use of [decode_json_fields](/reference/fleet/decode-json-fields.md) is advisable as follows: You need to have enabled hints autodiscovery, as described in the previous `Hints autodiscovery for Kubernetes log collection` example. diff --git a/reference/ingestion-tools/fleet/host-provider.md b/reference/fleet/host-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/host-provider.md rename to reference/fleet/host-provider.md diff --git a/reference/ingestion-tools/fleet/host-proxy-env-vars.md b/reference/fleet/host-proxy-env-vars.md similarity index 96% rename from reference/ingestion-tools/fleet/host-proxy-env-vars.md rename to reference/fleet/host-proxy-env-vars.md index 6d92b6291b..27957595cb 100644 --- a/reference/ingestion-tools/fleet/host-proxy-env-vars.md +++ b/reference/fleet/host-proxy-env-vars.md @@ -66,7 +66,7 @@ The location where you set these environment variables is platform-specific and After adding environment variables, restart the service. ::::{note} -If you use a proxy server to download new agent versions from `artifacts.elastic.co` for upgrading, configure [Agent binary download settings](/reference/ingestion-tools/fleet/fleet-settings.md#fleet-agent-binary-download-settings). +If you use a proxy server to download new agent versions from `artifacts.elastic.co` for upgrading, configure [Agent binary download settings](/reference/fleet/fleet-settings.md#fleet-agent-binary-download-settings). :::: diff --git a/reference/ingestion-tools/fleet/images/add-agent-to-hosts.png b/reference/fleet/images/add-agent-to-hosts.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-agent-to-hosts.png rename to reference/fleet/images/add-agent-to-hosts.png diff --git a/reference/ingestion-tools/fleet/images/add-fleet-server-advanced.png b/reference/fleet/images/add-fleet-server-advanced.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-fleet-server-advanced.png rename to reference/fleet/images/add-fleet-server-advanced.png diff --git a/reference/ingestion-tools/fleet/images/add-fleet-server-to-policy.png b/reference/fleet/images/add-fleet-server-to-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-fleet-server-to-policy.png rename to reference/fleet/images/add-fleet-server-to-policy.png diff --git a/reference/ingestion-tools/fleet/images/add-fleet-server.png b/reference/fleet/images/add-fleet-server.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-fleet-server.png rename to reference/fleet/images/add-fleet-server.png diff --git a/reference/ingestion-tools/fleet/images/add-integration-standalone.png b/reference/fleet/images/add-integration-standalone.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-integration-standalone.png rename to reference/fleet/images/add-integration-standalone.png diff --git a/reference/ingestion-tools/fleet/images/add-integration.png b/reference/fleet/images/add-integration.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-integration.png rename to reference/fleet/images/add-integration.png diff --git a/reference/ingestion-tools/fleet/images/add-logstash-output.png b/reference/fleet/images/add-logstash-output.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-logstash-output.png rename to reference/fleet/images/add-logstash-output.png diff --git a/reference/ingestion-tools/fleet/images/add-processor.png b/reference/fleet/images/add-processor.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-processor.png rename to reference/fleet/images/add-processor.png diff --git a/reference/ingestion-tools/fleet/images/add-remove-tags.png b/reference/fleet/images/add-remove-tags.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add-remove-tags.png rename to reference/fleet/images/add-remove-tags.png diff --git a/reference/ingestion-tools/fleet/images/add_resource_metadata.png b/reference/fleet/images/add_resource_metadata.png similarity index 100% rename from reference/ingestion-tools/fleet/images/add_resource_metadata.png rename to reference/fleet/images/add_resource_metadata.png diff --git a/reference/ingestion-tools/fleet/images/agent-activity.png b/reference/fleet/images/agent-activity.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-activity.png rename to reference/fleet/images/agent-activity.png diff --git a/reference/ingestion-tools/fleet/images/agent-architecture.png b/reference/fleet/images/agent-architecture.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-architecture.png rename to reference/fleet/images/agent-architecture.png diff --git a/reference/ingestion-tools/fleet/images/agent-detail-integrations-health.png b/reference/fleet/images/agent-detail-integrations-health.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-detail-integrations-health.png rename to reference/fleet/images/agent-detail-integrations-health.png diff --git a/reference/ingestion-tools/fleet/images/agent-detail-overview.png b/reference/fleet/images/agent-detail-overview.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-detail-overview.png rename to reference/fleet/images/agent-detail-overview.png diff --git a/reference/ingestion-tools/fleet/images/agent-health-status.png b/reference/fleet/images/agent-health-status.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-health-status.png rename to reference/fleet/images/agent-health-status.png diff --git a/reference/ingestion-tools/fleet/images/agent-metrics-dashboard.png b/reference/fleet/images/agent-metrics-dashboard.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-metrics-dashboard.png rename to reference/fleet/images/agent-metrics-dashboard.png diff --git a/reference/ingestion-tools/fleet/images/agent-monitoring-assets.png b/reference/fleet/images/agent-monitoring-assets.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-monitoring-assets.png rename to reference/fleet/images/agent-monitoring-assets.png diff --git a/reference/ingestion-tools/fleet/images/agent-monitoring-settings.png b/reference/fleet/images/agent-monitoring-settings.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-monitoring-settings.png rename to reference/fleet/images/agent-monitoring-settings.png diff --git a/reference/ingestion-tools/fleet/images/agent-output-settings.png b/reference/fleet/images/agent-output-settings.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-output-settings.png rename to reference/fleet/images/agent-output-settings.png diff --git a/reference/ingestion-tools/fleet/images/agent-policy-custom-field.png b/reference/fleet/images/agent-policy-custom-field.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-policy-custom-field.png rename to reference/fleet/images/agent-policy-custom-field.png diff --git a/reference/ingestion-tools/fleet/images/agent-privilege-mode.png b/reference/fleet/images/agent-privilege-mode.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-privilege-mode.png rename to reference/fleet/images/agent-privilege-mode.png diff --git a/reference/ingestion-tools/fleet/images/agent-proxy-server-managed-deployment.png b/reference/fleet/images/agent-proxy-server-managed-deployment.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-proxy-server-managed-deployment.png rename to reference/fleet/images/agent-proxy-server-managed-deployment.png diff --git a/reference/ingestion-tools/fleet/images/agent-proxy-server.png b/reference/fleet/images/agent-proxy-server.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-proxy-server.png rename to reference/fleet/images/agent-proxy-server.png diff --git a/reference/ingestion-tools/fleet/images/agent-set-logging-level.png b/reference/fleet/images/agent-set-logging-level.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-set-logging-level.png rename to reference/fleet/images/agent-set-logging-level.png diff --git a/reference/ingestion-tools/fleet/images/agent-status-diagram.png b/reference/fleet/images/agent-status-diagram.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-status-diagram.png rename to reference/fleet/images/agent-status-diagram.png diff --git a/reference/ingestion-tools/fleet/images/agent-status-filter.png b/reference/fleet/images/agent-status-filter.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-status-filter.png rename to reference/fleet/images/agent-status-filter.png diff --git a/reference/ingestion-tools/fleet/images/agent-tags.png b/reference/fleet/images/agent-tags.png similarity index 100% rename from reference/ingestion-tools/fleet/images/agent-tags.png rename to reference/fleet/images/agent-tags.png diff --git a/reference/ingestion-tools/fleet/images/apply-agent-policy.png b/reference/fleet/images/apply-agent-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/apply-agent-policy.png rename to reference/fleet/images/apply-agent-policy.png diff --git a/reference/ingestion-tools/fleet/images/ca-certs.png b/reference/fleet/images/ca-certs.png similarity index 100% rename from reference/ingestion-tools/fleet/images/ca-certs.png rename to reference/fleet/images/ca-certs.png diff --git a/reference/ingestion-tools/fleet/images/ca.png b/reference/fleet/images/ca.png similarity index 100% rename from reference/ingestion-tools/fleet/images/ca.png rename to reference/fleet/images/ca.png diff --git a/reference/ingestion-tools/fleet/images/certificate-rotation-agent-es.png b/reference/fleet/images/certificate-rotation-agent-es.png similarity index 100% rename from reference/ingestion-tools/fleet/images/certificate-rotation-agent-es.png rename to reference/fleet/images/certificate-rotation-agent-es.png diff --git a/reference/ingestion-tools/fleet/images/client-certs.png b/reference/fleet/images/client-certs.png similarity index 100% rename from reference/ingestion-tools/fleet/images/client-certs.png rename to reference/fleet/images/client-certs.png diff --git a/reference/ingestion-tools/fleet/images/collect-agent-diagnostics1.png b/reference/fleet/images/collect-agent-diagnostics1.png similarity index 100% rename from reference/ingestion-tools/fleet/images/collect-agent-diagnostics1.png rename to reference/fleet/images/collect-agent-diagnostics1.png diff --git a/reference/ingestion-tools/fleet/images/collect-agent-diagnostics2.png b/reference/fleet/images/collect-agent-diagnostics2.png similarity index 100% rename from reference/ingestion-tools/fleet/images/collect-agent-diagnostics2.png rename to reference/fleet/images/collect-agent-diagnostics2.png diff --git a/reference/ingestion-tools/fleet/images/component-templates-list.png b/reference/fleet/images/component-templates-list.png similarity index 100% rename from reference/ingestion-tools/fleet/images/component-templates-list.png rename to reference/fleet/images/component-templates-list.png diff --git a/reference/ingestion-tools/fleet/images/copy-api-key.png b/reference/fleet/images/copy-api-key.png similarity index 100% rename from reference/ingestion-tools/fleet/images/copy-api-key.png rename to reference/fleet/images/copy-api-key.png diff --git a/reference/ingestion-tools/fleet/images/create-component-template.png b/reference/fleet/images/create-component-template.png similarity index 100% rename from reference/ingestion-tools/fleet/images/create-component-template.png rename to reference/fleet/images/create-component-template.png diff --git a/reference/ingestion-tools/fleet/images/create-index-template.png b/reference/fleet/images/create-index-template.png similarity index 100% rename from reference/ingestion-tools/fleet/images/create-index-template.png rename to reference/fleet/images/create-index-template.png diff --git a/reference/ingestion-tools/fleet/images/create-standalone-agent-role.png b/reference/fleet/images/create-standalone-agent-role.png similarity index 100% rename from reference/ingestion-tools/fleet/images/create-standalone-agent-role.png rename to reference/fleet/images/create-standalone-agent-role.png diff --git a/reference/ingestion-tools/fleet/images/create-token.png b/reference/fleet/images/create-token.png similarity index 100% rename from reference/ingestion-tools/fleet/images/create-token.png rename to reference/fleet/images/create-token.png diff --git a/reference/ingestion-tools/fleet/images/dashboard-datastream01.png b/reference/fleet/images/dashboard-datastream01.png similarity index 100% rename from reference/ingestion-tools/fleet/images/dashboard-datastream01.png rename to reference/fleet/images/dashboard-datastream01.png diff --git a/reference/ingestion-tools/fleet/images/data-stream-info.png b/reference/fleet/images/data-stream-info.png similarity index 100% rename from reference/ingestion-tools/fleet/images/data-stream-info.png rename to reference/fleet/images/data-stream-info.png diff --git a/reference/ingestion-tools/fleet/images/datastream-namespace.png b/reference/fleet/images/datastream-namespace.png similarity index 100% rename from reference/ingestion-tools/fleet/images/datastream-namespace.png rename to reference/fleet/images/datastream-namespace.png diff --git a/reference/ingestion-tools/fleet/images/download-agent-policy.png b/reference/fleet/images/download-agent-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/download-agent-policy.png rename to reference/fleet/images/download-agent-policy.png diff --git a/reference/ingestion-tools/fleet/images/elastic-agent-edit-proxy-secure-settings.png b/reference/fleet/images/elastic-agent-edit-proxy-secure-settings.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-agent-edit-proxy-secure-settings.png rename to reference/fleet/images/elastic-agent-edit-proxy-secure-settings.png diff --git a/reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-agent-binary-source.png b/reference/fleet/images/elastic-agent-proxy-edit-agent-binary-source.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-agent-binary-source.png rename to reference/fleet/images/elastic-agent-proxy-edit-agent-binary-source.png diff --git a/reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-fleet-server.png b/reference/fleet/images/elastic-agent-proxy-edit-fleet-server.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-fleet-server.png rename to reference/fleet/images/elastic-agent-proxy-edit-fleet-server.png diff --git a/reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-output.png b/reference/fleet/images/elastic-agent-proxy-edit-output.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-output.png rename to reference/fleet/images/elastic-agent-proxy-edit-output.png diff --git a/reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-proxy.png b/reference/fleet/images/elastic-agent-proxy-edit-proxy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-agent-proxy-edit-proxy.png rename to reference/fleet/images/elastic-agent-proxy-edit-proxy.png diff --git a/reference/ingestion-tools/fleet/images/elastic-agent-proxy-gateway-secure.png b/reference/fleet/images/elastic-agent-proxy-gateway-secure.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-agent-proxy-gateway-secure.png rename to reference/fleet/images/elastic-agent-proxy-gateway-secure.png diff --git a/reference/ingestion-tools/fleet/images/elastic-agent-status-rule.png b/reference/fleet/images/elastic-agent-status-rule.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-agent-status-rule.png rename to reference/fleet/images/elastic-agent-status-rule.png diff --git a/reference/ingestion-tools/fleet/images/elastic-cloud-agent-policy.png b/reference/fleet/images/elastic-cloud-agent-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/elastic-cloud-agent-policy.png rename to reference/fleet/images/elastic-cloud-agent-policy.png diff --git a/reference/ingestion-tools/fleet/images/fleet-add-output-button.png b/reference/fleet/images/fleet-add-output-button.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-add-output-button.png rename to reference/fleet/images/fleet-add-output-button.png diff --git a/reference/ingestion-tools/fleet/images/fleet-epr-proxy.png b/reference/fleet/images/fleet-epr-proxy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-epr-proxy.png rename to reference/fleet/images/fleet-epr-proxy.png diff --git a/reference/ingestion-tools/fleet/images/fleet-policy-hidden-secret.png b/reference/fleet/images/fleet-policy-hidden-secret.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-policy-hidden-secret.png rename to reference/fleet/images/fleet-policy-hidden-secret.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-agent-policies-diagram.png b/reference/fleet/images/fleet-server-agent-policies-diagram.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-agent-policies-diagram.png rename to reference/fleet/images/fleet-server-agent-policies-diagram.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-agent-policy-page.png b/reference/fleet/images/fleet-server-agent-policy-page.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-agent-policy-page.png rename to reference/fleet/images/fleet-server-agent-policy-page.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-certs.png b/reference/fleet/images/fleet-server-certs.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-certs.png rename to reference/fleet/images/fleet-server-certs.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-cloud-deployment.png b/reference/fleet/images/fleet-server-cloud-deployment.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-cloud-deployment.png rename to reference/fleet/images/fleet-server-cloud-deployment.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-configuration.png b/reference/fleet/images/fleet-server-configuration.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-configuration.png rename to reference/fleet/images/fleet-server-configuration.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-hosted-container.png b/reference/fleet/images/fleet-server-hosted-container.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-hosted-container.png rename to reference/fleet/images/fleet-server-hosted-container.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-on-prem-deployment.png b/reference/fleet/images/fleet-server-on-prem-deployment.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-on-prem-deployment.png rename to reference/fleet/images/fleet-server-on-prem-deployment.png diff --git a/reference/ingestion-tools/fleet/images/fleet-server-on-prem-es-cloud.png b/reference/fleet/images/fleet-server-on-prem-es-cloud.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-server-on-prem-es-cloud.png rename to reference/fleet/images/fleet-server-on-prem-es-cloud.png diff --git a/reference/ingestion-tools/fleet/images/fleet-start.png b/reference/fleet/images/fleet-start.png similarity index 100% rename from reference/ingestion-tools/fleet/images/fleet-start.png rename to reference/fleet/images/fleet-start.png diff --git a/reference/ingestion-tools/fleet/images/green-check.svg b/reference/fleet/images/green-check.svg similarity index 100% rename from reference/ingestion-tools/fleet/images/green-check.svg rename to reference/fleet/images/green-check.svg diff --git a/reference/ingestion-tools/fleet/images/gsub_cronjob.png b/reference/fleet/images/gsub_cronjob.png similarity index 100% rename from reference/ingestion-tools/fleet/images/gsub_cronjob.png rename to reference/fleet/images/gsub_cronjob.png diff --git a/reference/ingestion-tools/fleet/images/gsub_deployment.png b/reference/fleet/images/gsub_deployment.png similarity index 100% rename from reference/ingestion-tools/fleet/images/gsub_deployment.png rename to reference/fleet/images/gsub_deployment.png diff --git a/reference/ingestion-tools/fleet/images/guide-add-agent-standalone01.png b/reference/fleet/images/guide-add-agent-standalone01.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-add-agent-standalone01.png rename to reference/fleet/images/guide-add-agent-standalone01.png diff --git a/reference/ingestion-tools/fleet/images/guide-add-nginx-integration.png b/reference/fleet/images/guide-add-nginx-integration.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-add-nginx-integration.png rename to reference/fleet/images/guide-add-nginx-integration.png diff --git a/reference/ingestion-tools/fleet/images/guide-agent-logs-flowing.png b/reference/fleet/images/guide-agent-logs-flowing.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-agent-logs-flowing.png rename to reference/fleet/images/guide-agent-logs-flowing.png diff --git a/reference/ingestion-tools/fleet/images/guide-agent-metrics-flowing.png b/reference/fleet/images/guide-agent-metrics-flowing.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-agent-metrics-flowing.png rename to reference/fleet/images/guide-agent-metrics-flowing.png diff --git a/reference/ingestion-tools/fleet/images/guide-agent-policies.png b/reference/fleet/images/guide-agent-policies.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-agent-policies.png rename to reference/fleet/images/guide-agent-policies.png diff --git a/reference/ingestion-tools/fleet/images/guide-create-agent-policy.png b/reference/fleet/images/guide-create-agent-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-create-agent-policy.png rename to reference/fleet/images/guide-create-agent-policy.png diff --git a/reference/ingestion-tools/fleet/images/guide-install-agent-on-host.png b/reference/fleet/images/guide-install-agent-on-host.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-install-agent-on-host.png rename to reference/fleet/images/guide-install-agent-on-host.png diff --git a/reference/ingestion-tools/fleet/images/guide-integrations-page.png b/reference/fleet/images/guide-integrations-page.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-integrations-page.png rename to reference/fleet/images/guide-integrations-page.png diff --git a/reference/ingestion-tools/fleet/images/guide-nginx-browser-breakdown.png b/reference/fleet/images/guide-nginx-browser-breakdown.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-nginx-browser-breakdown.png rename to reference/fleet/images/guide-nginx-browser-breakdown.png diff --git a/reference/ingestion-tools/fleet/images/guide-nginx-integration-added.png b/reference/fleet/images/guide-nginx-integration-added.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-nginx-integration-added.png rename to reference/fleet/images/guide-nginx-integration-added.png diff --git a/reference/ingestion-tools/fleet/images/guide-nginx-policy.png b/reference/fleet/images/guide-nginx-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-nginx-policy.png rename to reference/fleet/images/guide-nginx-policy.png diff --git a/reference/ingestion-tools/fleet/images/guide-nginx-welcome.png b/reference/fleet/images/guide-nginx-welcome.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-nginx-welcome.png rename to reference/fleet/images/guide-nginx-welcome.png diff --git a/reference/ingestion-tools/fleet/images/guide-sign-up-trial.png b/reference/fleet/images/guide-sign-up-trial.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-sign-up-trial.png rename to reference/fleet/images/guide-sign-up-trial.png diff --git a/reference/ingestion-tools/fleet/images/guide-system-metrics-dashboard.png b/reference/fleet/images/guide-system-metrics-dashboard.png similarity index 100% rename from reference/ingestion-tools/fleet/images/guide-system-metrics-dashboard.png rename to reference/fleet/images/guide-system-metrics-dashboard.png diff --git a/reference/ingestion-tools/fleet/images/helm-example-fleet-metrics-dashboard.png b/reference/fleet/images/helm-example-fleet-metrics-dashboard.png similarity index 100% rename from reference/ingestion-tools/fleet/images/helm-example-fleet-metrics-dashboard.png rename to reference/fleet/images/helm-example-fleet-metrics-dashboard.png diff --git a/reference/ingestion-tools/fleet/images/helm-example-nodes-enrollment-confirmation.png b/reference/fleet/images/helm-example-nodes-enrollment-confirmation.png similarity index 100% rename from reference/ingestion-tools/fleet/images/helm-example-nodes-enrollment-confirmation.png rename to reference/fleet/images/helm-example-nodes-enrollment-confirmation.png diff --git a/reference/ingestion-tools/fleet/images/helm-example-nodes-logs-and-metrics.png b/reference/fleet/images/helm-example-nodes-logs-and-metrics.png similarity index 100% rename from reference/ingestion-tools/fleet/images/helm-example-nodes-logs-and-metrics.png rename to reference/fleet/images/helm-example-nodes-logs-and-metrics.png diff --git a/reference/ingestion-tools/fleet/images/helm-example-nodes-metrics-dashboard.png b/reference/fleet/images/helm-example-nodes-metrics-dashboard.png similarity index 100% rename from reference/ingestion-tools/fleet/images/helm-example-nodes-metrics-dashboard.png rename to reference/fleet/images/helm-example-nodes-metrics-dashboard.png diff --git a/reference/ingestion-tools/fleet/images/helm-example-pods-metrics-dashboard.png b/reference/fleet/images/helm-example-pods-metrics-dashboard.png similarity index 100% rename from reference/ingestion-tools/fleet/images/helm-example-pods-metrics-dashboard.png rename to reference/fleet/images/helm-example-pods-metrics-dashboard.png diff --git a/reference/ingestion-tools/fleet/images/index-template-system-auth.png b/reference/fleet/images/index-template-system-auth.png similarity index 100% rename from reference/ingestion-tools/fleet/images/index-template-system-auth.png rename to reference/fleet/images/index-template-system-auth.png diff --git a/reference/ingestion-tools/fleet/images/ingest_pipeline_custom_k8s.png b/reference/fleet/images/ingest_pipeline_custom_k8s.png similarity index 100% rename from reference/ingestion-tools/fleet/images/ingest_pipeline_custom_k8s.png rename to reference/fleet/images/ingest_pipeline_custom_k8s.png diff --git a/reference/ingestion-tools/fleet/images/integration-root-requirement.png b/reference/fleet/images/integration-root-requirement.png similarity index 100% rename from reference/ingestion-tools/fleet/images/integration-root-requirement.png rename to reference/fleet/images/integration-root-requirement.png diff --git a/reference/ingestion-tools/fleet/images/integrations-server-hosted-container.png b/reference/fleet/images/integrations-server-hosted-container.png similarity index 100% rename from reference/ingestion-tools/fleet/images/integrations-server-hosted-container.png rename to reference/fleet/images/integrations-server-hosted-container.png diff --git a/reference/ingestion-tools/fleet/images/integrations.png b/reference/fleet/images/integrations.png similarity index 100% rename from reference/ingestion-tools/fleet/images/integrations.png rename to reference/fleet/images/integrations.png diff --git a/reference/ingestion-tools/fleet/images/k8skibanaUI.png b/reference/fleet/images/k8skibanaUI.png similarity index 100% rename from reference/ingestion-tools/fleet/images/k8skibanaUI.png rename to reference/fleet/images/k8skibanaUI.png diff --git a/reference/ingestion-tools/fleet/images/k8sscaling.png b/reference/fleet/images/k8sscaling.png similarity index 100% rename from reference/ingestion-tools/fleet/images/k8sscaling.png rename to reference/fleet/images/k8sscaling.png diff --git a/reference/ingestion-tools/fleet/images/kibana-agent-flyout.png b/reference/fleet/images/kibana-agent-flyout.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kibana-agent-flyout.png rename to reference/fleet/images/kibana-agent-flyout.png diff --git a/reference/ingestion-tools/fleet/images/kibana-fleet-agents copy.png b/reference/fleet/images/kibana-fleet-agents copy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kibana-fleet-agents copy.png rename to reference/fleet/images/kibana-fleet-agents copy.png diff --git a/reference/ingestion-tools/fleet/images/kibana-fleet-agents.png b/reference/fleet/images/kibana-fleet-agents.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kibana-fleet-agents.png rename to reference/fleet/images/kibana-fleet-agents.png diff --git a/reference/ingestion-tools/fleet/images/kibana-fleet-datasets.png b/reference/fleet/images/kibana-fleet-datasets.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kibana-fleet-datasets.png rename to reference/fleet/images/kibana-fleet-datasets.png diff --git a/reference/ingestion-tools/fleet/images/kibana-fleet-datastreams.png b/reference/fleet/images/kibana-fleet-datastreams.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kibana-fleet-datastreams.png rename to reference/fleet/images/kibana-fleet-datastreams.png diff --git a/reference/ingestion-tools/fleet/images/kibana-fleet-privileges-all.png b/reference/fleet/images/kibana-fleet-privileges-all.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kibana-fleet-privileges-all.png rename to reference/fleet/images/kibana-fleet-privileges-all.png diff --git a/reference/ingestion-tools/fleet/images/kibana-fleet-privileges-read.png b/reference/fleet/images/kibana-fleet-privileges-read.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kibana-fleet-privileges-read.png rename to reference/fleet/images/kibana-fleet-privileges-read.png diff --git a/reference/ingestion-tools/fleet/images/kubernetes_metadata.png b/reference/fleet/images/kubernetes_metadata.png similarity index 100% rename from reference/ingestion-tools/fleet/images/kubernetes_metadata.png rename to reference/fleet/images/kubernetes_metadata.png diff --git a/reference/ingestion-tools/fleet/images/logstash-certs.png b/reference/fleet/images/logstash-certs.png similarity index 100% rename from reference/ingestion-tools/fleet/images/logstash-certs.png rename to reference/fleet/images/logstash-certs.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-agents-offline.png b/reference/fleet/images/migrate-agent-agents-offline.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-agents-offline.png rename to reference/fleet/images/migrate-agent-agents-offline.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-deployment-id.png b/reference/fleet/images/migrate-agent-deployment-id.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-deployment-id.png rename to reference/fleet/images/migrate-agent-deployment-id.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-elasticsearch-output.png b/reference/fleet/images/migrate-agent-elasticsearch-output.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-elasticsearch-output.png rename to reference/fleet/images/migrate-agent-elasticsearch-output.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-fleet-server-host.png b/reference/fleet/images/migrate-agent-fleet-server-host.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-fleet-server-host.png rename to reference/fleet/images/migrate-agent-fleet-server-host.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-host-output-settings.png b/reference/fleet/images/migrate-agent-host-output-settings.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-host-output-settings.png rename to reference/fleet/images/migrate-agent-host-output-settings.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-install-command-output.png b/reference/fleet/images/migrate-agent-install-command-output.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-install-command-output.png rename to reference/fleet/images/migrate-agent-install-command-output.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-install-command.png b/reference/fleet/images/migrate-agent-install-command.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-install-command.png rename to reference/fleet/images/migrate-agent-install-command.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-new-deployment.png b/reference/fleet/images/migrate-agent-new-deployment.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-new-deployment.png rename to reference/fleet/images/migrate-agent-new-deployment.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-newly-enrolled-agents.png b/reference/fleet/images/migrate-agent-newly-enrolled-agents.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-newly-enrolled-agents.png rename to reference/fleet/images/migrate-agent-newly-enrolled-agents.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-policy-settings.png b/reference/fleet/images/migrate-agent-policy-settings.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-policy-settings.png rename to reference/fleet/images/migrate-agent-policy-settings.png diff --git a/reference/ingestion-tools/fleet/images/migrate-agent-take-snapshot.png b/reference/fleet/images/migrate-agent-take-snapshot.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migrate-agent-take-snapshot.png rename to reference/fleet/images/migrate-agent-take-snapshot.png diff --git a/reference/ingestion-tools/fleet/images/migration-add-integration-policy.png b/reference/fleet/images/migration-add-integration-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-add-integration-policy.png rename to reference/fleet/images/migration-add-integration-policy.png diff --git a/reference/ingestion-tools/fleet/images/migration-add-nginx-integration.png b/reference/fleet/images/migration-add-nginx-integration.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-add-nginx-integration.png rename to reference/fleet/images/migration-add-nginx-integration.png diff --git a/reference/ingestion-tools/fleet/images/migration-add-processor.png b/reference/fleet/images/migration-add-processor.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-add-processor.png rename to reference/fleet/images/migration-add-processor.png diff --git a/reference/ingestion-tools/fleet/images/migration-agent-data-streams01.png b/reference/fleet/images/migration-agent-data-streams01.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-agent-data-streams01.png rename to reference/fleet/images/migration-agent-data-streams01.png diff --git a/reference/ingestion-tools/fleet/images/migration-agent-details01.png b/reference/fleet/images/migration-agent-details01.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-agent-details01.png rename to reference/fleet/images/migration-agent-details01.png diff --git a/reference/ingestion-tools/fleet/images/migration-agent-status-healthy01.png b/reference/fleet/images/migration-agent-status-healthy01.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-agent-status-healthy01.png rename to reference/fleet/images/migration-agent-status-healthy01.png diff --git a/reference/ingestion-tools/fleet/images/migration-event-from-agent.png b/reference/fleet/images/migration-event-from-agent.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-event-from-agent.png rename to reference/fleet/images/migration-event-from-agent.png diff --git a/reference/ingestion-tools/fleet/images/migration-event-from-filebeat.png b/reference/fleet/images/migration-event-from-filebeat.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-event-from-filebeat.png rename to reference/fleet/images/migration-event-from-filebeat.png diff --git a/reference/ingestion-tools/fleet/images/migration-index-lifecycle-policies.png b/reference/fleet/images/migration-index-lifecycle-policies.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-index-lifecycle-policies.png rename to reference/fleet/images/migration-index-lifecycle-policies.png diff --git a/reference/ingestion-tools/fleet/images/migration-preserve-raw-event.png b/reference/fleet/images/migration-preserve-raw-event.png similarity index 100% rename from reference/ingestion-tools/fleet/images/migration-preserve-raw-event.png rename to reference/fleet/images/migration-preserve-raw-event.png diff --git a/reference/ingestion-tools/fleet/images/mutual-tls-cloud-proxy.png b/reference/fleet/images/mutual-tls-cloud-proxy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/mutual-tls-cloud-proxy.png rename to reference/fleet/images/mutual-tls-cloud-proxy.png diff --git a/reference/ingestion-tools/fleet/images/mutual-tls-cloud.png b/reference/fleet/images/mutual-tls-cloud.png similarity index 100% rename from reference/ingestion-tools/fleet/images/mutual-tls-cloud.png rename to reference/fleet/images/mutual-tls-cloud.png diff --git a/reference/ingestion-tools/fleet/images/mutual-tls-fs-onprem-proxy.png b/reference/fleet/images/mutual-tls-fs-onprem-proxy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/mutual-tls-fs-onprem-proxy.png rename to reference/fleet/images/mutual-tls-fs-onprem-proxy.png diff --git a/reference/ingestion-tools/fleet/images/mutual-tls-fs-onprem.png b/reference/fleet/images/mutual-tls-fs-onprem.png similarity index 100% rename from reference/ingestion-tools/fleet/images/mutual-tls-fs-onprem.png rename to reference/fleet/images/mutual-tls-fs-onprem.png diff --git a/reference/ingestion-tools/fleet/images/mutual-tls-on-prem.png b/reference/fleet/images/mutual-tls-on-prem.png similarity index 100% rename from reference/ingestion-tools/fleet/images/mutual-tls-on-prem.png rename to reference/fleet/images/mutual-tls-on-prem.png diff --git a/reference/ingestion-tools/fleet/images/mutual-tls-onprem-advanced-yaml.png b/reference/fleet/images/mutual-tls-onprem-advanced-yaml.png similarity index 100% rename from reference/ingestion-tools/fleet/images/mutual-tls-onprem-advanced-yaml.png rename to reference/fleet/images/mutual-tls-onprem-advanced-yaml.png diff --git a/reference/ingestion-tools/fleet/images/pod-latency.png b/reference/fleet/images/pod-latency.png similarity index 100% rename from reference/ingestion-tools/fleet/images/pod-latency.png rename to reference/fleet/images/pod-latency.png diff --git a/reference/ingestion-tools/fleet/images/privileged-and-unprivileged-agents.png b/reference/fleet/images/privileged-and-unprivileged-agents.png similarity index 100% rename from reference/ingestion-tools/fleet/images/privileged-and-unprivileged-agents.png rename to reference/fleet/images/privileged-and-unprivileged-agents.png diff --git a/reference/ingestion-tools/fleet/images/red-x.svg b/reference/fleet/images/red-x.svg similarity index 100% rename from reference/ingestion-tools/fleet/images/red-x.svg rename to reference/fleet/images/red-x.svg diff --git a/reference/ingestion-tools/fleet/images/review-component-template01.png b/reference/fleet/images/review-component-template01.png similarity index 100% rename from reference/ingestion-tools/fleet/images/review-component-template01.png rename to reference/fleet/images/review-component-template01.png diff --git a/reference/ingestion-tools/fleet/images/review-component-template02.png b/reference/fleet/images/review-component-template02.png similarity index 100% rename from reference/ingestion-tools/fleet/images/review-component-template02.png rename to reference/fleet/images/review-component-template02.png diff --git a/reference/ingestion-tools/fleet/images/revoke-token.png b/reference/fleet/images/revoke-token.png similarity index 100% rename from reference/ingestion-tools/fleet/images/revoke-token.png rename to reference/fleet/images/revoke-token.png diff --git a/reference/ingestion-tools/fleet/images/root-integration-and-unprivileged-agents.png b/reference/fleet/images/root-integration-and-unprivileged-agents.png similarity index 100% rename from reference/ingestion-tools/fleet/images/root-integration-and-unprivileged-agents.png rename to reference/fleet/images/root-integration-and-unprivileged-agents.png diff --git a/reference/ingestion-tools/fleet/images/schedule-upgrade.png b/reference/fleet/images/schedule-upgrade.png similarity index 100% rename from reference/ingestion-tools/fleet/images/schedule-upgrade.png rename to reference/fleet/images/schedule-upgrade.png diff --git a/reference/ingestion-tools/fleet/images/selected-agent-metrics-dashboard.png b/reference/fleet/images/selected-agent-metrics-dashboard.png similarity index 100% rename from reference/ingestion-tools/fleet/images/selected-agent-metrics-dashboard.png rename to reference/fleet/images/selected-agent-metrics-dashboard.png diff --git a/reference/ingestion-tools/fleet/images/show-token.png b/reference/fleet/images/show-token.png similarity index 100% rename from reference/ingestion-tools/fleet/images/show-token.png rename to reference/fleet/images/show-token.png diff --git a/reference/ingestion-tools/fleet/images/state-pod.png b/reference/fleet/images/state-pod.png similarity index 100% rename from reference/ingestion-tools/fleet/images/state-pod.png rename to reference/fleet/images/state-pod.png diff --git a/reference/ingestion-tools/fleet/images/system-managed.png b/reference/fleet/images/system-managed.png similarity index 100% rename from reference/ingestion-tools/fleet/images/system-managed.png rename to reference/fleet/images/system-managed.png diff --git a/reference/ingestion-tools/fleet/images/tls-overview-mutual-all.jpg b/reference/fleet/images/tls-overview-mutual-all.jpg similarity index 100% rename from reference/ingestion-tools/fleet/images/tls-overview-mutual-all.jpg rename to reference/fleet/images/tls-overview-mutual-all.jpg diff --git a/reference/ingestion-tools/fleet/images/tls-overview-mutual-fs-agent.png b/reference/fleet/images/tls-overview-mutual-fs-agent.png similarity index 100% rename from reference/ingestion-tools/fleet/images/tls-overview-mutual-fs-agent.png rename to reference/fleet/images/tls-overview-mutual-fs-agent.png diff --git a/reference/ingestion-tools/fleet/images/tls-overview-mutual-fs-es.png b/reference/fleet/images/tls-overview-mutual-fs-es.png similarity index 100% rename from reference/ingestion-tools/fleet/images/tls-overview-mutual-fs-es.png rename to reference/fleet/images/tls-overview-mutual-fs-es.png diff --git a/reference/ingestion-tools/fleet/images/tls-overview-oneway-all.jpg b/reference/fleet/images/tls-overview-oneway-all.jpg similarity index 100% rename from reference/ingestion-tools/fleet/images/tls-overview-oneway-all.jpg rename to reference/fleet/images/tls-overview-oneway-all.jpg diff --git a/reference/ingestion-tools/fleet/images/tls-overview-oneway-fs-agent.png b/reference/fleet/images/tls-overview-oneway-fs-agent.png similarity index 100% rename from reference/ingestion-tools/fleet/images/tls-overview-oneway-fs-agent.png rename to reference/fleet/images/tls-overview-oneway-fs-agent.png diff --git a/reference/ingestion-tools/fleet/images/tls-overview-oneway-fs-es.png b/reference/fleet/images/tls-overview-oneway-fs-es.png similarity index 100% rename from reference/ingestion-tools/fleet/images/tls-overview-oneway-fs-es.png rename to reference/fleet/images/tls-overview-oneway-fs-es.png diff --git a/reference/ingestion-tools/fleet/images/unprivileged-agent-warning.png b/reference/fleet/images/unprivileged-agent-warning.png similarity index 100% rename from reference/ingestion-tools/fleet/images/unprivileged-agent-warning.png rename to reference/fleet/images/unprivileged-agent-warning.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-agent-custom.png b/reference/fleet/images/upgrade-agent-custom.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-agent-custom.png rename to reference/fleet/images/upgrade-agent-custom.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-available-indicator.png b/reference/fleet/images/upgrade-available-indicator.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-available-indicator.png rename to reference/fleet/images/upgrade-available-indicator.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-detailed-state01.png b/reference/fleet/images/upgrade-detailed-state01.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-detailed-state01.png rename to reference/fleet/images/upgrade-detailed-state01.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-detailed-state02.png b/reference/fleet/images/upgrade-detailed-state02.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-detailed-state02.png rename to reference/fleet/images/upgrade-detailed-state02.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-failure.png b/reference/fleet/images/upgrade-failure.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-failure.png rename to reference/fleet/images/upgrade-failure.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-integration-policies-automatically.png b/reference/fleet/images/upgrade-integration-policies-automatically.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-integration-policies-automatically.png rename to reference/fleet/images/upgrade-integration-policies-automatically.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-integration.png b/reference/fleet/images/upgrade-integration.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-integration.png rename to reference/fleet/images/upgrade-integration.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-non-detailed.png b/reference/fleet/images/upgrade-non-detailed.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-non-detailed.png rename to reference/fleet/images/upgrade-non-detailed.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-package-policy.png b/reference/fleet/images/upgrade-package-policy.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-package-policy.png rename to reference/fleet/images/upgrade-package-policy.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-policy-editor.png b/reference/fleet/images/upgrade-policy-editor.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-policy-editor.png rename to reference/fleet/images/upgrade-policy-editor.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-resolve-conflicts.png b/reference/fleet/images/upgrade-resolve-conflicts.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-resolve-conflicts.png rename to reference/fleet/images/upgrade-resolve-conflicts.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-single-agent.png b/reference/fleet/images/upgrade-single-agent.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-single-agent.png rename to reference/fleet/images/upgrade-single-agent.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-states.png b/reference/fleet/images/upgrade-states.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-states.png rename to reference/fleet/images/upgrade-states.png diff --git a/reference/ingestion-tools/fleet/images/upgrade-view-previous-config.png b/reference/fleet/images/upgrade-view-previous-config.png similarity index 100% rename from reference/ingestion-tools/fleet/images/upgrade-view-previous-config.png rename to reference/fleet/images/upgrade-view-previous-config.png diff --git a/reference/ingestion-tools/fleet/images/view-agent-logs.png b/reference/fleet/images/view-agent-logs.png similarity index 100% rename from reference/ingestion-tools/fleet/images/view-agent-logs.png rename to reference/fleet/images/view-agent-logs.png diff --git a/reference/ingestion-tools/fleet/include_fields-processor.md b/reference/fleet/include_fields-processor.md similarity index 85% rename from reference/ingestion-tools/fleet/include_fields-processor.md rename to reference/fleet/include_fields-processor.md index 546b3796e9..6dd3bd1fe2 100644 --- a/reference/ingestion-tools/fleet/include_fields-processor.md +++ b/reference/fleet/include_fields-processor.md @@ -19,10 +19,10 @@ The `include_fields` processor specifies which fields to export if a certain con fields: ["field1", "field2", ...] ``` -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/index.md b/reference/fleet/index.md similarity index 93% rename from reference/ingestion-tools/fleet/index.md rename to reference/fleet/index.md index e1b750f136..3a881626dc 100644 --- a/reference/ingestion-tools/fleet/index.md +++ b/reference/fleet/index.md @@ -22,10 +22,10 @@ As the following diagram illustrates, {{agent}} can monitor the host where it's :alt: Image showing {{agent}} collecting data from local host and remote services ::: -To learn about installation options, refer to [](/reference/ingestion-tools/fleet/install-elastic-agents.md). +To learn about installation options, refer to [](/reference/fleet/install-elastic-agents.md). :::{note} -Using {{fleet}} and {{agent}} {{serverless-full}}? Please note these [restrictions](/reference/ingestion-tools/fleet/fleet-agent-serverless-restrictions.md). +Using {{fleet}} and {{agent}} {{serverless-full}}? Please note these [restrictions](/reference/fleet/fleet-agent-serverless-restrictions.md). ::: :::{tip} @@ -52,7 +52,7 @@ Agent policies specify which integrations you want to run and on which hosts. Yo When you add an integration, you configure inputs for logs and metrics, such as the path to your Nginx access logs. When you're done, you save the integration to an {{agent}} policy. The next time enrolled agents check in, they receive the update. Having the policies automatically deployed is more convenient than doing it yourself by using SSH, Ansible playbooks, or some other tool. -For more information, refer to [](/reference/ingestion-tools/fleet/agent-policy.md). +For more information, refer to [](/reference/fleet/agent-policy.md). If you prefer infrastructure as code, you may use YAML files and APIs. {{fleet}} has an API-first design. Anything you can do in the UI, you can also do using the API. This makes it easy to automate and integrate with other systems. @@ -60,7 +60,7 @@ If you prefer infrastructure as code, you may use YAML files and APIs. {{fleet}} The {{package-registry}} is an online package hosting service for the {{agent}} integrations available in {{kib}}. -{{kib}} connects to the {{package-registry}} at `epr.elastic.co` using the Elastic Package Manager, downloads the latest integration package, and stores its assets in {{es}}. This process typically requires an internet connection because integrations are updated and released periodically. You can find more information about running the {{package-registry}} in air-gapped environments in the section about [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +{{kib}} connects to the {{package-registry}} at `epr.elastic.co` using the Elastic Package Manager, downloads the latest integration package, and stores its assets in {{es}}. This process typically requires an internet connection because integrations are updated and released periodically. You can find more information about running the {{package-registry}} in air-gapped environments in the section about [Air-gapped environments](/reference/fleet/air-gapped.md). ## Elastic Artifact Registry [artifact-registry-intro] @@ -68,7 +68,7 @@ The {{package-registry}} is an online package hosting service for the {{agent}} Additionally, access to `artifacts.security.elastic.co` is needed for {{agent}} updates and security artifacts when using {{elastic-defend}}. -You can find more information about running the above mentioned resources in air-gapped environments in the section about [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +You can find more information about running the above mentioned resources in air-gapped environments in the section about [Air-gapped environments](/reference/fleet/air-gapped.md). ## Central management in {{fleet}} [central-management] @@ -117,7 +117,7 @@ For more information, refer to [{{stack}} subscriptions](https://www.elastic.co/ {{fleet-server}} is the mechanism to connect {{agents}} to {{fleet}}. It allows for a scalable infrastructure and is supported in {{ecloud}} and self-managed clusters. {{fleet-server}} is a separate process that communicates with the deployed {{agents}}. It can be started from any available x64 architecture {{agent}} artifact. -For more information, refer to [](/reference/ingestion-tools/fleet/fleet-server.md). +For more information, refer to [](/reference/fleet/fleet-server.md). :::{admonition} {{fleet-server}} with {{serverless-full}} On-premises {{fleet-server}} is not currently available for use with @@ -135,7 +135,7 @@ On macOS and Windows, when the {{elastic-defend}} integration is added to the ag ## Data streams make index management easier [data-streams-intro] -The data collected by {{agent}} is stored in indices that are more granular than you'd get by default with the {{beats}} shippers or APM Server. This gives you more visibility into the sources of data volume, and control over lifecycle management policies and index permissions. These indices are called [data streams](/reference/ingestion-tools/fleet/data-streams.md). +The data collected by {{agent}} is stored in indices that are more granular than you'd get by default with the {{beats}} shippers or APM Server. This gives you more visibility into the sources of data volume, and control over lifecycle management policies and index permissions. These indices are called [data streams](/reference/fleet/data-streams.md). ## Quick starts [fleet-elastic-agent-quick-start] diff --git a/reference/ingestion-tools/fleet/ingest-pipeline-kubernetes.md b/reference/fleet/ingest-pipeline-kubernetes.md similarity index 95% rename from reference/ingestion-tools/fleet/ingest-pipeline-kubernetes.md rename to reference/fleet/ingest-pipeline-kubernetes.md index e4379cf577..0a9a346909 100644 --- a/reference/ingestion-tools/fleet/ingest-pipeline-kubernetes.md +++ b/reference/fleet/ingest-pipeline-kubernetes.md @@ -13,7 +13,7 @@ Custom pipelines can be used to add custom data processing, like adding fields, The [{{k8s}} Integration](integration-docs://reference/kubernetes/index.md) is used to collect logs and metrics from Kubernetes clusters with {{agent}}. During the collection, the integration enhances the collected information with extra useful information that users can correlate with different Kubernetes assets. This additional information added on top of collected data, such as labels, annotations, ancestor names of Kubernetes assets, and others, are called metadata. -The [{{k8s}} Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) offers the `add_resource_metadata` option to configure the metadata enrichment options. +The [{{k8s}} Provider](/reference/fleet/kubernetes-provider.md) offers the `add_resource_metadata` option to configure the metadata enrichment options. For {{agent}} versions >[8.10.4], the default configuration for metadata enrichment is `add_resource_metadata.deployment=false` and `add_resource_metadata.cronjob=false`. This means that pods that are created from replicasets that belong to specific deployments would not be enriched with `kubernetes.deployment.name`. Additionally, pods that are created from jobs that belong to specific cronjobs, would not be enriched with `kubernetes.cronjob.name`. diff --git a/reference/ingestion-tools/fleet/install-agent-msi.md b/reference/fleet/install-agent-msi.md similarity index 88% rename from reference/ingestion-tools/fleet/install-agent-msi.md rename to reference/fleet/install-agent-msi.md index c141a17739..c901a97fd5 100644 --- a/reference/ingestion-tools/fleet/install-agent-msi.md +++ b/reference/fleet/install-agent-msi.md @@ -38,7 +38,7 @@ The MSI package installer must be run by an administrator account. The installer * `URL` is the {{fleet-server}} URL used to enroll the {{agent}} into {{fleet}}. You can find this on the {{fleet}} **Settings** tab in {{kib}}. * `TOKEN` is the authentication token used to enroll the {{agent}} into {{fleet}}. You can find this on the {{fleet}} **Enrollment tokens** tab. - When you run the command, the value set for `INSTALLARGS` will be passed to the [`elastic-agent install`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) command verbatim. + When you run the command, the value set for `INSTALLARGS` will be passed to the [`elastic-agent install`](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) command verbatim. 3. If you need to troubleshoot, you can install using `msiexec` with the `-L*V "log.txt"` option to create installation logs: @@ -53,10 +53,10 @@ The MSI package installer must be run by an administrator account. The installer Installing using an MSI package has the following behaviors: * If `INSTALLARGS` are not provided, the MSI will copy the files to a temporary folder and finish. -* If `INSTALLARGS` are provided, the MSI will copy the files to a temporary folder and then run the [`elastic-agent install`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) command with the provided parameters. If the install flow is successful, the temporary folder is deleted. +* If `INSTALLARGS` are provided, the MSI will copy the files to a temporary folder and then run the [`elastic-agent install`](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) command with the provided parameters. If the install flow is successful, the temporary folder is deleted. * If `INSTALLARGS` are provided but the `elastic-agent install` command fails, the top-level folder is NOT deleted, in order to allow for further troubleshooting. * If the `elastic-agent install` command fails for any reason, the MSI will rollback all changes. -* If the {{agent}} enrollment fails, the install will fail as well. To avoid this behavior you can add the [`--delay-enroll`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-install-command) option to the install command. +* If the {{agent}} enrollment fails, the install will fail as well. To avoid this behavior you can add the [`--delay-enroll`](/reference/fleet/agent-command-reference.md#elastic-agent-install-command) option to the install command. ## Upgrading [_upgrading] diff --git a/reference/ingestion-tools/fleet/install-elastic-agents-in-containers.md b/reference/fleet/install-elastic-agents-in-containers.md similarity index 61% rename from reference/ingestion-tools/fleet/install-elastic-agents-in-containers.md rename to reference/fleet/install-elastic-agents-in-containers.md index 73046b4c56..652ce6208d 100644 --- a/reference/ingestion-tools/fleet/install-elastic-agents-in-containers.md +++ b/reference/fleet/install-elastic-agents-in-containers.md @@ -9,18 +9,18 @@ You can run {{agent}} inside of a container — either with {{fleet-server}} To learn how to run {{agent}}s in a containerized environment, see: -* [Run {{agent}} in a container](/reference/ingestion-tools/fleet/elastic-agent-container.md) -* [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) - - * [Advanced {{agent}} configuration managed by {{fleet}}](/reference/ingestion-tools/fleet/advanced-kubernetes-managed-by-fleet.md) - * [Configuring Kubernetes metadata enrichment on {{agent}}](/reference/ingestion-tools/fleet/configuring-kubernetes-metadata.md) - * [Run {{agent}} on GKE managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md) - * [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md) - * [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md) - -* [Run {{agent}} Standalone on Kubernetes](/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md) -* [Scaling {{agent}} on {{k8s}}](/reference/ingestion-tools/fleet/scaling-on-kubernetes.md) -* [Using a custom ingest pipeline with the {{k8s}} Integration](/reference/ingestion-tools/fleet/ingest-pipeline-kubernetes.md) +* [Run {{agent}} in a container](/reference/fleet/elastic-agent-container.md) +* [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) + + * [Advanced {{agent}} configuration managed by {{fleet}}](/reference/fleet/advanced-kubernetes-managed-by-fleet.md) + * [Configuring Kubernetes metadata enrichment on {{agent}}](/reference/fleet/configuring-kubernetes-metadata.md) + * [Run {{agent}} on GKE managed by {{fleet}}](/reference/fleet/running-on-gke-managed-by-fleet.md) + * [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/fleet/running-on-eks-managed-by-fleet.md) + * [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/fleet/running-on-aks-managed-by-fleet.md) + +* [Run {{agent}} Standalone on Kubernetes](/reference/fleet/running-on-kubernetes-standalone.md) +* [Scaling {{agent}} on {{k8s}}](/reference/fleet/scaling-on-kubernetes.md) +* [Using a custom ingest pipeline with the {{k8s}} Integration](/reference/fleet/ingest-pipeline-kubernetes.md) * [Run {{agent}} on ECK](/deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md) — for {{eck}} users ::::{note} diff --git a/reference/ingestion-tools/fleet/install-elastic-agents.md b/reference/fleet/install-elastic-agents.md similarity index 78% rename from reference/ingestion-tools/fleet/install-elastic-agents.md rename to reference/fleet/install-elastic-agents.md index 8c316b0388..c34083bee4 100644 --- a/reference/ingestion-tools/fleet/install-elastic-agents.md +++ b/reference/fleet/install-elastic-agents.md @@ -26,13 +26,13 @@ You have a few options for installing and managing an {{agent}}: We recommend using {{fleet}} management because it makes the management and upgrade of your agents considerably easier. - Refer to [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). + Refer to [Install {{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md). * **Install {{agent}} in standalone mode (advanced users)** With this approach, you install {{agent}} and manually configure the agent locally on the system where it’s installed. You are responsible for managing and upgrading the agents. This approach is reserved for advanced users only. - Refer to [Install standalone {{agent}}s](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md). + Refer to [Install standalone {{agent}}s](/reference/fleet/install-standalone-elastic-agent.md). * **Install {{agent}} in a containerized environment** @@ -40,17 +40,17 @@ You have a few options for installing and managing an {{agent}}: Refer to: - * [Run {{agent}} in a container](/reference/ingestion-tools/fleet/elastic-agent-container.md) - * [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) + * [Run {{agent}} in a container](/reference/fleet/elastic-agent-container.md) + * [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) - * [Advanced {{agent}} configuration managed by {{fleet}}](/reference/ingestion-tools/fleet/advanced-kubernetes-managed-by-fleet.md) - * [Configuring Kubernetes metadata enrichment on {{agent}}](/reference/ingestion-tools/fleet/configuring-kubernetes-metadata.md) - * [Run {{agent}} on GKE managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md) - * [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md) - * [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md) + * [Advanced {{agent}} configuration managed by {{fleet}}](/reference/fleet/advanced-kubernetes-managed-by-fleet.md) + * [Configuring Kubernetes metadata enrichment on {{agent}}](/reference/fleet/configuring-kubernetes-metadata.md) + * [Run {{agent}} on GKE managed by {{fleet}}](/reference/fleet/running-on-gke-managed-by-fleet.md) + * [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/fleet/running-on-eks-managed-by-fleet.md) + * [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/fleet/running-on-aks-managed-by-fleet.md) - * [Run {{agent}} Standalone on Kubernetes](/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md) - * [Scaling {{agent}} on {{k8s}}](/reference/ingestion-tools/fleet/scaling-on-kubernetes.md) + * [Run {{agent}} Standalone on Kubernetes](/reference/fleet/running-on-kubernetes-standalone.md) + * [Scaling {{agent}} on {{k8s}}](/reference/fleet/scaling-on-kubernetes.md) * [Run {{agent}} on ECK](/deploy-manage/deploy/cloud-on-k8s/standalone-elastic-agent.md) — for {{eck}} users @@ -77,7 +77,7 @@ Using our lab environment as an example, we can observe the following resource c ### CPU and RSS memory size [_cpu_and_rss_memory_size] -We tested using an AWS `m7i.large` instance type with 2 vCPUs, 8.0 GB of memory, and up to 12.5 Gbps of bandwidth. The tests ingested a single log file using both the [throughput and scale preset](/reference/ingestion-tools/fleet/elasticsearch-output.md#output-elasticsearch-performance-tuning-settings) with self monitoring enabled. These tests are representative of use cases that attempt to ingest data as fast as possible. This does not represent the resource overhead when using [{{elastic-defend}}](integration-docs://reference/endpoint/index.md). +We tested using an AWS `m7i.large` instance type with 2 vCPUs, 8.0 GB of memory, and up to 12.5 Gbps of bandwidth. The tests ingested a single log file using both the [throughput and scale preset](/reference/fleet/elasticsearch-output.md#output-elasticsearch-performance-tuning-settings) with self monitoring enabled. These tests are representative of use cases that attempt to ingest data as fast as possible. This does not represent the resource overhead when using [{{elastic-defend}}](integration-docs://reference/endpoint/index.md). | Resource | Throughput | Scale | | --- | --- | --- | diff --git a/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md b/reference/fleet/install-fleet-managed-elastic-agent.md similarity index 74% rename from reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md rename to reference/fleet/install-fleet-managed-elastic-agent.md index 9edeb35fed..dbe2d9bb13 100644 --- a/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md +++ b/reference/fleet/install-fleet-managed-elastic-agent.md @@ -6,7 +6,7 @@ mapped_pages: # Install Fleet-managed Elastic Agents [install-fleet-managed-elastic-agent] ::::{admonition} -{{fleet}} is a web-based UI in {{kib}} for [centrally managing {{agent}}s](/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md). To use {{fleet}}, you install {{agent}}, then enroll the agent in a policy defined in {{kib}}. The policy includes integrations that specify how to collect observability data from specific services and protect endpoints. The {{agent}} connects to a trusted [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) instance to retrieve the policy and report agent events. +{{fleet}} is a web-based UI in {{kib}} for [centrally managing {{agent}}s](/reference/fleet/manage-elastic-agents-in-fleet.md). To use {{fleet}}, you install {{agent}}, then enroll the agent in a policy defined in {{kib}}. The policy includes integrations that specify how to collect observability data from specific services and protect endpoints. The {{agent}} connects to a trusted [{{fleet-server}}](/reference/fleet/fleet-server.md) instance to retrieve the policy and report agent events. :::: @@ -17,9 +17,9 @@ mapped_pages: To get up and running quickly, read one of our end-to-end guides: * New to Elastic? Read our solution [Getting started guides](/get-started/index.md). -* Want to add data to an existing cluster or deployment? Read our [*Quick starts*](/reference/ingestion-tools/fleet/index.md). +* Want to add data to an existing cluster or deployment? Read our [*Quick starts*](/reference/fleet/index.md). -Looking for upgrade info? Refer to [Upgrade {{agent}}s](/reference/ingestion-tools/fleet/upgrade-elastic-agent.md). +Looking for upgrade info? Refer to [Upgrade {{agent}}s](/reference/fleet/upgrade-elastic-agent.md). Just want to learn how to install {{agent}}? Continue reading this page. @@ -29,12 +29,12 @@ Just want to learn how to install {{agent}}? Continue reading this page. You will always need: * **A {{kib}} user with `All` privileges on {{fleet}} and {{integrations}}.** Since many Integrations assets are shared across spaces, users need the {{kib}} privileges in all spaces. -* **[{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) running in a location accessible to {{agent}}.** {{agent}} must have a direct network connection to {{fleet-server}} and {{es}}. If you’re using {{ecloud}}, {{fleet-server}} is already available as part of the {{integrations-server}}. For self-managed deployments, refer to [Deploy on-premises and self-managed](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md). -* **Internet connection for {{kib}} to download integration packages from the {{package-registry}}.** Make sure the {{kib}} server can connect to `https://epr.elastic.co` on port `443`. If your environment has network traffic restrictions, there are ways to work around this requirement. See [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md) for more information. +* **[{{fleet-server}}](/reference/fleet/fleet-server.md) running in a location accessible to {{agent}}.** {{agent}} must have a direct network connection to {{fleet-server}} and {{es}}. If you’re using {{ecloud}}, {{fleet-server}} is already available as part of the {{integrations-server}}. For self-managed deployments, refer to [Deploy on-premises and self-managed](/reference/fleet/add-fleet-server-on-prem.md). +* **Internet connection for {{kib}} to download integration packages from the {{package-registry}}.** Make sure the {{kib}} server can connect to `https://epr.elastic.co` on port `443`. If your environment has network traffic restrictions, there are ways to work around this requirement. See [Air-gapped environments](/reference/fleet/air-gapped.md) for more information. If you are using a {{fleet-server}} that uses your organization’s certificate, you will also need: -* **A Certificate Authority (CA) certificate to configure Transport Layer Security (TLS) to encrypt traffic.** If your organization already uses the {{stack}}, you may already have a CA certificate. If you do not have a CA certificate, you can read more about generating one in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). +* **A Certificate Authority (CA) certificate to configure Transport Layer Security (TLS) to encrypt traffic.** If your organization already uses the {{stack}}, you may already have a CA certificate. If you do not have a CA certificate, you can read more about generating one in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). If you’re running {{agent}} 7.9 or earlier, stop the agent and manually remove it from your host. @@ -51,12 +51,12 @@ You can install only a single {{agent}} per host. To install an {{agent}} and enroll it in {{fleet}}: 1. In {{fleet}}, open the **Agents** tab and click **Add agent**. -2. In the **Add agent** flyout, select an existing agent policy or create a new one. If you create a new policy, {{fleet}} generates a new [{{fleet}} enrollment token](/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md). +2. In the **Add agent** flyout, select an existing agent policy or create a new one. If you create a new policy, {{fleet}} generates a new [{{fleet}} enrollment token](/reference/fleet/fleet-enrollment-tokens.md). ::::{note} For on-premises deployments, you can dedicate a policy to all the agents in the network boundary and configure that policy to include a specific {{fleet-server}} (or a cluster of {{fleet-server}}s). - Read more in [Add a {{fleet-server}} to a policy](/reference/ingestion-tools/fleet/agent-policy.md#add-fleet-server-to-policy). + Read more in [Add a {{fleet-server}} to a policy](/reference/fleet/agent-policy.md#add-fleet-server-to-policy). :::: @@ -76,8 +76,8 @@ After about a minute, the agent will enroll in {{fleet}}, download the configura **Notes:** * If you encounter an "x509: certificate signed by unknown authority" error, you might be trying to enroll in a {{fleet-server}} that uses self-signed certs. To fix this problem in a non-production environment, pass the `--insecure` flag. For more information, refer to the [troubleshooting guide](/troubleshoot/ingest/fleet/common-problems.md#agent-enrollment-certs). -* Optionally, you can use the `--tag` flag to specify a comma-separated list of tags to apply to the enrolled {{agent}}. For more information, refer to [Filter list of Agents by tags](/reference/ingestion-tools/fleet/filter-agent-list-by-tags.md). -* Refer to [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md) for the location of installed {{agent}} files. +* Optionally, you can use the `--tag` flag to specify a comma-separated list of tags to apply to the enrolled {{agent}}. For more information, refer to [Filter list of Agents by tags](/reference/fleet/filter-agent-list-by-tags.md). +* Refer to [Installation layout](/reference/fleet/installation-layout.md) for the location of installed {{agent}} files. * Because {{agent}} is installed as an auto-starting service, it will restart automatically if the system is rebooted. To confirm that {{agent}} is installed and running, open the **Agents** tab in {{fleet}}. @@ -94,7 +94,7 @@ If the status hangs at Enrolling, make sure the `elastic-agent` process is runni If you run into problems: -* Check the {{agent}} logs. If you use the default policy, agent logs and metrics are collected automatically unless you change the default settings. For more information, refer to [Monitor {{agent}} in {{fleet}}](/reference/ingestion-tools/fleet/monitor-elastic-agent.md). +* Check the {{agent}} logs. If you use the default policy, agent logs and metrics are collected automatically unless you change the default settings. For more information, refer to [Monitor {{agent}} in {{fleet}}](/reference/fleet/monitor-elastic-agent.md). * Refer to the [troubleshooting guide](/troubleshoot/ingest/fleet/common-problems.md). -For information about managing {{agent}} in {{fleet}}, refer to [Centrally manage {{agent}}s in {{fleet}}](/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md). +For information about managing {{agent}} in {{fleet}}, refer to [Centrally manage {{agent}}s in {{fleet}}](/reference/fleet/manage-elastic-agents-in-fleet.md). diff --git a/reference/ingestion-tools/fleet/install-on-kubernetes-using-helm.md b/reference/fleet/install-on-kubernetes-using-helm.md similarity index 92% rename from reference/ingestion-tools/fleet/install-on-kubernetes-using-helm.md rename to reference/fleet/install-on-kubernetes-using-helm.md index 5e8acd9f71..111558bb3d 100644 --- a/reference/ingestion-tools/fleet/install-on-kubernetes-using-helm.md +++ b/reference/fleet/install-on-kubernetes-using-helm.md @@ -23,8 +23,8 @@ Features of the Helm-based {{agent}} install include: For detailed install steps, try one of our walk-through examples: -* [Example: Install standalone {{agent}} on Kubernetes using Helm](/reference/ingestion-tools/fleet/example-kubernetes-standalone-agent-helm.md) -* [Example: Install {{fleet}}-managed {{agent}} on {{k8s}} using Helm](/reference/ingestion-tools/fleet/example-kubernetes-fleet-managed-agent-helm.md) +* [Example: Install standalone {{agent}} on Kubernetes using Helm](/reference/fleet/example-kubernetes-standalone-agent-helm.md) +* [Example: Install {{fleet}}-managed {{agent}} on {{k8s}} using Helm](/reference/fleet/example-kubernetes-fleet-managed-agent-helm.md) ::::{note} The {{agent}} Helm chart is currently available from inside the [elastic/elastic-agent](https://github.com/elastic/elastic-agent) GitHub repo. It’s planned to soon make the chart available from the Elastic Helm repository. diff --git a/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md b/reference/fleet/install-standalone-elastic-agent.md similarity index 85% rename from reference/ingestion-tools/fleet/install-standalone-elastic-agent.md rename to reference/fleet/install-standalone-elastic-agent.md index 1d1d0dd26a..6318269198 100644 --- a/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md +++ b/reference/fleet/install-standalone-elastic-agent.md @@ -7,7 +7,7 @@ mapped_pages: To run an {{agent}} in standalone mode, install the agent and manually configure the agent locally on the system where it’s installed. You are responsible for managing and upgrading the agents. This approach is recommended for advanced users only. -We recommend using [{{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md), when possible, because it makes the management and upgrade of your agents considerably easier. +We recommend using [{{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md), when possible, because it makes the management and upgrade of your agents considerably easier. ::::{important} Standalone agents are unable to upgrade to new integration package versions automatically. When you upgrade the integration in {{kib}}, you’ll need to update the standalone policy manually. @@ -53,9 +53,9 @@ To install and run {{agent}} standalone: 2. Modify settings in the `elastic-agent.yml` as required. - To get started quickly and avoid errors, use {{kib}} to create and download a standalone configuration file rather than trying to build it by hand. For more information, refer to [Create a standalone {{agent}} policy](/reference/ingestion-tools/fleet/create-standalone-agent-policy.md). + To get started quickly and avoid errors, use {{kib}} to create and download a standalone configuration file rather than trying to build it by hand. For more information, refer to [Create a standalone {{agent}} policy](/reference/fleet/create-standalone-agent-policy.md). - For additional configuration options, refer to [*Configure standalone {{agent}}s*](/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md). + For additional configuration options, refer to [*Configure standalone {{agent}}s*](/reference/fleet/configure-standalone-elastic-agents.md). 3. In the `elastic-agent.yml` policy file, under `outputs`, specify an API key or user credentials for the {{agent}} to access {{es}}. For example: @@ -70,9 +70,9 @@ To install and run {{agent}} standalone: [...] ``` - 1. For more information required privileges and creating API keys, see [Grant standalone {{agent}}s access to {{es}}](/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md). + 1. For more information required privileges and creating API keys, see [Grant standalone {{agent}}s access to {{es}}](/reference/fleet/grant-access-to-elasticsearch.md). -4. Make sure the assets you need, such as dashboards and ingest pipelines, are set up in {{kib}} and {{es}}. If you used {{kib}} to generate the standalone configuration, the assets are set up automatically. Otherwise, you need to install them. For more information, refer to [View integration assets](/reference/ingestion-tools/fleet/view-integration-assets.md) and [Install integration assets](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md#install-integration-assets). +4. Make sure the assets you need, such as dashboards and ingest pipelines, are set up in {{kib}} and {{es}}. If you used {{kib}} to generate the standalone configuration, the assets are set up automatically. Otherwise, you need to install them. For more information, refer to [View integration assets](/reference/fleet/view-integration-assets.md) and [Install integration assets](/reference/fleet/install-uninstall-integration-assets.md#install-integration-assets). 5. From the agent directory, run the following commands to install {{agent}} and start it as a service. ::::{note} @@ -82,7 +82,7 @@ To install and run {{agent}} standalone: ::::{tab-set} :::{tab-item} macOS - + ::::{tip} You must run this command as the root user because some integrations require root privileges to collect sensitive data. :::: @@ -93,7 +93,7 @@ To install and run {{agent}} standalone: ::: :::{tab-item} Linux - + ::::{tip} You must run this command as the root user because some integrations require root privileges to collect sensitive data. :::: @@ -104,7 +104,7 @@ To install and run {{agent}} standalone: ::: :::{tab-item} Windows - + Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select **Run As Administrator**). From the PowerShell prompt, change to the directory where you installed {{agent}}, and run: @@ -115,7 +115,7 @@ To install and run {{agent}} standalone: ::: :::{tab-item} DEB - + ::::{tip} You must run this command as the root user because some integrations require root privileges to collect sensitive data. :::: @@ -126,9 +126,9 @@ To install and run {{agent}} standalone: ``` 1. The DEB package includes a service unit for Linux systems with systemd. On these systems, you can manage {{agent}} by using the usual systemd commands. If you don’t have systemd, run `sudo service elastic-agent start`. ::: - + :::{tab-item} RPM - + ::::{tip} You must run this command as the root user because some integrations require root privileges to collect sensitive data. :::: @@ -144,7 +144,7 @@ To install and run {{agent}} standalone: :::: -Refer to [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md) for the location of installed {{agent}} files. +Refer to [Installation layout](/reference/fleet/installation-layout.md) for the location of installed {{agent}} files. Because {{agent}} is installed as an auto-starting service, it will restart automatically if the system is rebooted. diff --git a/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md b/reference/fleet/install-uninstall-integration-assets.md similarity index 96% rename from reference/ingestion-tools/fleet/install-uninstall-integration-assets.md rename to reference/fleet/install-uninstall-integration-assets.md index 552885c173..380f1dd101 100644 --- a/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md +++ b/reference/fleet/install-uninstall-integration-assets.md @@ -33,7 +33,7 @@ These limitations and future plans for {{fleet}}'s integrations support in multi Uninstall an integration to remove all {{kib}} and {{es}} assets that were installed by the integration. -1. Before uninstalling an integration, [delete the integration policy](/reference/ingestion-tools/fleet/edit-delete-integration-policy.md) from any {{agent}} policies that use it. +1. Before uninstalling an integration, [delete the integration policy](/reference/fleet/edit-delete-integration-policy.md) from any {{agent}} policies that use it. Any {{agent}}s enrolled in the policy will stop using the deleted integration. diff --git a/reference/ingestion-tools/fleet/installation-layout.md b/reference/fleet/installation-layout.md similarity index 100% rename from reference/ingestion-tools/fleet/installation-layout.md rename to reference/fleet/installation-layout.md diff --git a/reference/ingestion-tools/fleet/integration-level-outputs.md b/reference/fleet/integration-level-outputs.md similarity index 88% rename from reference/ingestion-tools/fleet/integration-level-outputs.md rename to reference/fleet/integration-level-outputs.md index 10c562d0ce..c60d9612ec 100644 --- a/reference/ingestion-tools/fleet/integration-level-outputs.md +++ b/reference/fleet/integration-level-outputs.md @@ -17,9 +17,9 @@ Integration-level outputs are very useful for certain scenarios. For example: For each {{agent}}, the agent policy configures sending data to the following outputs in decreasing order of priority: -1. The output set in the [integration policy](/reference/ingestion-tools/fleet/add-integration-to-policy.md). -2. The output set in the integration’s parent [{{agent}} policy](/reference/ingestion-tools/fleet/agent-policy.md). This includes the case where an integration policy belongs to multiple {{agent}} policies. -3. The global, default data output set in the [{{fleet}} settings](/reference/ingestion-tools/fleet/fleet-settings.md). +1. The output set in the [integration policy](/reference/fleet/add-integration-to-policy.md). +2. The output set in the integration’s parent [{{agent}} policy](/reference/fleet/agent-policy.md). This includes the case where an integration policy belongs to multiple {{agent}} policies. +3. The global, default data output set in the [{{fleet}} settings](/reference/fleet/fleet-settings.md). ## Configure the output for an integration policy [_configure_the_output_for_an_integration_policy] diff --git a/reference/ingestion-tools/fleet/integrations-assets-best-practices.md b/reference/fleet/integrations-assets-best-practices.md similarity index 84% rename from reference/ingestion-tools/fleet/integrations-assets-best-practices.md rename to reference/fleet/integrations-assets-best-practices.md index 46c0a230b7..e538a7ed27 100644 --- a/reference/ingestion-tools/fleet/integrations-assets-best-practices.md +++ b/reference/fleet/integrations-assets-best-practices.md @@ -21,7 +21,7 @@ When you use integrations with {{fleet}} and {{agent}} there are some restrictio When you use standalone {{agent}} with integrations, the integration assets added to the {{agent}} policy must be installed on the destination {{es}} cluster. -* If {{kib}} is available, the integration assets can be [installed through {{fleet}}](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md). +* If {{kib}} is available, the integration assets can be [installed through {{fleet}}](/reference/fleet/install-uninstall-integration-assets.md). * If {{kib}} is not available (for instance if you have a remote cluster without a {{kib}} instance), then the integration assets need to be installed manually. @@ -64,14 +64,14 @@ For example: * If the `@package` component template of an integration is changed from a "normal" datastream to `TSDB` or `LogsDB`, some of the custom settings or mappings introduced may not be compatible with these indexing modes. * If the type of an ECS field is overridden from, for example, `keyword` to `text`, aggregations based on that field may be prevented for built-in dashboards. -A similar caution against custom index mappings is noted in [Edit the {{es}} index template](/reference/ingestion-tools/fleet/data-streams.md#data-streams-index-templates-edit). +A similar caution against custom index mappings is noted in [Edit the {{es}} index template](/reference/fleet/data-streams.md#data-streams-index-templates-edit). ## Creating a custom ingest pipeline [assets-restrictions-custom-ingest-pipeline] -If you create a custom index pipeline (as documented in the [Transform data with custom ingest pipelines](/reference/ingestion-tools/fleet/data-streams-pipeline-tutorial.md) tutorial), Elastic is not responsible for ensuring that it indexes and behaves as expected. Creating a custom pipeline involves custom processing of the incoming data, which should be done with caution and tested carefully. +If you create a custom index pipeline (as documented in the [Transform data with custom ingest pipelines](/reference/fleet/data-streams-pipeline-tutorial.md) tutorial), Elastic is not responsible for ensuring that it indexes and behaves as expected. Creating a custom pipeline involves custom processing of the incoming data, which should be done with caution and tested carefully. -Refer to [Ingest pipelines](/reference/ingestion-tools/fleet/data-streams.md#data-streams-pipelines) to learn more. +Refer to [Ingest pipelines](/reference/fleet/data-streams.md#data-streams-pipelines) to learn more. ## Cloning the index template of an integration package [assets-restrictions-cloning-index-template] @@ -80,6 +80,6 @@ When you clone the index template of an integration package, this involves risk Additionally, cloning index templates to add or inject additional component templates cannot be tested by Elastic, so we cannot guarantee that the template will work in future releases. -If you want to change the ILM Policy, the number of shards, or other settings for the datastreams of one or more integrations, but the changes do not need to be specific to a given namespace, it’s highly recommended to use the `package@custom` component templates, as described in [Scenario 1](/reference/ingestion-tools/fleet/data-streams-scenario1.md) and [Scenario 2](/reference/ingestion-tools/fleet/data-streams-scenario2.md) of the Customize data retention policies tutorial, so as to avoid the problems mentioned above. +If you want to change the ILM Policy, the number of shards, or other settings for the datastreams of one or more integrations, but the changes do not need to be specific to a given namespace, it’s highly recommended to use the `package@custom` component templates, as described in [Scenario 1](/reference/fleet/data-streams-scenario1.md) and [Scenario 2](/reference/fleet/data-streams-scenario2.md) of the Customize data retention policies tutorial, so as to avoid the problems mentioned above. -If you want to change these settings for the data streams in one or more integrations and the changes **need to be namespace specific**, then you can do so following the steps in [Scenario 3](/reference/ingestion-tools/fleet/data-streams-scenario3.md) of the Customize data retention policies tutorial, but be aware of the restrictions mentioned above. +If you want to change these settings for the data streams in one or more integrations and the changes **need to be namespace specific**, then you can do so following the steps in [Scenario 3](/reference/fleet/data-streams-scenario3.md) of the Customize data retention policies tutorial, but be aware of the restrictions mentioned above. diff --git a/reference/ingestion-tools/fleet/kafka-output-settings.md b/reference/fleet/kafka-output-settings.md similarity index 95% rename from reference/ingestion-tools/fleet/kafka-output-settings.md rename to reference/fleet/kafka-output-settings.md index 2d694d6614..2f1c380b7f 100644 --- a/reference/ingestion-tools/fleet/kafka-output-settings.md +++ b/reference/fleet/kafka-output-settings.md @@ -5,7 +5,7 @@ mapped_pages: # Kafka output settings [kafka-output-settings] -Specify these settings to send data over a secure connection to Kafka. In the {{fleet}} [Output settings](/reference/ingestion-tools/fleet/fleet-settings.md#output-settings), make sure that the Kafka output type is selected. +Specify these settings to send data over a secure connection to Kafka. In the {{fleet}} [Output settings](/reference/fleet/fleet-settings.md#output-settings), make sure that the Kafka output type is selected. ::::{note} If you plan to use {{ls}} to modify {{agent}} output data before it’s sent to Kafka, please refer to our [guidance](#kafka-output-settings-ls-warning) for doing so, further in on this page. @@ -18,7 +18,7 @@ If you plan to use {{ls}} to modify {{agent}} output data before it’s sent to | | | | --- | --- | | $$$kafka-output-version$$$
**Kafka version**
| The Kafka protocol version that {{agent}} will request when connecting. Defaults to `1.0.0`. Currently Kafka versions from `0.8.2.0` to `2.6.0` are supported, however the latest Kafka version (`3.x.x`) is expected to be compatible when version `2.6.0` is selected. When using Kafka 4.0 and newer, the version must be set to at least `2.1.0`.
| -| $$$kafka-output-hosts$$$
**Hosts**
| The addresses your {{agent}}s will use to connect to one or more Kafka brokers. Use the format `host:port` (without any protocol `http://`). Click **Add row** to specify additional addresses.

**Examples:**

* `localhost:9092`
* `mykafkahost:9092`

Refer to the [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) documentation for default ports and other configuration details.
| +| $$$kafka-output-hosts$$$
**Hosts**
| The addresses your {{agent}}s will use to connect to one or more Kafka brokers. Use the format `host:port` (without any protocol `http://`). Click **Add row** to specify additional addresses.

**Examples:**

* `localhost:9092`
* `mykafkahost:9092`

Refer to the [{{fleet-server}}](/reference/fleet/fleet-server.md) documentation for default ports and other configuration details.
| ### Authentication settings [_authentication_settings] @@ -51,7 +51,7 @@ Use this option to set the Kafka topic for each {{agent}} event. | | | | --- | --- | -| $$$kafka-output-topics-default$$$
**Default topic**
| Set a default topic to use for events sent by {{agent}} to the Kafka output.

You can set a static topic, for example `elastic-agent`, or you can choose to set a topic dynamically based on an [Elastic Common Scheme (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)) field. Available fields include:

* `data_stream_type`
* `data_stream.dataset`
* `data_stream.namespace`
* `@timestamp`
* `event-dataset`

You can also set a custom field. This is useful if you’re using the [`add_fields` processor](/reference/ingestion-tools/fleet/add_fields-processor.md) as part of your {{agent}} input. Otherwise, setting a custom field is not recommended.
| +| $$$kafka-output-topics-default$$$
**Default topic**
| Set a default topic to use for events sent by {{agent}} to the Kafka output.

You can set a static topic, for example `elastic-agent`, or you can choose to set a topic dynamically based on an [Elastic Common Scheme (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)) field. Available fields include:

* `data_stream_type`
* `data_stream.dataset`
* `data_stream.namespace`
* `@timestamp`
* `event-dataset`

You can also set a custom field. This is useful if you’re using the [`add_fields` processor](/reference/fleet/add_fields-processor.md) as part of your {{agent}} input. Otherwise, setting a custom field is not recommended.
| ### Header settings [_header_settings] @@ -91,10 +91,10 @@ Configure timeout and buffer size values for the Kafka brokers. | | | | --- | --- | | $$$kafka-output-other-key$$$
**Key**
| An optional formatted string specifying the Kafka event key. If configured, the event key can be extracted from the event using a format string.

See the [Kafka documentation](https://kafka.apache.org/intro#intro_topics) for the implications of a particular choice of key; by default, the key is chosen by the Kafka cluster.
| -| $$$kafka-output-other-proxy$$$
**Proxy**
| Select a proxy URL for {{agent}} to connect to Kafka. To learn about proxy configuration, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md).
| +| $$$kafka-output-other-proxy$$$
**Proxy**
| Select a proxy URL for {{agent}} to connect to Kafka. To learn about proxy configuration, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/fleet/fleet-agent-proxy-support.md).
| | $$$kafka-output-advanced-yaml-setting$$$
**Advanced YAML configuration**
| YAML settings that will be added to the Kafka output section of each policy that uses this output. Make sure you specify valid YAML. The UI does not currently provide validation.

See [Advanced YAML configuration](#kafka-output-settings-yaml-config) for descriptions of the available settings.
| -| $$$kafka-output-agent-integrations$$$
**Make this output the default for agent integrations**
| When this setting is on, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md).
| -| $$$kafka-output-agent-monitoring$$$
**Make this output the default for agent monitoring**
| When this setting is on, {{agent}}s use this output to send [agent monitoring data](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) if no other output is set in the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md).
| +| $$$kafka-output-agent-integrations$$$
**Make this output the default for agent integrations**
| When this setting is on, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/fleet/agent-policy.md).
| +| $$$kafka-output-agent-monitoring$$$
**Make this output the default for agent monitoring**
| When this setting is on, {{agent}}s use this output to send [agent monitoring data](/reference/fleet/monitor-elastic-agent.md) if no other output is set in the [agent policy](/reference/fleet/agent-policy.md).
| ## Advanced YAML configuration [kafka-output-settings-yaml-config] @@ -123,7 +123,7 @@ The data streams setup by the integrations expect to receive events having the s The structure of the documents sent from {{agent}} to `kafka` must not be modified by {{ls}}. We suggest disabling `ecs_compatibility` on both the `kafka` input and the `json` codec. -Refer to the [{{ls}} output for {{agent}}](/reference/ingestion-tools/fleet/ls-output-settings.md) documentation for more details. +Refer to the [{{ls}} output for {{agent}}](/reference/fleet/ls-output-settings.md) documentation for more details. ```yaml inputs { diff --git a/reference/ingestion-tools/fleet/kafka-output.md b/reference/fleet/kafka-output.md similarity index 96% rename from reference/ingestion-tools/fleet/kafka-output.md rename to reference/fleet/kafka-output.md index 0b5deb93a6..21dda248fa 100644 --- a/reference/ingestion-tools/fleet/kafka-output.md +++ b/reference/fleet/kafka-output.md @@ -47,7 +47,7 @@ If you are considering using {{ls}} to ship the data from `kafka` to {{es}}, ple The data streams set up by the integrations expect to receive events having the same structure and field names as they were sent directly from an {{agent}}. -Refer to [{{ls}} output for {{agent}}](/reference/ingestion-tools/fleet/logstash-output.md) documentation for more details. +Refer to [{{ls}} output for {{agent}}](/reference/fleet/logstash-output.md) documentation for more details. ```yaml inputs { @@ -90,7 +90,7 @@ The `kafka` output supports the following settings, grouped by category. Many of | $$$kafka-username-setting$$$
`username`
| The username for connecting to Kafka. If username is configured, the password must be configured as well.
| | $$$kafka-password-setting$$$
`password`
| The password for connecting to Kafka.
| | $$$kafka-sasl.mechanism-setting$$$
`sasl.mechanism`
| The SASL mechanism to use when connecting to Kafka. It can be one of:

* `PLAIN` for SASL/PLAIN.
* `SCRAM-SHA-256` for SCRAM-SHA-256.
* `SCRAM-SHA-512` for SCRAM-SHA-512. If `sasl.mechanism` is not set, `PLAIN` is used if `username` and `password` are provided. Otherwise, SASL authentication is disabled.
| -| $$$kafka-ssl-setting$$$
`ssl`
| When sending data to a secured cluster through the `kafka` output, {{agent}} can use SSL/TLS. For a list of available settings, refer to [SSL/TLS](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#client-ssl-options).
| +| $$$kafka-ssl-setting$$$
`ssl`
| When sending data to a secured cluster through the `kafka` output, {{agent}} can use SSL/TLS. For a list of available settings, refer to [SSL/TLS](/reference/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#client-ssl-options).
| ## Memory queue settings [output-kafka-memory-queue-settings] diff --git a/reference/ingestion-tools/fleet/kubernetes-provider.md b/reference/fleet/kubernetes-provider.md similarity index 97% rename from reference/ingestion-tools/fleet/kubernetes-provider.md rename to reference/fleet/kubernetes-provider.md index 3908062a0f..a110bf636f 100644 --- a/reference/ingestion-tools/fleet/kubernetes-provider.md +++ b/reference/fleet/kubernetes-provider.md @@ -134,7 +134,7 @@ The available keys are: These are the fields available within config templating. The `kubernetes.*` fields will be available on each emitted event. ::::{note} -`kubernetes.labels.*` and `kubernetes.annotations.*` used in config templating are not dedoted and should not be confused with labels and annotations added in the final Elasticsearch document and which are dedoted by default. For examples refer to [Conditions based autodiscover](/reference/ingestion-tools/fleet/conditions-based-autodiscover.md). +`kubernetes.labels.*` and `kubernetes.annotations.*` used in config templating are not dedoted and should not be confused with labels and annotations added in the final Elasticsearch document and which are dedoted by default. For examples refer to [Conditions based autodiscover](/reference/fleet/conditions-based-autodiscover.md). :::: @@ -225,5 +225,5 @@ The available keys are: | `kubernetes.service.uid` | `string` | UID of the Service | | `kubernetes.selectors.*` | `string` | Kubernetes selectors | -Refer to [kubernetes autodiscovery with Elastic Agent](/reference/ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md) for more information about shaping dynamic inputs for autodiscovery. +Refer to [kubernetes autodiscovery with Elastic Agent](/reference/fleet/elastic-agent-kubernetes-autodiscovery.md) for more information about shaping dynamic inputs for autodiscovery. diff --git a/reference/ingestion-tools/fleet/kubernetes_leaderelection-provider.md b/reference/fleet/kubernetes_leaderelection-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/kubernetes_leaderelection-provider.md rename to reference/fleet/kubernetes_leaderelection-provider.md diff --git a/reference/ingestion-tools/fleet/kubernetes_secrets-provider.md b/reference/fleet/kubernetes_secrets-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/kubernetes_secrets-provider.md rename to reference/fleet/kubernetes_secrets-provider.md diff --git a/reference/ingestion-tools/fleet/local-dynamic-provider.md b/reference/fleet/local-dynamic-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/local-dynamic-provider.md rename to reference/fleet/local-dynamic-provider.md diff --git a/reference/ingestion-tools/fleet/local-provider.md b/reference/fleet/local-provider.md similarity index 100% rename from reference/ingestion-tools/fleet/local-provider.md rename to reference/fleet/local-provider.md diff --git a/reference/ingestion-tools/fleet/logstash-output.md b/reference/fleet/logstash-output.md similarity index 96% rename from reference/ingestion-tools/fleet/logstash-output.md rename to reference/fleet/logstash-output.md index c3683ca4d3..4aa6977b8b 100644 --- a/reference/ingestion-tools/fleet/logstash-output.md +++ b/reference/fleet/logstash-output.md @@ -85,14 +85,14 @@ The `logstash` output supports the following settings, grouped by category. Many ## Authentication settings [output-logstash-authentication-settings] -When sending data to a secured cluster through the `logstash` output, {{agent}} can use SSL/TLS. For a list of available settings, refer to [SSL/TLS](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). +When sending data to a secured cluster through the `logstash` output, {{agent}} can use SSL/TLS. For a list of available settings, refer to [SSL/TLS](/reference/fleet/elastic-agent-ssl-configuration.md), specifically the settings under [Table 7, Common configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#common-ssl-options) and [Table 8, Client configuration options](/reference/fleet/elastic-agent-ssl-configuration.md#client-ssl-options). ::::{note} To use SSL/TLS, you must also configure the [{{agent}} input plugin for {{ls}}](logstash://reference/plugins-inputs-beats.md) to use SSL/TLS. :::: -For more information, refer to [Configure SSL/TLS for the {{ls}} output](/reference/ingestion-tools/fleet/secure-logstash-connections.md). +For more information, refer to [Configure SSL/TLS for the {{ls}} output](/reference/fleet/secure-logstash-connections.md). ## Memory queue settings [output-logstash-memory-queue-settings] diff --git a/reference/ingestion-tools/fleet/ls-output-settings.md b/reference/fleet/ls-output-settings.md similarity index 91% rename from reference/ingestion-tools/fleet/ls-output-settings.md rename to reference/fleet/ls-output-settings.md index fb76672a09..abb453a800 100644 --- a/reference/ingestion-tools/fleet/ls-output-settings.md +++ b/reference/fleet/ls-output-settings.md @@ -7,11 +7,11 @@ mapped_pages: Specify these settings to send data over a secure connection to {{ls}}. You must also configure a {{ls}} pipeline that reads encrypted data from {{agent}}s and sends the data to {{es}}. Follow the in-product steps to configure the {{ls}} pipeline. -In the {{fleet}} [Output settings](/reference/ingestion-tools/fleet/fleet-settings.md#output-settings), make sure that the {{ls}} output type is selected. +In the {{fleet}} [Output settings](/reference/fleet/fleet-settings.md#output-settings), make sure that the {{ls}} output type is selected. -Before using the {{ls}} output, you need to make sure that for any integrations that have been [added to your {{agent}} policy](/reference/ingestion-tools/fleet/add-integration-to-policy.md), the integration assets have been installed on the destination cluster. Refer to [Install and uninstall {{agent}} integration assets](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md) for the steps to add integration assets. +Before using the {{ls}} output, you need to make sure that for any integrations that have been [added to your {{agent}} policy](/reference/fleet/add-integration-to-policy.md), the integration assets have been installed on the destination cluster. Refer to [Install and uninstall {{agent}} integration assets](/reference/fleet/install-uninstall-integration-assets.md) for the steps to add integration assets. -To learn how to generate certificates, refer to [Configure SSL/TLS for the {{ls}} output](/reference/ingestion-tools/fleet/secure-logstash-connections.md). +To learn how to generate certificates, refer to [Configure SSL/TLS for the {{ls}} output](/reference/fleet/secure-logstash-connections.md). To receive the events in {{ls}}, you also need to create a {{ls}} configuration pipeline. The {{ls}} configuration pipeline listens for incoming {{agent}} connections, processes received events, and then sends the events to {{es}}. @@ -51,14 +51,14 @@ output { | | | | --- | --- | -| $$$ls-logstash-hosts$$$
**{{ls}} hosts**
| The addresses your {{agent}}s will use to connect to {{ls}}. Use the format `host:port`. Click **add** row to specify additional {{ls}} addresses.

**Examples:**

* `192.0.2.0:5044`
* `mylogstashhost:5044`

Refer to the [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) documentation for default ports and other configuration details.
| +| $$$ls-logstash-hosts$$$
**{{ls}} hosts**
| The addresses your {{agent}}s will use to connect to {{ls}}. Use the format `host:port`. Click **add** row to specify additional {{ls}} addresses.

**Examples:**

* `192.0.2.0:5044`
* `mylogstashhost:5044`

Refer to the [{{fleet-server}}](/reference/fleet/fleet-server.md) documentation for default ports and other configuration details.
| | $$$ls-server-ssl-certificate-authorities-setting$$$
**Server SSL certificate authorities**
| The CA certificate to use to connect to {{ls}}. This is the CA used to generate the certificate and key for {{ls}}. Copy and paste in the full contents for the CA certificate.

This setting is optional.
| | $$$ls-client-ssl-certificate-setting$$$
**Client SSL certificate**
| The certificate generated for the client. Copy and paste in the full contents of the certificate. This is the certificate that all the agents will use to connect to {{ls}}.

In cases where each client has a unique certificate, the local path to that certificate can be placed here. The agents will pick the certificate in that location when establishing a connection to {{ls}}.
| | $$$ls-client-ssl-certificate-key-setting$$$
**Client SSL certificate key**
| The private key generated for the client. This must be in PKCS 8 key. Copy and paste in the full contents of the certificate key. This is the certificate key that all the agents will use to connect to {{ls}}.

In cases where each client has a unique certificate key, the local path to that certificate key can be placed here. The agents will pick the certificate key in that location when establishing a connection to {{ls}}.

To prevent unauthorized access the certificate key is stored as a secret value. While secret storage is recommended, you can choose to override this setting and store the key as plain text in the agent policy definition. Secret storage requires {{fleet-server}} version 8.12 or higher.

Note that this setting can also be stored as a secret value or as plain text for preconfigured outputs. See [Preconfiguration settings](kibana://reference/configuration-reference/fleet-settings.md#_preconfiguration_settings_for_advanced_use_cases) in the {{kib}} Guide to learn more.
| -| $$$ls-agent-proxy-output$$$
**Proxy**
| Select a proxy URL for {{agent}} to connect to {{ls}}. To learn about proxy configuration, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md).
| +| $$$ls-agent-proxy-output$$$
**Proxy**
| Select a proxy URL for {{agent}} to connect to {{ls}}. To learn about proxy configuration, refer to [Using a proxy server with {{agent}} and {{fleet}}](/reference/fleet/fleet-agent-proxy-support.md).
| | $$$ls-output-advanced-yaml-setting$$$
**Advanced YAML configuration**
| YAML settings that will be added to the {{ls}} output section of each policy that uses this output. Make sure you specify valid YAML. The UI does not currently provide validation.

See [Advanced YAML configuration](#ls-output-settings-yaml-config) for descriptions of the available settings.
| -| $$$ls-agent-integrations-output$$$
**Make this output the default for agent integrations**
| When this setting is on, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md).

Output to {{ls}} is not supported for agent integrations in a policy used by {{fleet-server}} or APM.
| -| $$$ls-agent-monitoring-output$$$
**Make this output the default for agent monitoring**
| When this setting is on, {{agent}}s use this output to send [agent monitoring data](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) if no other output is set in the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md).

Output to {{ls}} is not supported for agent monitoring in a policy used by {{fleet-server}} or APM.
| +| $$$ls-agent-integrations-output$$$
**Make this output the default for agent integrations**
| When this setting is on, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/fleet/agent-policy.md).

Output to {{ls}} is not supported for agent integrations in a policy used by {{fleet-server}} or APM.
| +| $$$ls-agent-monitoring-output$$$
**Make this output the default for agent monitoring**
| When this setting is on, {{agent}}s use this output to send [agent monitoring data](/reference/fleet/monitor-elastic-agent.md) if no other output is set in the [agent policy](/reference/fleet/agent-policy.md).

Output to {{ls}} is not supported for agent monitoring in a policy used by {{fleet-server}} or APM.
| ## Advanced YAML configuration [ls-output-settings-yaml-config] diff --git a/reference/fleet/manage-agents.md b/reference/fleet/manage-agents.md new file mode 100644 index 0000000000..0cddb3e821 --- /dev/null +++ b/reference/fleet/manage-agents.md @@ -0,0 +1,32 @@ +--- +navigation_title: "{{agent}}s" +mapped_pages: + - https://www.elastic.co/guide/en/fleet/current/manage-agents.html +--- + +# {{agent}}s [manage-agents] + + +::::{tip} +To learn how to add {{agent}}s to {{fleet}}, see [Install {{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md). +:::: + + +To manage your {{agent}}s, go to **Management > {{fleet}} > Agents** in {{kib}}. On the **Agents** tab, you can perform the following actions: + +| User action | Result | +| --- | --- | +| [Unenroll {{agent}}s](/reference/fleet/unenroll-elastic-agent.md) | Unenroll {{agent}}s from {{fleet}}. | +| [Set inactivity timeout](/reference/fleet/set-inactivity-timeout.md) | Set inactivity timeout to move {{agent}}s to inactive status after being offline for the set amount of time. | +| [Upgrade {{agent}}s](/reference/fleet/upgrade-elastic-agent.md) | Upgrade {{agent}}s to the latest version. | +| [Migrate {{agent}}s](/reference/fleet/migrate-elastic-agent.md) | Migrate {{agent}}s from one cluster to another. | +| [Monitor {{agent}}s](/reference/fleet/monitor-elastic-agent.md) | Monitor {{fleet}}-managed {{agent}}s by viewing agent status, logs, and metrics. | +| [Add tags to filter the Agents list](/reference/fleet/filter-agent-list-by-tags.md) | Add tags to {{agent}}, then use the tags to filter the Agents list in {{fleet}}. | + + + + + + + + diff --git a/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md b/reference/fleet/manage-elastic-agents-in-fleet.md similarity index 59% rename from reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md rename to reference/fleet/manage-elastic-agents-in-fleet.md index 1a1fcb0b92..e81c04c783 100644 --- a/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md +++ b/reference/fleet/manage-elastic-agents-in-fleet.md @@ -13,29 +13,29 @@ The {{fleet}} app in {{kib}} supports both {{agent}} infrastructure management a * Manage {{agent}} binaries and specify settings installed on the host that determine whether the {{agent}} is enrolled in {{fleet}}, what version of the agent is running, and which agent policy is used. * Manage agent policies that specify agent configuration settings, which integrations are running, whether agent monitoring is turned on, input settings, and so on. -Advanced users who don’t want to use {{fleet}} for central management can use an external infrastructure management solution and [install {{agent}} in standalone mode](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md) instead. +Advanced users who don’t want to use {{fleet}} for central management can use an external infrastructure management solution and [install {{agent}} in standalone mode](/reference/fleet/install-standalone-elastic-agent.md) instead. :::: ::::{important} -{{fleet}} currently requires a {{kib}} user with `All` privileges on {{fleet}} and {{integrations}}. Since many Integrations assets are shared across spaces, users need the {{kib}} privileges in all spaces. Refer to [Required roles and privileges](/reference/ingestion-tools/fleet/fleet-roles-privileges.md) to learn how to create a user role with the required privileges to access {{fleet}} and {{integrations}}. +{{fleet}} currently requires a {{kib}} user with `All` privileges on {{fleet}} and {{integrations}}. Since many Integrations assets are shared across spaces, users need the {{kib}} privileges in all spaces. Refer to [Required roles and privileges](/reference/fleet/fleet-roles-privileges.md) to learn how to create a user role with the required privileges to access {{fleet}} and {{integrations}}. :::: -To learn how to add {{agent}}s to {{fleet}}, refer to [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). +To learn how to add {{agent}}s to {{fleet}}, refer to [Install {{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md). To use {{fleet}} go to **Management > {{fleet}}** in {{kib}}. The following table describes the main management actions you can perform in {{fleet}}: | Component | Management actions | | --- | --- | -| [{{fleet}} settings](/reference/ingestion-tools/fleet/fleet-settings.md) | Configure global settings available to all {{agent}}s managed by {{fleet}},including {{fleet-server}} hosts and output settings. | -| [{{agent}}s](/reference/ingestion-tools/fleet/manage-agents.md) | Enroll, unenroll, upgrade, add tags, and view {{agent}} status and logs. | -| [Policies](/reference/ingestion-tools/fleet/agent-policy.md) | Create and edit agent policies and add integrations to them. | -| [{{fleet}} enrollment tokens](/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md) | Create and revoke enrollment tokens. | +| [{{fleet}} settings](/reference/fleet/fleet-settings.md) | Configure global settings available to all {{agent}}s managed by {{fleet}},including {{fleet-server}} hosts and output settings. | +| [{{agent}}s](/reference/fleet/manage-agents.md) | Enroll, unenroll, upgrade, add tags, and view {{agent}} status and logs. | +| [Policies](/reference/fleet/agent-policy.md) | Create and edit agent policies and add integrations to them. | +| [{{fleet}} enrollment tokens](/reference/fleet/fleet-enrollment-tokens.md) | Create and revoke enrollment tokens. | | [Uninstall tokens](/solutions/security/configure-elastic-defend/prevent-elastic-agent-uninstallation.md) | ({{elastic-defend}} integration only) Access tokens to allow uninstalling {{agent}} from endpoints with Agent tamper protection enabled. | -| [Data streams](/reference/ingestion-tools/fleet/data-streams.md) | View data streams and navigate to dashboards to analyze your data. | +| [Data streams](/reference/fleet/data-streams.md) | View data streams and navigate to dashboards to analyze your data. | diff --git a/reference/ingestion-tools/fleet/manage-integrations.md b/reference/fleet/manage-integrations.md similarity index 58% rename from reference/ingestion-tools/fleet/manage-integrations.md rename to reference/fleet/manage-integrations.md index f077822b62..92c2ccb439 100644 --- a/reference/ingestion-tools/fleet/manage-integrations.md +++ b/reference/fleet/manage-integrations.md @@ -32,15 +32,15 @@ The following table shows the main actions you can perform in the **Integrations | User action | Result | | --- | --- | -| [Add an integration to an {{agent}} policy](/reference/ingestion-tools/fleet/add-integration-to-policy.md) | Configure an integration for a specific use case and add it to an {{agent}} policy. | -| [View integration policies](/reference/ingestion-tools/fleet/view-integration-policies.md) | View the integration policies created for a specific integration. | -| [Edit or delete an integration policy](/reference/ingestion-tools/fleet/edit-delete-integration-policy.md) | Change settings or delete the integration policy. | -| [Install and uninstall integration assets](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md) | Install, uninstall, and reinstall integration assets in {{kib}}. | -| [View integration assets](/reference/ingestion-tools/fleet/view-integration-assets.md) | View the {{kib}} assets installed for a specific integration. | -| [Upgrade an integration](/reference/ingestion-tools/fleet/upgrade-integration.md) | Upgrade an integration to the latest version. | +| [Add an integration to an {{agent}} policy](/reference/fleet/add-integration-to-policy.md) | Configure an integration for a specific use case and add it to an {{agent}} policy. | +| [View integration policies](/reference/fleet/view-integration-policies.md) | View the integration policies created for a specific integration. | +| [Edit or delete an integration policy](/reference/fleet/edit-delete-integration-policy.md) | Change settings or delete the integration policy. | +| [Install and uninstall integration assets](/reference/fleet/install-uninstall-integration-assets.md) | Install, uninstall, and reinstall integration assets in {{kib}}. | +| [View integration assets](/reference/fleet/view-integration-assets.md) | View the {{kib}} assets installed for a specific integration. | +| [Upgrade an integration](/reference/fleet/upgrade-integration.md) | Upgrade an integration to the latest version. | ::::{note} -The **Integrations** app in {{kib}} needs access to the public {{package-registry}} to discover integrations. If your deployment has network restrictions, you can [deploy your own self-managed {{package-registry}}](/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-diy-epr). +The **Integrations** app in {{kib}} needs access to the public {{package-registry}} to discover integrations. If your deployment has network restrictions, you can [deploy your own self-managed {{package-registry}}](/reference/fleet/air-gapped.md#air-gapped-diy-epr). :::: diff --git a/reference/ingestion-tools/fleet/managed-integrations-content.md b/reference/fleet/managed-integrations-content.md similarity index 100% rename from reference/ingestion-tools/fleet/managed-integrations-content.md rename to reference/fleet/managed-integrations-content.md diff --git a/reference/ingestion-tools/fleet/migrate-auditbeat-to-agent.md b/reference/fleet/migrate-auditbeat-to-agent.md similarity index 98% rename from reference/ingestion-tools/fleet/migrate-auditbeat-to-agent.md rename to reference/fleet/migrate-auditbeat-to-agent.md index d453560581..0ea3ad3efe 100644 --- a/reference/ingestion-tools/fleet/migrate-auditbeat-to-agent.md +++ b/reference/fleet/migrate-auditbeat-to-agent.md @@ -5,7 +5,7 @@ mapped_pages: # Migrate from Auditbeat to Elastic Agent [migrate-auditbeat-to-agent] -Before you begin, read [*Migrate from {{beats}} to {{agent}}*](/reference/ingestion-tools/fleet/migrate-from-beats-to-elastic-agent.md) to learn how to deploy {{agent}} and install integrations. +Before you begin, read [*Migrate from {{beats}} to {{agent}}*](/reference/fleet/migrate-from-beats-to-elastic-agent.md) to learn how to deploy {{agent}} and install integrations. Then come back to this page to learn about the integrations available to replace functionality provided by {{auditbeat}}. diff --git a/reference/ingestion-tools/fleet/migrate-elastic-agent.md b/reference/fleet/migrate-elastic-agent.md similarity index 100% rename from reference/ingestion-tools/fleet/migrate-elastic-agent.md rename to reference/fleet/migrate-elastic-agent.md diff --git a/reference/ingestion-tools/fleet/migrate-from-beats-to-elastic-agent.md b/reference/fleet/migrate-from-beats-to-elastic-agent.md similarity index 95% rename from reference/ingestion-tools/fleet/migrate-from-beats-to-elastic-agent.md rename to reference/fleet/migrate-from-beats-to-elastic-agent.md index e853359e43..606e384bc7 100644 --- a/reference/ingestion-tools/fleet/migrate-from-beats-to-elastic-agent.md +++ b/reference/fleet/migrate-from-beats-to-elastic-agent.md @@ -24,7 +24,7 @@ There are currently some limitations and requirements to be aware of before migr * **No support for configuring the {{beats}} internal queue.** Each Beat has an internal queue that stores events before batching and publishing them to the output. To improve data throughput, {{beats}} users can set [configuration options](beats://reference/filebeat/configuring-internal-queue.md) to tune the performance of the internal queue. However, the endless fine tuning required to configure the queue is cumbersome and not always fruitful. Instead of expecting users to configure the internal queue, {{agent}} uses sensible defaults. This means you won’t be able to migrate internal queue configurations to {{agent}}. -For more information about {{agent}} limitations, see [*{{beats}} and {{agent}} capabilities*](/reference/ingestion-tools/fleet/index.md). +For more information about {{agent}} limitations, see [*{{beats}} and {{agent}} capabilities*](/reference/fleet/index.md). ## Prepare for the migration [prepare-for-migration] @@ -33,18 +33,18 @@ Before you begin: 1. Review your existing {{beats}} configurations and make a list of the integrations that are required. For example, if your existing implementation collects logs and metrics from Nginx, add Nginx to your list. 2. Make a note of any processors or custom configurations you want to migrate. Some of these customizations may no longer be needed or possible in {{agent}}. -3. Decide if it’s the right time to migrate to {{agent}}. Review the information under [*{{beats}} and {{agent}} capabilities*](/reference/ingestion-tools/fleet/index.md). Make sure the integrations you need are supported and Generally Available, and that the output and features you require are also supported. +3. Decide if it’s the right time to migrate to {{agent}}. Review the information under [*{{beats}} and {{agent}} capabilities*](/reference/fleet/index.md). Make sure the integrations you need are supported and Generally Available, and that the output and features you require are also supported. If everything checks out, proceed to the next step. Otherwise, you might want to continue using {{beats}} and possibly deploy {{agent}} alongside {{beats}} to use features like endpoint protection. ## Set up {{fleet-server}} (self-managed deployments only) [_set_up_fleet_server_self_managed_deployments_only] -To use {{fleet}} for central management, a [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md) must be running and accessible to your hosts. +To use {{fleet}} for central management, a [{{fleet-server}}](/reference/fleet/fleet-server.md) must be running and accessible to your hosts. If you’re using {{ecloud}}, you can skip this step because {{ecloud}} runs a hosted version of {{fleet-server}}. -Otherwise, follow the steps for self-managed deployments described in [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/ingestion-tools/fleet/add-fleet-server-mixed.md) or [Deploy on-premises and self-managed](/reference/ingestion-tools/fleet/add-fleet-server-on-prem.md), depending on your deployment model, and then return to this page when you are done. +Otherwise, follow the steps for self-managed deployments described in [Deploy {{fleet-server}} on-premises and {{es}} on Cloud](/reference/fleet/add-fleet-server-mixed.md) or [Deploy on-premises and self-managed](/reference/fleet/add-fleet-server-on-prem.md), depending on your deployment model, and then return to this page when you are done. ## Deploy {{agent}} to your hosts to collect logs and metrics [_deploy_agent_to_your_hosts_to_collect_logs_and_metrics] @@ -53,7 +53,7 @@ To begin the migration, deploy an {{agent}} to a host where {{beats}} shippers a You can continue to run {{beats}} alongside {{agent}} until you’re satisfied with the data its sending to {{es}}. -Read [*Install {{agent}}s*](/reference/ingestion-tools/fleet/install-elastic-agents.md) to learn how to deploy an {{agent}}. To save time, return to this page when the {{agent}} is deployed, healthy, and successfully sending data. +Read [*Install {{agent}}s*](/reference/fleet/install-elastic-agents.md) to learn how to deploy an {{agent}}. To save time, return to this page when the {{agent}} is deployed, healthy, and successfully sending data. Here’s a high-level overview to help you understand the deployment process. @@ -80,7 +80,7 @@ It’s best to add one integration at a time and test it before adding more inte ## View agent details and inspect the data streams [_view_agent_details_and_inspect_the_data_streams] -After deploying an {{agent}} to a host, view details about the agent and inspect the data streams it creates. To learn more about the benefits of using data streams, refer to [Data streams](/reference/ingestion-tools/fleet/data-streams.md). +After deploying an {{agent}} to a host, view details about the agent and inspect the data streams it creates. To learn more about the benefits of using data streams, refer to [Data streams](/reference/fleet/data-streams.md). 1. On the **Agents** tab in **{{fleet}}**, confirm that the {{agent}} status is `Healthy`. diff --git a/reference/ingestion-tools/fleet/monitor-elastic-agent.md b/reference/fleet/monitor-elastic-agent.md similarity index 94% rename from reference/ingestion-tools/fleet/monitor-elastic-agent.md rename to reference/fleet/monitor-elastic-agent.md index 9c1ed439df..4d853fa0b5 100644 --- a/reference/ingestion-tools/fleet/monitor-elastic-agent.md +++ b/reference/fleet/monitor-elastic-agent.md @@ -21,7 +21,7 @@ Agent monitoring is turned on by default in the agent policy unless you turn it Want to receive an alert when your {{agent}} health status changes? Refer to [Enable alerts and ML jobs based on {{fleet}} and {{agent}} status](#fleet-alerting) and our [alerting example](#fleet-alerting-example). -For more detail about how agents communicate their status to {{fleet}}, refer to [{{agent}} health status](/reference/ingestion-tools/fleet/agent-health-status.md). +For more detail about how agents communicate their status to {{fleet}}, refer to [{{agent}} health status](/reference/fleet/agent-health-status.md). ## View agent status overview [view-agent-status] @@ -46,8 +46,8 @@ The **Agents** tab in **{{fleet}}** displays a maximum of 10,000 agents, shown o | **Unhealthy** | {{agent}}s have errors or are running in a degraded state. An agent will be reported as `unhealthy` as a result of a configuration problem on the host system. For example, an {{agent}} may not have the correct permissions required to run an integration that has been added to the {{agent}} policy. In this case, you may need to investigate and address the situation. | | **Updating** | {{agent}}s are updating the agent policy, updating the binary, or enrolling or unenrolling from {{fleet}}. | | **Offline** | {{agent}}s have stayed in an unhealthy status for a period of time. Offline agent’s API keys remain valid. You can still see these {{agent}}s in the {{fleet}} UI and investigate them for further diagnosis if required. | -| **Inactive** | {{agent}}s have been offline for longer than the time set in your [inactivity timeout](/reference/ingestion-tools/fleet/set-inactivity-timeout.md). These {{agent}}s are valid, but have been removed from the main {{fleet}} UI. | -| **Unenrolled** | {{agent}}s have been manually unenrolled and their API keys have been removed from the system. You can [unenroll](/reference/ingestion-tools/fleet/unenroll-elastic-agent.md) an offline {{agent}} using {{agent}} actions if you determine it’s offline and no longer valid.
These agents need to re-enroll in {{fleet}} to be operational again. | +| **Inactive** | {{agent}}s have been offline for longer than the time set in your [inactivity timeout](/reference/fleet/set-inactivity-timeout.md). These {{agent}}s are valid, but have been removed from the main {{fleet}} UI. | +| **Unenrolled** | {{agent}}s have been manually unenrolled and their API keys have been removed from the system. You can [unenroll](/reference/fleet/unenroll-elastic-agent.md) an offline {{agent}} using {{agent}} actions if you determine it’s offline and no longer valid.
These agents need to re-enroll in {{fleet}} to be operational again. | The following diagram shows the flow of {{agent}} statuses: @@ -215,7 +215,7 @@ Agent monitoring is turned on by default in the agent policy. To change agent mo 1. In {{fleet}}, open the **Agent policies** tab. 2. Click the agent policy to edit it, then click **Settings**. 3. Under **Agent monitoring**, deselect (or select) one or both of these settings: **Collect agent logs** and **Collect agent metrics**. -4. Under **Advanced monitoring options** you can configure additional settings including an HTTP monitoring endpoint, diagnostics rate limiting, and diagnostics file upload limits. Refer to [configure agent monitoring](/reference/ingestion-tools/fleet/agent-policy.md#change-policy-enable-agent-monitoring) for details. +4. Under **Advanced monitoring options** you can configure additional settings including an HTTP monitoring endpoint, diagnostics rate limiting, and diagnostics file upload limits. Refer to [configure agent monitoring](/reference/fleet/agent-policy.md#change-policy-enable-agent-monitoring) for details. 5. Save your changes. To turn off agent monitoring when creating a new agent policy: @@ -229,7 +229,7 @@ To turn off agent monitoring when creating a new agent policy: You may want to store all of the health and status data about your {{agents}} in a remote {{es}} cluster, so that it’s separate and independent from the deployment where you use {{fleet}} to manage the agents. -To do so, follow the steps in [Remote {{es}} output](/reference/ingestion-tools/fleet/remote-elasticsearch-output.md). After the new output is configured, follow the steps to update the {{agent}} policy and make sure that the **Output for agent monitoring** setting is enabled. {{agent}} monitoring data will use the remote {{es}} output that you configured. +To do so, follow the steps in [Remote {{es}} output](/reference/fleet/remote-elasticsearch-output.md). After the new output is configured, follow the steps to update the {{agent}} policy and make sure that the **Output for agent monitoring** setting is enabled. {{agent}} monitoring data will use the remote {{es}} output that you configured. ## Enable alerts and ML jobs based on {{fleet}} and {{agent}} status [fleet-alerting] diff --git a/reference/ingestion-tools/fleet/move_fields-processor.md b/reference/fleet/move_fields-processor.md similarity index 100% rename from reference/ingestion-tools/fleet/move_fields-processor.md rename to reference/fleet/move_fields-processor.md diff --git a/reference/ingestion-tools/fleet/mutual-tls.md b/reference/fleet/mutual-tls.md similarity index 96% rename from reference/ingestion-tools/fleet/mutual-tls.md rename to reference/fleet/mutual-tls.md index 414bd21be7..19ed0056cd 100644 --- a/reference/ingestion-tools/fleet/mutual-tls.md +++ b/reference/fleet/mutual-tls.md @@ -7,7 +7,7 @@ mapped_pages: Mutual Transport Layer Security (mTLS) provides a higher level of security and trust compared to one-way TLS, where only the server presents a certificate. It ensures that not only the server is who it claims to be, but the client is also authenticated. This is particularly valuable in scenarios where both parties need to establish trust and validate each other’s identities, such as in secure API communication, web services, or remote authentication. -For a summary of flow by which TLS is established between components using either one-way or mutual TLS, refer to [One-way and mutual TLS certifications flow](/reference/ingestion-tools/fleet/tls-overview.md). +For a summary of flow by which TLS is established between components using either one-way or mutual TLS, refer to [One-way and mutual TLS certifications flow](/reference/fleet/tls-overview.md). * [Overview](#mutual-tls-overview) * [On-premise deployments](#mutual-tls-on-premise) @@ -42,7 +42,7 @@ When mTLS is required, the secure setup between {{agent}}, {{fleet}}, and {{flee ::::{important} -When you run {{agent}} with the {{elastic-defend}} integration, the [TLS certificates](https://en.wikipedia.org/wiki/X.509) used to connect to {{fleet-server}} and {{es}} need to be generated using [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)). For a full list of available algorithms to use when configuring TLS or mTLS, see [Configure SSL/TLS for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md). These settings are available for both standalone and {{fleet}}-managed {{agent}}. +When you run {{agent}} with the {{elastic-defend}} integration, the [TLS certificates](https://en.wikipedia.org/wiki/X.509) used to connect to {{fleet-server}} and {{es}} need to be generated using [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)). For a full list of available algorithms to use when configuring TLS or mTLS, see [Configure SSL/TLS for standalone {{agents}}](/reference/fleet/elastic-agent-ssl-configuration.md). These settings are available for both standalone and {{fleet}}-managed {{agent}}. :::: @@ -53,7 +53,7 @@ When you run {{agent}} with the {{elastic-defend}} integration, the [TLS certifi :alt: Diagram of mutual TLS on premise deployment model ::: -Refer to the steps in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). To configure mutual TLS, include the following additional parameters when you install {{agent}} and {{fleet-server}}. +Refer to the steps in [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). To configure mutual TLS, include the following additional parameters when you install {{agent}} and {{fleet-server}}. ### {{agent}} settings [_agent_settings] diff --git a/reference/ingestion-tools/fleet/otel-agent-transform.md b/reference/fleet/otel-agent-transform.md similarity index 100% rename from reference/ingestion-tools/fleet/otel-agent-transform.md rename to reference/fleet/otel-agent-transform.md diff --git a/reference/ingestion-tools/fleet/otel-agent.md b/reference/fleet/otel-agent.md similarity index 83% rename from reference/ingestion-tools/fleet/otel-agent.md rename to reference/fleet/otel-agent.md index c1f4fca5e1..a7f70a2cfc 100644 --- a/reference/ingestion-tools/fleet/otel-agent.md +++ b/reference/fleet/otel-agent.md @@ -14,6 +14,6 @@ The [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) is a ven When you run {{agent}} in `otel` mode it supports the standard OTel Collector configuration format that defines a set of receivers, processors, exporters, and connectors. Logs, metrics, and traces can be ingested using OpenTelemetry data formats. -For a full overview and steps to configure {{agent}} in `otel` mode, including a guided onboarding, refer to the [Elastic Distributions for OpenTelemetry](https://github.com/elastic/opentelemetry/tree/main) repository in GitHub. You can also check the [`elastic-agent otel` command](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-otel-command) in the {{fleet}} and {{agent}} Command reference. +For a full overview and steps to configure {{agent}} in `otel` mode, including a guided onboarding, refer to the [Elastic Distributions for OpenTelemetry](https://github.com/elastic/opentelemetry/tree/main) repository in GitHub. You can also check the [`elastic-agent otel` command](/reference/fleet/agent-command-reference.md#elastic-agent-otel-command) in the {{fleet}} and {{agent}} Command reference. -If you have a currently running {{agent}} you can [transform it to run as an OTel Collector](/reference/ingestion-tools/fleet/otel-agent.md). \ No newline at end of file +If you have a currently running {{agent}} you can [transform it to run as an OTel Collector](/reference/fleet/otel-agent.md). \ No newline at end of file diff --git a/reference/ingestion-tools/fleet/package-signatures.md b/reference/fleet/package-signatures.md similarity index 97% rename from reference/ingestion-tools/fleet/package-signatures.md rename to reference/fleet/package-signatures.md index 120b30d767..26f8de816a 100644 --- a/reference/ingestion-tools/fleet/package-signatures.md +++ b/reference/fleet/package-signatures.md @@ -15,7 +15,7 @@ By installing an unverified package, you acknowledge that you assume any risk in To force installation of an unverified package: * When using the {{integrations}} UI, you’ll be prompted to confirm that you want to install the unverified integration. Click **Install anyway** to force installation. -* When using the {{fleet}} API, if you attempt to install an unverified package, you’ll see a 400 response code with a verification failed message. To force installation, set the URL parameter `ignoreUnverified=true`. For more information, refer to [{{kib}} {{fleet}} APIs](/reference/ingestion-tools/fleet/fleet-api-docs.md). +* When using the {{fleet}} API, if you attempt to install an unverified package, you’ll see a 400 response code with a verification failed message. To force installation, set the URL parameter `ignoreUnverified=true`. For more information, refer to [{{kib}} {{fleet}} APIs](/reference/fleet/fleet-api-docs.md). After installation, unverified {{integrations}} are flagged on the **Installed integrations** tab of the {{integrations}} UI. diff --git a/reference/ingestion-tools/fleet/processor-parse-aws-vpc-flow-log.md b/reference/fleet/processor-parse-aws-vpc-flow-log.md similarity index 99% rename from reference/ingestion-tools/fleet/processor-parse-aws-vpc-flow-log.md rename to reference/fleet/processor-parse-aws-vpc-flow-log.md index e215eed36e..649c02f777 100644 --- a/reference/ingestion-tools/fleet/processor-parse-aws-vpc-flow-log.md +++ b/reference/fleet/processor-parse-aws-vpc-flow-log.md @@ -25,7 +25,7 @@ processors: ## Configuration settings [_configuration_settings_33] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/processor-syntax.md b/reference/fleet/processor-syntax.md similarity index 94% rename from reference/ingestion-tools/fleet/processor-syntax.md rename to reference/fleet/processor-syntax.md index ef17189c2c..690e23bdd0 100644 --- a/reference/ingestion-tools/fleet/processor-syntax.md +++ b/reference/fleet/processor-syntax.md @@ -10,7 +10,7 @@ Specify a list of one or more processors: * When configuring processors in the standalone {{agent}} configuration file, put this list under the `processors` setting. * When using the Integrations UI in {{kib}}, put this list in the **Processors** field. -Each processor begins with a dash (-) and includes the processor name, an optional [condition](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions), and configuration settings to pass to the processor: +Each processor begins with a dash (-) and includes the processor name, an optional [condition](/reference/fleet/dynamic-input-configuration.md#conditions), and configuration settings to pass to the processor: ```yaml - : @@ -24,7 +24,7 @@ Each processor begins with a dash (-) and includes the processor name, an option ``` -If a [condition](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) is specified, it must be met in order for the processor to run. If no condition is specified, the processor always runs. +If a [condition](/reference/fleet/dynamic-input-configuration.md#conditions) is specified, it must be met in order for the processor to run. If no condition is specified, the processor always runs. To accomplish complex conditional processing, use the if-then-else processor configuration. This configuration allows you to run multiple processors based on a single condition. For example: diff --git a/reference/ingestion-tools/fleet/providers.md b/reference/fleet/providers.md similarity index 81% rename from reference/ingestion-tools/fleet/providers.md rename to reference/fleet/providers.md index 88dd181eea..7f5ffd67ff 100644 --- a/reference/ingestion-tools/fleet/providers.md +++ b/reference/fleet/providers.md @@ -50,12 +50,12 @@ Context providers use the Elastic Common Schema (ECS) naming to ensure consisten {{agent}} supports the following context providers: -* [Local](/reference/ingestion-tools/fleet/local-provider.md) -* [Agent Provider](/reference/ingestion-tools/fleet/agent-provider.md) -* [Host Provider](/reference/ingestion-tools/fleet/host-provider.md) -* [Env Provider](/reference/ingestion-tools/fleet/env-provider.md) -* [Kubernetes Secrets Provider](/reference/ingestion-tools/fleet/kubernetes_secrets-provider.md) -* [Kubernetes Leader Election Provider](/reference/ingestion-tools/fleet/kubernetes_leaderelection-provider.md) +* [Local](/reference/fleet/local-provider.md) +* [Agent Provider](/reference/fleet/agent-provider.md) +* [Host Provider](/reference/fleet/host-provider.md) +* [Env Provider](/reference/fleet/env-provider.md) +* [Kubernetes Secrets Provider](/reference/fleet/kubernetes_secrets-provider.md) +* [Kubernetes Leader Election Provider](/reference/fleet/kubernetes_leaderelection-provider.md) ### Dynamic Providers [dynamic-providers] @@ -64,9 +64,9 @@ Dynamic providers give an array of multiple key-value mappings. Each key-value m {{agent}} supports the following context providers: -* [Local Dynamic Provider](/reference/ingestion-tools/fleet/local-dynamic-provider.md) -* [Docker Provider](/reference/ingestion-tools/fleet/docker-provider.md) -* [Kubernetes Provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) +* [Local Dynamic Provider](/reference/fleet/local-dynamic-provider.md) +* [Docker Provider](/reference/fleet/docker-provider.md) +* [Kubernetes Provider](/reference/fleet/kubernetes-provider.md) ### Disabling Providers By Default [disable-providers-by-default] diff --git a/reference/ingestion-tools/fleet/rate_limit-processor.md b/reference/fleet/rate_limit-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/rate_limit-processor.md rename to reference/fleet/rate_limit-processor.md index 023652f8cc..5001d1a445 100644 --- a/reference/ingestion-tools/fleet/rate_limit-processor.md +++ b/reference/fleet/rate_limit-processor.md @@ -42,7 +42,7 @@ In the current implementation, rate-limited events are dropped. Future implement ## Configuration settings [_configuration_settings_34] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/registered_domain-processor.md b/reference/fleet/registered_domain-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/registered_domain-processor.md rename to reference/fleet/registered_domain-processor.md index 20f4267fa9..a6fafafc15 100644 --- a/reference/ingestion-tools/fleet/registered_domain-processor.md +++ b/reference/fleet/registered_domain-processor.md @@ -28,7 +28,7 @@ This processor uses the Mozilla Public Suffix list to determine the value. ## Configuration settings [_configuration_settings_35] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/remote-elasticsearch-output.md b/reference/fleet/remote-elasticsearch-output.md similarity index 79% rename from reference/ingestion-tools/fleet/remote-elasticsearch-output.md rename to reference/fleet/remote-elasticsearch-output.md index 53e147a4b8..2e7bbf10f4 100644 --- a/reference/ingestion-tools/fleet/remote-elasticsearch-output.md +++ b/reference/fleet/remote-elasticsearch-output.md @@ -7,7 +7,7 @@ mapped_pages: Beginning in version 8.12.0, you can send {{agent}} data to a remote {{es}} cluster. This is especially useful for data that you want to keep separate and independent from the deployment where you use {{fleet}} to manage the agents. -A remote {{es}} cluster supports the same [output settings](/reference/ingestion-tools/fleet/es-output-settings.md) as your main {{es}} cluster. +A remote {{es}} cluster supports the same [output settings](/reference/fleet/es-output-settings.md) as your main {{es}} cluster. ::::{warning} A bug has been found that causes {{elastic-defend}} response actions to stop working when a remote {{es}} output is configured for an agent. This bug is currently being investigated and is expected to be resolved in an upcoming release. @@ -42,9 +42,9 @@ To configure a remote {{es}} cluster for your {{agent}} data: To prevent unauthorized access the {{es}} Service Token is stored as a secret value. While secret storage is recommended, you can choose to override this setting and store the password as plain text in the agent policy definition. Secret storage requires {{fleet-server}} version 8.12 or higher. This setting can also be stored as a secret value or as plain text for preconfigured outputs. See [Preconfiguration settings](kibana://reference/configuration-reference/fleet-settings.md#_preconfiguration_settings_for_advanced_use_cases) in the {{kib}} Guide to learn more. :::: -6. Choose whether or not the remote output should be the default for agent integrations or for agent monitoring data. When set, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md). -7. Select which [performance tuning settings](/reference/ingestion-tools/fleet/es-output-settings.md#es-output-settings-performance-tuning-settings) you’d prefer in order to optimize {{agent}} for throughput, scale, or latency, or leave the default `balanced` setting. -8. Add any [advanced YAML configuration settings](/reference/ingestion-tools/fleet/es-output-settings.md#es-output-settings-yaml-config) that you’d like for the output. +6. Choose whether or not the remote output should be the default for agent integrations or for agent monitoring data. When set, {{agent}}s use this output to send data if no other output is set in the [agent policy](/reference/fleet/agent-policy.md). +7. Select which [performance tuning settings](/reference/fleet/es-output-settings.md#es-output-settings-performance-tuning-settings) you’d prefer in order to optimize {{agent}} for throughput, scale, or latency, or leave the default `balanced` setting. +8. Add any [advanced YAML configuration settings](/reference/fleet/es-output-settings.md#es-output-settings-yaml-config) that you’d like for the output. 9. Click **Save and apply settings**. After the output is created, you can update an {{agent}} policy to use the new remote {{es}} cluster: @@ -57,4 +57,4 @@ After the output is created, you can update an {{agent}} policy to use the new r The remote {{es}} cluster is now configured. -As a final step before using the remote {{es}} output, you need to make sure that for any integrations that have been [added to your {{agent}} policy](/reference/ingestion-tools/fleet/add-integration-to-policy.md), the integration assets have been installed on the remote {{es}} cluster. Refer to [Install and uninstall {{agent}} integration assets](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md) for the steps. +As a final step before using the remote {{es}} output, you need to make sure that for any integrations that have been [added to your {{agent}} policy](/reference/fleet/add-integration-to-policy.md), the integration assets have been installed on the remote {{es}} cluster. Refer to [Install and uninstall {{agent}} integration assets](/reference/fleet/install-uninstall-integration-assets.md) for the steps. diff --git a/reference/ingestion-tools/fleet/rename-processor.md b/reference/fleet/rename-processor.md similarity index 91% rename from reference/ingestion-tools/fleet/rename-processor.md rename to reference/fleet/rename-processor.md index 7d9508491b..b4dcc175ff 100644 --- a/reference/ingestion-tools/fleet/rename-processor.md +++ b/reference/fleet/rename-processor.md @@ -30,7 +30,7 @@ You can rename fields to resolve field name conflicts. For example, if an event ## Configuration settings [_configuration_settings_36] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -40,7 +40,7 @@ You can rename fields to resolve field name conflicts. For example, if an event | `ignore_missing` | No | `false` | Whether to ignore missing keys. If `true`, no error is logged when a key that should be renamed is missing. | | `fail_on_error` | No | `true` | Whether to fail renaming if an error occurs. If `true` and an error occurs, the renaming of fields is stopped, and the original event is returned. If `false`, renaming continues even if an error occurs during renaming. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. You can specify multiple `rename` processors under the `processors` section. diff --git a/reference/ingestion-tools/fleet/replace-fields.md b/reference/fleet/replace-fields.md similarity index 91% rename from reference/ingestion-tools/fleet/replace-fields.md rename to reference/fleet/replace-fields.md index e384e38cd0..3c285baa7d 100644 --- a/reference/ingestion-tools/fleet/replace-fields.md +++ b/reference/fleet/replace-fields.md @@ -35,7 +35,7 @@ The following example changes the path from `/usr/bin` to `/usr/local/bin`: ## Configuration settings [_configuration_settings_37] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -45,5 +45,5 @@ The following example changes the path from `/usr/bin` to `/usr/local/bin`: | `ignore_missing` | No | `false` | Whether to ignore missing fields. If `true`, no error is logged if the specified field is missing. | | `fail_on_error` | No | `true` | Whether to fail replacement of field values if an error occurs.If `true` and there’s an error, the replacement of field values is stopped, and the original event is returned.If `false`, replacement continues even if an error occurs during replacement. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. diff --git a/reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md b/reference/fleet/running-on-aks-managed-by-fleet.md similarity index 93% rename from reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md rename to reference/fleet/running-on-aks-managed-by-fleet.md index 046ee2a793..ad6cf537b8 100644 --- a/reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md +++ b/reference/fleet/running-on-aks-managed-by-fleet.md @@ -5,7 +5,7 @@ mapped_pages: # Run Elastic Agent on Azure AKS managed by Fleet [running-on-aks-managed-by-fleet] -Please follow the steps to run the {{agent}} on [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) page. +Please follow the steps to run the {{agent}} on [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) page. ## Important notes: [_important_notes_4] diff --git a/reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md b/reference/fleet/running-on-eks-managed-by-fleet.md similarity index 93% rename from reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md rename to reference/fleet/running-on-eks-managed-by-fleet.md index e4ce8e6a16..9da81925b4 100644 --- a/reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md +++ b/reference/fleet/running-on-eks-managed-by-fleet.md @@ -5,7 +5,7 @@ mapped_pages: # Run Elastic Agent on Amazon EKS managed by Fleet [running-on-eks-managed-by-fleet] -Please follow the steps to run the {{agent}} on [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) page. +Please follow the steps to run the {{agent}} on [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) page. ## Important notes: [_important_notes_3] diff --git a/reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md b/reference/fleet/running-on-gke-managed-by-fleet.md similarity index 94% rename from reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md rename to reference/fleet/running-on-gke-managed-by-fleet.md index 29e4cd8eac..1abe97c185 100644 --- a/reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md +++ b/reference/fleet/running-on-gke-managed-by-fleet.md @@ -5,7 +5,7 @@ mapped_pages: # Run Elastic Agent on GKE managed by Fleet [running-on-gke-managed-by-fleet] -Please follow the steps to run the {{agent}} on [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) page. +Please follow the steps to run the {{agent}} on [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) page. ### Important notes: [_important_notes_2] diff --git a/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md b/reference/fleet/running-on-kubernetes-managed-by-fleet.md similarity index 89% rename from reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md rename to reference/fleet/running-on-kubernetes-managed-by-fleet.md index aa01617d85..d4bd3c56ac 100644 --- a/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md +++ b/reference/fleet/running-on-kubernetes-managed-by-fleet.md @@ -39,7 +39,7 @@ mapped_pages: ``` ::::{warning} - On managed Kubernetes solutions, such as AKS, GKE or EKS, {{agent}} does not have the required permissions to collect metrics from [Kubernetes control plane](https://kubernetes.io/docs/concepts/overview/components/#control-plane-components) components, like `kube-scheduler` and `kube-controller-manager`. Audit logs are only available on Kubernetes control plane nodes as well, and hence cannot be collected by {{agent}}. Refer [here](integration-docs://reference/kubernetes/kube-scheduler.md) and [here](integration-docs://reference/kubernetes/kube-controller-manager.md) to find more information. For more information about specific cloud providers, refer to [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md), [Run {{agent}} on GKE managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md) and [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md) + On managed Kubernetes solutions, such as AKS, GKE or EKS, {{agent}} does not have the required permissions to collect metrics from [Kubernetes control plane](https://kubernetes.io/docs/concepts/overview/components/#control-plane-components) components, like `kube-scheduler` and `kube-controller-manager`. Audit logs are only available on Kubernetes control plane nodes as well, and hence cannot be collected by {{agent}}. Refer [here](integration-docs://reference/kubernetes/kube-scheduler.md) and [here](integration-docs://reference/kubernetes/kube-controller-manager.md) to find more information. For more information about specific cloud providers, refer to [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/fleet/running-on-aks-managed-by-fleet.md), [Run {{agent}} on GKE managed by {{fleet}}](/reference/fleet/running-on-gke-managed-by-fleet.md) and [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/fleet/running-on-eks-managed-by-fleet.md) :::: @@ -66,19 +66,19 @@ This manifest includes the Kubernetes integration to collect Kubernetes metrics The {{agent}} is deployed as a [DaemonSet](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) to ensure that there is a running instance on each node of the cluster. These instances are used to retrieve most metrics from the host, such as system metrics, Docker stats, and metrics from all the services running on top of Kubernetes. These metrics are accessed through the deployed `kube-state-metrics`. Notice that everything is deployed under the `kube-system` namespace by default. To change the namespace, modify the manifest file. -Moreover, one of the Pods in the DaemonSet will constantly hold a *leader lock* which makes it responsible for handling cluster-wide monitoring. You can find more information about leader election configuration options at [leader election provider](/reference/ingestion-tools/fleet/kubernetes_leaderelection-provider.md). The leader pod will retrieve metrics that are unique for the whole cluster, such as Kubernetes events or [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics). +Moreover, one of the Pods in the DaemonSet will constantly hold a *leader lock* which makes it responsible for handling cluster-wide monitoring. You can find more information about leader election configuration options at [leader election provider](/reference/fleet/kubernetes_leaderelection-provider.md). The leader pod will retrieve metrics that are unique for the whole cluster, such as Kubernetes events or [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics). For Kubernetes Security Posture Management (KSPM) purposes, the {{agent}} requires read access to various types of Kubernetes resources, node processes, and files. To achieve this, read permissions are granted to the {{agent}} for the necessary resources, and volumes from the hosting node’s file system are mounted to allow accessibility to the {{agent}} pods. ::::{tip} -The size and the number of nodes in a Kubernetes cluster can be large at times, and in such a case the Pod that will be collecting cluster level metrics might require more runtime resources than you would like to dedicate to all of the pods in the DaemonSet. The leader which is collecting the cluster wide metrics may face performance issues due to resource limitations if under-resourced. In this case users might consider avoiding the use of a single DaemonSet with the leader election strategy and instead run a dedicated standalone {{agent}} instance for collecting cluster wide metrics using a Deployment in addition to the DaemonSet to collect metrics for each node. Then both the Deployment and the DaemonSet can be resourced independently and appropriately. For more information check the [Scaling {{agent}} on {{k8s}}](/reference/ingestion-tools/fleet/scaling-on-kubernetes.md) page. +The size and the number of nodes in a Kubernetes cluster can be large at times, and in such a case the Pod that will be collecting cluster level metrics might require more runtime resources than you would like to dedicate to all of the pods in the DaemonSet. The leader which is collecting the cluster wide metrics may face performance issues due to resource limitations if under-resourced. In this case users might consider avoiding the use of a single DaemonSet with the leader election strategy and instead run a dedicated standalone {{agent}} instance for collecting cluster wide metrics using a Deployment in addition to the DaemonSet to collect metrics for each node. Then both the Deployment and the DaemonSet can be resourced independently and appropriately. For more information check the [Scaling {{agent}} on {{k8s}}](/reference/fleet/scaling-on-kubernetes.md) page. :::: ### Step 2: Configure {{agent}} policy [_step_2_configure_agent_policy] -The {{agent}} needs to be assigned to a policy to enable the proper inputs. To achieve Kubernetes observability, the policy needs to include the Kubernetes integration. Refer to [Create a policy](/reference/ingestion-tools/fleet/agent-policy.md#create-a-policy) and [Add an integration to a policy](/reference/ingestion-tools/fleet/agent-policy.md#add-integration) to learn how to configure the [Kubernetes integration](integration-docs://reference/kubernetes/index.md). +The {{agent}} needs to be assigned to a policy to enable the proper inputs. To achieve Kubernetes observability, the policy needs to include the Kubernetes integration. Refer to [Create a policy](/reference/fleet/agent-policy.md#create-a-policy) and [Add an integration to a policy](/reference/fleet/agent-policy.md#add-integration) to learn how to configure the [Kubernetes integration](integration-docs://reference/kubernetes/index.md). ### Step 3: Enroll {{agent}} to the policy [_step_3_enroll_agent_to_the_policy] @@ -89,7 +89,7 @@ Enrollment of an {{agent}} is defined as the action to register a specific agent A new `FLEET_ENROLLMENT_TOKEN` will be created upon new policy creation and will be inserted inside the Elastic Agent Manifest during the Guided installation. -Find more information for [Enrollment Tokens](/reference/ingestion-tools/fleet/fleet-enrollment-tokens.md). +Find more information for [Enrollment Tokens](/reference/fleet/fleet-enrollment-tokens.md). To specify different destination/credentials, change the following parameters in the manifest file: @@ -132,7 +132,7 @@ If you need to run {{fleet-server}} as well, adjust the `docker run` command abo 3. Service token to use for communication with {{es}} and {{kib}}. -Refer to [Environment variables](/reference/ingestion-tools/fleet/agent-environment-variables.md) for all available options. +Refer to [Environment variables](/reference/fleet/agent-environment-variables.md) for all available options. ### Step 4: Configure tolerations [_step_4_configure_tolerations] @@ -209,6 +209,6 @@ If you’d like to run {{agent}} on Kubernetes on a read-only file system, you c ::: 3. To view data flowing in, go to **Analytics → Discover** and select the index `metrics-*`, or even more specific, `metrics-kubernetes.*`. If you can’t see these indexes, [create a data view](/explore-analyze/find-and-organize/data-views.md) for them. -4. To view predefined dashboards, either select **Analytics→Dashboard** or [install assets through an integration](/reference/ingestion-tools/fleet/view-integration-assets.md). +4. To view predefined dashboards, either select **Analytics→Dashboard** or [install assets through an integration](/reference/fleet/view-integration-assets.md). diff --git a/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md b/reference/fleet/running-on-kubernetes-standalone.md similarity index 90% rename from reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md rename to reference/fleet/running-on-kubernetes-standalone.md index c9834fd4b8..2653cc3d98 100644 --- a/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md +++ b/reference/fleet/running-on-kubernetes-standalone.md @@ -37,7 +37,7 @@ mapped_pages: ``` ::::{warning} - On managed Kubernetes solutions, such as AKS, GKE or EKS, {{agent}} does not have the required permissions to collect metrics from [Kubernetes control plane](https://kubernetes.io/docs/concepts/overview/components/#control-plane-components) components, like `kube-scheduler` and `kube-controller-manager`. Audit logs are only available on Kubernetes control plane nodes as well, and hence cannot be collected by {{agent}}. Refer [here](integration-docs://reference/kubernetes/kube-scheduler.md) and [here](integration-docs://reference/kubernetes/kube-controller-manager.md) to find more information. For more information about specific cloud providers, refer to [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md), [Run {{agent}} on GKE managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md) and [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md) + On managed Kubernetes solutions, such as AKS, GKE or EKS, {{agent}} does not have the required permissions to collect metrics from [Kubernetes control plane](https://kubernetes.io/docs/concepts/overview/components/#control-plane-components) components, like `kube-scheduler` and `kube-controller-manager`. Audit logs are only available on Kubernetes control plane nodes as well, and hence cannot be collected by {{agent}}. Refer [here](integration-docs://reference/kubernetes/kube-scheduler.md) and [here](integration-docs://reference/kubernetes/kube-controller-manager.md) to find more information. For more information about specific cloud providers, refer to [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/fleet/running-on-aks-managed-by-fleet.md), [Run {{agent}} on GKE managed by {{fleet}}](/reference/fleet/running-on-gke-managed-by-fleet.md) and [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/fleet/running-on-eks-managed-by-fleet.md) :::: @@ -64,7 +64,7 @@ This manifest includes the Kubernetes integration to collect Kubernetes metrics The {{agent}} is deployed as a [DaemonSet](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) to ensure that there is a running instance on each node of the cluster. These instances are used to retrieve most metrics from the host, such as system metrics, Docker stats, and metrics from all the services running on top of Kubernetes. These metrics are accessed through the deployed `kube-state-metrics`. Notice that everything is deployed under the `kube-system` namespace by default. To change the namespace, modify the manifest file. -Moreover, one of the Pods in the DaemonSet will constantly hold a *leader lock* which makes it responsible for handling cluster-wide monitoring. You can find more information about leader election configuration options at [leader election provider](/reference/ingestion-tools/fleet/kubernetes_leaderelection-provider.md). The leader pod will retrieve metrics that are unique for the whole cluster, such as Kubernetes events or [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics). We make sure that these metrics are retrieved from the leader pod by applying the following [condition](/reference/ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md) in the manifest, before declaring the data streams with these metricsets: +Moreover, one of the Pods in the DaemonSet will constantly hold a *leader lock* which makes it responsible for handling cluster-wide monitoring. You can find more information about leader election configuration options at [leader election provider](/reference/fleet/kubernetes_leaderelection-provider.md). The leader pod will retrieve metrics that are unique for the whole cluster, such as Kubernetes events or [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics). We make sure that these metrics are retrieved from the leader pod by applying the following [condition](/reference/fleet/elastic-agent-kubernetes-autodiscovery.md) in the manifest, before declaring the data streams with these metricsets: ```yaml ... @@ -79,7 +79,7 @@ inputs: For Kubernetes Security Posture Management (KSPM) purposes, the {{agent}} requires read access to various types of Kubernetes resources, node processes, and files. To achieve this, read permissions are granted to the {{agent}} for the necessary resources, and volumes from the hosting node’s file system are mounted to allow accessibility to the {{agent}} pods. ::::{tip} -The size and the number of nodes in a Kubernetes cluster can be large at times, and in such a case the Pod that will be collecting cluster level metrics might require more runtime resources than you would like to dedicate to all of the pods in the DaemonSet. The leader which is collecting the cluster wide metrics may face performance issues due to resource limitations if under-resourced. In this case users might consider avoiding the use of a single DaemonSet with the leader election strategy and instead run a dedicated standalone {{agent}} instance for collecting cluster wide metrics using a Deployment in addition to the DaemonSet to collect metrics for each node. Then both the Deployment and the DaemonSet can be resourced independently and appropriately. For more information check the [Scaling {{agent}} on {{k8s}}](/reference/ingestion-tools/fleet/scaling-on-kubernetes.md) page. +The size and the number of nodes in a Kubernetes cluster can be large at times, and in such a case the Pod that will be collecting cluster level metrics might require more runtime resources than you would like to dedicate to all of the pods in the DaemonSet. The leader which is collecting the cluster wide metrics may face performance issues due to resource limitations if under-resourced. In this case users might consider avoiding the use of a single DaemonSet with the leader election strategy and instead run a dedicated standalone {{agent}} instance for collecting cluster wide metrics using a Deployment in addition to the DaemonSet to collect metrics for each node. Then both the Deployment and the DaemonSet can be resourced independently and appropriately. For more information check the [Scaling {{agent}} on {{k8s}}](/reference/fleet/scaling-on-kubernetes.md) page. :::: @@ -102,7 +102,7 @@ Set the {{es}} settings before deploying the manifest: 3. The {{es}} host to communicate with. -Refer to [Environment variables](/reference/ingestion-tools/fleet/agent-environment-variables.md) for all available options. +Refer to [Environment variables](/reference/fleet/agent-environment-variables.md) for all available options. ### Step 3: Configure tolerations [_step_3_configure_tolerations] @@ -170,7 +170,7 @@ If you’d like to run {{agent}} on Kubernetes on a read-only file system, you c :::: 2. You can see data flowing in by going to **Analytics → Discover** and selecting the index `metrics-*`, or even more specific, `metrics-kubernetes.*`. If you can’t see these indexes, [create a data view](/explore-analyze/find-and-organize/data-views.md) for them. -3. You can see predefined dashboards by selecting **Analytics→Dashboard**, or by [installing assets through an integration](/reference/ingestion-tools/fleet/view-integration-assets.md). +3. You can see predefined dashboards by selecting **Analytics→Dashboard**, or by [installing assets through an integration](/reference/fleet/view-integration-assets.md). ## Red Hat OpenShift configuration [_red_hat_openshift_configuration] @@ -261,6 +261,6 @@ If you are using Red Hat OpenShift, you need to specify additional settings in t ### Autodiscover targeted Pods [_autodiscover_targeted_pods] -Refer to [Kubernetes autodiscovery with {{agent}}](/reference/ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md) for more information. +Refer to [Kubernetes autodiscovery with {{agent}}](/reference/fleet/elastic-agent-kubernetes-autodiscovery.md) for more information. diff --git a/reference/ingestion-tools/fleet/scaling-on-kubernetes.md b/reference/fleet/scaling-on-kubernetes.md similarity index 94% rename from reference/ingestion-tools/fleet/scaling-on-kubernetes.md rename to reference/fleet/scaling-on-kubernetes.md index 55f0e5aec2..0fd5651360 100644 --- a/reference/ingestion-tools/fleet/scaling-on-kubernetes.md +++ b/reference/fleet/scaling-on-kubernetes.md @@ -7,8 +7,8 @@ mapped_pages: For more information on how to deploy {{agent}} on {{k8s}}, please review these pages: -* [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md). -* [Run {{agent}} Standalone on Kubernetes](/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md). +* [Run {{agent}} on Kubernetes managed by {{fleet}}](/reference/fleet/running-on-kubernetes-managed-by-fleet.md). +* [Run {{agent}} Standalone on Kubernetes](/reference/fleet/running-on-kubernetes-standalone.md). ### Observability at scale [_observability_at_scale] @@ -50,7 +50,7 @@ Controller manager and Scheduler datastreams are being enabled only on the speci The default manifest provided deploys {{agent}} as DaemonSet which results in an {{agent}} being deployed on every node of the {{k8s}} cluster. -Additionally, by default one agent is elected as **leader** (for more information visit [Kubernetes LeaderElection Provider](/reference/ingestion-tools/fleet/kubernetes_leaderelection-provider.md)). The {{agent}} Pod which holds the leadership lock is responsible for collecting the cluster-wide metrics in addition to its node’s metrics. +Additionally, by default one agent is elected as **leader** (for more information visit [Kubernetes LeaderElection Provider](/reference/fleet/kubernetes_leaderelection-provider.md)). The {{agent}} Pod which holds the leadership lock is responsible for collecting the cluster-wide metrics in addition to its node’s metrics. :::{image} images/k8sscaling.png :alt: {{agent}} as daemonset @@ -59,7 +59,7 @@ Additionally, by default one agent is elected as **leader** (for more informatio The above schema explains how {{agent}} collects and sends metrics to {{es}}. Because of Leader Agent being responsible to also collecting cluster-lever metrics, this means that it requires additional resources. -The DaemonSet deployment approach with leader election simplifies the installation of the {{agent}} because we define less {{k8s}} Resources in our manifest and we only need one single Agent policy for our Agents. Hence it is the default supported method for [Managed {{agent}} installation](/reference/ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md) +The DaemonSet deployment approach with leader election simplifies the installation of the {{agent}} because we define less {{k8s}} Resources in our manifest and we only need one single Agent policy for our Agents. Hence it is the default supported method for [Managed {{agent}} installation](/reference/fleet/running-on-kubernetes-managed-by-fleet.md) #### Specifying resources and limits in agent manifests [_specifying_resources_and_limits_in_agent_manifests] @@ -150,7 +150,7 @@ Policy configuration of {{k8s}} package can heavily affect the amount of metrics * Disabling log collection * Keep audit logs disabled * Disable events dataset -* Disable {{k8s}} control plane datasets in Cloud managed {{k8s}} instances (see more info ** [Run {{agent}} on GKE managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-gke-managed-by-fleet.md), [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-eks-managed-by-fleet.md), [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/ingestion-tools/fleet/running-on-aks-managed-by-fleet.md) pages) +* Disable {{k8s}} control plane datasets in Cloud managed {{k8s}} instances (see more info ** [Run {{agent}} on GKE managed by {{fleet}}](/reference/fleet/running-on-gke-managed-by-fleet.md), [Run {{agent}} on Amazon EKS managed by {{fleet}}](/reference/fleet/running-on-eks-managed-by-fleet.md), [Run {{agent}} on Azure AKS managed by {{fleet}}](/reference/fleet/running-on-aks-managed-by-fleet.md) pages) #### Dashboards and visualisations [_dashboards_and_visualisations] @@ -162,7 +162,7 @@ User experience regarding Dashboard responses, is also affected from the size of #### Disabling indexing host.ip and host.mac fields [_disabling_indexing_host_ip_and_host_mac_fields] -A new environemntal variable `ELASTIC_NETINFO: false` has been introduced to globally disable the indexing of `host.ip` and `host.mac` fields in your {{k8s}} integration. For more information see [Environment variables](/reference/ingestion-tools/fleet/agent-environment-variables.md). +A new environemntal variable `ELASTIC_NETINFO: false` has been introduced to globally disable the indexing of `host.ip` and `host.mac` fields in your {{k8s}} integration. For more information see [Environment variables](/reference/fleet/agent-environment-variables.md). Setting this to `false` is recommended for large scale setups where the `host.ip` and `host.mac` fields' index size increases. The number of IPs and MAC addresses reported increases significantly as a Kubenetes cluster grows. This leads to considerably increased indexing time, as well as the need for extra storage and additional overhead for visualization rendering. diff --git a/reference/ingestion-tools/fleet/script-processor.md b/reference/fleet/script-processor.md similarity index 98% rename from reference/ingestion-tools/fleet/script-processor.md rename to reference/fleet/script-processor.md index 836e04f9b7..1642b93312 100644 --- a/reference/ingestion-tools/fleet/script-processor.md +++ b/reference/fleet/script-processor.md @@ -73,7 +73,7 @@ function test() { ## Configuration settings [_configuration_settings_38] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that they process the raw event data rather than the final event sent to {{es}}. For related limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/secret-files-guide.md b/reference/fleet/secret-files-guide.md similarity index 94% rename from reference/ingestion-tools/fleet/secret-files-guide.md rename to reference/fleet/secret-files-guide.md index 47ae5dbbee..0826a08252 100644 --- a/reference/ingestion-tools/fleet/secret-files-guide.md +++ b/reference/fleet/secret-files-guide.md @@ -133,7 +133,7 @@ spec: ### {{agent}} Kubernetes secrets provider [_agent_kubernetes_secrets_provider] -When you are running {{fleet-server}} under {{agent}} in {{k8s}}, you can use {{agent}}'s [Kubernetes Secrets Provider](/reference/ingestion-tools/fleet/kubernetes_secrets-provider.md) to insert a {{k8s}} secret directly into {{fleet-server}}'s configuration. Note that due to how {{fleet-server}} is bootstrapped only the APM secrets (API key or secret token) can be specified with this provider. +When you are running {{fleet-server}} under {{agent}} in {{k8s}}, you can use {{agent}}'s [Kubernetes Secrets Provider](/reference/fleet/kubernetes_secrets-provider.md) to insert a {{k8s}} secret directly into {{fleet-server}}'s configuration. Note that due to how {{fleet-server}} is bootstrapped only the APM secrets (API key or secret token) can be specified with this provider. diff --git a/reference/ingestion-tools/fleet/secure-connections.md b/reference/fleet/secure-connections.md similarity index 97% rename from reference/ingestion-tools/fleet/secure-connections.md rename to reference/fleet/secure-connections.md index 1d4c177608..a82efe5337 100644 --- a/reference/ingestion-tools/fleet/secure-connections.md +++ b/reference/fleet/secure-connections.md @@ -7,9 +7,9 @@ mapped_pages: If you’re running a self-managed cluster, configure Transport Layer Security (TLS) to encrypt traffic between {{agent}}s, {{fleet-server}}, and other components in the {{stack}}. -For the install settings specific to mutual TLS, as opposed to one-way TLS, refer to [{{agent}} deployment models with mutual TLS](/reference/ingestion-tools/fleet/mutual-tls.md). +For the install settings specific to mutual TLS, as opposed to one-way TLS, refer to [{{agent}} deployment models with mutual TLS](/reference/fleet/mutual-tls.md). -For a summary of flow by which TLS is established between components using either one-way or mutual TLS, refer to [One-way and mutual TLS certifications flow](/reference/ingestion-tools/fleet/tls-overview.md). +For a summary of flow by which TLS is established between components using either one-way or mutual TLS, refer to [One-way and mutual TLS certifications flow](/reference/fleet/tls-overview.md). ::::{tip} [{{ecloud}}](https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body) provides secure, encrypted connections out of the box! @@ -35,7 +35,7 @@ Key passwords are not currently supported. ::::{important} -When you run {{agent}} with the {{elastic-defend}} integration, the [TLS certificates](https://en.wikipedia.org/wiki/X.509) used to connect to {{fleet-server}} and {{es}} need to be generated using [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)). For a full list of available algorithms to use when configuring TLS or mTLS, see [Configure SSL/TLS for standalone {{agents}}](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md). These settings are available for both standalone and {{fleet}}-managed {{agent}}. +When you run {{agent}} with the {{elastic-defend}} integration, the [TLS certificates](https://en.wikipedia.org/wiki/X.509) used to connect to {{fleet-server}} and {{es}} need to be generated using [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)). For a full list of available algorithms to use when configuring TLS or mTLS, see [Configure SSL/TLS for standalone {{agents}}](/reference/fleet/elastic-agent-ssl-configuration.md). These settings are available for both standalone and {{fleet}}-managed {{agent}}. :::: @@ -164,7 +164,7 @@ To encrypt traffic between {{agent}}s, {{fleet-server}}, and {{es}}: The following command installs {{agent}} as a service, enrolls it in the {{fleet-server}} policy, and starts the service. ::::{note} - If you’re using DEB or RPM, or already have the {{agent}} installed, use the `enroll` command along with the following options, then start the service as described in [Start {{agent}}](/reference/ingestion-tools/fleet/start-stop-elastic-agent.md#start-elastic-agent-service). + If you’re using DEB or RPM, or already have the {{agent}} installed, use the `enroll` command along with the following options, then start the service as described in [Start {{agent}}](/reference/fleet/start-stop-elastic-agent.md#start-elastic-agent-service). :::: diff --git a/reference/ingestion-tools/fleet/secure-logstash-connections.md b/reference/fleet/secure-logstash-connections.md similarity index 98% rename from reference/ingestion-tools/fleet/secure-logstash-connections.md rename to reference/fleet/secure-logstash-connections.md index e4808a1005..c88f914c02 100644 --- a/reference/ingestion-tools/fleet/secure-logstash-connections.md +++ b/reference/fleet/secure-logstash-connections.md @@ -168,7 +168,7 @@ bin/logstash ## Add a {{ls}} output to {{fleet}} [add-ls-output] -This section describes how to add a {{ls}} output and configure SSL settings in {{fleet}}. If you’re running {{agent}} standalone, refer to the [{{ls}} output](/reference/ingestion-tools/fleet/logstash-output.md) configuration docs. +This section describes how to add a {{ls}} output and configure SSL settings in {{fleet}}. If you’re running {{agent}} standalone, refer to the [{{ls}} output](/reference/fleet/logstash-output.md) configuration docs. 1. In {{kib}}, go to **{{fleet}} > Settings**. 2. Under **Outputs**, click **Add output**. If you’ve been following the {{ls}} steps in {{fleet}}, you might already be on this page. diff --git a/reference/ingestion-tools/fleet/secure.md b/reference/fleet/secure.md similarity index 55% rename from reference/ingestion-tools/fleet/secure.md rename to reference/fleet/secure.md index 64ad7700a1..7d9d9b9fcd 100644 --- a/reference/ingestion-tools/fleet/secure.md +++ b/reference/fleet/secure.md @@ -9,9 +9,9 @@ mapped_pages: Some connections may require you to generate certificates and configure SSL/TLS. -* [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md) -* [{{agent}} deployment models with mutual TLS](/reference/ingestion-tools/fleet/mutual-tls.md) -* [Configure SSL/TLS for the {{ls}} output](/reference/ingestion-tools/fleet/secure-logstash-connections.md) +* [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md) +* [{{agent}} deployment models with mutual TLS](/reference/fleet/mutual-tls.md) +* [Configure SSL/TLS for the {{ls}} output](/reference/fleet/secure-logstash-connections.md) diff --git a/reference/ingestion-tools/fleet/set-inactivity-timeout.md b/reference/fleet/set-inactivity-timeout.md similarity index 85% rename from reference/ingestion-tools/fleet/set-inactivity-timeout.md rename to reference/fleet/set-inactivity-timeout.md index b0eacaac46..3df3f31fad 100644 --- a/reference/ingestion-tools/fleet/set-inactivity-timeout.md +++ b/reference/fleet/set-inactivity-timeout.md @@ -11,9 +11,9 @@ When {{fleet-server}} receives a check-in from an inactive {{agent}}, it returns For example, if an employee is on holiday with their laptop off, the {{agent}} will transition to offline then inactive once the inactivity timeout limit is reached. This prevents the inactive {{agent}} from cluttering the {{fleet}} UI. When the employee returns, the {{agent}} checks in and returns to healthy status with valid API keys. -If an {{agent}} is no longer valid, you can manually [unenroll](/reference/ingestion-tools/fleet/unenroll-elastic-agent.md) inactive {{agent}}s to revoke the API keys. Unenrolled agents need to be re-enrolled to be operational again. +If an {{agent}} is no longer valid, you can manually [unenroll](/reference/fleet/unenroll-elastic-agent.md) inactive {{agent}}s to revoke the API keys. Unenrolled agents need to be re-enrolled to be operational again. -For more on {{agent}} statuses, see [view agent status](/reference/ingestion-tools/fleet/monitor-elastic-agent.md#view-agent-status). +For more on {{agent}} statuses, see [view agent status](/reference/fleet/monitor-elastic-agent.md#view-agent-status). ## Set the inactivity timeout [setting-inactivity-timeout] diff --git a/reference/ingestion-tools/fleet/start-stop-elastic-agent.md b/reference/fleet/start-stop-elastic-agent.md similarity index 100% rename from reference/ingestion-tools/fleet/start-stop-elastic-agent.md rename to reference/fleet/start-stop-elastic-agent.md diff --git a/reference/ingestion-tools/fleet/structure-config-file.md b/reference/fleet/structure-config-file.md similarity index 58% rename from reference/ingestion-tools/fleet/structure-config-file.md rename to reference/fleet/structure-config-file.md index 0ce62b9379..221b5f3554 100644 --- a/reference/ingestion-tools/fleet/structure-config-file.md +++ b/reference/fleet/structure-config-file.md @@ -7,34 +7,34 @@ mapped_pages: The `elastic-agent.yml` policy file contains all of the settings that determine how {{agent}} runs. The most important and commonly used settings are described here, including input and output options, providers used for variables and conditional output, security settings, logging options, enabling of special features, and specifications for {{agent}} upgrades. -An `elastic-agent.yml` file is modular: You can combine input, output, and all other settings to enable the [{{integrations}}](integration-docs://reference/index.md) to use with {{agent}}. Refer to [Create a standalone {{agent}} policy](/reference/ingestion-tools/fleet/create-standalone-agent-policy.md) for the steps to download the settings to use as a starting point, and then refer to the following examples to learn about the available settings: +An `elastic-agent.yml` file is modular: You can combine input, output, and all other settings to enable the [{{integrations}}](integration-docs://reference/index.md) to use with {{agent}}. Refer to [Create a standalone {{agent}} policy](/reference/fleet/create-standalone-agent-policy.md) for the steps to download the settings to use as a starting point, and then refer to the following examples to learn about the available settings: -* [Config file examples](/reference/ingestion-tools/fleet/config-file-examples.md) -* [Use standalone {{agent}} to monitor nginx](/reference/ingestion-tools/fleet/example-standalone-monitor-nginx.md). +* [Config file examples](/reference/fleet/config-file-examples.md) +* [Use standalone {{agent}} to monitor nginx](/reference/fleet/example-standalone-monitor-nginx.md). ## Config file components [structure-config-file-components] The following categories include the most common settings used to configure standalone {{agent}}. Follow each link for more detail and examples. -[Inputs](/reference/ingestion-tools/fleet/elastic-agent-input-configuration.md) +[Inputs](/reference/fleet/elastic-agent-input-configuration.md) : Specify how {{agent}} locates and processes input data. -[Providers](/reference/ingestion-tools/fleet/providers.md) +[Providers](/reference/fleet/providers.md) : Specify the key-value pairs used for variable substitution and conditionals in {{agent}} output. -[Outputs](/reference/ingestion-tools/fleet/elastic-agent-output-configuration.md) +[Outputs](/reference/fleet/elastic-agent-output-configuration.md) : Specify where {{agent}} sends data. -[SSL/TLS](/reference/ingestion-tools/fleet/elastic-agent-ssl-configuration.md) +[SSL/TLS](/reference/fleet/elastic-agent-ssl-configuration.md) : Configure SSL including SSL protocols and settings for certificates and keys. -[Logging](/reference/ingestion-tools/fleet/elastic-agent-standalone-logging-config.md) +[Logging](/reference/fleet/elastic-agent-standalone-logging-config.md) : Configure the {{agent}} logging output. -[Feature flags](/reference/ingestion-tools/fleet/elastic-agent-standalone-feature-flags.md) +[Feature flags](/reference/fleet/elastic-agent-standalone-feature-flags.md) : Configure any experiemental features in {{agent}}. These are disabled by default. -[Agent download](/reference/ingestion-tools/fleet/elastic-agent-standalone-download.md) +[Agent download](/reference/fleet/elastic-agent-standalone-download.md) : Specify the location of required artifacts and other settings used for {{agent}} upgrades. diff --git a/reference/ingestion-tools/fleet/syslog-processor.md b/reference/fleet/syslog-processor.md similarity index 98% rename from reference/ingestion-tools/fleet/syslog-processor.md rename to reference/fleet/syslog-processor.md index 48047a7e9b..3b2dfe3485 100644 --- a/reference/ingestion-tools/fleet/syslog-processor.md +++ b/reference/fleet/syslog-processor.md @@ -64,7 +64,7 @@ Will produce the following output: ## Configuration settings [_configuration_settings_39] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/timestamp-processor.md b/reference/fleet/timestamp-processor.md similarity index 98% rename from reference/ingestion-tools/fleet/timestamp-processor.md rename to reference/fleet/timestamp-processor.md index 1ac586367f..35eab1bd75 100644 --- a/reference/ingestion-tools/fleet/timestamp-processor.md +++ b/reference/fleet/timestamp-processor.md @@ -57,7 +57,7 @@ Here is an example that parses the `start_time` field and writes the result to t ## Configuration settings [_configuration_settings_40] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/tls-overview.md b/reference/fleet/tls-overview.md similarity index 97% rename from reference/ingestion-tools/fleet/tls-overview.md rename to reference/fleet/tls-overview.md index 099425b9b2..b7230cb3fd 100644 --- a/reference/ingestion-tools/fleet/tls-overview.md +++ b/reference/fleet/tls-overview.md @@ -85,7 +85,7 @@ To establish a mutual TLS connection, the agent presents its certificate, `agent :alt: Diagram of mutual TLS connection between Fleet Server and Elasticsearch ::: -Note that you can also configure mutual TLS for {{fleet-server}} and {{agent}} [using a proxy](/reference/ingestion-tools/fleet/mutual-tls.md#mutual-tls-cloud-proxy). +Note that you can also configure mutual TLS for {{fleet-server}} and {{agent}} [using a proxy](/reference/fleet/mutual-tls.md#mutual-tls-cloud-proxy). ### Relationship between components in a mutual TLS connection [_relationship_between_components_in_a_mutual_tls_connection] diff --git a/reference/fleet/toc.yml b/reference/fleet/toc.yml new file mode 100644 index 0000000000..60a0dbe243 --- /dev/null +++ b/reference/fleet/toc.yml @@ -0,0 +1,203 @@ +toc: + - file: index.md + - file: fleet-agent-serverless-restrictions.md + - file: migrate-from-beats-to-elastic-agent.md + children: + - file: migrate-auditbeat-to-agent.md + - file: deployment-models.md + children: + - file: fleet-server.md + - file: add-fleet-server-cloud.md + - file: add-fleet-server-on-prem.md + - file: add-fleet-server-mixed.md + - file: add-fleet-server-kubernetes.md + - file: fleet-server-scalability.md + - file: fleet-server-secrets.md + children: + - file: secret-files-guide.md + - file: fleet-server-monitoring.md + - file: install-elastic-agents.md + children: + - file: install-fleet-managed-elastic-agent.md + - file: install-standalone-elastic-agent.md + children: + - file: upgrade-standalone.md + - file: install-elastic-agents-in-containers.md + children: + - file: elastic-agent-container.md + - file: running-on-kubernetes-managed-by-fleet.md + - file: install-on-kubernetes-using-helm.md + - file: example-kubernetes-standalone-agent-helm.md + - file: example-kubernetes-fleet-managed-agent-helm.md + - file: advanced-kubernetes-managed-by-fleet.md + - file: configuring-kubernetes-metadata.md + - file: running-on-gke-managed-by-fleet.md + - file: running-on-eks-managed-by-fleet.md + - file: running-on-aks-managed-by-fleet.md + - file: running-on-kubernetes-standalone.md + - file: scaling-on-kubernetes.md + - file: ingest-pipeline-kubernetes.md + - file: agent-environment-variables.md + - file: otel-agent.md + - file: otel-agent-transform.md + - file: elastic-agent-unprivileged.md + - file: install-agent-msi.md + - file: installation-layout.md + - file: air-gapped.md + - file: fleet-agent-proxy-support.md + children: + - file: elastic-agent-proxy-config.md + - file: host-proxy-env-vars.md + - file: fleet-agent-proxy-managed.md + - file: fleet-agent-proxy-standalone.md + - file: epr-proxy-setting.md + - file: uninstall-elastic-agent.md + - file: start-stop-elastic-agent.md + - file: _agent_configuration_encryption.md + - file: secure.md + children: + - file: secure-connections.md + - file: certificates-rotation.md + - file: mutual-tls.md + - file: tls-overview.md + - file: secure-logstash-connections.md + - file: manage-elastic-agents-in-fleet.md + children: + - file: fleet-settings.md + children: + - file: es-output-settings.md + - file: ls-output-settings.md + - file: kafka-output-settings.md + - file: remote-elasticsearch-output.md + - file: fleet-settings-changing-outputs.md + - file: manage-agents.md + children: + - file: unenroll-elastic-agent.md + - file: set-inactivity-timeout.md + - file: upgrade-elastic-agent.md + - file: migrate-elastic-agent.md + - file: monitor-elastic-agent.md + - file: agent-health-status.md + - file: filter-agent-list-by-tags.md + - file: enrollment-handling-containerized-agent.md + - file: agent-policy.md + children: + - file: create-policy-no-ui.md + - file: enable-custom-policy-settings.md + - file: fleet-agent-environment-variables.md + - file: fleet-roles-privileges.md + - file: fleet-enrollment-tokens.md + - file: fleet-api-docs.md + - file: configure-standalone-elastic-agents.md + children: + - file: create-standalone-agent-policy.md + - file: structure-config-file.md + - file: elastic-agent-input-configuration.md + children: + - file: elastic-agent-simplified-input-configuration.md + - file: elastic-agent-inputs-list.md + - file: dynamic-input-configuration.md + - file: providers.md + children: + - file: local-provider.md + - file: agent-provider.md + - file: host-provider.md + - file: env-provider.md + - file: filesource-provider.md + - file: kubernetes_secrets-provider.md + - file: kubernetes_leaderelection-provider.md + - file: local-dynamic-provider.md + - file: docker-provider.md + - file: kubernetes-provider.md + - file: elastic-agent-output-configuration.md + children: + - file: elasticsearch-output.md + - file: kafka-output.md + - file: logstash-output.md + - file: elastic-agent-ssl-configuration.md + - file: elastic-agent-standalone-logging-config.md + - file: elastic-agent-standalone-feature-flags.md + - file: elastic-agent-standalone-download.md + - file: config-file-examples.md + children: + - file: config-file-example-apache.md + - file: config-file-example-nginx.md + - file: grant-access-to-elasticsearch.md + - file: example-standalone-monitor-nginx-serverless.md + - file: example-standalone-monitor-nginx.md + - file: debug-standalone-agents.md + - file: elastic-agent-kubernetes-autodiscovery.md + children: + - file: conditions-based-autodiscover.md + - file: hints-annotations-autodiscovery.md + - file: elastic-agent-monitoring-configuration.md + - file: elastic-agent-reference-yaml.md + - file: manage-integrations.md + children: + - file: package-signatures.md + - file: add-integration-to-policy.md + - file: view-integration-policies.md + - file: edit-delete-integration-policy.md + - file: install-uninstall-integration-assets.md + - file: view-integration-assets.md + - file: integration-level-outputs.md + - file: upgrade-integration.md + - file: managed-integrations-content.md + - file: integrations-assets-best-practices.md + - file: data-streams.md + children: + - file: data-streams-ilm-tutorial.md + - file: data-streams-scenario1.md + - file: data-streams-scenario2.md + - file: data-streams-scenario3.md + - file: data-streams-pipeline-tutorial.md + - file: data-streams-advanced-features.md + - file: agent-command-reference.md + - file: agent-processors.md + children: + - file: processor-syntax.md + - file: add-cloud-metadata-processor.md + - file: add_cloudfoundry_metadata-processor.md + - file: add_docker_metadata-processor.md + - file: add_fields-processor.md + - file: add_host_metadata-processor.md + - file: add_id-processor.md + - file: add_kubernetes_metadata-processor.md + - file: add_labels-processor.md + - file: add_locale-processor.md + - file: add_network_direction-processor.md + - file: add_nomad_metadata-processor.md + - file: add_observer_metadata-processor.md + - file: add_process_metadata-processor.md + - file: add_tags-processor.md + - file: community_id-processor.md + - file: convert-processor.md + - file: copy_fields-processor.md + - file: decode_base64_field-processor.md + - file: decode_cef-processor.md + - file: decode_csv_fields-processor.md + - file: decode_duration-processor.md + - file: decode-json-fields.md + - file: decode_xml-processor.md + - file: decode_xml_wineventlog-processor.md + - file: decompress_gzip_field-processor.md + - file: detect_mime_type-processor.md + - file: dissect-processor.md + - file: dns-processor.md + - file: drop_event-processor.md + - file: drop_fields-processor.md + - file: extract_array-processor.md + - file: fingerprint-processor.md + - file: include_fields-processor.md + - file: move_fields-processor.md + - file: processor-parse-aws-vpc-flow-log.md + - file: rate_limit-processor.md + - file: registered_domain-processor.md + - file: rename-processor.md + - file: replace-fields.md + - file: script-processor.md + - file: syslog-processor.md + - file: timestamp-processor.md + - file: translate_sid-processor.md + - file: truncate_fields-processor.md + - file: urldecode-processor.md \ No newline at end of file diff --git a/reference/ingestion-tools/fleet/translate_sid-processor.md b/reference/fleet/translate_sid-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/translate_sid-processor.md rename to reference/fleet/translate_sid-processor.md index f6b665de1f..c7a090729e 100644 --- a/reference/ingestion-tools/fleet/translate_sid-processor.md +++ b/reference/fleet/translate_sid-processor.md @@ -29,7 +29,7 @@ If the SID is invalid (malformed) or does not map to any account on the local sy ## Configuration settings [_configuration_settings_41] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/truncate_fields-processor.md b/reference/fleet/truncate_fields-processor.md similarity index 96% rename from reference/ingestion-tools/fleet/truncate_fields-processor.md rename to reference/fleet/truncate_fields-processor.md index 9d9670a54d..ebc35031da 100644 --- a/reference/ingestion-tools/fleet/truncate_fields-processor.md +++ b/reference/fleet/truncate_fields-processor.md @@ -27,7 +27,7 @@ This configuration truncates the field named `message` to five characters: ## Configuration settings [_configuration_settings_42] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: diff --git a/reference/ingestion-tools/fleet/unenroll-elastic-agent.md b/reference/fleet/unenroll-elastic-agent.md similarity index 100% rename from reference/ingestion-tools/fleet/unenroll-elastic-agent.md rename to reference/fleet/unenroll-elastic-agent.md diff --git a/reference/ingestion-tools/fleet/uninstall-elastic-agent.md b/reference/fleet/uninstall-elastic-agent.md similarity index 89% rename from reference/ingestion-tools/fleet/uninstall-elastic-agent.md rename to reference/fleet/uninstall-elastic-agent.md index 4752f19a7a..a71cbf0495 100644 --- a/reference/ingestion-tools/fleet/uninstall-elastic-agent.md +++ b/reference/fleet/uninstall-elastic-agent.md @@ -75,15 +75,15 @@ You might need to remove {{agent}} files manually if there’s a failure during To remove {{agent}} manually from your system: -1. [Unenroll the agent](/reference/ingestion-tools/fleet/unenroll-elastic-agent.md) if it’s managed by {{fleet}}. +1. [Unenroll the agent](/reference/fleet/unenroll-elastic-agent.md) if it’s managed by {{fleet}}. 2. For standalone agents, back up any configuration files you want to preserve. -3. On your host, [stop the agent](/reference/ingestion-tools/fleet/start-stop-elastic-agent.md#stop-elastic-agent-service). If any {{agent}}-related processes are still running, stop them too. +3. On your host, [stop the agent](/reference/fleet/start-stop-elastic-agent.md#stop-elastic-agent-service). If any {{agent}}-related processes are still running, stop them too. ::::{tip} Search for these processes and stop them if they’re still running: `filebeat`, `metricbeat`, `fleet-server`, and `elastic-endpoint`. :::: -4. Manually remove the {{agent}} files from your system. For example, if you’re running {{agent}} on macOS, delete `/Library/Elastic/Agent/*`. Not sure where the files are installed? Refer to [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md). +4. Manually remove the {{agent}} files from your system. For example, if you’re running {{agent}} on macOS, delete `/Library/Elastic/Agent/*`. Not sure where the files are installed? Refer to [Installation layout](/reference/fleet/installation-layout.md). 5. If you’ve configured the {{elastic-defend}} integration, also remove the files installed for endpoint protection. The directory structure is similar to {{agent}}, for example, `/Library/Elastic/Endpoint/*`. ::::{note} diff --git a/reference/ingestion-tools/fleet/upgrade-elastic-agent.md b/reference/fleet/upgrade-elastic-agent.md similarity index 98% rename from reference/ingestion-tools/fleet/upgrade-elastic-agent.md rename to reference/fleet/upgrade-elastic-agent.md index 9a429ce3ea..ad912f8ae7 100644 --- a/reference/ingestion-tools/fleet/upgrade-elastic-agent.md +++ b/reference/fleet/upgrade-elastic-agent.md @@ -8,7 +8,7 @@ mapped_pages: ::::{tip} -Want to upgrade a standalone agent instead? See [Upgrade standalone {{agent}}s](/reference/ingestion-tools/fleet/upgrade-standalone.md). +Want to upgrade a standalone agent instead? See [Upgrade standalone {{agent}}s](/reference/fleet/upgrade-standalone.md). :::: @@ -18,7 +18,7 @@ In most failure cases the {{agent}} may retry an upgrade after a short wait. The This approach simplifies the process of keeping your agents up to date. It also saves you time because you don’t need third-party tools or processes to manage upgrades. -By default, {{agent}}s require internet access to perform binary upgrades from {{fleet}}. However, you can host your own artifacts repository and configure {{agent}}s to download binaries from it. For more information, refer to [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +By default, {{agent}}s require internet access to perform binary upgrades from {{fleet}}. However, you can host your own artifacts repository and configure {{agent}}s to download binaries from it. For more information, refer to [Air-gapped environments](/reference/fleet/air-gapped.md). ::::{note} The upgrade feature is not supported for upgrading DEB/RPM packages or Docker images. Refer to [Upgrade RPM and DEB system packages](#upgrade-system-packages) to upgrade a DEB or RPM package manually. @@ -218,7 +218,7 @@ When the upgrade process for multiple agents has been detected to have stalled, If you have installed and enrolled {{agent}} using either a DEB (for a Debian-based Linux distribution) or RPM (for a RedHat-based Linux distribution) install package, the upgrade cannot be managed by {{fleet}}. Instead, you can perform the upgrade using these steps. -For installation steps refer to [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). +For installation steps refer to [Install {{fleet}}-managed {{agent}}s](/reference/fleet/install-fleet-managed-elastic-agent.md). ### Upgrade a DEB {{agent}} installation: [_upgrade_a_deb_agent_installation] diff --git a/reference/ingestion-tools/fleet/upgrade-integration.md b/reference/fleet/upgrade-integration.md similarity index 97% rename from reference/ingestion-tools/fleet/upgrade-integration.md rename to reference/fleet/upgrade-integration.md index bb614cc78c..bf79231dfc 100644 --- a/reference/ingestion-tools/fleet/upgrade-integration.md +++ b/reference/fleet/upgrade-integration.md @@ -8,7 +8,7 @@ mapped_pages: ::::{important} -By default, {{kib}} requires an internet connection to download integration packages from the {{package-registry}}. Make sure the {{kib}} server can connect to `https://epr.elastic.co` on port `443`. If network restrictions prevent {{kib}} from reaching the public {{package-registry}}, you can use a proxy server or host your own {{package-registry}}. To learn more, refer to [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +By default, {{kib}} requires an internet connection to download integration packages from the {{package-registry}}. Make sure the {{kib}} server can connect to `https://epr.elastic.co` on port `443`. If network restrictions prevent {{kib}} from reaching the public {{package-registry}}, you can use a proxy server or host your own {{package-registry}}. To learn more, refer to [Air-gapped environments](/reference/fleet/air-gapped.md). :::: @@ -42,7 +42,7 @@ In larger deployments, you should test integration upgrades on a sample {{agent} 5. After the upgrade is complete, verify that the installed version and latest version match. ::::{note} -You must upgrade standalone agents separately. If you used {{kib}} to create and download your standalone agent policy, see [Upgrade standalone agent policies after upgrading an integration](/reference/ingestion-tools/fleet/create-standalone-agent-policy.md#update-standalone-policies). +You must upgrade standalone agents separately. If you used {{kib}} to create and download your standalone agent policy, see [Upgrade standalone agent policies after upgrading an integration](/reference/fleet/create-standalone-agent-policy.md#update-standalone-policies). :::: diff --git a/reference/ingestion-tools/fleet/upgrade-standalone.md b/reference/fleet/upgrade-standalone.md similarity index 74% rename from reference/ingestion-tools/fleet/upgrade-standalone.md rename to reference/fleet/upgrade-standalone.md index 8b81270014..4cbc2dfa97 100644 --- a/reference/ingestion-tools/fleet/upgrade-standalone.md +++ b/reference/fleet/upgrade-standalone.md @@ -8,7 +8,7 @@ mapped_pages: To upgrade a standalone agent running on an edge node: 1. Make sure the `elastic-agent` service is running. -2. From the directory where {{agent}} is installed, run the `upgrade` command to upgrade to a new version. Not sure where the agent is installed? Refer to [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md). +2. From the directory where {{agent}} is installed, run the `upgrade` command to upgrade to a new version. Not sure where the agent is installed? Refer to [Installation layout](/reference/fleet/installation-layout.md). For example, on macOS, to upgrade the agent from version 8.8.0 to 8.8.1, you would run: @@ -20,7 +20,7 @@ To upgrade a standalone agent running on an edge node: This command upgrades the binary. Your agent policy should continue to work, but you might need to upgrade it to use new features and capabilities. -For more command-line options, see the help for the [`upgrade`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-upgrade-command) command. +For more command-line options, see the help for the [`upgrade`](/reference/fleet/agent-command-reference.md#elastic-agent-upgrade-command) command. ## Upgrading standalone {{agent}} in an air-gapped environmment [upgrade-standalone-air-gapped] @@ -28,12 +28,12 @@ The basic upgrade scenario should work for most use cases. However, in an air-ga As an alterative, you can do one of the following: -* [Configure a proxy server](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md) for standalone {{agent}} to access the {{artifact-registry}}. -* [Host your own artifact registry](/reference/ingestion-tools/fleet/air-gapped.md#host-artifact-registry) for standalone {{agent}} to access binary downloads. +* [Configure a proxy server](/reference/fleet/fleet-agent-proxy-support.md) for standalone {{agent}} to access the {{artifact-registry}}. +* [Host your own artifact registry](/reference/fleet/air-gapped.md#host-artifact-registry) for standalone {{agent}} to access binary downloads. -As well, starting from version 8.9.0, during the upgrade process {{agent}} needs to download a PGP/GPG key. Refer to [Configure {{agents}} to download a PGP/GPG key from {{fleet-server}}](/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-pgp-fleet) for the steps to configure the key download location in an air-gapped environment. +As well, starting from version 8.9.0, during the upgrade process {{agent}} needs to download a PGP/GPG key. Refer to [Configure {{agents}} to download a PGP/GPG key from {{fleet-server}}](/reference/fleet/air-gapped.md#air-gapped-pgp-fleet) for the steps to configure the key download location in an air-gapped environment. -Refer to [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md) for more details. +Refer to [Air-gapped environments](/reference/fleet/air-gapped.md) for more details. ## Verifying {{agent}} package signatures [upgrade-standalone-verify-package] @@ -42,7 +42,7 @@ Standalone {{agent}} verifies each package that it downloads using publically av At times, the Elastic private GPG key may need to be rotated, either due to the key expiry or due to the private key having been exposed. In this case, standalone {{agent}} upgrades can fail because the embedded public key no longer works. -In the event of a private GPG key rotation, you can use the following options with the [`upgrade`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-upgrade-command) command to either skip the verification process (not recommended) or force {{agent}} to use a new public key for verification: +In the event of a private GPG key rotation, you can use the following options with the [`upgrade`](/reference/fleet/agent-command-reference.md#elastic-agent-upgrade-command) command to either skip the verification process (not recommended) or force {{agent}} to use a new public key for verification: `--skip-verify` : Skip the package verification process. This option is not recommended as it is insecure. diff --git a/reference/ingestion-tools/fleet/urldecode-processor.md b/reference/fleet/urldecode-processor.md similarity index 88% rename from reference/ingestion-tools/fleet/urldecode-processor.md rename to reference/fleet/urldecode-processor.md index 0cba6dbdd3..9f1e2a02f6 100644 --- a/reference/ingestion-tools/fleet/urldecode-processor.md +++ b/reference/fleet/urldecode-processor.md @@ -27,7 +27,7 @@ In this example, `field1` is decoded in `field2`. ## Configuration settings [_configuration_settings_43] ::::{note} -{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/ingestion-tools/fleet/agent-processors.md#limitations) +{{agent}} processors execute *before* ingest pipelines, which means that your processor configurations cannot refer to fields that are created by ingest pipelines or {{ls}}. For more limitations, refer to [What are some limitations of using processors?](/reference/fleet/agent-processors.md#limitations) :::: @@ -37,5 +37,5 @@ In this example, `field1` is decoded in `field2`. | `ignore_missing` | No | `false` | Whether to ignore missing keys. If `true`, no error is logged if a key that should be URL-decoded is missing. | | `fail_on_error` | No | `true` | Whether to fail if an error occurs. If `true` and an error occurs, the URL-decoding of fields is stopped, and the original event is returned. If `false`, decoding continues even if an error occurs during decoding. | -See [Conditions](/reference/ingestion-tools/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. +See [Conditions](/reference/fleet/dynamic-input-configuration.md#conditions) for a list of supported conditions. diff --git a/reference/ingestion-tools/fleet/view-integration-assets.md b/reference/fleet/view-integration-assets.md similarity index 100% rename from reference/ingestion-tools/fleet/view-integration-assets.md rename to reference/fleet/view-integration-assets.md diff --git a/reference/ingestion-tools/fleet/view-integration-policies.md b/reference/fleet/view-integration-policies.md similarity index 100% rename from reference/ingestion-tools/fleet/view-integration-policies.md rename to reference/fleet/view-integration-policies.md diff --git a/reference/glossary/index.md b/reference/glossary/index.md index df09d67770..afee987a06 100644 --- a/reference/glossary/index.md +++ b/reference/glossary/index.md @@ -26,7 +26,7 @@ $$$glossary-advanced-settings$$$ Advanced Settings : Enables you to control the appearance and behavior of {{kib}} by setting the date format, default index, and other attributes. Part of {{kib}} Stack Management. See [Advanced Settings](kibana://reference/advanced-settings.md). $$$glossary-agent-policy$$$ Agent policy -: A collection of inputs and settings that defines the data to be collected by {{agent}}. An agent policy can be applied to a single agent or shared by a group of agents; this makes it easier to manage many agents at scale. See [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md). +: A collection of inputs and settings that defines the data to be collected by {{agent}}. An agent policy can be applied to a single agent or shared by a group of agents; this makes it easier to manage many agents at scale. See [{{agent}} policies](/reference/fleet/agent-policy.md). $$$glossary-alias$$$ alias : Secondary name for a group of [data streams](/reference/glossary/index.md#glossary-data-stream) or [indices](/reference/glossary/index.md#glossary-index). Most {{es}} APIs accept an alias in place of a data stream or index. See [Aliases](/manage-data/data-store/aliases.md). @@ -189,7 +189,7 @@ $$$glossary-ml-datafeed$$$ datafeed : {{anomaly-jobs-cap}} can analyze either a one-off batch of data or continuously in real time. {{dfeeds-cap}} retrieve data from {{es}} for analysis. $$$glossary-dataset$$$ dataset -: A collection of data that has the same structure. The name of a dataset typically signifies its source. See [data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md). +: A collection of data that has the same structure. The name of a dataset typically signifies its source. See [data stream naming scheme](/reference/fleet/data-streams.md). $$$glossary-delete-phase$$$ delete phase : Last possible phase in the [index lifecycle](/reference/glossary/index.md#glossary-index-lifecycle). In the delete phase, an [index](/reference/glossary/index.md#glossary-index) is no longer needed and can safely be deleted. See [Index lifecycle](/manage-data/lifecycle/index-lifecycle-management/index-lifecycle.md). @@ -231,7 +231,7 @@ $$$glossary-edge$$$ edge : A connection between nodes in a graph that shows that they are related. The line weight indicates the strength of the relationship. See [Graph](/explore-analyze/visualize/graph.md). $$$glossary-elastic-agent$$$ {{agent}} -: A single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. See [{{agent}} overview](/reference/ingestion-tools/fleet/index.md). +: A single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. See [{{agent}} overview](/reference/fleet/index.md). $$$glossary-ece$$$ {{ece}} (ECE) : The official enterprise offering to host and manage the {{stack}} yourself at scale. Can be installed on a public cloud platform, such as AWS, GCP or Microsoft Azure, on your own private cloud, or on bare metal. @@ -315,7 +315,7 @@ $$$glossary-fleet-server$$$ {{fleet-server}} : {{fleet-server}} is a component used to centrally manage {{agent}}s. It serves as a control plane for updating agent policies, collecting status information, and coordinating actions across agents. $$$glossary-fleet$$$ Fleet -: Fleet provides a way to centrally manage {{agent}}s at scale. There are two parts: The Fleet app in {{kib}} provides a web-based UI to add and remotely manage agents, while the {{fleet-server}} provides the backend service that manages agents. See [{{agent}} overview](/reference/ingestion-tools/fleet/index.md). +: Fleet provides a way to centrally manage {{agent}}s at scale. There are two parts: The Fleet app in {{kib}} provides a web-based UI to add and remotely manage agents, while the {{fleet-server}} provides the backend service that manages agents. See [{{agent}} overview](/reference/fleet/index.md). $$$glossary-flush$$$ flush : Writes data from the [transaction log](elasticsearch://reference/elasticsearch/index-settings/translog.md) to disk for permanent storage. @@ -721,7 +721,7 @@ $$$glossary-stack-alert$$$ stack rule : The general purpose rule types {{kib}} provides out of the box. Refer to [Stack rules](/explore-analyze/alerts-cases/alerts/rule-types.md#stack-rules). $$$glossary-standalone$$$ standalone -: This mode allows manual configuration and management of {{agent}}s locally on the systems where they are installed. See [Install standalone {{agent}}s](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md). +: This mode allows manual configuration and management of {{agent}}s locally on the systems where they are installed. See [Install standalone {{agent}}s](/reference/fleet/install-standalone-elastic-agent.md). $$$glossary-stunnel$$$ stunnel : Securely tunnels all traffic in an {{ece}} installation. diff --git a/reference/glossary/toc.yml b/reference/glossary/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/glossary/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/index.md b/reference/index.md index b4bde93570..2b80fc94ef 100644 --- a/reference/index.md +++ b/reference/index.md @@ -10,7 +10,7 @@ Explore the reference documentation for Elastic APIs. | | | | --- | --- | | {{es}} | • [{{es}}](elasticsearch://reference/elasticsearch/rest-apis/index.md)
• [{{es}} Serverless](https://www.elastic.co/docs/api/doc/elasticsearch-serverless)
| -| {{kib}} | • [{{kib}}](https://www.elastic.co/docs/api/doc/kibana)
• [{{kib}} Serverless](https://www.elastic.co/docs/api/doc/serverless)
• [{{fleet}}](/reference/ingestion-tools/fleet/fleet-api-docs.md)
• [{{observability}} Serverless SLOs](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-slo)
• [{{elastic-sec}}](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-security-ai-assistant-api)
• [{{elastic-sec}} Serverless](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-security-ai-assistant-api)
| +| {{kib}} | • [{{kib}}](https://www.elastic.co/docs/api/doc/kibana)
• [{{kib}} Serverless](https://www.elastic.co/docs/api/doc/serverless)
• [{{fleet}}](/reference/fleet/fleet-api-docs.md)
• [{{observability}} Serverless SLOs](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-slo)
• [{{elastic-sec}}](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-security-ai-assistant-api)
• [{{elastic-sec}} Serverless](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-security-ai-assistant-api)
| | {{ls}} | • [Monitoring {{ls}}](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html)
| | APM | • [APM](/solutions/observability/apps/apm-server-api.md)
• [APM Serverless](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-apm-agent-configuration)
• [Observability intake Serverless](https://www.elastic.co/docs/api/doc/observability-serverless)
| | {{ecloud}} | • [{{ech}}](https://www.elastic.co/docs/api/doc/cloud)
• [{{ecloud}} Serverless](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless)
• [{{ece}}](https://www.elastic.co/docs/api/doc/cloud-enterprise)
• [{{eck}}](cloud-on-k8s://reference/api-docs.md)
| diff --git a/reference/ingestion-tools/fleet/manage-agents.md b/reference/ingestion-tools/fleet/manage-agents.md deleted file mode 100644 index bc7ffac653..0000000000 --- a/reference/ingestion-tools/fleet/manage-agents.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -navigation_title: "{{agent}}s" -mapped_pages: - - https://www.elastic.co/guide/en/fleet/current/manage-agents.html ---- - -# {{agent}}s [manage-agents] - - -::::{tip} -To learn how to add {{agent}}s to {{fleet}}, see [Install {{fleet}}-managed {{agent}}s](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). -:::: - - -To manage your {{agent}}s, go to **Management > {{fleet}} > Agents** in {{kib}}. On the **Agents** tab, you can perform the following actions: - -| User action | Result | -| --- | --- | -| [Unenroll {{agent}}s](/reference/ingestion-tools/fleet/unenroll-elastic-agent.md) | Unenroll {{agent}}s from {{fleet}}. | -| [Set inactivity timeout](/reference/ingestion-tools/fleet/set-inactivity-timeout.md) | Set inactivity timeout to move {{agent}}s to inactive status after being offline for the set amount of time. | -| [Upgrade {{agent}}s](/reference/ingestion-tools/fleet/upgrade-elastic-agent.md) | Upgrade {{agent}}s to the latest version. | -| [Migrate {{agent}}s](/reference/ingestion-tools/fleet/migrate-elastic-agent.md) | Migrate {{agent}}s from one cluster to another. | -| [Monitor {{agent}}s](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) | Monitor {{fleet}}-managed {{agent}}s by viewing agent status, logs, and metrics. | -| [Add tags to filter the Agents list](/reference/ingestion-tools/fleet/filter-agent-list-by-tags.md) | Add tags to {{agent}}, then use the tags to filter the Agents list in {{fleet}}. | - - - - - - - - diff --git a/reference/ingestion-tools.md b/reference/ingestion-tools/index.md similarity index 100% rename from reference/ingestion-tools.md rename to reference/ingestion-tools/index.md diff --git a/reference/ingestion-tools/toc.yml b/reference/ingestion-tools/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/ingestion-tools/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/observability/toc.yml b/reference/observability/toc.yml new file mode 100644 index 0000000000..167c31621d --- /dev/null +++ b/reference/observability/toc.yml @@ -0,0 +1,8 @@ +toc: + - file: index.md + - file: fields-and-object-schemas.md + children: + - file: fields-and-object-schemas/logs-app-fields.md + - file: fields-and-object-schemas/metrics-app-fields.md + - file: elastic-entity-model.md + - file: serverless/infrastructure-app-fields.md \ No newline at end of file diff --git a/reference/search/search.md b/reference/search/index.md similarity index 99% rename from reference/search/search.md rename to reference/search/index.md index 838fd47923..298f136696 100644 --- a/reference/search/search.md +++ b/reference/search/index.md @@ -1,6 +1,7 @@ --- navigation_title: "Search" --- + # Search reference % Derived from https://www.elastic.co/platform diff --git a/reference/search/toc.yml b/reference/search/toc.yml new file mode 100644 index 0000000000..f2ab236796 --- /dev/null +++ b/reference/search/toc.yml @@ -0,0 +1,2 @@ +toc: + - file: index.md \ No newline at end of file diff --git a/reference/security/toc.yml b/reference/security/toc.yml new file mode 100644 index 0000000000..7d7ed3efeb --- /dev/null +++ b/reference/security/toc.yml @@ -0,0 +1,8 @@ +toc: + - file: index.md + - file: fields-and-object-schemas/index.md + children: + - file: fields-and-object-schemas/siem-field-reference.md + - file: fields-and-object-schemas/timeline-object-schema.md + - file: fields-and-object-schemas/alert-schema.md + - file: endpoint-command-reference.md \ No newline at end of file diff --git a/reference/toc.yml b/reference/toc.yml deleted file mode 100644 index bd46a942a4..0000000000 --- a/reference/toc.yml +++ /dev/null @@ -1,266 +0,0 @@ -toc: - - file: index.md - - file: security/index.md - children: - - file: security/fields-and-object-schemas/index.md - children: - - file: security/fields-and-object-schemas/siem-field-reference.md - - file: security/fields-and-object-schemas/timeline-object-schema.md - - file: security/fields-and-object-schemas/alert-schema.md - - file: security/endpoint-command-reference.md - - file: observability/index.md - children: - - file: observability/fields-and-object-schemas.md - children: - - file: observability/fields-and-object-schemas/logs-app-fields.md - - file: observability/fields-and-object-schemas/metrics-app-fields.md - - file: observability/elastic-entity-model.md - - file: observability/serverless/infrastructure-app-fields.md - - file: search/search.md - - file: elasticsearch.md - children: - - file: elasticsearch/clients/index.md - - file: ingestion-tools.md - children: - - file: ingestion-tools/fleet/index.md - children: - - file: ingestion-tools/fleet/fleet-agent-serverless-restrictions.md - - file: ingestion-tools/fleet/migrate-from-beats-to-elastic-agent.md - children: - - file: ingestion-tools/fleet/migrate-auditbeat-to-agent.md - - file: ingestion-tools/fleet/deployment-models.md - children: - - file: ingestion-tools/fleet/fleet-server.md - - file: ingestion-tools/fleet/add-fleet-server-cloud.md - - file: ingestion-tools/fleet/add-fleet-server-on-prem.md - - file: ingestion-tools/fleet/add-fleet-server-mixed.md - - file: ingestion-tools/fleet/add-fleet-server-kubernetes.md - - file: ingestion-tools/fleet/fleet-server-scalability.md - - file: ingestion-tools/fleet/fleet-server-secrets.md - children: - - file: ingestion-tools/fleet/secret-files-guide.md - - file: ingestion-tools/fleet/fleet-server-monitoring.md - - file: ingestion-tools/fleet/install-elastic-agents.md - children: - - file: ingestion-tools/fleet/install-fleet-managed-elastic-agent.md - - file: ingestion-tools/fleet/install-standalone-elastic-agent.md - children: - - file: ingestion-tools/fleet/upgrade-standalone.md - - file: ingestion-tools/fleet/install-elastic-agents-in-containers.md - children: - - file: ingestion-tools/fleet/elastic-agent-container.md - - file: ingestion-tools/fleet/running-on-kubernetes-managed-by-fleet.md - - file: ingestion-tools/fleet/install-on-kubernetes-using-helm.md - - file: ingestion-tools/fleet/example-kubernetes-standalone-agent-helm.md - - file: ingestion-tools/fleet/example-kubernetes-fleet-managed-agent-helm.md - - file: ingestion-tools/fleet/advanced-kubernetes-managed-by-fleet.md - - file: ingestion-tools/fleet/configuring-kubernetes-metadata.md - - file: ingestion-tools/fleet/running-on-gke-managed-by-fleet.md - - file: ingestion-tools/fleet/running-on-eks-managed-by-fleet.md - - file: ingestion-tools/fleet/running-on-aks-managed-by-fleet.md - - file: ingestion-tools/fleet/running-on-kubernetes-standalone.md - - file: ingestion-tools/fleet/scaling-on-kubernetes.md - - file: ingestion-tools/fleet/ingest-pipeline-kubernetes.md - - file: ingestion-tools/fleet/agent-environment-variables.md - - file: ingestion-tools/fleet/otel-agent.md - - file: ingestion-tools/fleet/otel-agent-transform.md - - file: ingestion-tools/fleet/elastic-agent-unprivileged.md - - file: ingestion-tools/fleet/install-agent-msi.md - - file: ingestion-tools/fleet/installation-layout.md - - file: ingestion-tools/fleet/air-gapped.md - - file: ingestion-tools/fleet/fleet-agent-proxy-support.md - children: - - file: ingestion-tools/fleet/elastic-agent-proxy-config.md - - file: ingestion-tools/fleet/host-proxy-env-vars.md - - file: ingestion-tools/fleet/fleet-agent-proxy-managed.md - - file: ingestion-tools/fleet/fleet-agent-proxy-standalone.md - - file: ingestion-tools/fleet/epr-proxy-setting.md - - file: ingestion-tools/fleet/uninstall-elastic-agent.md - - file: ingestion-tools/fleet/start-stop-elastic-agent.md - - file: ingestion-tools/fleet/_agent_configuration_encryption.md - - file: ingestion-tools/fleet/secure.md - children: - - file: ingestion-tools/fleet/secure-connections.md - - file: ingestion-tools/fleet/certificates-rotation.md - - file: ingestion-tools/fleet/mutual-tls.md - - file: ingestion-tools/fleet/tls-overview.md - - file: ingestion-tools/fleet/secure-logstash-connections.md - - file: ingestion-tools/fleet/manage-elastic-agents-in-fleet.md - children: - - file: ingestion-tools/fleet/fleet-settings.md - children: - - file: ingestion-tools/fleet/es-output-settings.md - - file: ingestion-tools/fleet/ls-output-settings.md - - file: ingestion-tools/fleet/kafka-output-settings.md - - file: ingestion-tools/fleet/remote-elasticsearch-output.md - - file: ingestion-tools/fleet/fleet-settings-changing-outputs.md - - file: ingestion-tools/fleet/manage-agents.md - children: - - file: ingestion-tools/fleet/unenroll-elastic-agent.md - - file: ingestion-tools/fleet/set-inactivity-timeout.md - - file: ingestion-tools/fleet/upgrade-elastic-agent.md - - file: ingestion-tools/fleet/migrate-elastic-agent.md - - file: ingestion-tools/fleet/monitor-elastic-agent.md - - file: ingestion-tools/fleet/agent-health-status.md - - file: ingestion-tools/fleet/filter-agent-list-by-tags.md - - file: ingestion-tools/fleet/enrollment-handling-containerized-agent.md - - file: ingestion-tools/fleet/agent-policy.md - children: - - file: ingestion-tools/fleet/create-policy-no-ui.md - - file: ingestion-tools/fleet/enable-custom-policy-settings.md - - file: ingestion-tools/fleet/fleet-agent-environment-variables.md - - file: ingestion-tools/fleet/fleet-roles-privileges.md - - file: ingestion-tools/fleet/fleet-enrollment-tokens.md - - file: ingestion-tools/fleet/fleet-api-docs.md - - file: ingestion-tools/fleet/configure-standalone-elastic-agents.md - children: - - file: ingestion-tools/fleet/create-standalone-agent-policy.md - - file: ingestion-tools/fleet/structure-config-file.md - - file: ingestion-tools/fleet/elastic-agent-input-configuration.md - children: - - file: ingestion-tools/fleet/elastic-agent-simplified-input-configuration.md - - file: ingestion-tools/fleet/elastic-agent-inputs-list.md - - file: ingestion-tools/fleet/dynamic-input-configuration.md - - file: ingestion-tools/fleet/providers.md - children: - - file: ingestion-tools/fleet/local-provider.md - - file: ingestion-tools/fleet/agent-provider.md - - file: ingestion-tools/fleet/host-provider.md - - file: ingestion-tools/fleet/env-provider.md - - file: ingestion-tools/fleet/filesource-provider.md - - file: ingestion-tools/fleet/kubernetes_secrets-provider.md - - file: ingestion-tools/fleet/kubernetes_leaderelection-provider.md - - file: ingestion-tools/fleet/local-dynamic-provider.md - - file: ingestion-tools/fleet/docker-provider.md - - file: ingestion-tools/fleet/kubernetes-provider.md - - file: ingestion-tools/fleet/elastic-agent-output-configuration.md - children: - - file: ingestion-tools/fleet/elasticsearch-output.md - - file: ingestion-tools/fleet/kafka-output.md - - file: ingestion-tools/fleet/logstash-output.md - - file: ingestion-tools/fleet/elastic-agent-ssl-configuration.md - - file: ingestion-tools/fleet/elastic-agent-standalone-logging-config.md - - file: ingestion-tools/fleet/elastic-agent-standalone-feature-flags.md - - file: ingestion-tools/fleet/elastic-agent-standalone-download.md - - file: ingestion-tools/fleet/config-file-examples.md - children: - - file: ingestion-tools/fleet/config-file-example-apache.md - - file: ingestion-tools/fleet/config-file-example-nginx.md - - file: ingestion-tools/fleet/grant-access-to-elasticsearch.md - - file: ingestion-tools/fleet/example-standalone-monitor-nginx-serverless.md - - file: ingestion-tools/fleet/example-standalone-monitor-nginx.md - - file: ingestion-tools/fleet/debug-standalone-agents.md - - file: ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md - children: - - file: ingestion-tools/fleet/conditions-based-autodiscover.md - - file: ingestion-tools/fleet/hints-annotations-autodiscovery.md - - file: ingestion-tools/fleet/elastic-agent-monitoring-configuration.md - - file: ingestion-tools/fleet/elastic-agent-reference-yaml.md - - file: ingestion-tools/fleet/manage-integrations.md - children: - - file: ingestion-tools/fleet/package-signatures.md - - file: ingestion-tools/fleet/add-integration-to-policy.md - - file: ingestion-tools/fleet/view-integration-policies.md - - file: ingestion-tools/fleet/edit-delete-integration-policy.md - - file: ingestion-tools/fleet/install-uninstall-integration-assets.md - - file: ingestion-tools/fleet/view-integration-assets.md - - file: ingestion-tools/fleet/integration-level-outputs.md - - file: ingestion-tools/fleet/upgrade-integration.md - - file: ingestion-tools/fleet/managed-integrations-content.md - - file: ingestion-tools/fleet/integrations-assets-best-practices.md - - file: ingestion-tools/fleet/data-streams.md - children: - - file: ingestion-tools/fleet/data-streams-ilm-tutorial.md - - file: ingestion-tools/fleet/data-streams-scenario1.md - - file: ingestion-tools/fleet/data-streams-scenario2.md - - file: ingestion-tools/fleet/data-streams-scenario3.md - - file: ingestion-tools/fleet/data-streams-pipeline-tutorial.md - - file: ingestion-tools/fleet/data-streams-advanced-features.md - - file: ingestion-tools/fleet/agent-command-reference.md - - file: ingestion-tools/fleet/agent-processors.md - children: - - file: ingestion-tools/fleet/processor-syntax.md - - file: ingestion-tools/fleet/add-cloud-metadata-processor.md - - file: ingestion-tools/fleet/add_cloudfoundry_metadata-processor.md - - file: ingestion-tools/fleet/add_docker_metadata-processor.md - - file: ingestion-tools/fleet/add_fields-processor.md - - file: ingestion-tools/fleet/add_host_metadata-processor.md - - file: ingestion-tools/fleet/add_id-processor.md - - file: ingestion-tools/fleet/add_kubernetes_metadata-processor.md - - file: ingestion-tools/fleet/add_labels-processor.md - - file: ingestion-tools/fleet/add_locale-processor.md - - file: ingestion-tools/fleet/add_network_direction-processor.md - - file: ingestion-tools/fleet/add_nomad_metadata-processor.md - - file: ingestion-tools/fleet/add_observer_metadata-processor.md - - file: ingestion-tools/fleet/add_process_metadata-processor.md - - file: ingestion-tools/fleet/add_tags-processor.md - - file: ingestion-tools/fleet/community_id-processor.md - - file: ingestion-tools/fleet/convert-processor.md - - file: ingestion-tools/fleet/copy_fields-processor.md - - file: ingestion-tools/fleet/decode_base64_field-processor.md - - file: ingestion-tools/fleet/decode_cef-processor.md - - file: ingestion-tools/fleet/decode_csv_fields-processor.md - - file: ingestion-tools/fleet/decode_duration-processor.md - - file: ingestion-tools/fleet/decode-json-fields.md - - file: ingestion-tools/fleet/decode_xml-processor.md - - file: ingestion-tools/fleet/decode_xml_wineventlog-processor.md - - file: ingestion-tools/fleet/decompress_gzip_field-processor.md - - file: ingestion-tools/fleet/detect_mime_type-processor.md - - file: ingestion-tools/fleet/dissect-processor.md - - file: ingestion-tools/fleet/dns-processor.md - - file: ingestion-tools/fleet/drop_event-processor.md - - file: ingestion-tools/fleet/drop_fields-processor.md - - file: ingestion-tools/fleet/extract_array-processor.md - - file: ingestion-tools/fleet/fingerprint-processor.md - - file: ingestion-tools/fleet/include_fields-processor.md - - file: ingestion-tools/fleet/move_fields-processor.md - - file: ingestion-tools/fleet/processor-parse-aws-vpc-flow-log.md - - file: ingestion-tools/fleet/rate_limit-processor.md - - file: ingestion-tools/fleet/registered_domain-processor.md - - file: ingestion-tools/fleet/rename-processor.md - - file: ingestion-tools/fleet/replace-fields.md - - file: ingestion-tools/fleet/script-processor.md - - file: ingestion-tools/fleet/syslog-processor.md - - file: ingestion-tools/fleet/timestamp-processor.md - - file: ingestion-tools/fleet/translate_sid-processor.md - - file: ingestion-tools/fleet/truncate_fields-processor.md - - file: ingestion-tools/fleet/urldecode-processor.md - - file: ingestion-tools/observability/apm.md - children: - - file: ingestion-tools/observability/apm-settings.md - - file: ingestion-tools/cloud/apm-settings.md - - file: ingestion-tools/cloud-enterprise/apm-settings.md - - file: ingestion-tools/apm/apm-agents.md - - file: ecs.md - - file: data-analysis/index.md - children: - - file: data-analysis/machine-learning/supplied-anomaly-detection-configurations.md - children: - - file: data-analysis/machine-learning/ootb-ml-jobs-apache.md - - file: data-analysis/machine-learning/ootb-ml-jobs-apm.md - - file: data-analysis/machine-learning/ootb-ml-jobs-auditbeat.md - - file: data-analysis/machine-learning/ootb-ml-jobs-logs-ui.md - - file: data-analysis/machine-learning/ootb-ml-jobs-metricbeat.md - - file: data-analysis/machine-learning/ootb-ml-jobs-metrics-ui.md - - file: data-analysis/machine-learning/ootb-ml-jobs-nginx.md - - file: data-analysis/machine-learning/ootb-ml-jobs-siem.md - - file: data-analysis/machine-learning/ootb-ml-jobs-uptime.md - - file: data-analysis/machine-learning/machine-learning-functions.md - children: - - file: data-analysis/machine-learning/ml-count-functions.md - - file: data-analysis/machine-learning/ml-geo-functions.md - - file: data-analysis/machine-learning/ml-info-functions.md - - file: data-analysis/machine-learning/ml-metric-functions.md - - file: data-analysis/machine-learning/ml-rare-functions.md - - file: data-analysis/machine-learning/ml-sum-functions.md - - file: data-analysis/machine-learning/ml-time-functions.md - - file: data-analysis/observability/index.md - children: - - file: data-analysis/observability/observability-host-metrics.md - - file: data-analysis/observability/observability-container-metrics.md - - file: data-analysis/observability/observability-kubernetes-pod-metrics.md - - file: data-analysis/observability/observability-aws-metrics.md - - file: data-analysis/kibana/canvas-functions.md - children: - - file: data-analysis/kibana/tinymath-functions.md - - file: glossary/index.md \ No newline at end of file diff --git a/solutions/observability/apps/apm-server-systemd.md b/solutions/observability/apps/apm-server-systemd.md index 6ecdc705d1..41767747f2 100644 --- a/solutions/observability/apps/apm-server-systemd.md +++ b/solutions/observability/apps/apm-server-systemd.md @@ -8,7 +8,7 @@ applies_to: # APM Server and systemd [apm-running-with-systemd] ::::{important} -These commands only apply to the APM Server binary installation method. Fleet-managed users should see [Start and stop {{agent}}s on edge hosts](/reference/ingestion-tools/fleet/start-stop-elastic-agent.md). +These commands only apply to the APM Server binary installation method. Fleet-managed users should see [Start and stop {{agent}}s on edge hosts](/reference/fleet/start-stop-elastic-agent.md). :::: diff --git a/solutions/observability/apps/configure-elasticsearch-output.md b/solutions/observability/apps/configure-elasticsearch-output.md index 24332b9080..c89a4ed835 100644 --- a/solutions/observability/apps/configure-elasticsearch-output.md +++ b/solutions/observability/apps/configure-elasticsearch-output.md @@ -14,7 +14,7 @@ applies_to: ::::{note} ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "") -This documentation only applies to APM Server binary users. Fleet-managed users should see [Configure the {{es}} output](/reference/ingestion-tools/fleet/elasticsearch-output.md). +This documentation only applies to APM Server binary users. Fleet-managed users should see [Configure the {{es}} output](/reference/fleet/elasticsearch-output.md). :::: diff --git a/solutions/observability/apps/configure-logging.md b/solutions/observability/apps/configure-logging.md index 4928595862..cbc8b19fe5 100644 --- a/solutions/observability/apps/configure-logging.md +++ b/solutions/observability/apps/configure-logging.md @@ -14,7 +14,7 @@ applies_to: ::::{note} ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "") -These configuration options are only relevant to APM Server binary users. Fleet-managed users should see [View {{agent}} logs](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) to learn how to view logs and change the logging level of {{agent}}. +These configuration options are only relevant to APM Server binary users. Fleet-managed users should see [View {{agent}} logs](/reference/fleet/monitor-elastic-agent.md) to learn how to view logs and change the logging level of {{agent}}. :::: diff --git a/solutions/observability/apps/data-streams.md b/solutions/observability/apps/data-streams.md index 4bc739e0b1..19c28490d1 100644 --- a/solutions/observability/apps/data-streams.md +++ b/solutions/observability/apps/data-streams.md @@ -13,7 +13,7 @@ mapped_pages: * Flexible naming scheme * Fewer ingest permissions required -See the [{{fleet}} and {{agent}} Guide](/reference/ingestion-tools/fleet/data-streams.md) to learn more. +See the [{{fleet}} and {{agent}} Guide](/reference/fleet/data-streams.md) to learn more. :::: diff --git a/solutions/observability/apps/enable-apm-server-binary-debugging.md b/solutions/observability/apps/enable-apm-server-binary-debugging.md index 5818ea27b0..050e4a22ed 100644 --- a/solutions/observability/apps/enable-apm-server-binary-debugging.md +++ b/solutions/observability/apps/enable-apm-server-binary-debugging.md @@ -10,7 +10,7 @@ mapped_pages: ::::{note} -Fleet-managed users should see [View {{agent}} logs](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) to learn how to view logs and change the logging level of {{agent}}. +Fleet-managed users should see [View {{agent}} logs](/reference/fleet/monitor-elastic-agent.md) to learn how to view logs and change the logging level of {{agent}}. :::: diff --git a/solutions/observability/apps/fleet-managed-apm-server.md b/solutions/observability/apps/fleet-managed-apm-server.md index 835bb772f6..a9fe880607 100644 --- a/solutions/observability/apps/fleet-managed-apm-server.md +++ b/solutions/observability/apps/fleet-managed-apm-server.md @@ -14,7 +14,7 @@ You need {{es}} for storing and searching your data, and {{kib}} for visualizing * {{es}} cluster and {{kib}} (version 9.0) with a basic license or higher. [Learn how to install the {{stack}} on your own hardware](../../../get-started/the-stack.md). * Secure, encrypted connection between {{kib}} and {{es}}. For more information, see [Start the {{stack}} with security enabled](../../../deploy-manage/deploy/self-managed/installing-elasticsearch.md). -* Internet connection for {{kib}} to download integration packages from the {{package-registry}}. Make sure the {{kib}} server can connect to `https://epr.elastic.co` on port `443`. If your environment has network traffic restrictions, there are ways to work around this requirement. See [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md) for more information. +* Internet connection for {{kib}} to download integration packages from the {{package-registry}}. Make sure the {{kib}} server can connect to `https://epr.elastic.co` on port `443`. If your environment has network traffic restrictions, there are ways to work around this requirement. See [Air-gapped environments](/reference/fleet/air-gapped.md) for more information. * {{kib}} user with `All` privileges on {{fleet}} and {{integrations}}. Since many Integrations assets are shared across spaces, users need the {{kib}} privileges in all spaces. * In the {{es}} configuration, the [built-in API key service](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md#api-key-service-settings) must be enabled. (`xpack.security.authc.api_key.enabled: true`) * In the {{kib}} configuration, the saved objects encryption key must be set. {{fleet}} requires this setting in order to save API keys and encrypt them in {{kib}}. You can either set `xpack.encryptedSavedObjects.encryptionKey` to an alphanumeric value of at least 32 characters, or run the [`kibana-encryption-keys` command](kibana://reference/commands/kibana-encryption-keys.md) to generate the key. @@ -60,7 +60,7 @@ You can install only a single {{agent}} per host, which means you cannot run {{f :::: -1. In {{fleet}}, open the **Settings** tab. For more information about these settings, see [{{fleet}} settings](/reference/ingestion-tools/fleet/fleet-settings.md). +1. In {{fleet}}, open the **Settings** tab. For more information about these settings, see [{{fleet}} settings](/reference/fleet/fleet-settings.md). 2. Under **Fleet Server hosts**, click **Edit hosts** and specify one or more host URLs your {{agent}}s will use to connect to {{fleet-server}}. For example, `https://192.0.2.1:8220`, where `192.0.2.1` is the host IP where you will install {{fleet-server}}. Save and apply your settings. ::::{tip} @@ -82,8 +82,8 @@ You can install only a single {{agent}} per host, which means you cannot run {{f * Choose **Quick Start** if you want {{fleet}} to generate a {{fleet-server}} policy and enrollment token for you. The {{fleet-server}} policy will include a {{fleet-server}} integration plus a system integration for monitoring {{agent}}. This option generates self-signed certificates and is not recommended for production use cases. * Choose **Advanced** if you want to either: - * Use your own {{fleet-server}} policy. You can create a new {{fleet-server}} policy or select an existing one. Alternatively you can [create a {{fleet-server}} policy without using the UI](/reference/ingestion-tools/fleet/create-policy-no-ui.md), and select the policy here. - * Use your own TLS certificates to encrypt traffic between {{agent}}s and {{fleet-server}}. To learn how to generate certs, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). + * Use your own {{fleet-server}} policy. You can create a new {{fleet-server}} policy or select an existing one. Alternatively you can [create a {{fleet-server}} policy without using the UI](/reference/fleet/create-policy-no-ui.md), and select the policy here. + * Use your own TLS certificates to encrypt traffic between {{agent}}s and {{fleet-server}}. To learn how to generate certs, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). * It’s recommended you generate a unique service token for each {{fleet-server}}. For other ways to generate service tokens, see [`elasticsearch-service-tokens`](elasticsearch://reference/elasticsearch/command-line-tools/service-tokens-command.md). * If you are providing your own certificates: @@ -91,7 +91,7 @@ You can install only a single {{agent}} per host, which means you cannot run {{f * Before running the `install` command, make sure you replace the values in angle brackets. * Note that the URL specified by `--url` must match the DNS name used to generate the certificate specified by `--fleet-server-cert`. -* The `install` command installs the {{agent}} as a managed service and enrolls it in a {{fleet-server}} policy. For more {{fleet-server}} commands, see [{{agent}} command reference](/reference/ingestion-tools/fleet/agent-command-reference.md). +* The `install` command installs the {{agent}} as a managed service and enrolls it in a {{fleet-server}} policy. For more {{fleet-server}} commands, see [{{agent}} command reference](/reference/fleet/agent-command-reference.md). If installation is successful, you’ll see confirmation that {{fleet-server}} connected. Click **Continue enrolling Elastic Agent** to begin enrolling your agents in {{fleet-server}}. @@ -100,7 +100,7 @@ If you’re unable to add a {{fleet}}-managed agent, click the **Agents** tab an :::: -For more information, refer to [{{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md). +For more information, refer to [{{fleet-server}}](/reference/fleet/fleet-server.md). ## Step 2: Add and configure the APM integration [add-apm-integration] @@ -148,7 +148,7 @@ If you don’t have a {{fleet}} setup already in place, the easiest way to get s An internet connection is required to install the APM integration via the Fleet UI in Kibana. ::::{dropdown} If you don’t have an internet connection -If your environment has network traffic restrictions, there are other ways to install the APM integration. See [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md) for more information. +If your environment has network traffic restrictions, there are other ways to install the APM integration. See [Air-gapped environments](/reference/fleet/air-gapped.md) for more information. Option 1: Update `kibana.yml` : Update `kibana.yml` to include the following, then restart {{kib}}. diff --git a/solutions/observability/apps/high-availability.md b/solutions/observability/apps/high-availability.md index fdc25361b7..aba9b38c60 100644 --- a/solutions/observability/apps/high-availability.md +++ b/solutions/observability/apps/high-availability.md @@ -16,7 +16,7 @@ In case of temporal issues, like unavailable {{es}} or a sudden high workload, A If {{es}} goes down, the APM Server will eventually deny incoming requests. Both the APM Server and {{apm-agent}}(s) will issue logs accordingly. ::::{tip} -Fleet-managed APM Server users might also be interested in [Fleet/Agent proxy support](/reference/ingestion-tools/fleet/fleet-agent-proxy-support.md). +Fleet-managed APM Server users might also be interested in [Fleet/Agent proxy support](/reference/fleet/fleet-agent-proxy-support.md). :::: diff --git a/solutions/observability/apps/manage-data-retention.md b/solutions/observability/apps/manage-data-retention.md index ba68d27fc0..cfd2d1c350 100644 --- a/solutions/observability/apps/manage-data-retention.md +++ b/solutions/observability/apps/manage-data-retention.md @@ -58,4 +58,4 @@ To find Synthetics data streams: :::: -Then, you can refer to [Tutorial: Customize data retention for integrations](/reference/ingestion-tools/fleet/data-streams-ilm-tutorial.md) to learn how to apply a custom {{ilm-init}} policy to the browser data streams. \ No newline at end of file +Then, you can refer to [Tutorial: Customize data retention for integrations](/reference/fleet/data-streams-ilm-tutorial.md) to learn how to apply a custom {{ilm-init}} policy to the browser data streams. \ No newline at end of file diff --git a/solutions/observability/apps/monitor-fleet-managed-apm-server.md b/solutions/observability/apps/monitor-fleet-managed-apm-server.md index 37afeec652..f022329e55 100644 --- a/solutions/observability/apps/monitor-fleet-managed-apm-server.md +++ b/solutions/observability/apps/monitor-fleet-managed-apm-server.md @@ -73,7 +73,7 @@ Before you can monitor APM, you must have monitoring data for the {{es}} product ``` -See the [{{agent}} command reference](/reference/ingestion-tools/fleet/agent-command-reference.md) for more information on the enroll command. +See the [{{agent}} command reference](/reference/fleet/agent-command-reference.md) for more information on the enroll command. ## Install and configure {{metricbeat}} to collect monitoring data [apm-install-config-metricbeat] diff --git a/solutions/observability/apps/monitor-resources-on-private-networks.md b/solutions/observability/apps/monitor-resources-on-private-networks.md index 8ce17bbbc4..51b0448243 100644 --- a/solutions/observability/apps/monitor-resources-on-private-networks.md +++ b/solutions/observability/apps/monitor-resources-on-private-networks.md @@ -39,8 +39,8 @@ To grant access via IP, use [this list of egress IPs](https://manifest.synthetic Start by setting up {{fleet-server}} and {{agent}}: -* **Set up {{fleet-server}}**: If you are using {{ecloud}}, {{fleet-server}} will already be provided and you can skip this step. To learn more, refer to [Set up {{fleet-server}}](/reference/ingestion-tools/fleet/fleet-server.md). -* **Create an agent policy**: For more information on agent policies and creating them, refer to [{{agent}} policy](/reference/ingestion-tools/fleet/agent-policy.md#create-a-policy). +* **Set up {{fleet-server}}**: If you are using {{ecloud}}, {{fleet-server}} will already be provided and you can skip this step. To learn more, refer to [Set up {{fleet-server}}](/reference/fleet/fleet-server.md). +* **Create an agent policy**: For more information on agent policies and creating them, refer to [{{agent}} policy](/reference/fleet/agent-policy.md#create-a-policy). ::::{important} A {{private-location}} should be set up against an agent policy that runs on a single {{agent}}. The {{agent}} must be **enrolled in Fleet** ({{private-location}}s cannot be set up using **standalone** {{agents}}). Do *not* run the same agent policy on multiple agents being used for {{private-location}}s, as you may end up with duplicate or missing tests. {{private-location}}s do not currently load balance tests across multiple {{agents}}. See [Scaling {{private-location}}s](../../../solutions/observability/apps/monitor-resources-on-private-networks.md#synthetics-private-location-scaling) for information on increasing the capacity within a {{private-location}}. @@ -68,9 +68,9 @@ To pull the Docker image run: docker pull docker.elastic.co/elastic-agent/elastic-agent-complete:8.16.1 ``` -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/ingestion-tools/fleet/fleet-enrollment-tokens.md) as needed. +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. -For more information on running {{agent}} with Docker, refer to [Run {{agent}} in a container](/reference/ingestion-tools/fleet/elastic-agent-container.md). +For more information on running {{agent}} with Docker, refer to [Run {{agent}} in a container](/reference/fleet/elastic-agent-container.md). ```sh docker run \ @@ -89,7 +89,7 @@ The `elastic-agent-complete` Docker image requires additional capabilities to op ::::{note} -You may need to set other environment variables. Learn how in [{{agent}} environment variables guide](/reference/ingestion-tools/fleet/agent-environment-variables.md). +You may need to set other environment variables. Learn how in [{{agent}} environment variables guide](/reference/fleet/agent-environment-variables.md). :::: diff --git a/solutions/observability/apps/ssltls-output-settings.md b/solutions/observability/apps/ssltls-output-settings.md index cd7bae7926..c17a098e53 100644 --- a/solutions/observability/apps/ssltls-output-settings.md +++ b/solutions/observability/apps/ssltls-output-settings.md @@ -10,7 +10,7 @@ applies_to: ::::{note} ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "") -These configuration options are only relevant to APM Server binary users. Fleet-managed users should see the [Fleet output settings](/reference/ingestion-tools/fleet/fleet-settings.md). +These configuration options are only relevant to APM Server binary users. Fleet-managed users should see the [Fleet output settings](/reference/fleet/fleet-settings.md). :::: diff --git a/solutions/observability/apps/switch-self-installation-to-apm-integration.md b/solutions/observability/apps/switch-self-installation-to-apm-integration.md index 3ec0388401..4569c9a5aa 100644 --- a/solutions/observability/apps/switch-self-installation-to-apm-integration.md +++ b/solutions/observability/apps/switch-self-installation-to-apm-integration.md @@ -25,7 +25,7 @@ Review the [Elastic APM release notes](apm-server://release-notes/index.md) and ## Add a {{fleet}} Server [apm-integration-upgrade-2] -{{fleet}} Server is a component of the {{stack}} used to centrally manage {{agent}}s. The APM integration requires a {{fleet}} Server to be running and accessible to your hosts. Add a {{fleet}} Server by following [this guide](/reference/ingestion-tools/fleet/deployment-models.md). +{{fleet}} Server is a component of the {{stack}} used to centrally manage {{agent}}s. The APM integration requires a {{fleet}} Server to be running and accessible to your hosts. Add a {{fleet}} Server by following [this guide](/reference/fleet/deployment-models.md). ::::{tip} If you’re upgrading a self-managed deployment of the {{stack}}, you’ll need to enable [{{es}} security](../../../deploy-manage/deploy/self-managed/installing-elasticsearch.md) and the [API key service](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md). @@ -44,7 +44,7 @@ It’s possible to install the Elastic APM integration on the same {{agent}} tha :::: -The {{fleet}}-managed {{agent}} will run the Elastic APM integration on your edge nodes, next to your applications. To install a {{fleet}}-managed {{agent}}, follow [this guide](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). +The {{fleet}}-managed {{agent}} will run the Elastic APM integration on your edge nodes, next to your applications. To install a {{fleet}}-managed {{agent}}, follow [this guide](/reference/fleet/install-fleet-managed-elastic-agent.md). ## Add the APM integration [apm-integration-upgrade-4] diff --git a/solutions/observability/apps/synthetics-encryption-security.md b/solutions/observability/apps/synthetics-encryption-security.md index 4dd29fb8c9..76de7e2af4 100644 --- a/solutions/observability/apps/synthetics-encryption-security.md +++ b/solutions/observability/apps/synthetics-encryption-security.md @@ -23,4 +23,4 @@ The Global Elastic Synthetics Service performs all communication of sensitive da In Kibana configuration for private locations is stored in two places, Synthetics saved objects which always encrypt sensitive fields using [Kibana Secure Saved Objects](../../../deploy-manage/security/secure-saved-objects.md) and also in Fleet, which uses unencrypted saved objects restricted by user permissions. For Elastic Cloud customers all data is secured on disk regardless of whether additional saved object encryption is present. See our [Cloud Security Statement](https://www.elastic.co/cloud/security) for more information. We recommend that self-managed customers encrypt disks for their Elasticsearch instances if this is a concern. -All data is encrypted in transit. See [Elastic Agent configuration encryption](/reference/ingestion-tools/fleet/_agent_configuration_encryption.md) for more details. \ No newline at end of file +All data is encrypted in transit. See [Elastic Agent configuration encryption](/reference/fleet/_agent_configuration_encryption.md) for more details. \ No newline at end of file diff --git a/solutions/observability/apps/upgrade-self-installation-of-apm-integration-to-8x.md b/solutions/observability/apps/upgrade-self-installation-of-apm-integration-to-8x.md index 700b2952e9..526d333e38 100644 --- a/solutions/observability/apps/upgrade-self-installation-of-apm-integration-to-8x.md +++ b/solutions/observability/apps/upgrade-self-installation-of-apm-integration-to-8x.md @@ -33,4 +33,4 @@ This upgrade guide is for the Elastic APM integration. Only use this guide if bo 2. Under **Agents**, click **Upgrade available** to see a list of agents that you can upgrade. 3. Choose **Upgrade agent** from the **Actions** menu next to the agent you want to upgrade. The **Upgrade agent** option is grayed out when an upgrade is unavailable, or the {{kib}} version is lower than the agent version. - For more details, or for bulk upgrade instructions, see [Upgrade {{agent}}](/reference/ingestion-tools/fleet/upgrade-elastic-agent.md) + For more details, or for bulk upgrade instructions, see [Upgrade {{agent}}](/reference/fleet/upgrade-elastic-agent.md) diff --git a/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md b/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md index ddbb8acf50..716ee6bd4b 100644 --- a/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md +++ b/solutions/observability/cloud/monitor-amazon-cloud-compute-ec2.md @@ -52,7 +52,7 @@ Expand the **quick guide** to learn how, or skip to the next section if your dat 9. When incoming data is confirmed—​after a minute or two—​click **View assets** to access the dashboards. -For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/ingestion-tools/fleet/index.md). +For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/fleet/index.md). :::: diff --git a/solutions/observability/cloud/monitor-amazon-kinesis-data-streams.md b/solutions/observability/cloud/monitor-amazon-kinesis-data-streams.md index 00db4016fd..04b51302f4 100644 --- a/solutions/observability/cloud/monitor-amazon-kinesis-data-streams.md +++ b/solutions/observability/cloud/monitor-amazon-kinesis-data-streams.md @@ -54,7 +54,7 @@ Expand the **quick guide** to learn how, or skip to the next section if your dat 9. When incoming data is confirmed—​after a minute or two—​click **View assets** to access the dashboards. -For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/ingestion-tools/fleet/index.md). +For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/fleet/index.md). :::: diff --git a/solutions/observability/cloud/monitor-amazon-simple-queue-service-sqs.md b/solutions/observability/cloud/monitor-amazon-simple-queue-service-sqs.md index 68062101a4..790a758004 100644 --- a/solutions/observability/cloud/monitor-amazon-simple-queue-service-sqs.md +++ b/solutions/observability/cloud/monitor-amazon-simple-queue-service-sqs.md @@ -50,7 +50,7 @@ Expand the **quick guide** to learn how, or skip to the next section if your dat 9. When incoming data is confirmed—​after a minute or two—​click **View assets** to access the dashboards. -For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/ingestion-tools/fleet/index.md). +For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/fleet/index.md). :::: diff --git a/solutions/observability/cloud/monitor-amazon-simple-storage-service-s3.md b/solutions/observability/cloud/monitor-amazon-simple-storage-service-s3.md index 8b3c4ca706..f6bc070af9 100644 --- a/solutions/observability/cloud/monitor-amazon-simple-storage-service-s3.md +++ b/solutions/observability/cloud/monitor-amazon-simple-storage-service-s3.md @@ -53,7 +53,7 @@ Expand the **quick guide** to learn how, or skip to the next section if your dat 9. When incoming data is confirmed—​after a minute or two—​click **View assets** to access the dashboards. -For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/ingestion-tools/fleet/index.md). +For more information {{agent}} and integrations, refer to the [{{fleet}} and {{agent}} documentation](/reference/fleet/index.md). :::: diff --git a/solutions/observability/infra-and-hosts/tutorial-observe-kubernetes-deployments.md b/solutions/observability/infra-and-hosts/tutorial-observe-kubernetes-deployments.md index 91d016cba3..28cae541c2 100644 --- a/solutions/observability/infra-and-hosts/tutorial-observe-kubernetes-deployments.md +++ b/solutions/observability/infra-and-hosts/tutorial-observe-kubernetes-deployments.md @@ -60,7 +60,7 @@ The default deployments include processors, when needed, for enriching events wi :alt: Metadata processors for cloud ::: -For more on these processors, refer to the [`add_cloud_metadata`](/reference/ingestion-tools/fleet/add-cloud-metadata-processor.md) and [`add_host_metadata`](/reference/ingestion-tools/fleet/add_host_metadata-processor.md) documentation. +For more on these processors, refer to the [`add_cloud_metadata`](/reference/fleet/add-cloud-metadata-processor.md) and [`add_host_metadata`](/reference/fleet/add_host_metadata-processor.md) documentation. By default, the Kubernetes integration enriches logs and metrics with valuable metadata. @@ -421,7 +421,7 @@ Provide the following information to collect Kubernetes events metrics: Collecting and parsing Kubernetes container logs is on by default. Containers running within Kubernetes pods publish logs to stdout or stderr. These logs are written to a location known to kubelet. The container parser is enabled by default. You can enable additional parsers in **advanced settings**. -Metadata enrichment is also enabled by default, and is based on the Kubernetes provider. Use the `add_resource_metadata` block of the Kubernetes provider to configure it. Refer to the [Kubernetes provider](/reference/ingestion-tools/fleet/kubernetes-provider.md) docs for more on configuring the provider. +Metadata enrichment is also enabled by default, and is based on the Kubernetes provider. Use the `add_resource_metadata` block of the Kubernetes provider to configure it. Refer to the [Kubernetes provider](/reference/fleet/kubernetes-provider.md) docs for more on configuring the provider. Refer to [Kubernetes container logs](https://docs.elastic.co/en/integrations/kubernetes/container-logs) for more on collecting container logs. @@ -466,7 +466,7 @@ After configuring your integration, you need to download and update your manifes After downloading the manifest, open it and update the `ES_USERNAME` and `ES_PASSWORD` environment variables in the DaemonSet to match your {{es}} credentials. -You can also further modify the manifest to fit your needs. For example, you might want to enable autodiscovery to automatically discover container logs. Refer to the [autodiscovery docs](/reference/ingestion-tools/fleet/elastic-agent-kubernetes-autodiscovery.md) in the {{fleet}} guide for more on enabling autodiscovery in your manifest. +You can also further modify the manifest to fit your needs. For example, you might want to enable autodiscovery to automatically discover container logs. Refer to the [autodiscovery docs](/reference/fleet/elastic-agent-kubernetes-autodiscovery.md) in the {{fleet}} guide for more on enabling autodiscovery in your manifest. Once you are ready to deploy your {{agent}}: @@ -483,7 +483,7 @@ Once you are ready to deploy your {{agent}}: ``` -Refer to [Debug standalone Elastic Agents](/reference/ingestion-tools/fleet/debug-standalone-agents.md) if you run into any issues with configuring or installing your {{agent}}. +Refer to [Debug standalone Elastic Agents](/reference/fleet/debug-standalone-agents.md) if you run into any issues with configuring or installing your {{agent}}. ## Part 3: Explore logs and metrics [monitor-kubernetes-explore] diff --git a/solutions/observability/logs.md b/solutions/observability/logs.md index 31bc7abc1e..48d1a05635 100644 --- a/solutions/observability/logs.md +++ b/solutions/observability/logs.md @@ -38,21 +38,21 @@ When choosing between {{agent}} and {{filebeat}}, consider the different feature Install an {{agent}} and use {{fleet}} to define, configure, and manage your agents in a central location. -See [install {{fleet}}-managed {{agent}}](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md). +See [install {{fleet}}-managed {{agent}}](/reference/fleet/install-fleet-managed-elastic-agent.md). #### Standalone {{agent}} [observability-log-monitoring-standalone-agent] Install an {{agent}} and manually configure it locally on the system where it’s installed. You are responsible for managing and upgrading the agents. -See [install standalone {{agent}}](/reference/ingestion-tools/fleet/install-standalone-elastic-agent.md). +See [install standalone {{agent}}](/reference/fleet/install-standalone-elastic-agent.md). #### {{agent}} in a containerized environment [observability-log-monitoring-agent-in-a-containerized-environment] Run an {{agent}} inside of a container — either with {{fleet-server}} or standalone. -See [install {{agent}} in containers](/reference/ingestion-tools/fleet/install-elastic-agents-in-containers.md). +See [install {{agent}} in containers](/reference/fleet/install-elastic-agents-in-containers.md). ### {{filebeat}} [observability-log-monitoring-filebeat] diff --git a/solutions/observability/logs/add-service-name-to-logs.md b/solutions/observability/logs/add-service-name-to-logs.md index 4511d37835..3f1932b0f8 100644 --- a/solutions/observability/logs/add-service-name-to-logs.md +++ b/solutions/observability/logs/add-service-name-to-logs.md @@ -19,7 +19,7 @@ To add a service name to your logs, either: ## Use the add fields processor to add a service name [observability-add-logs-service-name-use-the-add-fields-processor-to-add-a-service-name] -For log data without a service name, use the [`add_fields` processor](/reference/ingestion-tools/fleet/add_fields-processor.md) to add the `service.name` field. You can add the processor in an integration’s settings or in the {{agent}} or {{filebeat}} configuration. +For log data without a service name, use the [`add_fields` processor](/reference/fleet/add_fields-processor.md) to add the `service.name` field. You can add the processor in an integration’s settings or in the {{agent}} or {{filebeat}} configuration. For example, adding the `add_fields` processor to the inputs section of a standalone {{agent}} or {{filebeat}} configuration would add `your_service_name` as the `service.name` field: @@ -38,7 +38,7 @@ Adding the `add_fields` processor to an integration’s settings would add `your :screenshot: ::: -For more on defining processors, refer to [define processors](/reference/ingestion-tools/fleet/agent-processors.md). +For more on defining processors, refer to [define processors](/reference/fleet/agent-processors.md). ## Map an existing field to the service name field [observability-add-logs-service-name-map-an-existing-field-to-the-service-name-field] diff --git a/solutions/observability/logs/parse-route-logs.md b/solutions/observability/logs/parse-route-logs.md index 6b7fe85930..01901a634d 100644 --- a/solutions/observability/logs/parse-route-logs.md +++ b/solutions/observability/logs/parse-route-logs.md @@ -155,7 +155,7 @@ PUT _ingest/pipeline/logs-example-default The previous command sets the following values for your ingest pipeline: -* `_ingest/pipeline/logs-example-default`: The name of the pipeline,`logs-example-default`, needs to match the name of your data stream. You’ll set up your data stream in the next section. For more information, refer to the [data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). +* `_ingest/pipeline/logs-example-default`: The name of the pipeline,`logs-example-default`, needs to match the name of your data stream. You’ll set up your data stream in the next section. For more information, refer to the [data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). * `field`: The field you’re extracting data from, `message` in this case. * `pattern`: The pattern of the elements in your log data. The `%{@timestamp} %{{message}}` pattern extracts the timestamp, `2023-08-08T13:45:12.123Z`, to the `@timestamp` field, while the rest of the message, `WARN 192.168.1.101 Disk usage exceeds 90%.`, stays in the `message` field. The dissect processor looks for the space as a separator defined by the pattern. @@ -255,7 +255,7 @@ The example index template above sets the following component templates: #### Create a data stream [observability-parse-log-data-create-a-data-stream] -Create your data stream using the [data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). Name your data stream to match the name of your ingest pipeline, `logs-example-default` in this case. Post the example log to your data stream with this command: +Create your data stream using the [data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). Name your data stream to match the name of your ingest pipeline, `logs-example-default` in this case. Post the example log to your data stream with this command: ```console POST logs-example-default/_doc diff --git a/solutions/observability/logs/plaintext-application-logs.md b/solutions/observability/logs/plaintext-application-logs.md index 6705742b73..536482c1eb 100644 --- a/solutions/observability/logs/plaintext-application-logs.md +++ b/solutions/observability/logs/plaintext-application-logs.md @@ -251,7 +251,7 @@ PUT _ingest/pipeline/filebeat* <1> } ``` -1. `_ingest/pipeline/filebeat*`: The name of the pipeline. Update the pipeline name to match the name of your data stream. For more information, refer to [Data stream naming scheme](/reference/ingestion-tools/fleet/data-streams.md#data-streams-naming-scheme). +1. `_ingest/pipeline/filebeat*`: The name of the pipeline. Update the pipeline name to match the name of your data stream. For more information, refer to [Data stream naming scheme](/reference/fleet/data-streams.md#data-streams-naming-scheme). 2. `processors.dissect`: Adds a [dissect processor](elasticsearch://reference/ingestion-tools/enrich-processor/dissect-processor.md) to extract structured fields from your log message. 3. `field`: The field you’re extracting data from, `message` in this case. 4. `pattern`: The pattern of the elements in your log data. The pattern varies depending on your log format. `%{@timestamp}` is required. `%{log.level}`, `%{host.ip}`, and `%{{message}}` are common [ECS](ecs://reference/index.md) fields. This pattern would match a log file in this format: `2023-11-07T09:39:01.012Z ERROR 192.168.1.110 Server hardware failure detected.` diff --git a/solutions/observability/logs/stream-any-log-file.md b/solutions/observability/logs/stream-any-log-file.md index 316a6f347b..4c576fccf0 100644 --- a/solutions/observability/logs/stream-any-log-file.md +++ b/solutions/observability/logs/stream-any-log-file.md @@ -273,7 +273,7 @@ inputs: Next, set the values for these fields: * `hosts` – Copy the {{es}} endpoint from **Help menu (![help icon](/solutions/images/observability-help-icon.png "")) → Connection details**. For example, `https://my-deployment.es.us-central1.gcp.cloud.es.io:443`. -* `api-key` – Use an API key to grant the agent access to {{es}}. To create an API key for your agent, refer to the [Create API keys for standalone agents](/reference/ingestion-tools/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) documentation. +* `api-key` – Use an API key to grant the agent access to {{es}}. To create an API key for your agent, refer to the [Create API keys for standalone agents](/reference/fleet/grant-access-to-elasticsearch.md#create-api-key-standalone-agent) documentation. ::::{note} The API key format should be `:`. Make sure you selected **Beats** when you created your API key. Base64 encoded API keys are not currently supported in this configuration. @@ -430,7 +430,7 @@ If you’re not seeing your log files in the UI, verify the following in the `el * The path to your logs file under `paths` is correct. * Your API key is in `:` format. If not, your API key may be in an unsupported format, and you’ll need to create an API key in **Beats** format. -If you’re still running into issues, see [{{agent}} troubleshooting](../../../troubleshoot/ingest/fleet/common-problems.md) and [Configure standalone Elastic Agents](/reference/ingestion-tools/fleet/configure-standalone-elastic-agents.md). +If you’re still running into issues, see [{{agent}} troubleshooting](../../../troubleshoot/ingest/fleet/common-problems.md) and [Configure standalone Elastic Agents](/reference/fleet/configure-standalone-elastic-agents.md). ## Next steps [logs-stream-next-steps] diff --git a/solutions/security/asset-management.md b/solutions/security/asset-management.md index b8efab886e..19f779cffa 100644 --- a/solutions/security/asset-management.md +++ b/solutions/security/asset-management.md @@ -11,7 +11,7 @@ applies_to: The **Assets** page allows you to manage the following features: -* [{{fleet}}](/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md) -* [{{integrations}}](/reference/ingestion-tools/fleet/manage-integrations.md) +* [{{fleet}}](/reference/fleet/manage-elastic-agents-in-fleet.md) +* [{{integrations}}](/reference/fleet/manage-integrations.md) * [Endpoint protection](manage-elastic-defend.md) * [Cloud security](cloud.md) diff --git a/solutions/security/configure-elastic-defend/create-an-elastic-defend-policy-using-api.md b/solutions/security/configure-elastic-defend/create-an-elastic-defend-policy-using-api.md index 3f2e1a340e..cb028e33d5 100644 --- a/solutions/security/configure-elastic-defend/create-an-elastic-defend-policy-using-api.md +++ b/solutions/security/configure-elastic-defend/create-an-elastic-defend-policy-using-api.md @@ -9,7 +9,7 @@ applies_to: # Create an Elastic Defend policy using API [create-defend-policy-api] -In addition to [configuring an {{elastic-defend}} policy](configure-an-integration-policy-for-elastic-defend.md) through the {{elastic-sec}} UI, you can create and customize an {{elastic-defend}} policy through the API. This is a three-step process involving the [{{fleet}} API](/reference/ingestion-tools/fleet/fleet-api-docs.md). You can repeat steps 2 and 3 to make more modifications to the {{elastic-defend}} policy. +In addition to [configuring an {{elastic-defend}} policy](configure-an-integration-policy-for-elastic-defend.md) through the {{elastic-sec}} UI, you can create and customize an {{elastic-defend}} policy through the API. This is a three-step process involving the [{{fleet}} API](/reference/fleet/fleet-api-docs.md). You can repeat steps 2 and 3 to make more modifications to the {{elastic-defend}} policy. ::::{admonition} Requirements You must have the **{{elastic-defend}} Policy Management: All** [privilege](elastic-defend-feature-privileges.md) to configure an integration policy. diff --git a/solutions/security/configure-elastic-defend/install-elastic-defend.md b/solutions/security/configure-elastic-defend/install-elastic-defend.md index e58f819da8..758f415b42 100644 --- a/solutions/security/configure-elastic-defend/install-elastic-defend.md +++ b/solutions/security/configure-elastic-defend/install-elastic-defend.md @@ -12,7 +12,7 @@ applies_to: # Install the {{elastic-defend}} integration -Like other Elastic integrations, {{elastic-defend}} is integrated into the {{agent}} using [{{fleet}}](/reference/ingestion-tools/fleet/index.md). Upon configuration, the integration allows the {{agent}} to monitor events on your host and send data to the {{security-app}}. +Like other Elastic integrations, {{elastic-defend}} is integrated into the {{agent}} using [{{fleet}}](/reference/fleet/index.md). Upon configuration, the integration allows the {{agent}} to monitor events on your host and send data to the {{security-app}}. ::::{admonition} Requirements * {{fleet}} is required for {{elastic-defend}}. @@ -62,7 +62,7 @@ If you’re using macOS, some versions may require you to grant Full Disk Access | **Traditional Endpoint presets** | All traditional endpoint presets *except **Data Collection*** have these preventions enabled by default: malware, ransomware, memory threat, malicious behavior, and credential theft. Each preset collects the following events:

- **Data Collection:** All events; no preventions
- **Next-Generation Antivirus (NGAV):** Process events; all preventions
- **Essential EDR (Endpoint Detection & Response):** Process, Network, File events; all preventions
- **Complete EDR (Endpoint Detection & Response):** All events; all preventions
| | **Cloud Workloads presets** | Both cloud workload presets are intended for monitoring cloud-based Linux hosts. Therefore, [session data](/solutions/security/investigate/session-view.md) collection, which enriches process events, is enabled by default. They both have all preventions disabled by default, and collect process, network, and file events.

- **All events:** Includes data from automated sessions.
- **Interactive only:** Filters out data from non-interactive sessions by creating an [event filter](/solutions/security/manage-elastic-defend/event-filters.md).
| -6. Enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md). +6. Enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/fleet/agent-policy.md). 7. When you’re ready, click **Save and continue**. 8. To complete the integration, select **Add {{agent}} to your hosts** and continue to the next section to install the {{agent}} on your hosts. @@ -72,7 +72,7 @@ If you’re using macOS, some versions may require you to grant Full Disk Access To enable the {{elastic-defend}} integration, you must enroll agents in the relevant policy using {{fleet}}. ::::{important} -Before you add an {{agent}}, a {{fleet-server}} must be running. Refer to [Add a {{fleet-server}}](/reference/ingestion-tools/fleet/deployment-models.md). +Before you add an {{agent}}, a {{fleet-server}} must be running. Refer to [Add a {{fleet-server}}](/reference/fleet/deployment-models.md). {{elastic-defend}} cannot be integrated with an {{agent}} in standalone mode. :::: @@ -91,7 +91,7 @@ If you are running an {{stack}} version earlier than 7.13.0, you can skip this s If you have upgraded to an {{stack}} version that includes {{fleet-server}} 7.13.0 or newer, you will need to redeploy your agents. Review the following scenarios to ensure you take the appropriate steps. * If you redeploy the {{agent}} to the same machine through the {{fleet}} application after you upgrade, a new agent will appear. -* If you want to remove the {{agent}} entirely without transitioning to the {{fleet-server}}, then you will need to manually uninstall the {{agent}} on the machine. This will also uninstall the endpoint. Refer to [Uninstall Elastic Agent](/reference/ingestion-tools/fleet/uninstall-elastic-agent.md). +* If you want to remove the {{agent}} entirely without transitioning to the {{fleet-server}}, then you will need to manually uninstall the {{agent}} on the machine. This will also uninstall the endpoint. Refer to [Uninstall Elastic Agent](/reference/fleet/uninstall-elastic-agent.md). * In the rare event that the {{agent}} fails to uninstall, you might need to manually uninstall the endpoint. Refer to [Uninstall an endpoint](/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md#uninstall-endpoint) at the end of this topic. @@ -104,7 +104,7 @@ If you have upgraded to an {{stack}} version that includes {{fleet-server}} 7.13 :screenshot: ::: -2. Select an agent policy for the {{agent}}. You can select an existing policy, or select **Create new agent policy** to create a new one. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md). +2. Select an agent policy for the {{agent}}. You can select an existing policy, or select **Create new agent policy** to create a new one. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/fleet/agent-policy.md). The selected agent policy should include the integration you want to install on the hosts covered by the agent policy (in this example, {{elastic-defend}}). diff --git a/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md b/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md index 10f98fe903..652be29686 100644 --- a/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md +++ b/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md @@ -10,7 +10,7 @@ applies_to: # Uninstall {{agent}} [uninstall-agent] -To uninstall {{agent}} from a host, run the `uninstall` command from the directory where it’s running. Refer to the [{{fleet}} and {{agent}} documentation](/reference/ingestion-tools/fleet/uninstall-elastic-agent.md) for more information. +To uninstall {{agent}} from a host, run the `uninstall` command from the directory where it’s running. Refer to the [{{fleet}} and {{agent}} documentation](/reference/fleet/uninstall-elastic-agent.md) for more information. If [Agent tamper protection](prevent-elastic-agent-uninstallation.md) is enabled on the Agent policy for the host, you’ll need to include the uninstall token in the command, using the `--uninstall-token` flag. You can [find the uninstall token](prevent-elastic-agent-uninstallation.md#fleet-uninstall-tokens) on the Agent policy. Alternatively, find **{{fleet}}** in the navigation menu or by using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md), and select **Uninstall tokens**. @@ -53,7 +53,7 @@ If you have multiple tamper-protected {{agent}} policies, you may want to provid ## Uninstall {{elastic-endpoint}} [uninstall-endpoint] -Use these commands to uninstall {{elastic-endpoint}} from a host **ONLY** if [uninstalling an {{agent}}](/reference/ingestion-tools/fleet/uninstall-elastic-agent.md) is unsuccessful. +Use these commands to uninstall {{elastic-endpoint}} from a host **ONLY** if [uninstalling an {{agent}}](/reference/fleet/uninstall-elastic-agent.md) is unsuccessful. Windows diff --git a/solutions/security/endpoint-response-actions.md b/solutions/security/endpoint-response-actions.md index 26666e626a..2f92fd0ab3 100644 --- a/solutions/security/endpoint-response-actions.md +++ b/solutions/security/endpoint-response-actions.md @@ -311,7 +311,7 @@ This panel displays only the response actions that you have the user role or pri You can use this panel to build commands with less typing. Click the add icon (![Add icon](/solutions/images/security-add-command-icon.png "title =20x20")) to add a command to the input area, enter any additional parameters or a comment, then press **Return** to run the command. -If the endpoint is running an older version of {{agent}}, some response actions may not be supported, as indicated by an informational icon and tooltip. [Upgrade {{agent}}](/reference/ingestion-tools/fleet/upgrade-elastic-agent.md) on the endpoint to be able to use the latest response actions. +If the endpoint is running an older version of {{agent}}, some response actions may not be supported, as indicated by an informational icon and tooltip. [Upgrade {{agent}}](/reference/fleet/upgrade-elastic-agent.md) on the endpoint to be able to use the latest response actions. :::{image} /solutions/images/security-response-console-unsupported-command.png :alt: Unsupported response action with tooltip diff --git a/solutions/security/endpoint-response-actions/configure-third-party-response-actions.md b/solutions/security/endpoint-response-actions/configure-third-party-response-actions.md index 6e974fa97c..bb62ea25b7 100644 --- a/solutions/security/endpoint-response-actions/configure-third-party-response-actions.md +++ b/solutions/security/endpoint-response-actions/configure-third-party-response-actions.md @@ -56,7 +56,7 @@ Expand a section below for your endpoint security system: * **URL**: The base URL of the CrowdStrike API. 4. Select the **Falcon Alerts** and **Hosts** sub-options under **Collect CrowdStrike logs via API**. - 5. Scroll down and enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md). + 5. Scroll down and enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/fleet/agent-policy.md). 6. Click **Save and continue**. 7. Select **Add {{agent}} to your hosts** and continue with the [{{agent}} installation steps](/solutions/security/configure-elastic-defend/install-elastic-defend.md#enroll-agent) to install {{agent}} on a resource in your network (such as a server or VM). {{agent}} will act as a bridge collecting data from CrowdStrike and sending it back to {{elastic-sec}}. @@ -104,7 +104,7 @@ Expand a section below for your endpoint security system: 1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md), search for and select **Microsoft Defender for Endpoint**, then select **Add Microsoft Defender for Endpoint**. 2. Enter an **Integration name**. Entering a **Description** is optional. 3. Ensure that **Microsoft Defender for Endpoint logs** is selected, and enter the required values for **Client ID**, **Client Secret**, and **Tenant ID**. - 4. Scroll down and enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md). + 4. Scroll down and enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/fleet/agent-policy.md). 5. Click **Save and continue**. 6. Select **Add {{agent}} to your hosts** and continue with the [{{agent}} installation steps](/solutions/security/configure-elastic-defend/install-elastic-defend.md#enroll-agent) to install {{agent}} on a resource in your network (such as a server or VM). {{agent}} will act as a bridge, collecting data from Microsoft Defender for Endpoint and sending it back to {{elastic-sec}}. @@ -160,7 +160,7 @@ Expand a section below for your endpoint security system: * **URL**: The SentinelOne console URL. * **API Token**: The SentinelOne API access token you generated previously, with permission to read SentinelOne data. - 4. Scroll down and enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/ingestion-tools/fleet/agent-policy.md). + 4. Scroll down and enter a name for the agent policy in **New agent policy name**. If other agent policies already exist, you can click the **Existing hosts** tab and select an existing policy instead. For more details on {{agent}} configuration settings, refer to [{{agent}} policies](/reference/fleet/agent-policy.md). 5. Click **Save and continue**. 6. Select **Add {{agent}} to your hosts** and continue with the [{{agent}} installation steps](/solutions/security/configure-elastic-defend/install-elastic-defend.md#enroll-agent) to install {{agent}} on a resource in your network (such as a server or VM). {{agent}} will act as a bridge collecting data from SentinelOne and sending it to {{elastic-sec}}. diff --git a/solutions/security/get-started/configure-advanced-settings.md b/solutions/security/get-started/configure-advanced-settings.md index d5bb2be110..5cd1816424 100644 --- a/solutions/security/get-started/configure-advanced-settings.md +++ b/solutions/security/get-started/configure-advanced-settings.md @@ -65,7 +65,7 @@ Index patterns use wildcards to specify a set of indices. For example, the `file :::: -All of the default index patterns match [{{beats}}](beats://reference/index.md) and [{{agent}}](/reference/ingestion-tools/fleet/index.md) indices. This means all data shipped via {{beats}} and the {{agent}} is automatically added to the {{security-app}}. +All of the default index patterns match [{{beats}}](beats://reference/index.md) and [{{agent}}](/reference/fleet/index.md) indices. This means all data shipped via {{beats}} and the {{agent}} is automatically added to the {{security-app}}. You can add or remove any indices and index patterns as required. In {{serverless-short}}, the maximum number of items that you can include in a comma-delimited list is 50. In {{stack}}, there is no limit. For more information on {{es}} indices, refer to [Data in: documents and indices](/manage-data/data-store/index-basics.md). diff --git a/solutions/security/get-started/elastic-security-ui.md b/solutions/security/get-started/elastic-security-ui.md index 9e762b5828..d83f63f270 100644 --- a/solutions/security/get-started/elastic-security-ui.md +++ b/solutions/security/get-started/elastic-security-ui.md @@ -169,7 +169,7 @@ Expand this section to access the following pages: The Assets section allows you to manage the following features: -* [{{fleet}}](/reference/ingestion-tools/fleet/manage-elastic-agents-in-fleet.md) +* [{{fleet}}](/reference/fleet/manage-elastic-agents-in-fleet.md) * [Endpoint protection](/solutions/security/manage-elastic-defend.md) * [Endpoints](/solutions/security/manage-elastic-defend/endpoints.md): View and manage hosts running {{elastic-defend}}. @@ -203,7 +203,7 @@ stack: all Expand this section to access and manage: - Additional security features - [Stack monitoring](/deploy-manage/monitor/stack-monitoring.md) -- [{{integrations}}](/reference/ingestion-tools/fleet/manage-integrations.md) +- [{{integrations}}](/reference/fleet/manage-integrations.md) ### Project Settings ```yaml {applies_to} @@ -212,7 +212,7 @@ serverless: all Expand this section to access and manage: - Additional security features -- [{{integrations}}](/reference/ingestion-tools/fleet/manage-integrations.md) +- [{{integrations}}](/reference/fleet/manage-integrations.md) - [Billing](/deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions.md) and [subscription](/deploy-manage/cloud-organization/billing/manage-subscription.md) options for your {{serverless-short}} project diff --git a/solutions/security/get-started/enable-threat-intelligence-integrations.md b/solutions/security/get-started/enable-threat-intelligence-integrations.md index b015bb1f9e..83f5060091 100644 --- a/solutions/security/get-started/enable-threat-intelligence-integrations.md +++ b/solutions/security/get-started/enable-threat-intelligence-integrations.md @@ -35,7 +35,7 @@ There are a few scenarios when data won’t display in the Threat Intelligence v ## Add an {{agent}} integration [agent-ti-integration] -1. Install a [{{fleet}}-managed {{agent}}](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md) on the hosts you want to monitor. +1. Install a [{{fleet}}-managed {{agent}}](/reference/fleet/install-fleet-managed-elastic-agent.md) on the hosts you want to monitor. 2. In the Threat Intelligence view, click **Enable sources** to view the Integrations page. Scroll down and select **Elastic Agent only** to filter by {{agent}} integrations. ::::{tip} diff --git a/solutions/security/get-started/ingest-data-to-elastic-security.md b/solutions/security/get-started/ingest-data-to-elastic-security.md index d2c0686299..73669967bb 100644 --- a/solutions/security/get-started/ingest-data-to-elastic-security.md +++ b/solutions/security/get-started/ingest-data-to-elastic-security.md @@ -12,8 +12,8 @@ applies_to: To ingest data, you can use: -* The [{{agent}}](/reference/ingestion-tools/fleet/index.md) with the **{{elastic-defend}}** integration, which protects your hosts and sends logs, metrics, and endpoint security data to {{elastic-sec}}. See [Install {{elastic-defend}}](/solutions/security/configure-elastic-defend/install-elastic-defend.md). -* The {{agent}} with integrations, which are available in the [Elastic Package Registry (EPR)](/reference/ingestion-tools/fleet/index.md#package-registry-intro). To install an integration that works with {{elastic-sec}}, go to the {{kib}} Home page or navigation menu and click **Add integrations**. On the Integrations page, click the **Security** category filter, then select an integration to view the installation instructions. For more information on integrations, refer to [{{integrations}}](https://docs.elastic.co/en/integrations). +* The [{{agent}}](/reference/fleet/index.md) with the **{{elastic-defend}}** integration, which protects your hosts and sends logs, metrics, and endpoint security data to {{elastic-sec}}. See [Install {{elastic-defend}}](/solutions/security/configure-elastic-defend/install-elastic-defend.md). +* The {{agent}} with integrations, which are available in the [Elastic Package Registry (EPR)](/reference/fleet/index.md#package-registry-intro). To install an integration that works with {{elastic-sec}}, go to the {{kib}} Home page or navigation menu and click **Add integrations**. On the Integrations page, click the **Security** category filter, then select an integration to view the installation instructions. For more information on integrations, refer to [{{integrations}}](https://docs.elastic.co/en/integrations). * **{{beats}}** shippers installed for each system you want to monitor. * The {{agent}} to send data from Splunk to {{elastic-sec}}. See [Get started with data from Splunk](/solutions/observability/get-started/add-data-from-splunk.md). * Third-party collectors configured to ship ECS-compliant data. [*Elastic Security ECS field reference*](/reference/security/fields-and-object-schemas/siem-field-reference.md) provides a list of ECS fields used in {{elastic-sec}}. diff --git a/solutions/security/investigate/add-osquery-response-actions.md b/solutions/security/investigate/add-osquery-response-actions.md index 032e3da158..41d69593f9 100644 --- a/solutions/security/investigate/add-osquery-response-actions.md +++ b/solutions/security/investigate/add-osquery-response-actions.md @@ -20,7 +20,7 @@ Osquery Response Actions allow you to add live queries to custom query rules so ::::{admonition} Requirements * Ensure you have the appropriate [{{stack}} subscription](https://www.elastic.co/pricing) or [{{serverless-short}} project tier](../../../deploy-manage/deploy/elastic-cloud/project-settings.md). * The [Osquery manager integration](manage-integration.md) must be installed. -* {{agent}}'s [status](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) must be `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. +* {{agent}}'s [status](/reference/fleet/monitor-elastic-agent.md) must be `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. * Your role must have [Osquery feature privileges](/solutions/security/investigate/osquery.md). * You can only add Osquery Response Actions to custom query rules. diff --git a/solutions/security/investigate/indicators-of-compromise.md b/solutions/security/investigate/indicators-of-compromise.md index 538c016ff6..a0d4b9a942 100644 --- a/solutions/security/investigate/indicators-of-compromise.md +++ b/solutions/security/investigate/indicators-of-compromise.md @@ -17,7 +17,7 @@ The Indicators page collects data from enabled threat intelligence feeds and pro * In serverless, the Indicators page requires the Security Analytics Complete [project feature](/deploy-manage/deploy/elastic-cloud/project-settings.md) * You must have *one* of the following installed on the hosts you want to monitor: - * **{{agent}}** - Install a [{{fleet}}-managed {{agent}}](/reference/ingestion-tools/fleet/install-fleet-managed-elastic-agent.md) and ensure the agent’s status is `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. + * **{{agent}}** - Install a [{{fleet}}-managed {{agent}}](/reference/fleet/install-fleet-managed-elastic-agent.md) and ensure the agent’s status is `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. * **{{filebeat}}** - Install [{{filebeat}}](beats://reference/filebeat/filebeat-installation-configuration.md) version 8.x or later. Earlier {{filebeat}} versions are incompatible with ECS and will prevent indicator data from displaying in the Indicators table. diff --git a/solutions/security/investigate/manage-integration.md b/solutions/security/investigate/manage-integration.md index 8c0d26ee1d..c361b1b38b 100644 --- a/solutions/security/investigate/manage-integration.md +++ b/solutions/security/investigate/manage-integration.md @@ -15,7 +15,7 @@ applies_to: ## System requirements [_system_requirements] -* [{{fleet}}](/reference/ingestion-tools/fleet/index.md) is enabled on your cluster, and one or more [{{agents}}](/reference/ingestion-tools/fleet/install-elastic-agents.md) is enrolled. +* [{{fleet}}](/reference/fleet/index.md) is enabled on your cluster, and one or more [{{agents}}](/reference/fleet/install-elastic-agents.md) is enrolled. * The [Osquery Manager](https://docs.elastic.co/en/integrations/osquery_manager) integration has been added and configured for an agent policy through {{fleet}}. This integration supports x64 architecture on Windows, MacOS, and Linux platforms, and ARM64 architecture on Linux. ::::{note} @@ -94,12 +94,12 @@ For each agent policy where you want to allow `curl` table queries, edit the Osq ## Upgrade Osquery versions [_upgrade_osquery_versions] -The [Osquery version](https://github.com/osquery/osquery/releases) available on an {{agent}} is associated to the version of Osquery Beat on the Agent. To get the latest version of Osquery Beat, [upgrade your {{agent}}](/reference/ingestion-tools/fleet/upgrade-elastic-agent.md). +The [Osquery version](https://github.com/osquery/osquery/releases) available on an {{agent}} is associated to the version of Osquery Beat on the Agent. To get the latest version of Osquery Beat, [upgrade your {{agent}}](/reference/fleet/upgrade-elastic-agent.md). ## Debug issues [_debug_issues] -If you encounter issues with **Osquery Manager**, find the relevant logs for {{elastic-agent}} and Osquerybeat in the agent directory. Refer to the [Fleet Installation layout](/reference/ingestion-tools/fleet/installation-layout.md) to find the log file location for your OS. +If you encounter issues with **Osquery Manager**, find the relevant logs for {{elastic-agent}} and Osquerybeat in the agent directory. Refer to the [Fleet Installation layout](/reference/fleet/installation-layout.md) to find the log file location for your OS. ```ts ../data/elastic-agent-*/logs/elastic-agent-json.log-* diff --git a/solutions/security/investigate/osquery-faq.md b/solutions/security/investigate/osquery-faq.md index dc0aded725..23f7069cdc 100644 --- a/solutions/security/investigate/osquery-faq.md +++ b/solutions/security/investigate/osquery-faq.md @@ -49,7 +49,7 @@ Osquery uses a superset of SQLite for queries. To get started with osquery SQL, ## How often is Osquery updated for Osquery Manager? [osquery-updates] -When a new [version of Osquery is released](https://github.com/osquery/osquery/releases), it is included in a subsequent Elastic Agent release and applied when the agent is upgraded. After that, when running queries from Osquery Manager in {{kib}}, the updated Osquery version is used. Refer to the Fleet and Elastic Agent Guide for help with [upgrading Fleet-managed Elastic Agents](/reference/ingestion-tools/fleet/upgrade-elastic-agent.md). +When a new [version of Osquery is released](https://github.com/osquery/osquery/releases), it is included in a subsequent Elastic Agent release and applied when the agent is upgraded. After that, when running queries from Osquery Manager in {{kib}}, the updated Osquery version is used. Refer to the Fleet and Elastic Agent Guide for help with [upgrading Fleet-managed Elastic Agents](/reference/fleet/upgrade-elastic-agent.md). To check what Osquery version is installed on an Elastic Agent, you can run `SELECT version FROM osquery_info;` as a live query in {{kib}}. The `version` in the response is the Osquery version installed on the agent. diff --git a/solutions/security/investigate/run-osquery-from-alerts.md b/solutions/security/investigate/run-osquery-from-alerts.md index 194fd74aae..a923f41229 100644 --- a/solutions/security/investigate/run-osquery-from-alerts.md +++ b/solutions/security/investigate/run-osquery-from-alerts.md @@ -14,7 +14,7 @@ Run live queries on hosts associated with alerts to learn more about your infras ::::{admonition} Requirements * The [Osquery manager integration](/solutions/security/investigate/manage-integration.md) must be installed. -* {{agent}}'s [status](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) must be `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. +* {{agent}}'s [status](/reference/fleet/monitor-elastic-agent.md) must be `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. * Your role must have the appropriate [feature privileges](/solutions/security/investigate/osquery.md#required_osquery-privileges) in {{stack}} or [user role](/deploy-manage/users-roles/cloud-organization/user-roles.md) in {{serverless-short}}. :::: diff --git a/solutions/security/investigate/run-osquery-from-investigation-guides.md b/solutions/security/investigate/run-osquery-from-investigation-guides.md index ecc51ec158..5637c5648f 100644 --- a/solutions/security/investigate/run-osquery-from-investigation-guides.md +++ b/solutions/security/investigate/run-osquery-from-investigation-guides.md @@ -21,7 +21,7 @@ Detection rule investigation guides suggest steps for triaging, analyzing, and r ::::{admonition} Requirements * The [Osquery manager integration](/solutions/security/investigate/manage-integration.md) must be installed. -* {{agent}}'s [status](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) must be `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. +* {{agent}}'s [status](/reference/fleet/monitor-elastic-agent.md) must be `Healthy`. Refer to [{{fleet}} Troubleshooting](/troubleshoot/ingest/fleet/common-problems.md) if it isn’t. * In {{stack}}, your role must have [Osquery feature privileges](/solutions/security/investigate/osquery.md). * In {{serverless-short}}, you must have the appropriate user role to use this feature. diff --git a/solutions/security/manage-elastic-defend/endpoints.md b/solutions/security/manage-elastic-defend/endpoints.md index 0981a2c794..b8f7ef29f7 100644 --- a/solutions/security/manage-elastic-defend/endpoints.md +++ b/solutions/security/manage-elastic-defend/endpoints.md @@ -57,7 +57,7 @@ The Endpoints list provides the following data: * **View host details**: View host details on the **Hosts** page in the {{security-app}}. * **View agent policy**: View the agent policy in {{fleet}}. * **View agent details**: View {{agent}} details and activity logs in {{fleet}}. - * **Reassign agent policy**: Change the [agent policy](/reference/ingestion-tools/fleet/agent-policy.md#apply-a-policy) assigned to the host in {{fleet}}. + * **Reassign agent policy**: Change the [agent policy](/reference/fleet/agent-policy.md#apply-a-policy) assigned to the host in {{fleet}}. ### Endpoint details [endpoint-details] diff --git a/troubleshoot/ingest/fleet/common-problems.md b/troubleshoot/ingest/fleet/common-problems.md index ca1080f0b6..b975333a41 100644 --- a/troubleshoot/ingest/fleet/common-problems.md +++ b/troubleshoot/ingest/fleet/common-problems.md @@ -18,7 +18,7 @@ We have collected the most common known problems and listed them here. If your p Have a question? Read our [FAQ](frequently-asked-questions.md), or contact us in the [discuss forum](https://discuss.elastic.co/). Your feedback is valuable to us. -Running {{agent}} standalone? Also refer to [Debug standalone {{agent}}s](/reference/ingestion-tools/fleet/debug-standalone-agents.md). +Running {{agent}} standalone? Also refer to [Debug standalone {{agent}}s](/reference/fleet/debug-standalone-agents.md). ## Troubleshooting contents [troubleshooting-contents] @@ -64,7 +64,7 @@ Find troubleshooting information for {{fleet}}, {{fleet-server}}, and {{agent}} In {{fleet}}, if you delete an {{agent}} policy that is associated with one or more inactive enrolled agents, when the agent returns back to a `Healthy` or `Offline` state, it cannot be unenrolled. Attempting to unenroll the agent results in an `Error unenrolling agent` message, and the unenrollment fails. -To resolve this problem, you can use the [{{kib}} {{fleet}} APIs](/reference/ingestion-tools/fleet/fleet-api-docs.md) to force unenroll the agent. +To resolve this problem, you can use the [{{kib}} {{fleet}} APIs](/reference/fleet/fleet-api-docs.md) to force unenroll the agent. To uninstall a single {{agent}}: @@ -100,7 +100,7 @@ For details about the error and how to resolve it, refer to the section `Runtime ## {{agent}}s hosted on {{ecloud}} are stuck in `Updating` or `Offline` [agents-in-cloud-stuck-at-updating] -In {{ecloud}}, after [upgrading](/reference/ingestion-tools/fleet/upgrade-integration.md) {{fleet-server}} and its integration policies, agents enrolled in the {{ecloud}} agent policy may experience issues updating. To resolve this problem: +In {{ecloud}}, after [upgrading](/reference/fleet/upgrade-integration.md) {{fleet-server}} and its integration policies, agents enrolled in the {{ecloud}} agent policy may experience issues updating. To resolve this problem: 1. In a terminal window, run the following `cURL` request, providing your {{kib}} superuser credentials to reset the {{ecloud}} agent policy. @@ -180,7 +180,7 @@ To enable {{fleet}} and set up {{fleet-server}} on a self-managed cluster: 1. Copy the Elastic user name to the {{kib}} configuration file. 2. Restart {{kib}}. - 3. Follow the documented steps for setting up a self-managed {{fleet-server}}. For more information, refer to [What is {{fleet-server}}?](/reference/ingestion-tools/fleet/fleet-server.md). + 3. Follow the documented steps for setting up a self-managed {{fleet-server}}. For more information, refer to [What is {{fleet-server}}?](/reference/fleet/fleet-server.md). @@ -199,7 +199,7 @@ In air-gapped environments, you may encounter the following error if you’re us {"type":"log","@timestamp":"2022-03-02T09:58:36-05:00","tags":["error","plugins","fleet"],"pid":58716,"message":"Error connecting to package registry: request to https://customer.server.name:8443/categories?experimental=true&include_policy_templates=true&kibana.version=7.17.0 failed, reason: self signed certificate in certificate chain"} ``` -To fix this problem, add your CA certificate file path to the {{kib}} startup file by defining the `NODE_EXTRA_CA_CERTS` environment variable. More information about this in [TLS configuration of the {{package-registry}}](/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-tls) section. +To fix this problem, add your CA certificate file path to the {{kib}} startup file by defining the `NODE_EXTRA_CA_CERTS` environment variable. More information about this in [TLS configuration of the {{package-registry}}](/reference/fleet/air-gapped.md#air-gapped-tls) section. ## {{fleet}} in {{kib}} crashes [fleet-app-crashes] @@ -232,7 +232,7 @@ Traffic between {{agent}}s and {{fleet-server}} over HTTPS will be encrypted; yo Allowing {{fleet-server}} to generate self-signed certificates is useful to get things running for development, but not recommended in a production environment. -For more information, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/ingestion-tools/fleet/secure-connections.md). +For more information, refer to [Configure SSL/TLS for self-managed {{fleet-server}}s](/reference/fleet/secure-connections.md). ## {{agent}} enrollment fails on the host with `x509: cannot validate certificate for x.x.x.x because it doesn't contain any IP SANs` message [es-enrollment-certs] @@ -298,7 +298,7 @@ When creating an issue or sending a support forum communication, this section ca ``` ::::{note} - Both of the above commands are accessible via Windows or macOS with their OS-specific slight variation in how you call them. If needed, please refer to [*Install {{agent}}s*](/reference/ingestion-tools/fleet/install-elastic-agents.md) for examples of how to adjust them. + Both of the above commands are accessible via Windows or macOS with their OS-specific slight variation in how you call them. If needed, please refer to [*Install {{agent}}s*](/reference/fleet/install-elastic-agents.md) for examples of how to adjust them. :::: @@ -431,7 +431,7 @@ For information on where to find agent logs, refer to our [FAQ](frequently-asked ## {{agent}} is stuck in status `Updating` [fleet-agent-stuck-on-updating] -Beginning in {{stack}} version 8.11, a stuck {{agent}} upgrade should be detected automatically, and you can [restart the upgrade](/reference/ingestion-tools/fleet/upgrade-elastic-agent.md#restart-upgrade-single) from {{fleet}}. +Beginning in {{stack}} version 8.11, a stuck {{agent}} upgrade should be detected automatically, and you can [restart the upgrade](/reference/fleet/upgrade-elastic-agent.md#restart-upgrade-single) from {{fleet}}. ## {{fleet-server}} is running and healthy with data, but other Agents cannot use it to connect to {{es}} [secondary-agent-not-connecting] @@ -469,7 +469,7 @@ If you’re running {{agent}} in the foreground (and not as a service) on Linux If you’re using the {{elastic-defend}} integration, make sure you’re running {{agent}} under the SYSTEM account. ::::{tip} -If you install {{agent}} as a service as described in [*Install {{agent}}s*](/reference/ingestion-tools/fleet/install-elastic-agents.md), {{agent}} runs under the SYSTEM account by default. +If you install {{agent}} as a service as described in [*Install {{agent}}s*](/reference/fleet/install-elastic-agents.md), {{agent}} runs under the SYSTEM account by default. :::: @@ -489,11 +489,11 @@ To run {{agent}} under the SYSTEM account, you can do the following: If you try to upgrade an integration policy that is several versions old, there may be substantial conflicts or configuration issues. Rather than trying to fix these problems, it might be faster to create a new policy, test it, and roll out the integration upgrade to additional hosts. -After [upgrading the integration](/reference/ingestion-tools/fleet/upgrade-integration.md): +After [upgrading the integration](/reference/fleet/upgrade-integration.md): -1. [Create a new policy](/reference/ingestion-tools/fleet/agent-policy.md#create-a-policy). -2. [Add the integration to the policy](/reference/ingestion-tools/fleet/agent-policy.md#add-integration). The newer version is automatically used. -3. [Apply the policy](/reference/ingestion-tools/fleet/agent-policy.md#apply-a-policy) to an {{agent}}. +1. [Create a new policy](/reference/fleet/agent-policy.md#create-a-policy). +2. [Add the integration to the policy](/reference/fleet/agent-policy.md#add-integration). The newer version is automatically used. +3. [Apply the policy](/reference/fleet/agent-policy.md#apply-a-policy) to an {{agent}}. ::::{tip} In larger deployments, you should test integration upgrades on a sample {{agent}} before rolling out a larger upgrade initiative. Only after a small trial is deemed successful should the updated policy be rolled out all hosts. @@ -507,7 +507,7 @@ After [upgrading the integration](/reference/ingestion-tools/fleet/upgrade-integ 4. Repeat this process for each policy with the out-of-date integration. ::::{note} - In some instances, for example, when there are hundreds or thousands of different {{agent}}s and policies that need to be updated, this upgrade path is not feasible. In this case, update one policy and use the [Copy a policy](/reference/ingestion-tools/fleet/agent-policy.md#copy-policy) action to apply the updated policy versions to additional policies. This method’s downside is losing the granularity of assessing the individual Integration version changes individually across policies. + In some instances, for example, when there are hundreds or thousands of different {{agent}}s and policies that need to be updated, this upgrade path is not feasible. In this case, update one policy and use the [Copy a policy](/reference/fleet/agent-policy.md#copy-policy) action to apply the updated policy versions to additional policies. This method’s downside is losing the granularity of assessing the individual Integration version changes individually across policies. :::: @@ -713,7 +713,7 @@ To resolve the problem, allocate additional memory to the agent and then restart ## Error when running {{agent}} commands with `sudo` [agent-sudo-error] -On Linux systems, when you install {{agent}} [without administrative privileges](/reference/ingestion-tools/fleet/elastic-agent-unprivileged.md), that is, using the `--unprivileged` flag, {{agent}} commands should not be run with `sudo`. Doing so may result in an error due to the agent not having the required privileges. +On Linux systems, when you install {{agent}} [without administrative privileges](/reference/fleet/elastic-agent-unprivileged.md), that is, using the `--unprivileged` flag, {{agent}} commands should not be run with `sudo`. Doing so may result in an error due to the agent not having the required privileges. For example, when you run {{agent}} with the `--unprivileged` flag, running the `elastic-agent inspect` command will result in an error like the following: @@ -749,7 +749,7 @@ The previous command generates a local file named `elastic_agent_installation_co * {{agent}} Standalone deployed as a `DaemonSet` * [Kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) deployed as a `Deployment` -The content of this file is equivalent to what you’d obtain by following the [Run {{agent}} Standalone on Kubernetes](/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md) steps, with the exception that `kube-state-metrics` is not included in the standalone method. +The content of this file is equivalent to what you’d obtain by following the [Run {{agent}} Standalone on Kubernetes](/reference/fleet/running-on-kubernetes-standalone.md) steps, with the exception that `kube-state-metrics` is not included in the standalone method. **Possible issues** @@ -803,9 +803,9 @@ If the installation is correct and all resources are deployed, but data is not f * Missing cluster-level metrics (provided by `kube-state-metrics`): - As described in [Run {{agent}} Standalone on Kubernetes](/reference/ingestion-tools/fleet/running-on-kubernetes-standalone.md), the {{agent}} Pod acting as `leader` is responsible for retrieving cluster-level metrics from `kube-state-metrics` and delivering them to [data streams](../../../manage-data/data-store/data-streams.md) prefixed as `metrics-kubernetes.state_`. In order to troubleshoot a situation where these metrics are not appearing: + As described in [Run {{agent}} Standalone on Kubernetes](/reference/fleet/running-on-kubernetes-standalone.md), the {{agent}} Pod acting as `leader` is responsible for retrieving cluster-level metrics from `kube-state-metrics` and delivering them to [data streams](../../../manage-data/data-store/data-streams.md) prefixed as `metrics-kubernetes.state_`. In order to troubleshoot a situation where these metrics are not appearing: - 1. Determine which Pod owns the [leadership](/reference/ingestion-tools/fleet/kubernetes_leaderelection-provider.md) `lease` in the cluster, with: + 1. Determine which Pod owns the [leadership](/reference/fleet/kubernetes_leaderelection-provider.md) `lease` in the cluster, with: ```sh kubectl get lease -n kube-system elastic-agent-cluster-leader @@ -831,7 +831,7 @@ If the installation is correct and all resources are deployed, but data is not f * Performance problems: - Monitor the CPU and Memory usage of the agents Pods and adjust the manifest requests and limits as needed. Refer to [Scaling {{agent}} on {{k8s}}](/reference/ingestion-tools/fleet/scaling-on-kubernetes.md) for more details about the needed resources. + Monitor the CPU and Memory usage of the agents Pods and adjust the manifest requests and limits as needed. Refer to [Scaling {{agent}} on {{k8s}}](/reference/fleet/scaling-on-kubernetes.md) for more details about the needed resources. Extra resources for {{agent}} on Kubernetes troubleshooting and information: diff --git a/troubleshoot/ingest/fleet/frequently-asked-questions.md b/troubleshoot/ingest/fleet/frequently-asked-questions.md index 85cc6d37cd..1624d85e43 100644 --- a/troubleshoot/ingest/fleet/frequently-asked-questions.md +++ b/troubleshoot/ingest/fleet/frequently-asked-questions.md @@ -27,7 +27,7 @@ Also read [Troubleshoot common problems](common-problems.md). ## Why doesn’t my enrolled agent show up in the {{fleet}} app? [enrolled-agent-not-showing-up] -If {{agent}} was successfully enrolled, but doesn’t show up in the **Agents** list, it might not be started. Make sure the `elastic-agent` process is running on the host. If it’s not running, use the [`run`](/reference/ingestion-tools/fleet/agent-command-reference.md#elastic-agent-run-command) command to start it. The most common way to deploy an {{agent}} is by using the `install` command. This command starts the {{agent}} for you. +If {{agent}} was successfully enrolled, but doesn’t show up in the **Agents** list, it might not be started. Make sure the `elastic-agent` process is running on the host. If it’s not running, use the [`run`](/reference/fleet/agent-command-reference.md#elastic-agent-run-command) command to start it. The most common way to deploy an {{agent}} is by using the `install` command. This command starts the {{agent}} for you. ## Where does {{agent}} store logs after startup? [where-are-the-agent-logs] @@ -42,12 +42,12 @@ You’ll find logs for the {{beats}} shippers, such as {{metricbeat}}, under pat If the log path does not exist, {{agent}} was unable to start {{metricbeat}}, which is a higher level problem to triage. Usually you can see these logs in the {{fleet}} UI, unless there are problems severe enough that the {{agent}} or its related processes cannot send data to {{es}}. -See [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md) to find out the exact paths for each platform. +See [Installation layout](/reference/fleet/installation-layout.md) to find out the exact paths for each platform. ## What policy is the {{agent}} running? [what-is-my-agent-config] -To find the policy file, inspect the `elastic-agent.yml` file in the directory where {{agent}} is running. Not sure where the agent is running? See [Installation layout](/reference/ingestion-tools/fleet/installation-layout.md). +To find the policy file, inspect the `elastic-agent.yml` file in the directory where {{agent}} is running. Not sure where the agent is running? See [Installation layout](/reference/fleet/installation-layout.md). If the agent is running in {{fleet}} mode, this file contains the following citation: @@ -102,7 +102,7 @@ If {{metricbeat}} is able to send data to {{es}}, there is possibly a bug or pro ## How do I restore an {{agent}} that I deleted from {{fleet}}? [i-deleted-my-agent] -It’s okay, we’ve got your back! The data is still in {{es}}. To add {{agent}} to {{fleet}} again, [Stop {{agent}}](/reference/ingestion-tools/fleet/start-stop-elastic-agent.md#stop-elastic-agent-service), re-enroll it on the host, then run {{agent}}. +It’s okay, we’ve got your back! The data is still in {{es}}. To add {{agent}} to {{fleet}} again, [Stop {{agent}}](/reference/fleet/start-stop-elastic-agent.md#stop-elastic-agent-service), re-enroll it on the host, then run {{agent}}. ## How do I restart {{agent}} after rebooting my host? [i-rebooted-my-host] @@ -124,13 +124,13 @@ elastic-agent restart {{agent}} does not download integration packages. When you add an integration in {{fleet}}, {{kib}} connects to the {{package-registry}} at `epr.elastic.co`, downloads the integration package, and stores its assets in {{es}}. This means that you no longer have to run a manual setup command to load integrations as you did previously with {{beats}} modules. -By default, {{kib}} requires an internet connection to download integration packages from the {{package-registry}}. If network restrictions prevent {{kib}} from reaching the public {{package-registry}}, you can use a proxy server or host your own {{package-registry}}. To learn more, refer to [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +By default, {{kib}} requires an internet connection to download integration packages from the {{package-registry}}. If network restrictions prevent {{kib}} from reaching the public {{package-registry}}, you can use a proxy server or host your own {{package-registry}}. To learn more, refer to [Air-gapped environments](/reference/fleet/air-gapped.md). ## Does {{agent}} download anything from the Internet? [does-agent-download-anything-from-internet] * In version 7.10 and later, a fully capable artifact can be installed with no connection to the Elastic download site. However, if it is in use, the {{elastic-defend}} process is instructed to attempt to download newer released versions of the integration-specific artifacts it uses. Some of those are, for example, the malware model, trusted applications artifact, exceptions list artifact, and others. {{elastic-endpoint}} will continue to protect the host even if it’s unable to download updates. However, it won’t receive updates to protections until {{agent}} is upgraded to a new version. For more information, refer to the [{{elastic-sec}} documentation](/solutions/security.md). -* {{agent}} requires internet access to download artifacts for binary upgrades. In air-gapped environments, you can host your own artifact registry. For more information, refer to [Air-gapped environments](/reference/ingestion-tools/fleet/air-gapped.md). +* {{agent}} requires internet access to download artifacts for binary upgrades. In air-gapped environments, you can host your own artifact registry. For more information, refer to [Air-gapped environments](/reference/fleet/air-gapped.md). ## Do I need to set up the {{beats}} managed by {{agent}}? [do-i-need-to-setup-elastic-agent] @@ -162,7 +162,7 @@ The policy generated by {{fleet}} already contains the correct {{es}} address an ## If I delete an integration dashboard asset from {{kib}}, how do I get it back? [how-do-i-reinstall-a-missing-dashboard-asset] -To reinstall the assets for a specific integration, you can use the {{fleet}} UI. For more information, see [Reinstall integration assets](/reference/ingestion-tools/fleet/install-uninstall-integration-assets.md#reinstall-integration-assets). +To reinstall the assets for a specific integration, you can use the {{fleet}} UI. For more information, see [Reinstall integration assets](/reference/fleet/install-uninstall-integration-assets.md#reinstall-integration-assets). Alternatively, you can use the {{fleet}} API using the package name and version. This needs to be run against the {{kib}} API and not the {{es}} API to be successful. To reinstall package assets, execute the following call with the `force` parameter in the body: diff --git a/troubleshoot/observability/apm/common-problems.md b/troubleshoot/observability/apm/common-problems.md index f5d7fa5dbd..562d04bdc0 100644 --- a/troubleshoot/observability/apm/common-problems.md +++ b/troubleshoot/observability/apm/common-problems.md @@ -41,7 +41,7 @@ If no data shows up in {{es}}, first make sure that your APM components are prop ::::::{tab-item} Fleet-managed **Is {{agent}} healthy?** -In {{kib}} open **{{fleet}}** and find the host that is running the APM integration; confirm that its status is **Healthy**. If it isn’t, check the {{agent}} logs to diagnose potential causes. See [Monitor {{agent}}s](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) to learn more. +In {{kib}} open **{{fleet}}** and find the host that is running the APM integration; confirm that its status is **Healthy**. If it isn’t, check the {{agent}} logs to diagnose potential causes. See [Monitor {{agent}}s](/reference/fleet/monitor-elastic-agent.md) to learn more. **Is APM Server happy?** diff --git a/troubleshoot/observability/apm/enable-apm-server-binary-debugging.md b/troubleshoot/observability/apm/enable-apm-server-binary-debugging.md index 97b0394f70..79c238e3dc 100644 --- a/troubleshoot/observability/apm/enable-apm-server-binary-debugging.md +++ b/troubleshoot/observability/apm/enable-apm-server-binary-debugging.md @@ -12,7 +12,7 @@ applies_to: ::::{note} -Fleet-managed users should see [View {{agent}} logs](/reference/ingestion-tools/fleet/monitor-elastic-agent.md) to learn how to view logs and change the logging level of {{agent}}. +Fleet-managed users should see [View {{agent}} logs](/reference/fleet/monitor-elastic-agent.md) to learn how to view logs and change the logging level of {{agent}}. :::: diff --git a/troubleshoot/observability/troubleshoot-logs.md b/troubleshoot/observability/troubleshoot-logs.md index f8e6ff2aea..b1b3bcaba1 100644 --- a/troubleshoot/observability/troubleshoot-logs.md +++ b/troubleshoot/observability/troubleshoot-logs.md @@ -164,7 +164,7 @@ If the **Waiting for Logs to be shipped…​** step never completes, logs are n #### Solution [logs-troubleshooting-wait-for-logs-solution] -Inspect the {{agent}} logs for errors. See the [Debug standalone {{agent}}s](/reference/ingestion-tools/fleet/debug-standalone-agents.md#inspect-standalone-agent-logs) documentation for more on finding errors in {{agent}} logs. +Inspect the {{agent}} logs for errors. See the [Debug standalone {{agent}}s](/reference/fleet/debug-standalone-agents.md#inspect-standalone-agent-logs) documentation for more on finding errors in {{agent}} logs. ## Mapping and pipeline issues [logs-common-mapping-troubleshooting] diff --git a/troubleshoot/observability/troubleshooting-infrastructure-monitoring/understanding-no-results-found-message.md b/troubleshoot/observability/troubleshooting-infrastructure-monitoring/understanding-no-results-found-message.md index f2c48393f2..07a8b1f0f3 100644 --- a/troubleshoot/observability/troubleshooting-infrastructure-monitoring/understanding-no-results-found-message.md +++ b/troubleshoot/observability/troubleshooting-infrastructure-monitoring/understanding-no-results-found-message.md @@ -34,7 +34,7 @@ This could be for any of these reasons: Follow our OpenTelemetry quickstart under **Observability** → **Add data** to make sure OpenTelemetry data is correctly mapped to ECS-compliant fields. :::: -* You have explicitly chosen not to send these metrics. You may choose to limit the metrics sent to Elastic to save on space and improve cluster performance. For example, the System integration has options to choose which metrics you want to send. You can [edit the integration policy](/reference/ingestion-tools/fleet/edit-delete-integration-policy.md) to begin collecting the missing metrics. For example: +* You have explicitly chosen not to send these metrics. You may choose to limit the metrics sent to Elastic to save on space and improve cluster performance. For example, the System integration has options to choose which metrics you want to send. You can [edit the integration policy](/reference/fleet/edit-delete-integration-policy.md) to begin collecting the missing metrics. For example: :::{image} /troubleshoot/images/observability-turn-on-system-metrics.png :alt: Screenshot showing system cpu and diskio metrics selected for collection