Skip to content

Commit 0baf603

Browse files
authored
Merge branch 'main' into ingest-arch-landing
2 parents 56a8308 + fc64617 commit 0baf603

File tree

98 files changed

+740
-1066
lines changed

Some content is hidden

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

98 files changed

+740
-1066
lines changed

.github/workflows/docs-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
uses: elastic/docs-builder/.github/workflows/preview-build.yml@main
1212
with:
1313
continue-on-error: false
14-
strict: false
14+
strict: true
1515
permissions:
1616
deployments: write
1717
id-token: write

deploy-manage/cloud-organization/billing/manage-subscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To change your subscription level:
3939

4040
### Feature usage notifications [ec_feature_usage_notifications]
4141

42-
:::{applies}
42+
:::{applies_to}
4343
:hosted: all
4444
:::
4545

deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ You can add new Elastic Stack packs to your installation through the Cloud UI, t
348348

349349
To add a new Elastic Stack pack from the Cloud UI:
350350

351-
1. Download the [Elastic Stack version]() that you want.
351+
1. Download the Elastic Stack version that you want.
352352
2. [Log into the Cloud UI](log-into-cloud-ui.md).
353353
3. From the **Platform** menu, select **Elastic Stack**.
354354
4. Select **Upload Elastic Stack pack**.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ spec:
9292
* `xpack.fleet.agents.elasticsearch.hosts` must point to the {{es}} cluster where {{agents}} should send data. For ECK-managed {{es}} clusters ECK creates a Service accessible through `https://ES_RESOURCE_NAME-es-http.ES_RESOURCE_NAMESPACE.svc:9200` URL, where `ES_RESOURCE_NAME` is the name of {{es}} resource and `ES_RESOURCE_NAMESPACE` is the namespace it was deployed within. See [Storing local state in host path volume](configuration-examples-standalone.md#k8s_storing_local_state_in_host_path_volume) for details on adjusting this field when running agent as non-root as it becomes required.
9393
* `xpack.fleet.agents.fleet_server.hosts` must point to {{fleet-server}} that {{agents}} should connect to. For ECK-managed {{fleet-server}} instances, ECK creates a Service accessible through `https://FS_RESOURCE_NAME-agent-http.FS_RESOURCE_NAMESPACE.svc:8220` URL, where `FS_RESOURCE_NAME` is the name of {{agent}} resource with {{fleet-server}} enabled and `FS_RESOURCE_NAMESPACE` is the namespace it was deployed in.
9494
* `xpack.fleet.packages` are required packages to enable {{fleet-server}} and {{agents}} to enroll.
95-
* `xpack.fleet.agentPolicies` policies are needed for {{fleet-server}} and {{agents}} to enroll to, check {{fleet-guide}}/agent-policy.html for more information.
95+
* `xpack.fleet.agentPolicies` policies are needed for {{fleet-server}} and {{agents}} to enroll to, check https://www.elastic.co/guide/en/fleet/current/agent-policy.html for more information.
9696

9797

9898
## Set referenced resources [k8s-elastic-agent-fleet-configuration-setting-referenced-resources]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ mapped_pages:
77

88
# Logstash plugins [k8s-logstash-plugins]
99

10-
The power of {{ls}} is in the plugins--{{logstash-ref}}/input-plugins.html[inputs], [outputs](https://www.elastic.co/guide/en/logstash/current/output-plugins.html), [filters,](https://www.elastic.co/guide/en/logstash/current/filter-plugins.html) and [codecs](https://www.elastic.co/guide/en/logstash/current/codec-plugins.html).
10+
The power of {{ls}} is in the plugins--[inputs](https://www.elastic.co/guide/en/logstash/current/input-plugins.html), [outputs](https://www.elastic.co/guide/en/logstash/current/output-plugins.html), [filters,](https://www.elastic.co/guide/en/logstash/current/filter-plugins.html) and [codecs](https://www.elastic.co/guide/en/logstash/current/codec-plugins.html).
1111

1212
In {{ls}} on ECK, you can use the same plugins that you use for other {{ls}} instances—​including Elastic-supported, community-supported, and custom plugins. However, you may have other factors to consider, such as how you configure your {{k8s}} resources, how you specify additional resources, and how you scale your {{ls}} installation.
1313

deploy-manage/deploy/elastic-cloud/manage-integrations-server.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ The APM secret token can no longer be reset from the Elasticsearch Service UI. C
2828

2929
This example demonstrates how to use the Elasticsearch Service RESTful API to create a deployment with Integrations Server enabled.
3030

31-
For more information on how to manage Integrations Server from the UI, check [Manage your Integrations Server]()
32-
3331

3432
#### Requirements [ec_requirements_2]
3533

deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-bootstrap-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ By default each node will automatically bootstrap itself into a single-node clus
7474
* `discovery.seed_hosts`
7575
* `cluster.initial_master_nodes`
7676

77-
To add a new node into an existing cluster, configure `discovery.seed_hosts` or other relevant discovery settings so that the new node can discover the existing master-eligible nodes in the cluster. To bootstrap a new multi-node cluster, configure `cluster.initial_master_nodes` as described in the [section on cluster bootstrapping]() as well as `discovery.seed_hosts` or other relevant discovery settings.
77+
To add a new node into an existing cluster, configure `discovery.seed_hosts` or other relevant discovery settings so that the new node can discover the existing master-eligible nodes in the cluster. To bootstrap a new multi-node cluster, configure `cluster.initial_master_nodes` as described in the section on cluster bootstrapping as well as `discovery.seed_hosts` or other relevant discovery settings.
7878

7979
::::{admonition} Forming a single cluster
8080
:name: modules-discovery-bootstrap-cluster-joining

deploy-manage/maintenance.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html
4+
applies_to:
5+
deployment:
6+
ess:
7+
ece:
8+
self:
49
---
510

6-
# Maintenance [ece-manage-kibana]
11+
# Maintenance [maintenance]
712

8-
Kibana is an open source analytics and visualization platform designed to work with Elasticsearch, that makes it easy to perform advanced data analysis and to visualize your data in a variety of charts, tables, and maps. Its simple, browser-based interface enables you to quickly create and share dynamic dashboards that display changes to Elasticsearch queries in real time.
13+
This section outlines the key tasks and processes required to maintain a healthy, performant, and secure {{es}} infrastructure and its deployments.
914

10-
Most deployment templates include a Kibana instance, but if it wasn’t part of the initial deployment you can go to the **Kibana** page and **Enable** Kibana.
11-
12-
The new Kibana instance takes a few moments to provision. After provisioning Kibana is complete, you can use the endpoint URL to access Kibana.
13-
14-
::::{tip}
15-
You can log into Kibana as the `elastic` superuser. The password was provided when you created your deployment or can be [reset](users-roles/cluster-or-deployment-auth/built-in-users.md). On AWS and not able to access Kibana? [Check if you need to update your endpoint URL first](../troubleshoot/deployments/cloud-enterprise/common-issues.md#ece-aws-private-ip).
16-
::::
17-
18-
19-
From the deployment **Kibana** page you can also:
20-
21-
* Terminate your Kibana instance, which stops it. The information is stored in your Elasticsearch cluster, so stopping and restarting should not risk your Kibana information.
22-
* Restart it after stopping.
23-
* Upgrade your Kibana instance version if it is out of sync with your Elasticsearch cluster.
24-
* Delete to fully remove the instance, wipe it from the disk, and stop charges.
15+
The topics covered include:
2516

17+
* **[ECE Maintenance](maintenance/ece.md)**: Explains the procedures for maintaining both the host infrastructure and {{es}} deployments within Elastic Cloud Enterprise (ECE).
18+
* **[Start and Stop services](maintenance/start-stop-services.md)**: Provides step-by-step instructions on how to safely start and stop your {{es}} deployment or {{kib}} instance, particularly when performing actions that require a restart.
19+
* **[Add and remove {{es}} nodes](maintenance/add-and-remove-elasticsearch-nodes.md)**: Guides you through the process of enrolling new nodes or safely removing existing ones from a self-managed {{es}} cluster to optimize resource utilization and cluster performance.

deploy-manage/maintenance/add-and-remove-elasticsearch-nodes.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html
4+
applies_to:
5+
deployment:
6+
self:
47
---
58

69
# Add and Remove Elasticsearch nodes [add-elasticsearch-nodes]
@@ -21,17 +24,25 @@ When you add more nodes to a cluster, it automatically allocates replica shards.
2124
:alt: A cluster with three nodes
2225
:::
2326

24-
2527
## Enroll nodes in an existing cluster [_enroll_nodes_in_an_existing_cluster_5]
2628

29+
::::{tip}
30+
Refer to the following pages to learn more about how to add nodes to your cluster in different environments:
31+
32+
* [autoscaling](../autoscaling.md)
33+
* [{{ece}}](../deploy/cloud-enterprise/resize-deployment.md)
34+
* [{{ech}}](../deploy/elastic-cloud/configure.md)
35+
* [{{eck}}](../deploy/cloud-on-k8s/update-deployments.md)
36+
37+
::::
38+
2739
You can enroll additional nodes on your local machine to experiment with how an {{es}} cluster with multiple nodes behaves.
2840

2941
::::{note}
3042
To add a node to a cluster running on multiple machines, you must also set [`discovery.seed_hosts`](../deploy/self-managed/important-settings-configuration.md#unicast.hosts) so that the new node can discover the rest of its cluster.
3143

3244
::::
3345

34-
3546
When {{es}} starts for the first time, the security auto-configuration process binds the HTTP layer to `0.0.0.0`, but only binds the transport layer to localhost. This intended behavior ensures that you can start a single-node cluster with security enabled by default without any additional configuration.
3647

3748
Before enrolling a new node, additional actions such as binding to an address other than `localhost` or satisfying bootstrap checks are typically necessary in production clusters. During that time, an auto-generated enrollment token could expire, which is why enrollment tokens aren’t generated automatically.
@@ -64,21 +75,18 @@ To enroll new nodes in your cluster, create an enrollment token with the `elasti
6475

6576
For more information about discovery and shard allocation, refer to [*Discovery and cluster formation*](../distributed-architecture/discovery-cluster-formation.md) and [Cluster-level shard allocation and routing settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html).
6677

67-
6878
## Master-eligible nodes [add-elasticsearch-nodes-master-eligible]
6979

7080
As nodes are added or removed Elasticsearch maintains an optimal level of fault tolerance by automatically updating the cluster’s *voting configuration*, which is the set of [master-eligible nodes](../distributed-architecture/clusters-nodes-shards/node-roles.md#master-node-role) whose responses are counted when making decisions such as electing a new master or committing a new cluster state.
7181

7282
It is recommended to have a small and fixed number of master-eligible nodes in a cluster, and to scale the cluster up and down by adding and removing master-ineligible nodes only. However there are situations in which it may be desirable to add or remove some master-eligible nodes to or from a cluster.
7383

74-
7584
### Adding master-eligible nodes [modules-discovery-adding-nodes]
7685

7786
If you wish to add some nodes to your cluster, simply configure the new nodes to find the existing cluster and start them up. Elasticsearch adds the new nodes to the voting configuration if it is appropriate to do so.
7887

7988
During master election or when joining an existing formed cluster, a node sends a join request to the master in order to be officially added to the cluster.
8089

81-
8290
### Removing master-eligible nodes [modules-discovery-removing-nodes]
8391

8492
When removing master-eligible nodes, it is important not to remove too many all at the same time. For instance, if there are currently seven master-eligible nodes and you wish to reduce this to three, it is not possible simply to stop four of the nodes at once: to do so would leave only three nodes remaining, which is less than half of the voting configuration, which means the cluster cannot take any further actions.
@@ -108,7 +116,6 @@ Although the voting configuration exclusions API is most useful for down-scaling
108116
Voting exclusions are only required when removing at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes, nor are they required when removing fewer than half of the master-eligible nodes.
109117
::::
110118

111-
112119
Adding an exclusion for a node creates an entry for that node in the voting configuration exclusions list, which has the system automatically try to reconfigure the voting configuration to remove that node and prevents it from returning to the voting configuration once it has removed. The current list of exclusions is stored in the cluster state and can be inspected as follows:
113120

114121
```console
@@ -129,4 +136,3 @@ DELETE /_cluster/voting_config_exclusions
129136
# to return to the voting configuration in the future.
130137
DELETE /_cluster/voting_config_exclusions?wait_for_removal=false
131138
```
132-

deploy-manage/maintenance/ece.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1+
---
2+
applies_to:
3+
deployment:
4+
ece:
5+
---
6+
17
# ECE maintenance
28

3-
% What needs to be done: Write from scratch
9+
Elastic Cloud Enterprise (ECE), being a self-managed Elastic Stack deployment platform, abstracts much of the complexity of running {{es}}, but still requires regular maintenance at both the platform and deployment levels. Maintenance activities range from managing individual deployments to performing infrastructure-level updates on ECE hosts.
10+
11+
## Deployment maintenance and host infrastructure maintenance [ece-deployment-host-infra-maintenance]
412

5-
% GitHub issue: https://github.com/elastic/docs-projects/issues/353
13+
[Deployment maintenance](ece/deployments-maintenance.md) focuses on managing individual {{es}} and {{kib}} instances within ECE. This includes actions such as [pausing instances](ece/pause-instance.md), [stopping request routing to nodes](ece/start-stop-routing-requests.md), and [moving instances between allocators](ece/move-nodes-instances-from-allocators.md) to optimize resource usage or prepare for maintenance. These tasks help maintain service availability and performance without affecting the underlying infrastructure.
614

7-
% Scope notes: Introduction about ECE maintenance and activities / actions. Explain the difference between deployments maintenance and ECE hosts infrastructure maintenance.
15+
[ECE host infrastructure maintenance](ece/perform-ece-hosts-maintenance.md) involves managing virtual machines that host ECE itself. This includes tasks like applying operating system patches, upgrading software, or decommissioning hosts. Infrastructure maintenance often requires more careful planning, as it can impact multiple deployments running on the affected hosts. Methods such as placing allocators into [maintenance mode](ece/enable-maintenance-mode.md) and redistributing workloads provide a smooth transition during maintenance operations.
816

9-
⚠️ **This page is a work in progress.** ⚠️
17+
This section provides guidance on best practices for both types of maintenance, helping you maintain a resilient ECE environment.

0 commit comments

Comments
 (0)