Skip to content

Commit 03a022b

Browse files
authored
Merge branch 'main' into lucabelluccini-patch-1
2 parents 5bb4ca5 + 4b5e99d commit 03a022b

File tree

9 files changed

+113
-29
lines changed

9 files changed

+113
-29
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thank you for contributing to the Elastic Docs! 🎉
3+
Use this template to help us efficiently review your contribution.
4+
-->
5+
6+
## Summary
7+
<!--
8+
Describe what your PR changes or improves.
9+
If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change.
10+
-->
11+
12+
## Generative AI disclosure
13+
<!--
14+
To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following:
15+
-->
16+
1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
17+
- [ ] Yes
18+
- [ ] No
19+
<!--
20+
2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).
21+
22+
Tool(s) and model(s) used:
23+
-->
24+

.github/workflows/vale-linting.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Vale Documentation Linting
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '**.md'
7+
- '**.adoc'
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
vale:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v5
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Run Vale Linter
22+
uses: elastic/vale-rules/lint@main
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Vale Report
2+
3+
on:
4+
workflow_run:
5+
workflows: ["Vale Documentation Linting"]
6+
types:
7+
- completed
8+
9+
permissions:
10+
pull-requests: read
11+
12+
jobs:
13+
report:
14+
runs-on: ubuntu-latest
15+
if: github.event.workflow_run.event == 'pull_request'
16+
permissions:
17+
pull-requests: write
18+
19+
steps:
20+
- name: Post Vale Results
21+
uses: elastic/vale-rules/report@main
22+
with:
23+
github_token: ${{ secrets.GITHUB_TOKEN }}

contribute-docs/api-docs/kibana-api-docs-quickstart.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ responses:
202202
:sync: code-generated
203203
204204
:::{note}
205-
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues. See [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh) for the full list of paths captured in CI.
205+
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues.
206206
:::
207207
208208
This step captures the OpenAPI specification that {{kib}} generates at runtime from your route definitions. It spins up a local {{es}} and {{kib}} cluster with your code changes. This generates the following output files in the `oas_docs` directory:
@@ -214,13 +214,27 @@ This step captures the OpenAPI specification that {{kib}} generates at runtime f
214214
- [Docker](https://docs.docker.com/get-docker/) must be running
215215
- If you're an Elastician, ensure you're logged into Docker with your Elastic account
216216
217-
**Capture all API paths** (recommended):
217+
To capture all the documented API paths, copy the command from [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh). For example:
218218
219219
```bash
220-
node scripts/capture_oas_snapshot --update
220+
node scripts/capture_oas_snapshot \
221+
--include-path /api/status \
222+
--include-path /api/alerting/rule/ \
223+
--include-path /api/alerting/rules \
224+
--include-path /api/actions \
225+
--include-path /api/security/role \
226+
--include-path /api/spaces \
227+
--include-path /api/streams \
228+
--include-path /api/fleet \
229+
--include-path /api/saved_objects/_import \
230+
--include-path /api/saved_objects/_export \
231+
--include-path /api/maintenance_window \
232+
--include-path /api/agent_builder
233+
--update
221234
```
222235
223-
**For faster iteration**, capture the specific paths you're working on:
236+
For faster iteration, you can capture the specific paths you're working on, though this minimized output should not be included in your pull request.
237+
For example:
224238

225239
```bash
226240
node scripts/capture_oas_snapshot --update --include-path /api/your/specific/path

deploy-manage/deploy/deployment-comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For more details about feature availability in Serverless, check [](elastic-clou
1818

1919
| Feature/capability | Self-managed | {{ech}} | Serverless |
2020
|-------------------|-------------|--------------------------------|-------------------------|
21-
| Hosting | Any infrastructure | {{ecloud}} through AWS, Azure, or GCP | {{ecloud}} through AWS or Azure |
21+
| Hosting | Any infrastructure | {{ecloud}} through AWS, Azure, or GCP | {{ecloud}} through AWS, Azure, or GCP |
2222
| Hardware configuration | Full control | Limited control | Managed by Elastic |
2323
| Autoscaling | No | Available | Automatic |
2424
| Data tiers management | Through ILM policies | Available | No data tiers |

deploy-manage/tools/cross-cluster-replication/ccr-getting-started-prerequisites.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ products:
1616

1717
To complete this tutorial, you need:
1818

19-
* The `manage` cluster privilege on the local cluster.
20-
* A license on both clusters that includes {{ccr}}. [Activate a free 30-day trial](../../license/manage-your-license-in-self-managed-cluster.md).
21-
* An index on the remote cluster that contains the data you want to replicate. This tutorial uses the sample eCommerce orders data set. [Load sample data](../../../explore-analyze/index.md#gs-get-data-into-kibana).
22-
* In the local cluster, all nodes with the `master` [node role](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#node-roles) must also have the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. The local cluster must also have at least one node with both a data role and the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. Individual tasks for coordinating replication scale based on the number of data nodes with the `remote_cluster_client` role in the local cluster.
19+
- The `manage` cluster privilege on the local cluster.
20+
- Both clusters must have the same [license](/deploy-manage/license.md) type, and that license must support {{ccr}}.
21+
- [Activate a free 30-day trial](../../license/manage-your-license-in-self-managed-cluster.md).
22+
- An index on the remote cluster that contains the data you want to replicate. This tutorial uses the sample eCommerce orders data set. [Load sample data](../../../explore-analyze/index.md#gs-get-data-into-kibana).
23+
- In the local cluster, all nodes with the `master` [node role](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#node-roles) must also have the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. The local cluster must also have at least one node with both a data role and the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. Individual tasks for coordinating replication scale based on the number of data nodes with the `remote_cluster_client` role in the local cluster.
2324

manage-data/data-store/data-streams/set-up-tsds.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ PUT _ilm/policy/my-weather-sensor-lifecycle-policy
6363
}
6464
}
6565
// Additional phases (warm, cold, delete) as needed
66-
}
6766
}
6867
}
6968
}
@@ -85,10 +84,10 @@ The structure of a time series data stream is defined by an index template. Crea
8584
- To define dimensions dynamically, you can use a pass-through object. For details, refer to [Defining sub-fields as time series dimensions](elasticsearch://reference/elasticsearch/mapping-reference/passthrough.md#passthrough-dimensions).
8685
- **Metrics:** To define a metric, use the `time_series_metric` mapping parameter. For details, refer to [Metrics](/manage-data/data-store/data-streams/time-series-data-stream-tsds.md#time-series-metric).
8786
- **Timestamp** (optional): Define a `date` or `date_nanos` mapping for the `@timestamp` field. If you don't specify a mapping, {{es}} maps `@timestamp` as a `date` field with default options.
88-
- {applies_to}`serverless: unavailable` {applies_to}`stack: ga` **Lifecycle management**: For {{stack}}, include lifecycle settings to enable automatic rollover and prevent indices from growing too large.
89-
- Set `"lifecycle": { "enabled": true }`.
90-
- If you created an ILM policy in [step 1](#tsds-ilm-policy), reference it with `index.lifecycle.name`.
91-
- **Other settings** (optional): Additional index settings, such as [`index.number_of_replicas`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#dynamic-index-number-of-replicas), for the data stream's backing indices.
87+
- {applies_to}`serverless: unavailable` {applies_to}`stack: ga` **Lifecycle management**: If you're using {{stack}}, define a lifecycle to enable automatic rollover and prevent indices from growing too large.
88+
- Add a `lifecycle` object and specify `"enabled": true`.
89+
- If you created an ILM policy in [step 1](#tsds-ilm-policy), reference it in the settings with `index.lifecycle.name`.
90+
- **Settings** (optional): Define any relevant index settings, such as [`index.number_of_replicas`](elasticsearch://reference/elasticsearch/index-settings/index-modules.md#dynamic-index-number-of-replicas), for the data stream's backing indices.
9291
- **Priority:** Set the priority higher than `200` to avoid [collisions](/manage-data/data-store/templates.md#avoid-index-pattern-collisions) with built-in templates.
9392

9493
**Example index template PUT request:**
@@ -101,10 +100,10 @@ PUT _index_template/my-weather-sensor-index-template
101100
"template": {
102101
"settings": {
103102
"index.mode": "time_series",
104-
"index.lifecycle.name": "my-lifecycle-policy", <1>
105-
"lifecycle": {
106-
"enabled": true <2>
107-
}
103+
"index.lifecycle.name": "my-lifecycle-policy" <1>
104+
},
105+
"lifecycle": {
106+
"enabled": true <2>
108107
},
109108
"mappings": {
110109
"properties": {

reference/fleet/data-streams-scenario3.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ metrics-system.network-production@custom
5656
3. Use the template above to set the name—in this case, `metrics-system.network-production@custom`. Click **Next**.
5757
4. Under **Index settings**, set the {{ilm-init}} policy name under the `lifecycle.name` key:
5858

59-
```json
60-
{
61-
"lifecycle": {
62-
"name": "90-days-default"
63-
}
64-
}
65-
```
59+
```json
60+
{
61+
"lifecycle": {
62+
"name": "90-days-default"
63+
}
64+
}
65+
```
6666

6767
5. Continue to **Review** and ensure your request looks similar to the image below. If it does, click **Create component template**.
6868

@@ -78,10 +78,9 @@ metrics-system.network-production@custom
7878
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.
7979

8080
::::{warning}
81-
- If you duplicate an 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 are not propagated to the cloned version when you upgrade versions.
82-
- 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. Check out [Cloning the index template of an integration package](/reference/fleet/integrations-assets-best-practices.md#assets-restrictions-cloning-index-template) for details.
83-
84-
+ 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**, 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), to avoid the problems mentioned earlier. Check out the [ILM](/reference/fleet/data-streams.md#data-streams-ilm) section for details.
81+
* If you duplicate an 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 are not propagated to the cloned version when you upgrade versions.
82+
* 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. Check out [Cloning the index template of an integration package](/reference/fleet/integrations-assets-best-practices.md#assets-restrictions-cloning-index-template) for details.
83+
* If you want to change the ILM policy, the number of shards, or other settings for the data streams of one or more integrations, but **the changes do not need to be specific to a given namespace**, 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), to avoid the problems mentioned earlier. Check out the [ILM](/reference/fleet/data-streams.md#data-streams-ilm) section for details.
8584

8685
::::
8786

solutions/search/agent-builder/limitations-known-issues.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Error: Invalid function call syntax
4040
Error executing agent: No tool calls found in the response.
4141
```
4242

43+
$$$conversation-length-exceeded$$$
44+
4345
### {{esql}} limitations
4446

4547
{{esql}} tools are subject to the current limitations of the {{esql}} language itself. For example, [named parameters](elasticsearch://reference/query-languages/esql/esql-syntax.md#esql-function-named-params) (`?parameter_name`) do not currently work with the `LIKE` and `RLIKE` operators ([issue #131356](https://github.com/elastic/elasticsearch/issues/131356)).

0 commit comments

Comments
 (0)