kibana/docs
Marius Iversen 9ed2865838
New Integration Assistant plugin (#184296)
## Summary

This is a PR to add a new backend plugin (frontend will be done in
separate [PR](https://github.com/elastic/kibana/pull/184546)).

The purpose of the plugin is to provide a set of API routes that is used
to perform a variety of GenAI workflows to generate new integrations
based on provided inputs.

It reuses the existing GenAI connectors for its LLM communication, and
provides a set of API's to create ECS mapping, Categorization, Related
Fields and an API to generate the actual integration package zip, which
is forwarded to the UI component.

### Planned follow-up changes:

As the PR is getting way too large, some planned changes would be added
in much smaller follow-ups. This includes mostly more improved try/catch
for certain routes, adding debug/error log entries where relevant,
especially for the API endpoints themself, some more unit and end2end
tests.

- OpenAPI spec for the API will be handled in a separate PR
- All the missing unit tests will be added as a followup PR

### Testing

The `integration_assistant` plugin will be disabled by default while
it's being implemented so we can iterate and merge partial PRs without
interfering with the releases. This config will work as our feature
flag:


6aefd4ff7b/x-pack/plugins/integration_assistant/server/config.ts (L11-L13)

To test it add this to your _kibana.dev.yml_:
```
xpack.integration_assistant.enabled: true
```

### Checklist

Delete any items that are not applicable to this PR.

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: Patryk Kopycinski <contact@patrykkopycinski.com>
Co-authored-by: Sergi Massaneda <sergi.massaneda@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Bharat Pasupula <saibharatchandra.pasupula@elastic.co>
Co-authored-by: Bharat Pasupula <123897612+bhapas@users.noreply.github.com>
2024-06-13 16:48:36 -06:00
..
api Update the docs to clarify the ID of the private location created (#184818) 2024-06-05 14:36:03 +01:00
apm [DOCS] Update Observability docs to fix problems found during testing (#175636) 2024-01-29 11:05:21 -08:00
canvas Removes duplicate images (#173097) 2023-12-11 11:36:25 -08:00
concepts [DOCS] Update ESQL docs (#183617) 2024-05-17 14:50:05 +02:00
dev-tools Sort out objectization in variable substitution (#162382) 2023-07-27 09:30:52 +09:00
developer New Integration Assistant plugin (#184296) 2024-06-13 16:48:36 -06:00
development/plugins/expressions/public Remove old doc generation system for core APIs (#134313) 2022-06-21 17:43:17 +02:00
discover [DOCS] Update ESQL docs (#183617) 2024-05-17 14:50:05 +02:00
fleet [DOCS] Fleet managed content (#178380) 2024-03-25 22:14:29 +00:00
getting-started [DOCS] Updates the quick start guide (#163165) 2023-08-04 15:55:25 +02:00
management Gemini connector integration (#183668) 2024-06-06 11:52:35 -06:00
maps [Docs][Chore] Fix asset tracking tutorial from 8.12 improvements (#176061) 2024-02-02 05:22:55 -07:00
migration [DOCS] Remove breaking changes tags (#162928) 2023-08-02 08:27:22 -04:00
observability
osquery [DOCS] Documents Osquery Timeout setting (#174595) 2024-01-17 15:29:23 +00:00
playground [DOCS] Add note to playground context: one field only currently (#184039) 2024-05-22 19:24:58 +02:00
settings Gemini connector integration (#183668) 2024-06-06 11:52:35 -06:00
setup Add http2 support for Kibana server (#183465) 2024-06-03 09:34:13 +02:00
siem [DOCS] Elastic Sec Overview (Fixing Image) (#104529) 2021-07-07 09:58:09 -04:00
spaces Removing docs about multi-tenancy (#143698) 2022-10-24 16:01:43 -04:00
user [DOCS] Adjusts log rate analysis docs (#185008) 2024-06-12 11:19:14 +02:00
accessibility.asciidoc
action-type-template.asciidoc [DOCS] Add preconfigured AWS Bedrock connector (#168663) 2023-10-16 08:23:12 -07:00
CHANGELOG.asciidoc [DOCS] 8.14.1 release notes (#186029) 2024-06-11 20:29:58 +00:00
gs-index.asciidoc [DOCS] Remove or move book-scoped attributes (#155210) 2023-04-20 09:12:09 -07:00
index.asciidoc [Docs] remove Kibana book-scoped variables (#178676) 2024-03-14 11:53:33 -04:00
index.x.asciidoc
landing-page.asciidoc [DOCS] Fix welcome-to-elastic link (#166357) 2023-09-14 06:08:35 -04:00
limitations.asciidoc
migration.asciidoc
redirects.asciidoc [DOCS] Add Playground docs (#182692) 2024-05-08 17:29:17 +01:00
rule-type-template.asciidoc [DOCS] Create and manage rule action frequencies (#150957) 2023-02-23 13:16:46 -08:00
template.asciidoc [DOCS] Remove snapshot and restore docs (#114836) 2021-11-16 16:59:24 -05:00