From 4d754e3c21b2f2c9c1f47ae586d57289fe58a881 Mon Sep 17 00:00:00 2001 From: Andrew Ochsner Date: Tue, 2 Apr 2024 14:48:11 -0500 Subject: [PATCH 1/4] make elasticsearch provider optional if search.elasticsearch not defined Signed-off-by: Andrew Ochsner --- .changeset/tough-snakes-wink.md | 5 +++++ plugins/search-backend-module-elasticsearch/src/alpha.ts | 6 ++++++ 2 files changed, 11 insertions(+) create mode 100644 .changeset/tough-snakes-wink.md diff --git a/.changeset/tough-snakes-wink.md b/.changeset/tough-snakes-wink.md new file mode 100644 index 0000000000..53ce799fff --- /dev/null +++ b/.changeset/tough-snakes-wink.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-search-backend-module-elasticsearch': minor +--- + +For new backend, make Elasticsearch provider optional if no config diff --git a/plugins/search-backend-module-elasticsearch/src/alpha.ts b/plugins/search-backend-module-elasticsearch/src/alpha.ts index f5952fbc86..cb29cb0f26 100644 --- a/plugins/search-backend-module-elasticsearch/src/alpha.ts +++ b/plugins/search-backend-module-elasticsearch/src/alpha.ts @@ -68,6 +68,12 @@ export default createBackendModule({ config: coreServices.rootConfig, }, async init({ searchEngineRegistry, logger, config }) { + const baseKey = 'search.elasticsearch'; + const baseConfig = config.getOptional(baseKey); + if (!baseConfig) { + return; + } + searchEngineRegistry.setSearchEngine( await ElasticSearchSearchEngine.fromConfig({ logger, From d37e77e385f9451a64d9d0ee3fad02d42ccd977f Mon Sep 17 00:00:00 2001 From: Andrew Ochsner Date: Fri, 5 Apr 2024 08:25:57 -0500 Subject: [PATCH 2/4] Update .changeset/tough-snakes-wink.md Co-authored-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Signed-off-by: Andrew Ochsner --- .changeset/tough-snakes-wink.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/tough-snakes-wink.md b/.changeset/tough-snakes-wink.md index 53ce799fff..a234bd4012 100644 --- a/.changeset/tough-snakes-wink.md +++ b/.changeset/tough-snakes-wink.md @@ -2,4 +2,4 @@ '@backstage/plugin-search-backend-module-elasticsearch': minor --- -For new backend, make Elasticsearch provider optional if no config +When using the New Backend System, the Elasticsearch provider will only be added if the `search.elasticsearch` config section exists. From 6e83f6ce355ddab1685f944c815b937ed313459f Mon Sep 17 00:00:00 2001 From: Andrew Ochsner Date: Fri, 5 Apr 2024 08:28:49 -0500 Subject: [PATCH 3/4] Update alpha.ts Signed-off-by: Andrew Ochsner --- plugins/search-backend-module-elasticsearch/src/alpha.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/plugins/search-backend-module-elasticsearch/src/alpha.ts b/plugins/search-backend-module-elasticsearch/src/alpha.ts index cb29cb0f26..187df3040e 100644 --- a/plugins/search-backend-module-elasticsearch/src/alpha.ts +++ b/plugins/search-backend-module-elasticsearch/src/alpha.ts @@ -71,6 +71,7 @@ export default createBackendModule({ const baseKey = 'search.elasticsearch'; const baseConfig = config.getOptional(baseKey); if (!baseConfig) { + logger.info('No configuration found under "search.elasticsearch" key. Skipping search engine inititalization.'); return; } From 797de9c45d49388e5a59457bfcb556f95d5ec5aa Mon Sep 17 00:00:00 2001 From: Andrew Ochsner Date: Fri, 5 Apr 2024 08:59:08 -0500 Subject: [PATCH 4/4] Update alpha.ts Signed-off-by: Andrew Ochsner --- plugins/search-backend-module-elasticsearch/src/alpha.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/plugins/search-backend-module-elasticsearch/src/alpha.ts b/plugins/search-backend-module-elasticsearch/src/alpha.ts index 187df3040e..0af5904df0 100644 --- a/plugins/search-backend-module-elasticsearch/src/alpha.ts +++ b/plugins/search-backend-module-elasticsearch/src/alpha.ts @@ -71,7 +71,9 @@ export default createBackendModule({ const baseKey = 'search.elasticsearch'; const baseConfig = config.getOptional(baseKey); if (!baseConfig) { - logger.info('No configuration found under "search.elasticsearch" key. Skipping search engine inititalization.'); + logger.warn( + 'No configuration found under "search.elasticsearch" key. Skipping search engine inititalization.', + ); return; }