Skip to content

Commit a7a009d

Browse files
authored
Merge branch 'main' into mw-ts-toc-cleanup
2 parents e1130fb + 8abc8fe commit a7a009d

File tree

245 files changed

+12768
-12950
lines changed

Some content is hidden

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

245 files changed

+12768
-12950
lines changed

.github/workflows/docs-deploy.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

deploy-manage/tools/snapshot-and-restore.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ mapped_urls:
66
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-snapshot-restore.html
77
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-restoring-snapshots.html
88
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-snapshots.html
9+
10+
applies:
11+
stack: all
12+
hosted: all
13+
ece: all
14+
eck: all
15+
916
---
1017

1118
# Snapshot and restore
Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,75 @@
1+
---
2+
3+
applies:
4+
stack: all
5+
hosted: all
6+
ece: all
7+
eck: all
8+
9+
---
10+
111
# Manage snapshot repositories
212

313
% What needs to be done: Write from scratch
414

515
% GitHub issue: https://github.com/elastic/docs-projects/issues/343
616

7-
% Scope notes: Landing page for this containing links for Cloud and ECE
17+
% Scope notes: Landing page for this containing links for Cloud and ECE
18+
19+
Snapshot repositories allow you to back up and restore your Elasticsearch data efficiently. Whether you're using [{{ech}}](#elastic-cloud-hosted), [{{ece}} (ECE)](#elastic-cloud-enterprise-ece), [{{eck}} (ECK)](#elastic-cloud-on-kubernetes-eck), or managing your own [{{es}} cluster](#self-managed), configuring a snapshot repository ensures data security, long-term archiving, and seamless migration across environments.
20+
21+
## Supported repository types
22+
23+
### Self-managed
24+
25+
If you manage your own Elasticsearch cluster, you can use the following built-in snapshot repository types:
26+
27+
* [Azure](/deploy-manage/tools/snapshot-and-restore/azure-repository.md)
28+
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository.md)
29+
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/s3-repository.md)
30+
* [Shared file system](/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository.md)
31+
* [Read-only URL](/deploy-manage/tools/snapshot-and-restore/read-only-url-repository.md)
32+
* [Source-only](/deploy-manage/tools/snapshot-and-restore/source-only-repository.md)
33+
34+
Other repository types are available through official plugins:
35+
36+
* [Hadoop Distributed File System (HDFS)](https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html)
37+
38+
### Elastic Cloud Hosted
39+
40+
{{ech}} deployments automatically register a repository named `found-snapshots` in {{es}} clusters. These repositories are used together with the `cloud-snapshot-policy` SLM policy to take periodic snapshots of your {{es}} clusters. You can also use the `found-snapshots` repository for your own [SLM policies](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md#automate-snapshots-slm) or to store searchable snapshots.
41+
42+
The `found-snapshots` repository is specific to each deployment. However, you can restore snapshots from another deployment’s found-snapshots repository if the deployments are under the same account and in the same region.
43+
44+
Elastic Cloud Hosted deployments also support the following repository types:
45+
46+
* [Azure](/deploy-manage/tools/snapshot-and-restore/ec-azure-snapshotting.md)
47+
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/ec-gcs-snapshotting.md)
48+
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/ec-aws-custom-repository.md)
49+
* [Source-only](/deploy-manage/tools/snapshot-and-restore/source-only-repository.md)
50+
51+
For more details, refer to [Managing snapshot repositories in Elastic Cloud Hosted](/deploy-manage/tools/snapshot-and-restore/elastic-cloud-hosted.md).
52+
53+
### Elastic Cloud Enterprise (ECE)
54+
55+
Snapshot repositories are managed at the platform level in Elastic Cloud Enterprise (ECE) and can be associated with deployments as needed. ECE supports the creation and maintenance of multiple repositories, but each deployment can be linked to only one repository for automatic snapshots.
56+
57+
When a platform-level repository is associated with a deployment, the `found-snapshots` repository is added to the {{es}} cluster, and, similar to Elastic Cloud, a snapshot is taken every 30 minutes by default. The interval can be adjusted on per deployment basis.
58+
59+
Elastic Cloud Enterprise installations support the following Elasticsearch snapshot repository types:
60+
61+
* [Azure](/deploy-manage/tools/snapshot-and-restore/azure-storage-repository.md)
62+
* [Google Cloud Storage](/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-gcs-repository.md)
63+
* [AWS S3](/deploy-manage/tools/snapshot-and-restore/minio-on-premise-repository.md)
64+
65+
:::{note}
66+
No repository types other than those listed are supported in the Elastic Cloud Enterprise platform, even if they are supported by Elasticsearch.
67+
:::
68+
69+
For more details, refer to [Managing snapshot repositories in Elastic Cloud Enterprise](/deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md).
70+
71+
### Elastic Cloud on Kubernetes (ECK)
72+
73+
{{es}} clusters deployed through ECK support the same type of deployments as self-managed {{es}} clusters. ECK does not currently provide any automation or functionality to facilitate the integration of snapshot repositores within the {{es}} clusters.
74+
75+
For more information and examples, refer to [create automated snapshots on ECK](/deploy-manage/tools/snapshot-and-restore/cloud-on-k8s.md).

get-started/stack-components.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

get-started/the-stack.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,72 @@ This section provides an overview of the {{stack}} and its components — includ
1111

1212
$$$kibana-navigation-search$$$
1313

14+
## An overview of the {{stack}} [stack-components]
15+
16+
What exactly is the "{{stack}}"? It’s a fast and highly scalable set of components — {{es}}, {{kib}}, {{beats}}, {{ls}}, and others — that together enable you to securely take data from any source, in any format, and then search, analyze, and visualize it.
17+
18+
You can deploy the {{stack}} as a Cloud service supported on AWS, Google Cloud, and Azure, or as an on-prem installation on your own hardware.
19+
20+
![Components of the Elastic Stack](../images/stack-components-diagram.svg)
21+
22+
### Ingest [_ingest]
23+
24+
Elastic provides a number of components that ingest data. Collect and ship logs, metrics, and other types of data with {{agent}} or {{beats}}. Manage your {{agents}} with {{fleet}}. Collect detailed performance information with Elastic APM.
25+
26+
If you want to transform or enrich data before it’s stored, you can use {{es}} ingest pipelines or {{ls}}.
27+
28+
Trying to decide which ingest component to use? Refer to [Adding data to {{es}}](https://www.elastic.co/guide/en/cloud/current/ec-cloud-ingest-data.html) to help you decide.
29+
30+
$$$stack-components-agent$$$
31+
32+
{{fleet}} and {{agent}}
33+
: {{agent}} is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Each agent has a single policy to which you can add integrations for new data sources, security protections, and more.
34+
35+
{{fleet}} enables you to centrally manage {{agents}} and their policies. Use {{fleet}} to monitor the state of all your {{agents}}, manage agent policies, and upgrade {{agent}} binaries or integrations.
36+
37+
[Learn more about {{fleet}} and {{agent}}](https://www.elastic.co/guide/en/fleet/current/fleet-overview.html).
38+
39+
40+
$$$stack-components-apm$$$
41+
42+
APM
43+
: Elastic APM is an application performance monitoring system built on the {{stack}}. It allows you to monitor software services and applications in real-time, by collecting detailed performance information on response time for incoming requests, database queries, calls to caches, external HTTP requests, and more. This makes it easy to pinpoint and fix performance problems quickly. [Learn more about APM](/solutions/observability/apps/application-performance-monitoring-apm.md).
44+
45+
$$$stack-components-beats$$$
46+
47+
{{beats}}
48+
: {{beats}} are data shippers that you install as agents on your servers to send operational data to {{es}}. {{beats}} are available for many standard observability data scenarios, including audit data, log files and journals, cloud data, availability, metrics, network traffic, and Windows event logs. [Learn more about {{beats}}](https://www.elastic.co/guide/en/beats/libbeat/current/beats-reference.html).
49+
50+
$$$stack-components-ingest-pipelines$$$
51+
52+
{{es}} ingest pipelines
53+
: Ingest pipelines let you perform common transformations on your data before indexing them into {{es}}. You can configure one or more "processor" tasks to run sequentially, making specific changes to your documents before storing them in {{es}}. [Learn more about ingest pipelines](https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html).
54+
55+
$$$stack-components-logstash$$$
56+
57+
{{ls}}
58+
: {{ls}} is a data collection engine with real-time pipelining capabilities. It can dynamically unify data from disparate sources and normalize the data into destinations of your choice. {{ls}} supports a broad array of input, filter, and output plugins, with many native codecs further simplifying the ingestion process. [Learn more about {{ls}}](https://www.elastic.co/guide/en/logstash/current/introduction.html).
59+
60+
61+
### Store [_store]
62+
63+
$$$stack-components-elasticsearch$$$
64+
65+
{{es}}
66+
: {{es}} is the distributed search and analytics engine at the heart of the {{stack}}. It provides near real-time search and analytics for all types of data. Whether you have structured or unstructured text, numerical data, or geospatial data, {{es}} can efficiently store and index it in a way that supports fast searches. {{es}} provides a REST API that enables you to store data in {{es}} and retrieve it. The REST API also provides access to {{es}}'s search and analytics capabilities. [Learn more about {{es}}](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html).
67+
68+
69+
### Consume [_consume]
70+
71+
Use {{kib}} to query and visualize the data that’s stored in {{es}}. Or, use the {{es}} clients to access data in {{es}} directly from common programming languages.
72+
73+
$$$stack-components-kibana$$$
74+
75+
{{kib}}
76+
: {{kib}} is the tool to harness your {{es}} data and to manage the {{stack}}. Use it to analyze and visualize the data that’s stored in {{es}}. {{kib}} is also the home for the Elastic Enterprise Search, Elastic Observability and Elastic Security solutions. [Learn more about {{kib}}](https://www.elastic.co/guide/en/kibana/current/introduction.html).
77+
78+
$$$stack-components-elasticsearch-clients$$$
79+
80+
{{es}} clients
81+
: The clients provide a convenient mechanism to manage API requests and responses to and from {{es}} from popular languages such as Java, Ruby, Go, Python, and others. Both official and community contributed clients are available. [Learn more about the {{es}} clients](https://www.elastic.co/guide/en/elasticsearch/client/index.html).
82+

get-started/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ toc:
33
- file: index.md
44
- file: the-stack.md
55
children:
6-
- file: stack-components.md
76
- file: introduction.md
87
- file: installing-elastic-stack.md
98
- file: deployment-options.md

0 commit comments

Comments
 (0)