Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Backport 2.x] [navigation]feat: reorder features and rename title and description #1107

Merged
merged 1 commit into from
Aug 15, 2024
Merged

[Backport 2.x] [navigation]feat: reorder features and rename title and description #1107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 88 additions & 73 deletions public/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,62 +31,68 @@ interface IndexManagementSetupDeps {
}

const ISM_CATEGORIES: Record<string, AppCategory> = Object.freeze({
indexes: {
id: "indexes",
label: "Indexes",
automation_policies: {
id: "automation_policies",
label: "Automation policies",
order: 2000,
euiIconType: "managementApp",
},
templates: {
id: "templates",
label: "Templates",
order: 3000,
},
index_backup_and_recovery: {
id: "index_backup_and_recovery",
label: "Index Backup and Recovery",
order: 3000,
euiIconType: "managementApp",
label: "Index backup and recovery",
order: 4000,
},
});

const ISM_FEATURE_DESCRIPTION: Record<string, string> = Object.freeze({
index_management: i18n.translate("indexManagement.description", {
index_management: i18n.translate("index-management-dashboards-plugin.indexManagement.description", {
defaultMessage: "Manage your indexes with state polices, templates and aliases. You can also roll up or transform your indexes.",
}),
snapshot_management: i18n.translate("snapshotManagement.description", {
snapshot_management: i18n.translate("index-management-dashboards-plugin.snapshotManagement.description", {
defaultMessage: "Back up and restore your cluster's indexes and state. Setup a policy to automate snapshot creation and deletion.",
}),
indexes: i18n.translate("indexes.description", {
defaultMessage: "Manage your indexes",
indexes: i18n.translate("index-management-dashboards-plugin.indexes.description", {
defaultMessage: "Configure and manage indexes.",
}),
policy_managed_indexes: i18n.translate("index-management-dashboards-plugin.policyManagedIndexes.description", {
defaultMessage: "View indexes managed by Index State Management (ISM) policies.",
}),
policy_managed_indexes: i18n.translate("policyManagedIndexes.description", {
defaultMessage: "Manage your policy managed indexes",
data_streams: i18n.translate("index-management-dashboards-plugin.dataStreams.description", {
defaultMessage: "Simplify time-series data management.",
}),
data_streams: i18n.translate("dataStreams.description", {
defaultMessage: "Manage your data streams",
aliases: i18n.translate("index-management-dashboards-plugin.aliases.description", {
defaultMessage: "Organize multiple indexes under virtual index names.",
}),
aliases: i18n.translate("aliases.description", {
defaultMessage: "Manage your index aliases",
index_state_management_policies: i18n.translate("index-management-dashboards-plugin.indexStateManagementPolicies.description", {
defaultMessage: "Automate periodic administrative tasks.",
}),
index_state_management_policies: i18n.translate("indexStateManagementPolicies.description", {
defaultMessage: "Manage your index state management policies",
index_templates: i18n.translate("index-management-dashboards-plugin.indexTemplates.description", {
defaultMessage: "Create predefined mappings and settings for new indexes.",
}),
index_templates: i18n.translate("indexTemplates.description", {
defaultMessage: "Manage your index templates",
notification_settings: i18n.translate("index-management-dashboards-plugin.notificationSettings.description", {
defaultMessage: "Set default notifications on index operation statuses.",
}),
notification_settings: i18n.translate("notificationSettings.description", {
defaultMessage: "Manage your notification settings",
rollup_jobs: i18n.translate("index-management-dashboards-plugin.rollupJobs.description", {
defaultMessage: "Reduce data granularity by rolling up old data into summarized indexes.",
}),
rollup_jobs: i18n.translate("rollupJobs.description", {
defaultMessage: "Manage your rollup jobs",
transform_jobs: i18n.translate("index-management-dashboards-plugin.transformJobs.description", {
defaultMessage: "Create summarized views of your data organized by specific fields.",
}),
transform_jobs: i18n.translate("transformJobs.description", {
defaultMessage: "Manage your transform jobs",
index_snapshots: i18n.translate("index-management-dashboards-plugin.indexSnapshots.description", {
defaultMessage: "Back up your indexes.",
}),
index_snapshots: i18n.translate("indexSnapshots.description", {
defaultMessage: "Manage your index snapshots",
snapshot_policies: i18n.translate("index-management-dashboards-plugin.snapshotPolicies.description", {
defaultMessage: "Set up automatic data snapshots.",
}),
snapshot_policies: i18n.translate("snapshotPolicies.description", {
defaultMessage: "Manage your snapshot policies",
snapshot_repositories: i18n.translate("index-management-dashboards-plugin.snapshotRepositories.description", {
defaultMessage: "Configure remote storage for snapshots.",
}),
snapshot_repositories: i18n.translate("snapshotRepositories.description", {
defaultMessage: "Manage your snapshot repositories",
component_templates: i18n.translate("index-management-dashboards-plugin.componentTemplates.description", {
defaultMessage: "Define components for your index templates.",
}),
});

Expand Down Expand Up @@ -173,8 +179,6 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.INDICES)}`,
title: "Indexes",
order: 8040,
category: ISM_CATEGORIES.indexes,
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.indexes,
updater$: this.appStateUpdater,
Expand All @@ -186,9 +190,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// policy managed index route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.MANAGED_INDICES)}`,
title: "Policy Managed Indexes",
order: 8040,
category: ISM_CATEGORIES.indexes,
title: "Policy-managed indexes",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.policy_managed_indexes,
updater$: this.appStateUpdater,
Expand All @@ -200,9 +202,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// data streams route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.DATA_STREAMS)}`,
title: "Data Streams",
order: 8040,
category: ISM_CATEGORIES.indexes,
title: "Data streams",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.data_streams,
updater$: this.appStateUpdater,
Expand All @@ -214,9 +214,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// index alias route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.ALIASES)}`,
title: "Index Aliases",
order: 8040,
category: ISM_CATEGORIES.indexes,
title: "Index aliases",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.aliases,
updater$: this.appStateUpdater,
Expand All @@ -228,9 +226,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// index templates route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.TEMPLATES)}`,
title: "Index Templates",
order: 8040,
category: ISM_CATEGORIES.indexes,
title: "Index templates",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.index_templates,
updater$: this.appStateUpdater,
Expand All @@ -239,12 +235,22 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
},
});

// component templates route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.COMPOSABLE_TEMPLATES)}`,
title: "Component templates",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.component_templates,
updater$: this.appStateUpdater,
mount: async (params: AppMountParameters) => {
return mountWrapper(params, ROUTES.TEMPLATES);
},
});

// notification settings route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.NOTIFICATIONS)}`,
title: "Notification Settings",
order: 8040,
category: ISM_CATEGORIES.indexes,
title: "Index operation notifications",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.notification_settings,
updater$: this.appStateUpdater,
Expand All @@ -256,9 +262,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// rollup jobs route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.ROLLUPS)}`,
title: "Rollup Jobs",
order: 8040,
category: ISM_CATEGORIES.indexes,
title: "Rollup jobs",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.rollup_jobs,
updater$: this.appStateUpdater,
Expand All @@ -270,9 +274,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// transform jobs route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.TRANSFORMS)}`,
title: "Transform Jobs",
order: 8040,
category: ISM_CATEGORIES.indexes,
title: "Transform jobs",
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.transform_jobs,
updater$: this.appStateUpdater,
Expand All @@ -284,8 +286,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// index snapshots route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.SNAPSHOTS)}`,
title: "Index Snapshots",
order: 8040,
title: "Index snapshots",
category: ISM_CATEGORIES.index_backup_and_recovery,
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.index_snapshots,
Expand All @@ -298,8 +299,7 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
// snapshot repositories route
core.application.register({
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.REPOSITORIES)}`,
title: "Snapshot Repositories",
order: 8040,
title: "Snapshot repositories",
category: ISM_CATEGORIES.index_backup_and_recovery,
workspaceAvailability: WorkspaceAvailability.outsideWorkspace,
description: ISM_FEATURE_DESCRIPTION.snapshot_repositories,
Expand All @@ -319,55 +319,70 @@ export class IndexManagementPlugin implements Plugin<IndexManagementPluginSetup,
core.chrome.navGroup.addNavLinksToGroup(DEFAULT_NAV_GROUPS.dataAdministration, [
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.INDICES)}`,
category: ISM_CATEGORIES.indexes,
category: DEFAULT_APP_CATEGORIES.manageData,
order: 200,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.MANAGED_INDICES)}`,
category: ISM_CATEGORIES.indexes,
category: ISM_CATEGORIES.automation_policies,
order: 100,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.DATA_STREAMS)}`,
category: ISM_CATEGORIES.indexes,
category: DEFAULT_APP_CATEGORIES.manageData,
order: 400,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.ALIASES)}`,
category: ISM_CATEGORIES.indexes,
category: DEFAULT_APP_CATEGORIES.manageData,
order: 300,
},
{
id: imApplicationID,
category: ISM_CATEGORIES.indexes,
title: "Index State Management Policies",
order: 8040,
category: ISM_CATEGORIES.automation_policies,
title: "Index State Management policies",
order: 200,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.TEMPLATES)}`,
category: ISM_CATEGORIES.indexes,
category: ISM_CATEGORIES.templates,
order: 100,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.NOTIFICATIONS)}`,
category: ISM_CATEGORIES.indexes,
category: DEFAULT_APP_CATEGORIES.manageData,
order: 500,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.ROLLUPS)}`,
category: ISM_CATEGORIES.indexes,
category: ISM_CATEGORIES.automation_policies,
order: 300,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.TRANSFORMS)}`,
category: ISM_CATEGORIES.indexes,
category: ISM_CATEGORIES.automation_policies,
order: 400,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.SNAPSHOTS)}`,
category: ISM_CATEGORIES.index_backup_and_recovery,
order: 100,
},
{
id: smApplicationID,
category: ISM_CATEGORIES.index_backup_and_recovery,
title: "Snapshot Policies",
order: 8040,
title: "Snapshot policies",
order: 200,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.REPOSITORIES)}`,
category: ISM_CATEGORIES.index_backup_and_recovery,
order: 300,
},
{
id: `opensearch_index_management_dashboards_${encodeURIComponent(ROUTES.COMPOSABLE_TEMPLATES)}`,
category: ISM_CATEGORIES.templates,
order: 200,
},
]);

Expand Down
Loading