Version Packages

2021-08-05 00:24:56 +00:00
parent edcb115530
commit 326cbd7408
141 changed files with 1178 additions and 616 deletions
@@ -1,5 +1,79 @@
 # @backstage/plugin-search-backend-node

+## 0.4.1
+
+### Patch Changes
+
+- d9c13d535: Implements configuration and indexing functionality for ElasticSearch search engine. Adds indexing, searching and default translator for ElasticSearch and modifies default backend example-app to use ES if it is configured.
+
+  ## Example configurations:
+
+  ### AWS
+
+  Using AWS hosted ElasticSearch the only configuration options needed is the URL to the ElasticSearch service. The implementation assumes
+  that environment variables for AWS access key id and secret access key are defined in accordance to the [default AWS credential chain.](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html).
+
+  ```yaml
+  search:
+    elasticsearch:
+      provider: aws
+      node: https://my-backstage-search-asdfqwerty.eu-west-1.es.amazonaws.com
+  ```
+
+  ### Elastic.co
+
+  Elastic Cloud hosted ElasticSearch uses a Cloud ID to determine the instance of hosted ElasticSearch to connect to. Additionally, username and password needs to be provided either directly or using environment variables like defined in [Backstage documentation.](https://backstage.io/docs/conf/writing#includes-and-dynamic-data)
+
+  ```yaml
+  search:
+    elasticsearch:
+      provider: elastic
+      cloudId: backstage-elastic:asdfqwertyasdfqwertyasdfqwertyasdfqwerty==
+      auth:
+        username: elastic
+        password: changeme
+  ```
+
+  ### Others
+
+  Other ElasticSearch instances can be connected to by using standard ElasticSearch authentication methods and exposed URL, provided that the cluster supports that. The configuration options needed are the URL to the node and authentication information. Authentication can be handled by either providing username/password or and API key or a bearer token. In case both username/password combination and one of the tokens are provided, token takes precedence. For more information how to create an API key, see [Elastic documentation on API keys](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html) and how to create a bearer token, see [Elastic documentation on tokens.](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html)
+
+  #### Configuration examples
+
+  ##### With username and password
+
+  ```yaml
+  search:
+    elasticsearch:
+      node: http://localhost:9200
+      auth:
+        username: elastic
+        password: changeme
+  ```
+
+  ##### With bearer token
+
+  ```yaml
+  search:
+    elasticsearch:
+      node: http://localhost:9200
+      auth:
+        bearer: token
+  ```
+
+  ##### With API key
+
+  ```yaml
+  search:
+    elasticsearch:
+      node: http://localhost:9200
+      auth:
+        apiKey: base64EncodedKey
+  ```
+
+- Updated dependencies
+  - @backstage/search-common@0.1.3
+
 ## 0.4.0

 ### Minor Changes
@@ -1,6 +1,6 @@
 {
  "name": "@backstage/plugin-search-backend-node",
-  "version": "0.4.0",
+  "version": "0.4.1",
  "main": "src/index.ts",
  "types": "src/index.ts",
  "license": "Apache-2.0",
@@ -19,14 +19,14 @@
    "clean": "backstage-cli clean"
  },
  "dependencies": {
-    "@backstage/search-common": "^0.1.2",
+    "@backstage/search-common": "^0.1.3",
    "winston": "^3.2.1",
    "lunr": "^2.3.9",
    "@types/lunr": "^2.3.3"
  },
  "devDependencies": {
-    "@backstage/backend-common": "^0.8.6",
-    "@backstage/cli": "^0.7.4"
+    "@backstage/backend-common": "^0.8.8",
+    "@backstage/cli": "^0.7.7"
  },
  "files": [
    "dist"