feat: update Elastic integration to use API key authentication and enhance documentation#3485
Conversation
…hance documentation Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
|
👋 Commands for maintainers:
|
|
/sp start |
|
✅ Ready. Web: https://pr-3485-ephemeral.superplane.com |
felixgateru
left a comment
felixgateru
left a comment
There was a problem hiding this comment.
A suggestion why not include the instructions of step 3 into step 1 and 2 instead of needing to get to step 3. In step 1 you can tell me to go to my deployment and then copy the elastucseach endpoint
What do you think about this?
| - **API Key** (recommended for Elastic Cloud): Go to Kibana → Stack Management → API Keys and create a new key. Paste the base64-encoded ` + "`id:api_key`" + ` value. | ||
| - **Username / Password**: Provide the credentials for a user with the required privileges. | ||
| 4. **Kibana alerts (trigger)**: SuperPlane automatically creates a signed Kibana Webhook connector. You still need to attach that connector to your alert rules in Kibana. | ||
| 1. **Elasticsearch URL**: |
There was a problem hiding this comment.
A suggestion why not include the instructions of step 3 into step 1 and 2 instead of needing to get to step 3. In step 1 you can tell me to go to my deployment and then copy the elastucseach endpoint
What do you think about this?
| 2. **Kibana URL**: | ||
| - Open Kibana in your browser and copy the URL from the address bar. | ||
| - Keep only the base URL: protocol, host, and port. | ||
| - Remove anything after that, such as ` + "`/app/...`" + `, anything starting with ` + "`?`" + `, or anything starting with ` + "`#`" + `. | ||
| - Example browser URL: ` + "`https://my-cluster.kb.us-east-1.aws.found.io:9243/app/home`" + `. | ||
| - Paste into SuperPlane: ` + "`https://my-cluster.kb.us-east-1.aws.found.io:9243`" + `. |
There was a problem hiding this comment.
The instructions for the Kibana URL do not represent the best UX
I have the endpoint here instead in the mydeployments page:
There was a problem hiding this comment.
I updated it to this:
… alert and index document mappers Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
| @@ -52,18 +52,13 @@ func Test__IndexDocument__Setup(t *testing.T) { | |||
| } | |||
There was a problem hiding this comment.
For the index document, can the Document ID be a resource type so that it is selectable? Is this possible to implement
There was a problem hiding this comment.
Having it as an IntegrationResource here may not be the best UX since the user can supply his own ID and this is the ID that will be used for the document indexed. The ID may not already exist on elastic.
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
…hook configuration Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
…ment and rule attachment logic Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
… logic Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
|
Co-authored-by: Pedro Leão <forestileao@users.noreply.github.com>
Signed-off-by: Pedro F. Leao <pedroforestileao@gmail.com>
…hance documentation (superplanehq#3485) <!-- CURSOR_AGENT_PR_BODY_BEGIN --> Implements superplanehq#3435 This PR adds an update on the elastic integration to fix the following: - Update documentation on integration setup to show where to get kbana and elasticsearch urls - Updates the configuration for the trigger: keeps status as `FieldAnyPredicateList`, and status, severity as `FieldIntegrationResource` ### Demo Video [Screencast from 2026-03-17 13-18-10.webm](https://github.com/user-attachments/assets/129597d4-2d1d-4b89-888b-556257cce140) <!-- CURSOR_AGENT_PR_BODY_END --> <div><a href="https://cursor.com/agents/bc-df2bae57-6f54-4a6a-96e1-436f4c949c84"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a href="https://cursor.com/background-agent?bcId=bc-df2bae57-6f54-4a6a-96e1-436f4c949c84"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img alt="Open in Cursor" width="131" height="28" src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a> </div> --------- Signed-off-by: WashingtonKK <washingtonkigan@gmail.com> Signed-off-by: Pedro F. Leao <pedroforestileao@gmail.com> Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Pedro Leão <forestileao@users.noreply.github.com> Co-authored-by: Pedro F. Leao <pedroforestileao@gmail.com>
![https://cursor.com/assets/images/open-in-web-dark.png"><source](https://cursor.com/assets/images/open-in-web-dark.png"><source){kind=link}
![https://cursor.com/assets/images/open-in-web-light.png"><img](https://cursor.com/assets/images/open-in-web-light.png"><img){kind=link}
![https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a](https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a){kind=link}
![https://cursor.com/assets/images/open-in-cursor-dark.png"><source](https://cursor.com/assets/images/open-in-cursor-dark.png"><source){kind=link}
![https://cursor.com/assets/images/open-in-cursor-light.png"><img](https://cursor.com/assets/images/open-in-cursor-light.png"><img){kind=link}
![https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a> </div](https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a> </div){kind=link}
5 participants
Implements #3435
This PR adds an update on the elastic integration to fix the following:
FieldAnyPredicateList, and status, severity asFieldIntegrationResourceDemo Video
Screencast.from.2026-03-17.13-18-10.webm