Skip to content

Commit 12fb88e

Browse files
authored
Merge branch 'main' into kamilf92-patch-2
2 parents 2074e63 + 0b2d653 commit 12fb88e

File tree

43 files changed

+501
-51
lines changed

Some content is hidden

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

43 files changed

+501
-51
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 }}

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,7 @@ AGENTS.md
1212
.github/instructions/**.instructions.md
1313
CLAUDE.md
1414
GEMINI.md
15-
.cursor
15+
.cursor
16+
17+
# VS code settings
18+
.vscode

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/cloud-enterprise/resize-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To resize a deployment:
3434
::::
3535

3636
RAM per instance
37-
: Node and instance capacity should be sufficient to sustain your search workload, even if you lose an availability zone. Currently, half of the memory is assigned to the JVM heap. For example, on an {{es}} cluster node with 32 GB RAM, 16 GB would be allotted to heap. Up to 64 GB RAM and 1 TB storage per node are supported.
37+
: Node and instance capacity should be sufficient to sustain your search workload, even if you lose an availability zone. For instances up to 64 GB of RAM, half the memory is assigned to the JVM heap. For instances larger than 64 GB, the heap size is capped at 32 GB. For example, on an {{es}} cluster node with 32 GB RAM, 16 GB would be allotted to heap, while on a 128 GB node, 32 GB would be allotted to heap. Up to 256 GB RAM and 1 TB storage per node are supported.
3838

3939
Before finalizing your changes, you can review the **Architecture** summary, which shows the total number of instances per zone, with each circle color representing a different type of instance.
4040

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ ECK is compatible with the following Kubernetes distributions and related techno
7777

7878
:::{tab-item} ECK 3.2
7979
* Kubernetes 1.30-1.34
80-
* OpenShift 4.15-4.19
80+
* OpenShift 4.15-4.20
8181
* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)
8282
* Helm: {{eck_helm_minimum_version}}+
8383
:::

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/deploy/elastic-cloud/ec-customize-deployment-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To change a cluster’s topology, from deployment management, select **Edit depl
3131

3232
For trials, larger sizes are not available until you [add a credit card](../../cloud-organization/billing/add-billing-details.md).
3333

34-
Currently, half the memory is assigned to the JVM heap (a bit less when monitoring is activated). For example, on a 32 GB cluster, 16 GB are allotted to heap. The disk-to-RAM ratio currently is 1:24, meaning that you get 24 GB of storage space for each 1 GB of RAM. All clusters are backed by SSD drives.
34+
For instances up to 64 GB of RAM, half the memory is assigned to the JVM heap (a bit less when monitoring is activated). For instances larger than 64 GB, the heap size is capped at 32 GB. For example, on a 32 GB instance, 16 GB are allotted to heap, while on a 128 GB instance, 32 GB are allotted to heap. Up to 256 GB RAM per instance is supported. The disk-to-RAM ratio currently is 1:24, meaning that you get 24 GB of storage space for each 1 GB of RAM. All clusters are backed by SSD drives.
3535

3636
::::{tip}
3737
For production systems, each {{es}} instance in your cluster should have at least 4 GB of RAM, which assigns 2 GB to the JVM heap. Review [Minimum size recommendations for production use](elastic-cloud-hosted-planning.md#ec-minimum-recommendations) for more details.

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

0 commit comments

Comments
 (0)