libredb / libredb/libredb-studio
[FEATURE] elastic search connection - support API key
- Dominant language
- TypeScript
- Stars
- 726
- Forks
- 119
- Avg merge
- 7h 47m
- Merged PRs (30d)
- 265
Description
## Is your feature request related to a problem?
It is preferred to use API keys for authentication as opposed to basic auth with username/password.
## Describe the solution you'd like
Allow the connection to use API key
## Describe alternatives you've considered
Using username/password
## Use Case
When adding an elastic search connection
## Additional Context
Official documentation:
- https://www.elastic.co/docs/deploy-manage/api-keys/elasticsearch-api-keys
## Implementation Notes (Optional)
You can reference the airbyte elastic search connector:
- https://docs.airbyte.com/integrations/destinations/elasticsearch
Note that in Kibana (Elastic Search Frontend/UI), the key can be displayed in different formats:
- Encoded
- Beats
- Logstash
The "Beats" or "Logstash" format is what gives you the unecoded version for `API Key ID` and `API Key Secret`, in the form:
```
API_KEY_ID:API_KEY_SECRET
```
e.g.
```
EWkMhKACjF5eHMlg6Car:y9cTq7AQ4u16CO_sKM0Knp
```
Contributor guide
Research direction
Start by locating the Elasticsearch connection configuration and its existing username/password authentication path, then compare it with the official Elasticsearch API-key format and the referenced Airbyte connector. Done means an Elasticsearch connection can accept an API key ID and secret and authenticate successfully, including the documented key formats.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elasticsearch, typescript
- Domain
- databases, search
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100