Skip to content

Commit

Permalink
Update ILM searchable snapshot copy to refer to fully-mounted indices…
Browse files Browse the repository at this point in the history
… and partially-mounted indices (#98693)

 * Change Searchable snapshot repository label to to Snapshot repository.
  • Loading branch information
cjcenizal committed Apr 30, 2021
1 parent 7cabbb8 commit 6bc8ed8
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 42 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ export const HotPhase: FunctionComponent = () => {
<>
{<ForcemergeField phase={'hot'} />}
<ShrinkField phase={'hot'} />
{license.canUseSearchableSnapshot() && <SearchableSnapshotField phase={'hot'} />}
{license.canUseSearchableSnapshot() && <SearchableSnapshotField phase="hot" />}
<ReadonlyField phase={'hot'} />
</>
)}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,31 +25,60 @@ export interface Props {
canBeDisabled?: boolean;
}

const geti18nTexts = (phase: Props['phase']) => ({
title: i18n.translate('xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotFieldTitle', {
defaultMessage: 'Searchable snapshot',
}),
description:
phase === 'frozen' ? (
<FormattedMessage
id="xpack.indexLifecycleMgmt.editPolicy.frozenPhase.searchableSnapshotFieldDescription"
defaultMessage="Take a snapshot of your data and mount it as a searchable snapshot. To reduce costs, only a cache of the snapshot is mounted in the frozen tier. {learnMoreLink}"
values={{
learnMoreLink: (
<LearnMoreLink docPath="searchable-snapshots.html#searchable-snapshots-shared-cache" />
),
}}
/>
) : (
<FormattedMessage
id="xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotFieldDescription"
defaultMessage="Take a snapshot of your data and mount it as a searchable snapshot. {learnMoreLink}"
values={{
learnMoreLink: <LearnMoreLink docPath="ilm-searchable-snapshot.html" />,
}}
/>
),
});
const geti18nTexts = (phase: Props['phase']) => {
switch (phase) {
// Hot and cold phases both create fully mounted snapshots.
case 'hot':
case 'cold':
return {
title: i18n.translate(
'xpack.indexLifecycleMgmt.editPolicy.fullyMountedSearchableSnapshotField.title',
{
defaultMessage: 'Searchable snapshot',
}
),
description: (
<FormattedMessage
id="xpack.indexLifecycleMgmt.editPolicy.fullyMountedSearchableSnapshotField.description"
defaultMessage="Convert to a fully-mounted index that contains a complete copy of your data and is backed by a snapshot. You can reduce the number of replicas and rely on the snapshot for resiliency. {learnMoreLink}"
values={{
learnMoreLink: <LearnMoreLink docPath="ilm-searchable-snapshot.html" />,
}}
/>
),
toggleLabel: i18n.translate(
'xpack.indexLifecycleMgmt.editPolicy.fullyMountedSearchableSnapshotField.toggleLabel',
{ defaultMessage: 'Convert to fully-mounted index' }
),
};

// Frozen phase creates a partially mounted snapshot.
case 'frozen':
return {
title: i18n.translate(
'xpack.indexLifecycleMgmt.editPolicy.partiallyMountedSearchableSnapshotField.title',
{
defaultMessage: 'Searchable snapshot',
}
),
description: (
<FormattedMessage
id="xpack.indexLifecycleMgmt.editPolicy.frozenPhase.partiallyMountedSearchableSnapshotField.description"
defaultMessage="Convert to a partially-mounted index that caches the index metadata. Data is retrieved from the snapshot as needed to process search requests. This minimizes the index footprint while keeping all of your data fully searchable. {learnMoreLink}"
values={{
learnMoreLink: (
<LearnMoreLink docPath="searchable-snapshots.html#searchable-snapshots-shared-cache" />
),
}}
/>
),
toggleLabel: i18n.translate(
'xpack.indexLifecycleMgmt.editPolicy.partiallyMountedSearchableSnapshotField.toggleLabel',
{ defaultMessage: 'Convert to partially-mounted index' }
),
};
}
};

export const SearchableSnapshotField: FunctionComponent<Props> = ({
phase,
Expand Down Expand Up @@ -228,7 +257,7 @@ export const SearchableSnapshotField: FunctionComponent<Props> = ({
'xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotCalloutBody',
{
defaultMessage:
'Force merge, shrink, read only and freeze actions are not allowed when searchable snapshots are enabled in this phase.',
'Force merge, shrink, read only, and freeze actions are not allowed when converting data to a fully-mounted index in this phase.',
}
)}
data-test-subj="searchableSnapshotFieldsDisabledCallout"
Expand Down Expand Up @@ -273,10 +302,7 @@ export const SearchableSnapshotField: FunctionComponent<Props> = ({
disabled: isDisabledDueToLicense,
onChange: setIsFieldToggleChecked,
'data-test-subj': 'searchableSnapshotToggle',
label: i18n.translate(
'xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotsToggleLabel',
{ defaultMessage: 'Create searchable snapshot' }
),
label: i18nTexts.toggleLabel,
}
: undefined
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ export const i18nTexts = {
searchableSnapshotsRepoFieldLabel: i18n.translate(
'xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotRepoFieldLabel',
{
defaultMessage: 'Searchable snapshot repository',
defaultMessage: 'Snapshot repository',
}
),
searchableSnapshotsStorageFieldLabel: i18n.translate(
Expand Down Expand Up @@ -216,21 +216,21 @@ export const i18nTexts = {
descriptions: {
hot: i18n.translate('xpack.indexLifecycleMgmt.editPolicy.hotPhase.hotPhaseDescription', {
defaultMessage:
'Store your most-recent, most frequently-searched data in the hot tier, which provides the best indexing and search performance at the highest cost.',
'Store your most recent, most frequently-searched data in the hot tier. The hot tier provides the best indexing and search performance by using the most powerful, expensive hardware.',
}),
warm: i18n.translate('xpack.indexLifecycleMgmt.editPolicy.warmPhase.warmPhaseDescription', {
defaultMessage:
'Move data to the warm tier, which is optimized for search performance over indexing performance. Data is infrequently added or updated in the warm phase.',
'Move data to the warm tier when you are still likely to search it, but infrequently need to update it. The warm tier is optimized for search performance over indexing performance.',
}),
cold: i18n.translate('xpack.indexLifecycleMgmt.editPolicy.coldPhase.coldPhaseDescription', {
defaultMessage:
'Move data to the cold tier, which is optimized for cost savings over search performance. Data is normally read-only in the cold phase.',
'Move data to the cold tier when you are searching it less often and don’t need to update it. The cold tier is optimized for cost savings over search performance.',
}),
frozen: i18n.translate(
'xpack.indexLifecycleMgmt.editPolicy.frozenPhase.frozenPhaseDescription',
{
defaultMessage:
'Archive data as searchable snapshots in the frozen tier. The frozen tier is optimized for maximum cost savings. Data in the frozen tier is rarely accessed and never updated.',
'Move data to the frozen tier for long term retention. The frozen tier provides the most cost-effective way store your data and still be able to search it.',
}
),
delete: i18n.translate(
Expand Down
3 changes: 0 additions & 3 deletions x-pack/plugins/translations/translations/ja-JP.json
Original file line number Diff line number Diff line change
Expand Up @@ -10052,12 +10052,9 @@
"xpack.indexLifecycleMgmt.editPolicy.saveButton": "ポリシーを保存",
"xpack.indexLifecycleMgmt.editPolicy.saveErrorMessage": "ライフサイクルポリシー {lifecycleName} の保存中にエラーが発生しました",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotCalloutBody": "検索可能なスナップショットがホットフェーズで有効な場合には、強制、マージ、縮小、凍結、コールドフェーズの検索可能なスナップショットは許可されません。",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotFieldDescription": "選択したリポジトリで管理されたインデックスのスナップショットを作成し、検索可能なスナップショットとしてマウントします。{learnMoreLink}",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotFieldTitle": "検索可能スナップショット",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotLicenseCalloutBody": "検索可能なスナップショットを作成するには、エンタープライズライセンスが必要です。",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotLicenseCalloutTitle": "エンタープライズライセンスが必要です",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotRepoRequiredError": "スナップショットリポジトリ名が必要です。",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotsToggleLabel": "検索可能スナップショットを作成",
"xpack.indexLifecycleMgmt.editPolicy.secondsOptionLabel": "秒",
"xpack.indexLifecycleMgmt.editPolicy.showPolicyJsonButto": "リクエストを表示",
"xpack.indexLifecycleMgmt.editPolicy.shrinkIndexExplanationText": "インデックス情報をプライマリシャードの少ない新規インデックスに縮小します。",
Expand Down
3 changes: 0 additions & 3 deletions x-pack/plugins/translations/translations/zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -10183,12 +10183,9 @@
"xpack.indexLifecycleMgmt.editPolicy.saveButton": "保存策略",
"xpack.indexLifecycleMgmt.editPolicy.saveErrorMessage": "保存生命周期策略 {lifecycleName} 时出错",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotCalloutBody": "在热阶段启用可搜索快照时,不允许强制合并、缩小、冻结可搜索快照以及将其置入冷阶段。",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotFieldDescription": "在所选存储库中拍取受管索引的快照,并将其安装为可搜索快照。{learnMoreLink}",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotFieldTitle": "可搜索快照",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotLicenseCalloutBody": "要创建可搜索快照,需要企业许可证。",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotLicenseCalloutTitle": "需要企业许可证",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotRepoRequiredError": "快照存储库名称必填。",
"xpack.indexLifecycleMgmt.editPolicy.searchableSnapshotsToggleLabel": "创建可搜索快照",
"xpack.indexLifecycleMgmt.editPolicy.secondsOptionLabel": "秒",
"xpack.indexLifecycleMgmt.editPolicy.showPolicyJsonButto": "显示请求",
"xpack.indexLifecycleMgmt.editPolicy.shrinkIndexExplanationText": "将索引缩小成具有较少主分片的新索引。",
Expand Down

0 comments on commit 6bc8ed8

Please sign in to comment.