Skip to content

Commit b122468

Browse files
committed
[DOCS] Add definitions & remove fully-remote storage.
1 parent fef25cc commit b122468

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

docs/reference/glossary.asciidoc

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ An <<glossary-index-pattern,index pattern>> that automatically configures new in
3939
For more information, see {ref}/ccr-auto-follow.html[Managing auto follow patterns].
4040
// end::auto-follow-pattern-def[]
4141

42+
[[glossary-backup-snapshot]] backup snapshot ::
43+
// tag::backup-snapshot-def[]
44+
A snapshot of a cluster, data stream, or index that resides in a remote data store such as S3
45+
and is used for backup and recovery.
46+
// end::backup-snapshot-def[]
47+
4248
[[glossary-cluster]] cluster ::
4349
// tag::cluster-def[]
4450
One or more <<glossary-node,nodes>> that share the
@@ -450,6 +456,12 @@ in the <<glossary-mapping,mapping>>.
450456
// end::routing-def[]
451457
--
452458

459+
[[glossary-searchable-snapshot]] searchable snapshot ::
460+
// tag::searchable-snapshot-def[]
461+
A <<glossary-snapshot, snapshot>> of an index or data stream that resides in a remote data store
462+
such as S3 and can be accessed dynamically at query time.
463+
// end::searchable-snapshot-def[]
464+
453465
[[glossary-shard]] shard ::
454466
+
455467
--
@@ -486,9 +498,13 @@ See the {ref}/indices-shrink-index.html[shrink index API].
486498

487499
[[glossary-snapshot]] snapshot ::
488500
// tag::snapshot-def[]
489-
A backup taken from a running {es} cluster.
490-
A snapshot can include backups of an entire cluster or only data streams and
491-
indices you specify.
501+
Captures the state of a cluster, index, or data stream at a particular point in time.
502+
See <<glossary-backup-snapshot, backup snapshot>> and <<glossary-searchable-snapshot, searchable snapshot>>.
503+
// end::snapshot-def[]
504+
505+
[[glossary-snapshot]] snapshot-backed index ::
506+
// tag::snapshot-def[]
507+
A read-only index that relies on a <<glossary-searchable-snapshot, searchable snapshot>> for redundancy.
492508
// end::snapshot-def[]
493509

494510
[[glossary-snapshot-lifecycle-policy]] snapshot lifecycle policy ::

docs/reference/searchable-snapshots/index.asciidoc

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,22 @@
33

44
{search-snaps-cap} enable you to significantly reduce costs by
55
leveraging external storage for read-only data.
6-
Searchable snapshots can be used in two ways:
6+
Like snapshots used for backup and recovery, a searchable snapshot is a point-in-time copy
7+
of an index or data stream stored in a remote data store such as S3.
78

8-
* Snapshot-backed indices: Instead of maintaining replicas of your data within the cluster,
9-
a snapshot-backed index relies on a searchable snapshot for redundancy.
10-
You can perform all regular data retrieval operations, but cannot write to the index.
9+
Snapshot-backed indices use searchable snapshots for redundancy rather than replicas within the cluster.
10+
They support all regular data retrieval operations with performance comparable to a normal index.
1111
In the event of a failure, data is recovered from the snapshot.
1212
Latency increases during recovery, but you can continue to query your data.
1313

14-
* Fully-remote storage: Data is only brought into the cluster from the snapshot
15-
when it is needed to service a query.
16-
Because of the additional overhead, querying your data takes significantly longer
17-
and it’s only accessible via asynchronous search.
18-
1914
A snapshot-backed index essentially halves the number of nodes you need for read-only data.
20-
If you are using ILM to manage your data, in the cold phase it can
15+
If you are using {ilm-init} to manage your data, in the cold phase it can
2116
automatically create a searchable snapshot, convert your index to a snapshot-backed index,
2217
and move it to nodes in the cold tier.
2318

24-
When you use fully-remote storage, you have access to your data when you need it,
25-
without the expense of maintaining it in the cluster at all.
26-
2719
While searchable snapshots are separate from the snapshots used for backup and recovery,
2820
they are just snapshots. In fact, you can mount any existing snapshot as a snapshot-backed index.
2921
When you use the same repository for both types of snapshots, each snapshot is incremental.
3022
Files are shared among searchable snapshots and backup snapshots to avoid data duplication.
3123
This means that the additional storage costs for using searchable snapshots are negligible.
24+

0 commit comments

Comments
 (0)