|
| 1 | +[role="xpack"] |
| 2 | +[[epm]] |
| 3 | +== Elastic Package Manager |
| 4 | + |
| 5 | +These are the docs for the Elastic Package Manager (EPM). |
| 6 | + |
| 7 | + |
| 8 | +=== Configuration |
| 9 | + |
| 10 | +The Elastic Package Manager by default access `epr.elastic.co` to retrieve the package. The url can be configured with: |
| 11 | + |
| 12 | +``` |
| 13 | +xpack.epm.registryUrl: 'http://localhost:8080' |
| 14 | +``` |
| 15 | + |
| 16 | +=== API |
| 17 | + |
| 18 | +The Package Manager offers an API. Here an example on how they can be used. |
| 19 | + |
| 20 | +List installed packages: |
| 21 | + |
| 22 | +``` |
| 23 | +curl localhost:5601/api/ingest_manager/epm/packages |
| 24 | +``` |
| 25 | + |
| 26 | +Install a package: |
| 27 | + |
| 28 | +``` |
| 29 | +curl -X POST localhost:5601/api/ingest_manager/epm/packages/iptables-1.0.4 |
| 30 | +``` |
| 31 | + |
| 32 | +Delete a package: |
| 33 | + |
| 34 | +``` |
| 35 | +curl -X DELETE localhost:5601/api/ingest_manager/epm/packages/iptables-1.0.4 |
| 36 | +``` |
| 37 | + |
| 38 | +=== Definitions |
| 39 | + |
| 40 | +This section is to define terms used across ingest management. |
| 41 | + |
| 42 | +==== Elastic Agent |
| 43 | +A single, unified agent that users can deploy to hosts or containers. It controls which data is collected from the host or containers and where the data is sent. It will run Beats, Endpoint or other monitoring programs as needed. It can operate standalone or pull a configuration policy from Fleet. |
| 44 | + |
| 45 | +==== Namespace |
| 46 | +A user-specified string that will be used to part of the index name in Elasticsearch. It helps users identify logs coming from a specific environment (like prod or test), an application, or other identifiers. |
| 47 | + |
| 48 | +==== Package |
| 49 | + |
| 50 | +A package contains all the assets for the Elastic Stack. A more detailed definition of a package can be found under https://github.com/elastic/package-registry . |
| 51 | + |
| 52 | + |
| 53 | +== Indexing Strategy |
| 54 | + |
| 55 | +Ingest Management enforces an indexing strategy to allow the system to automically detect indices and run queries on it. In short the indexing strategy looks as following: |
| 56 | + |
| 57 | +``` |
| 58 | +{type}-{dataset}-{namespace} |
| 59 | +``` |
| 60 | + |
| 61 | +The `{type}` can be `logs` or `metrics`. The `{namespace}` is the part where the user can use free form. The only two requirement are that it has only characters allowed in an Elasticsearch index name and does NOT contain a `-`. The `dataset` is defined by the data that is indexed. The same requirements as for the namespace apply. It is expected that the fields for type, namespace and dataset are part of each event and are constant keywords. |
| 62 | + |
| 63 | +Note: More `{type}`s might be added in the future like `apm` and `endpoint`. |
| 64 | + |
| 65 | +This indexing strategy has a few advantages: |
| 66 | + |
| 67 | +* Each index contains only the fields which are relevant for the dataset. This leads to more dense indices and better field completion. |
| 68 | +* ILM policies can be applied per namespace per dataset. |
| 69 | +* Rollups can be specified per namespace per dataset. |
| 70 | +* Having the namespace user configurable makes setting security permissions possible. |
| 71 | +* Having a global metrics and logs template, allows to create new indices on demand which still follow the convention. This is common in the case of k8s as an example. |
| 72 | +* Constant keywords allow to narrow down the indices we need to access for querying very efficiently. This is especially relevant in environments which a large number of indices or with indices on slower nodes. |
| 73 | + |
| 74 | +=== Ingest Pipeline |
| 75 | + |
| 76 | +The ingest pipelines for a specific dataset will have the following naming scheme: |
| 77 | + |
| 78 | +``` |
| 79 | +{type}-{dataset}-{package.version} |
| 80 | +``` |
| 81 | + |
| 82 | +As an example, the ingest pipeline for the Nginx access logs is called `logs-nginx.access-3.4.1`. The same ingest pipeline is used for all namespaces. It is possible that a dataset has multiple ingest pipelines in which case a suffix is added to the name. |
| 83 | + |
| 84 | +The version is included in each pipeline to allow upgrades. The pipeline itself is listed in the index template and is automatically applied at ingest time. |
| 85 | + |
| 86 | +=== Templates & ILM Policies |
| 87 | + |
| 88 | +To make the above strategy possible, alias templates are required. For each type there is a basic alias template with a default ILM policy. These default templates apply to all indices which follow the indexing strategy and do not have a more specific dataset alias template. |
| 89 | + |
| 90 | +The `metrics` and `logs` alias template contain all the basic fields from ECS. |
| 91 | + |
| 92 | +Each type template contains an ILM policy. Modifying this default ILM policy will affect all data covered by the default templates. |
| 93 | + |
| 94 | +The templates for a dataset are called as following: |
| 95 | + |
| 96 | +``` |
| 97 | +{type}-{dataset} |
| 98 | +``` |
| 99 | + |
| 100 | +The pattern used inside the index template is `{type}-{dataset}-*` to match all namespaces. |
| 101 | + |
| 102 | +=== Defaults |
| 103 | + |
| 104 | +If the Elastic Agent is used to ingest data and only the type is specified, `default` for the namespace is used and `generic` for the dataset. |
| 105 | + |
| 106 | +=== Data filtering |
| 107 | + |
| 108 | +Filtering for data in queries for example in visualizations or dashboards should always be done on the constant keyword fields. Visualizations needing data for the nginx.access dataset should query on `type:logs AND dataset:nginx.access`. As these are constant keywords the prefiltering is very efficient. |
| 109 | + |
| 110 | +=== Security permissions |
| 111 | + |
| 112 | +Security permissions can be set on different levels. To set special permissions for the access on the prod namespace an index pattern as below can be used: |
| 113 | + |
| 114 | +``` |
| 115 | +/(logs|metrics)-[^-]+-prod-$/ |
| 116 | +``` |
| 117 | + |
| 118 | +To set specific permissions on the logs index, the following can be used: |
| 119 | + |
| 120 | +``` |
| 121 | +/^(logs|metrics)-.*/ |
| 122 | +``` |
| 123 | + |
| 124 | +Todo: The above queries need to be tested. |
| 125 | + |
| 126 | + |
| 127 | + |
| 128 | +== Package Manager |
| 129 | + |
| 130 | +=== Package Upgrades |
| 131 | + |
| 132 | +When upgrading a package between a bugfix or a minor version, no breaking changes should happen. Upgrading a package has the following effect: |
| 133 | + |
| 134 | +* Removal of existing dashboards |
| 135 | +* Installation of new dashboards |
| 136 | +* Write new ingest pipelines with the version |
| 137 | +* Write new Elasticsearch alias templates |
| 138 | +* Trigger a rollover for all the affected indices |
| 139 | + |
| 140 | +The new ingest pipeline is expected to still work with the data coming from older configurations. In most cases this means some of the fields can be missing. For this to work, each event must contain the version of config / package it is coming from to make such a decision. |
| 141 | + |
| 142 | +In case of a breaking change in the data structure, the new ingest pipeline is also expected to deal with this change. In case there are breaking changes which cannot be dealt with in an ingest pipeline, a new package has to be created. |
| 143 | + |
| 144 | +Each package lists its minimal required agent version. In case there are agents enrolled with an older version, the user is notified to upgrade these agents as otherwise the new configs cannot be rolled out. |
| 145 | + |
| 146 | + |
0 commit comments