-
Notifications
You must be signed in to change notification settings - Fork 156
Adding screenshots to certain equivalent steps #3251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
f38bb62
753df18
707b379
f11edbe
535bc1e
4de0d58
465139e
4530d8a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,7 +33,26 @@ For more information, refer to [Check lifecycle progress](/manage-data/lifecycle | |
|
||
## Create an ingest pipeline to transform your general content [manage-general-content-with-data-streams-ingest] | ||
|
||
Create an ingest pipeline that uses the [`set` enrich processor](elasticsearch://reference/enrich-processor/set-processor.md) to add a `@timestamp` field: | ||
You can create an ingest pipeline that uses the [`set` enrich processor](elasticsearch://reference/enrich-processor/set-processor.md) to add a `@timestamp` field. Follow these steps in Kibana or using the [create or update a pipeline](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-pipeline) API. | ||
|
||
::::{tab-set} | ||
:group: kibana-api | ||
:::{tab-item} {{kib}} | ||
:sync: kibana | ||
To add an ingest pipeline in {{kib}}, go to **Stack Management > Ingest Pipelines**, and then select **Create pipeline > New pipeline**. | ||
|
||
Configure the pipeline with a name, description, and a **Set** processor that adds the `@timestamp` field with a value of `{{_ingest.timestamp}}`. | ||
|
||
:::{image} /manage-data/images/elasticsearch-reference-tutorial-ilm-general-content-ingest.png | ||
:alt: Create ingest pipeline | ||
:screenshot: | ||
::: | ||
|
||
::: | ||
|
||
:::{tab-item} API | ||
:sync: api | ||
Use the API to add an ingest pipeline: | ||
|
||
```console | ||
PUT _ingest/pipeline/ingest_time_1 | ||
|
@@ -48,11 +67,38 @@ PUT _ingest/pipeline/ingest_time_1 | |
}] | ||
} | ||
``` | ||
::: | ||
:::: | ||
|
||
## Create a lifecycle policy [manage-general-content-with-data-streams-policy] | ||
|
||
In this example, the policy is configured to roll over when the shard size reaches 10 GB: | ||
A lifecycle policy specifies the phases in the index lifecycle and the actions to perform in each phase. A lifecycle can have up to five phases: `hot`, `warm`, `cold`, `frozen`, and `delete`. | ||
|
||
For example, you might define a policy named `indextods` that is configured to roll over when the shard size reaches 10 GB. | ||
|
||
You can create the policy in {{kib}} or with the [create or update policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle) API. | ||
|
||
::::{tab-set} | ||
:group: kibana-api | ||
:::{tab-item} {{kib}} | ||
:sync: kibana | ||
To create the policy in {{kib}}, open the menu and go to **Stack Management > Index Lifecycle Policies**. Click **Create policy**. | ||
|
||
In the **Hot phase**, by default, an ILM-managed index [rolls over](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-rollover.md) when either: | ||
* It reaches 30 days of age. | ||
* One or more primary shards reach 50 GB in size. | ||
|
||
Disable **Use recommended defaults** to adjust these values and roll over when the primary shard reaches 10GB. | ||
|
||
:::{image} /manage-data/images/elasticsearch-reference-tutorial-ilm-rollover-general-content-create-policy.png | ||
:alt: Create policy page | ||
:screenshot: | ||
::: | ||
::: | ||
|
||
:::{tab-item} API | ||
:sync: api | ||
Use the API to create a lifecyle policy: | ||
```console | ||
PUT _ilm/policy/indextods | ||
{ | ||
|
@@ -73,13 +119,84 @@ PUT _ilm/policy/indextods | |
} | ||
} | ||
``` | ||
::: | ||
:::: | ||
|
||
For more information about lifecycle phases and available actions, check [Create a lifecycle policy](configure-lifecycle-policy.md#ilm-create-policy). | ||
For more information about lifecycle phases and available actions, refer to [Create a lifecycle policy](configure-lifecycle-policy.md#ilm-create-policy). | ||
|
||
|
||
## Create an index template to apply the ingest pipeline and lifecycle policy [manage-general-content-with-data-streams-template] | ||
|
||
Create an index template that uses the created ingest pipeline and lifecycle policy: | ||
To use the created lifecycle policy, you configure an index template that uses it. | ||
When creating the index template, specify the following details: | ||
* the name of the lifecycle policy, which in our example is `indextods` | ||
* the ingest pipeline that enriches the data by adding the `@timestamp` field, which in our example is `ingest_time_1` | ||
* that the template is data stream enabled by including the `data_stream` definition | ||
* the index pattern, which ensures that this template will be applied to matching indices and in our example is `movetods` | ||
|
||
You can create the template in {{kib}} or with the [create or update index template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) API. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @kilfoyle -- I've made a few more changes here since you've last reviewed this and added the steps to create a template in Kibana for this specific tutorial example. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looks great! I checked the new section and had just the one comment below. So nice to have all the UI steps now! |
||
|
||
::::{tab-set} | ||
:group: kibana-api | ||
:::{tab-item} {{kib}} | ||
:sync: kibana | ||
To create an index template in Kibana, complete these steps: | ||
|
||
1. Go to **Stack Management > Index Management**. In the **Index Templates** tab, select **Create template**. | ||
|
||
 | ||
|
||
1. On the **Logistics** page: | ||
1. Specify the name of the template. For example `index_to_dot`. | ||
1. Specify a pattern to match the indices you want to manage with the lifecycle policy. For example, `movetodos`. | ||
1. Turn on the **Create data streams** toggle. | ||
1. Set the [index mode](elasticsearch://reference/elasticsearch/index-settings/time-series.md) to **Standard**. | ||
1. Optional: On the **Component templates** page, use the search and filter tools to select any [component templates](/manage-data/data-store/templates.md#component-templates) to include in the index template. The index template will inherit the settings, mappings, and aliases defined in the component templates and apply them to indices when they're created. | ||
|
||
1. On the **Index settings** page, specify the lifecycle policy and ingest pipeline you want to use. For example, `indextods` and `ingest_time_1`: | ||
|
||
```json | ||
{ | ||
"lifecycle": { | ||
"name": "indextods" | ||
}, | ||
"default_pipeline": "ingest_time_1" | ||
} | ||
``` | ||
|
||
1. On the **Mappings** page, customize the fields and data types used when documents are indexed into {{es}}. For example, select **Load JSON** and include these mappings: | ||
|
||
```json | ||
{ | ||
"_source": { | ||
"excludes": [], | ||
"includes": [], | ||
"enabled": true | ||
}, | ||
"_routing": { | ||
"required": false | ||
}, | ||
"dynamic": true, | ||
"numeric_detection": false, | ||
"date_detection": true, | ||
"dynamic_date_formats": [ | ||
"strict_date_optional_time", | ||
"yyyy/MM/dd HH:mm:ss Z||yyyy/MM/dd Z" | ||
] | ||
} | ||
``` | ||
|
||
1. On the **Review** page, confirm your selections. You can check your selected options, as well as both the format of the index template that will be created and the associated API request. | ||
|
||
The newly created index template will be used for all new indices with names that match the specified pattern, and for each of these, the specified ILM policy will be applied. | ||
|
||
For more information about configuring templates in Kibana, refer to [Manage index templates](/manage-data/data-store/index-basics.md#index-management-manage-index-templates). | ||
::: | ||
|
||
:::{tab-item} API | ||
:sync: api | ||
|
||
Use the [create index template API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) to create an index template that specifies the created ingest pipeline and lifecycle policy: | ||
|
||
```console | ||
PUT _index_template/index_to_dot | ||
|
@@ -120,6 +237,10 @@ PUT _index_template/index_to_dot | |
} | ||
} | ||
``` | ||
::: | ||
:::: | ||
|
||
|
||
|
||
## Create a data stream [manage-general-content-with-data-streams-create-stream] | ||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.