Skip to content

Commit f786d8b

Browse files
authored
Merge branch 'main' into inge4pres-patch-1
2 parents 00f69db + 4ea6db0 commit f786d8b

File tree

535 files changed

+5620
-2463
lines changed

Some content is hidden

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

535 files changed

+5620
-2463
lines changed

.github/CODEOWNERS

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
/deploy-manage/ @elastic/admin-docs
1212
/explore-analyze/ @elastic/core-docs @elastic/experience-docs
1313
/extend/ @elastic/core-docs
14-
/get-started/ @elastic/core-docs
14+
/get-started/ @elastic/core-docs @elastic/project-docs
1515

1616
/manage-data/ @elastic/admin-docs
1717
/manage-data/data-store/ @elastic/admin-docs @elastic/developer-docs
@@ -35,7 +35,7 @@
3535
/release-notes/ @elastic/docs
3636

3737
/release-notes/apm-agents/ @elastic/ingest-docs
38-
/release-notes/elastic-cloud-serverless/ @elastic/admin-docs
38+
/release-notes/elastic-cloud-serverless/ @elastic/admin-docs @elastic/docs-serverless-release-team
3939
/release-notes/elastic-observability/ @elastic/ski-docs
4040
/release-notes/elastic-security/ @elastic/ski-docs
4141
/release-notes/elasticsearch-clients/ @elastic/developer-docs
@@ -44,9 +44,11 @@
4444

4545
/solutions/ @elastic/experience-docs @elastic/developer-docs
4646
/solutions/observability/ @elastic/experience-docs
47-
/solutions/observability/get-started/ @elastic/ski-docs
47+
/solutions/observability/get-started/ @elastic/ski-docs @elastic/project-docs
4848
/solutions/search/ @elastic/developer-docs
49+
/solutions/search/get-started/ @elastic/developer-docs @elastic/project-docs
4950
/solutions/security/ @elastic/experience-docs
51+
/solutions/security/get-started @elastic/experience-docs @elastic/project-docs
5052

5153
/troubleshoot/ @elastic/docs
5254
/troubleshoot/deployments/ @elastic/admin-docs
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Update Kube-Stack Version
2+
3+
on:
4+
schedule:
5+
# Run every Monday at 9:00 AM UTC
6+
- cron: '0 9 * * 1'
7+
workflow_dispatch: # Allow manual triggering
8+
9+
jobs:
10+
update-kube-stack-version:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
with:
17+
token: ${{ secrets.GITHUB_TOKEN }}
18+
19+
- name: Set up Python
20+
uses: actions/setup-python@v4
21+
with:
22+
python-version: '3.9'
23+
24+
- name: Run kube-stack version update script
25+
run: |
26+
cd scripts
27+
python update_kube_stack_version.py
28+
29+
- name: Check for changes
30+
id: verify-changed-files
31+
run: |
32+
if [ -n "$(git status --porcelain)" ]; then
33+
echo "changed=true" >> $GITHUB_OUTPUT
34+
else
35+
echo "changed=false" >> $GITHUB_OUTPUT
36+
fi
37+
38+
- name: Commit and push changes
39+
if: steps.verify-changed-files.outputs.changed == 'true'
40+
run: |
41+
git config --local user.email "[email protected]"
42+
git config --local user.name "GitHub Action"
43+
git add docs/docset.yml
44+
git commit -m "chore: update kube-stack version [skip ci]"
45+
git push
46+
47+
- name: Create Pull Request
48+
if: steps.verify-changed-files.outputs.changed == 'true'
49+
uses: peter-evans/create-pull-request@v5
50+
with:
51+
token: ${{ secrets.GITHUB_TOKEN }}
52+
commit-message: "chore: update kube-stack version"
53+
title: "chore: update kube-stack version"
54+
body: |
55+
This PR automatically updates the kube-stack version in `docs/docset.yml` based on the latest version from the elastic-agent repository.
56+
57+
**Changes:**
58+
- Updated kube-stack version in docset.yml
59+
60+
This PR was created automatically by the weekly kube-stack version update workflow.
61+
branch: update-kube-stack-version
62+
delete-branch: true
63+
labels: |
64+
automated
65+
documentation

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
.artifacts
33
.DS_store
44

5+
# Jetbrains files
6+
.idea
7+
*.iml
8+
59
# Add LLM/AI related files
610
AGENTS.md
711
.github/copilot-instructions.md

deploy-manage/api-keys.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ applies_to:
66
ece: ga
77
self: ga
88
serverless: ga
9+
navigation_title: API keys
910
---
1011

11-
# API keys
12+
# Elastic API keys
1213

1314
API keys are security mechanisms used to authenticate and authorize access to your deployments and {{es}} resources.
1415

deploy-manage/autoscaling/trained-model-autoscaling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ In case of ingest-optimized deployments, we maximize the number of model allocat
133133
| Level | Allocations | Threads | VCUs |
134134
| --- | --- | --- | --- |
135135
| Low | 0 to 2 dynamically | 1 | 0 to 16 dynamically |
136-
| Medium | 1 to 32 dynamically | 1 | 8 to 256 dynamically |
137-
| High | 1 to 512 for Search<br> 1 to 128 for Security and Observability<br> | 1 | 8 to 4096 for Search<br> 8 to 1024 for Security and Observability<br> |
136+
| Medium | 0 to 32 dynamically | 1 | 8 to 256 dynamically |
137+
| High | 0 to 512 for Search<br> 1 to 128 for Security and Observability<br> | 1 | 8 to 4096 for Search<br> 8 to 1024 for Security and Observability<br> |
138138

139139
:::
140140

deploy-manage/deploy/cloud-enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ In ECE, a deployment is a managed {{stack}} environment that provides users with
4444

4545
The section covers the following tasks:
4646

47-
* [Deploy ECE orchestrator](./cloud-enterprise/deploy-an-orchestrator.md)
47+
* [Deploy an ECE orchestrator](./cloud-enterprise/deploy-an-orchestrator.md)
4848
- [Prepare the environment](./cloud-enterprise/prepare-environment.md)
4949
- [Install ECE](./cloud-enterprise/install.md)
5050
- [Air gapped installations](./cloud-enterprise/air-gapped-install.md)

deploy-manage/deploy/cloud-enterprise/access-kibana.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
navigation_title: Access {{kib}}
23
mapped_pages:
34
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-access-kibana.html
45
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html
@@ -9,7 +10,7 @@ products:
910
- id: cloud-enterprise
1011
---
1112

12-
# Access {{kib}} [ece-access-kibana]
13+
# Access {{kib}} on {{ece}} [ece-access-kibana]
1314

1415
{{kib}} is an open source analytics and visualization platform designed to search, view, and interact with data stored in {{es}} indices.
1516

deploy-manage/deploy/cloud-enterprise/add-plugins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
navigation_title: Configure plugins and extensions
2+
navigation_title: Add plugins and extensions
33
applies_to:
44
deployment:
55
ece:
66
---
77

8-
# Add plugins and extensions [ece-adding-plugins]
8+
# Add plugins and extensions in {{ece}} [ece-adding-plugins]
99

1010
Plugins extend the core functionality of {{es}}. {{ece}} makes it easy to add plugins to your deployment by providing a number of plugins that work with your version of {{es}}. One advantage of these plugins is that you generally don’t have to worry about upgrading plugins when upgrading to a new {{es}} version, unless there are breaking changes. The plugins are upgraded along with the rest of your deployment.
1111

deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
applies_to:
33
deployment:
44
ece: all
5+
navigation_title: Deploy an orchestrator
56
---
6-
# Deploy an orchestrator
7+
# Deploy an {{ece}} orchestrator
78

89
{{ece}} (ECE) provides a centralized platform that allows organizations to run {{es}}, {{kib}}, and other {{stack}} components across multiple machines, whether in a private or public cloud, virtual machines, or your own premises.
910

deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -13,54 +13,60 @@ products:
1313

1414
If you create a deployment template that includes more than one data configuration, you must also specify how {{ece}} should manage indices for your users when they create their deployments. For time-series use cases such as logging, metrics, and APM, providing a template that enables index management ensures that data is being stored in the most cost-effective way possible as it ages.
1515

16-
In a template that creates a hot-warm architecture, you can use index curation to specify where new indices are created initially and where they are moved to later on. However, index curation has been deprecated in favor of index lifecycle management, which offers additional features and more fine-grained control over indices. For instance, using ILM you can enable automatic roll-over of index aliases to new indices when existing indices become too large or too old, and you can set indices to be deleted when they are no longer useful.
16+
Configuring index management is part of the larger task of [creating deployment templates](ece-configuring-ece-create-templates.md) or editing them. The choices you make here determine which index management methods are available to your users when they create deployments.
1717

18+
You should configure all index management methods that you want your users to be able to choose from when they create their deployments from your template. You can configure index curation, index lifecycle management, or both.
1819

19-
## Before you begin [ece_before_you_begin_4]
2020

21-
Configuring index management is part of the larger task of [creating deployment templates](ece-configuring-ece-create-templates.md) or editing them. The choices you make here determine which index management methods are available to your users when they create deployments.
21+
## Available index management strategies
2222

23-
You should configure all index management methods that you want your users to be able to choose from when they create their deployments from your template. You can configure index curation, index lifecycle management, or both.
23+
Index lifecycle management
24+
: Uses the [{{ilm}}](/manage-data/lifecycle/index-lifecycle-management.md) feature of the {{stack}} that provides an integrated and streamlined way to manage time-based data, making it easier to follow best practices for managing your indices. Compared to index curation, ILM gives you more fine-grained control over the lifecycle of each index.
2425

25-
::::{note}
26-
Index curation has been deprecated in favor of [index lifecycle management](/manage-data/lifecycle/index-lifecycle-management.md). For {{stack}} version 6.7 and later, any deployments using index curation will be prompted to [migrate to ILM](/manage-data/lifecycle/index-lifecycle-management/migrate-index-management.md).
27-
::::
26+
Index curation (Curator) {applies_to}`stack: deprecated 6.7`
27+
: Creates new indices on hot nodes first and moves them to warm nodes later on, based on the data views (formerly *index patterns*) you specify. Also manages replica counts for you, so that all shards of an index can fit on the right data nodes. Compared to index lifecycle management, index curation for time-based indices supports only one action, to move indices from nodes on one data configuration to another, but it is more straightforward to set up initially and all setup can be done directly from the Cloud UI.
28+
29+
If your users need to delete indices once they are no longer useful to them, they can run [Curator](curator://reference/index.md) on-premise to manage indices for {{es}} clusters hosted on {{ece}}.
2830

29-
## Steps [ece_steps_2]
31+
::::{note}
32+
Index curation has been deprecated in favor of [index lifecycle management](/manage-data/lifecycle/index-lifecycle-management.md). For {{stack}} version 6.7 and later, any deployments using index curation will be prompted to [migrate to ILM](/manage-data/lifecycle/index-lifecycle-management/migrate-index-management.md).
33+
::::
3034

31-
To configure index management when you create a deployment template:
3235

33-
1. On the **Index Management** page, configure the index curation methods that you want to be available when your users create deployments:
36+
## Configure {{ilm}}
3437

35-
Index lifecycle management
36-
: Uses the ILM feature of the {{stack}} that provides an integrated and streamlined way to manage time-based data, making it easier to follow best practices for managing your indices. Compared to index curation, ILM gives you more fine-grained control over the lifecycle of each index.
38+
To configure {{ilm}} as part of your deployment template:
3739

38-
To configure index lifecycle management:
40+
On the **Index Management** page, under **{{ilm}} ({{ilm-init}})**, specify the node attributes for your data configurations.
3941

40-
1. Specify the node attributes for your data configurations.
42+
Node attributes are simple key-value pairs, such as `node_type: hot`, `node_type: warm`, and `node_type: cold`. These node attributes add defining metadata attributes to each data configuration in your template that tell your users what they can be used for. What you define here should help guide your users when they set up their index lifecycle management policy in {{kib}}, such as a hot-warm policy.
4143

42-
Node attributes are simple key-value pairs, such as `node_type: hot`, `node_type: warm`, and `node_type: cold`. These node attributes add defining metadata attributes to each data configuration in your template that tell your users what they can be used for. What you define here should help guide your users when they set up their index lifecycle management policy in {{kib}}, such as a hot-warm policy.
44+
For each data tier, specify an attribute key-value pair in the **Node attributes** field, with the key and value separated by a colon. Repeat this process until you have added all the node attributes that you want to be available to your users when they create an index lifecycle policy later on.
4345

44-
1. Specify an attribute key-value pair in the **Node attributes** field, with the key and value separated by a colon.
45-
2. Repeat the previous step until you have added all the node attributes that you want to be available to your users when they create an index lifecycle policy later on.
46+
## Configure index curation
47+
```{applies_to}
48+
stack: deprecated 6.7
49+
```
4650

51+
::::{note}
52+
Index curation has been deprecated in favor of [index lifecycle management](/manage-data/lifecycle/index-lifecycle-management.md). For {{stack}} version 6.7 and later, any deployments using index curation will be prompted to [migrate to ILM](/manage-data/lifecycle/index-lifecycle-management/migrate-index-management.md).
53+
::::
4754

48-
Index curation
49-
: Creates new indices on hot nodes first and moves them to warm nodes later on, based on the data views (formerly *index patterns*) you specify. Also manages replica counts for you, so that all shards of an index can fit on the right data nodes. Compared to index lifecycle management, index curation for time-based indices supports only one action, to move indices from nodes on one data configuration to another, but it is more straightforward to set up initially and all setup can be done directly from the Cloud UI.
55+
To configure index curation as part of your deployment template:
5056

51-
If your user need to delete indices once they are no longer useful to them, they can run [Curator](curator://reference/index.md) on-premise to manage indices for {{es}} clusters hosted on {{ece}}.
57+
1. On the **Index Management** page, under **Index curation**, click **Configure**.
5258

53-
To configure index curation:
59+
2. Configure index curation by adding an index pattern:
5460

55-
1. Select the hot data configuration where new indices get created initially.
56-
2. Select the warm nodes where older indices get moved to later on when they get curated.
57-
3. Specify which indices get curated by including at least one data view.
61+
1. Select the hot data configuration where new indices get created initially.
62+
2. Select the warm nodes where older indices get moved to later on when they get curated.
63+
3. Specify which indices get curated by including at least one index pattern.
5864

59-
By default, the pattern is `*`, which means that all indices get curated. For logging use cases, you could specify to curate only the `logstash-*`, `metricbeat-*`, or `filebeat-*` data views, for example.
65+
By default, the pattern is `*`, which means that all indices get curated. For logging use cases, you could specify to curate only the `logstash-*`, `metricbeat-*`, or `filebeat-*` data views, for example.
6066

61-
4. Specify the time interval after which indices get curated.
67+
4. Specify the time interval after which indices get curated.
6268

63-
2. Select **Next**.
69+
## Next steps
6470

6571
After you have completed these steps, continue with [creating your deployment template](ece-configuring-ece-create-templates.md#ece-configuring-ece-create-templates-ui).
6672

0 commit comments

Comments
 (0)