Creates content connectors page in security docs #2113
Conversation
benironside
added
documentation
🔍 Preview links for changed docs |
is there a place where we can link users for full list of connectors? @benironside |
| Elastic's content connectors allow you to extract, transform, index, and sync data from third-party applications including Github, PagerDuty, Jira, OpsGenie, Teams, Google Drive, Slack, email, and more. To see a complete list of the available connectors, follow the setup instructions below. | ||
|
|
||
| ## Setup | ||
| {{stack}} supports two deployment methods: Elastic managed, and self-managed. {{sec-serverless}} only supports Elastic managed deployments. Self-managed deployments require you to manage the {{elastic-agent}} that forwards data to Elastic and allow you to customize the connector's code, whereas Elastic managed deployments use agentless technology and do not allow customization. |
There was a problem hiding this comment.
| {{stack}} supports two deployment methods: Elastic managed, and self-managed. {{sec-serverless}} only supports Elastic managed deployments. Self-managed deployments require you to manage the {{elastic-agent}} that forwards data to Elastic and allow you to customize the connector's code, whereas Elastic managed deployments use agentless technology and do not allow customization. | |
| {{stack}} supports two deployment methods for your connectors: Elastic managed, and self-managed. {{sec-serverless}} only supports Elastic managed connectors. Self-managed connectors require you to manage the {{elastic-agent}} that forwards data to Elastic and allow you to customize the connector's code, whereas Elastic managed connectors use agentless technology and do not allow customization. |
Suggestion to avoid confusion with stack deployment models
Reading this paragraph, I also wonder about what this page states: https://www.elastic.co/docs/reference/search-connectors/
"As of Elastic 9.0, managed connectors on Elastic Cloud Hosted are no longer available. All connectors must be self-managed."
If I reconcile this paragraph with the sentence from that other page, that gives:
- Serverless only supports Elastic managed connectors
- ECH only supports self-managed connectors
- What about other Stack deployment types?
I think we should try to clarify, as I either misunderstood, or we're giving conflicting/partial information in our various pages.
@leemthompo maybe you can help here?
There was a problem hiding this comment.
Yes https://www.elastic.co/docs/reference/search-connectors/elastic-managed-connectors will have to be updated because now managed connectors have been revived by the Sec/Obs teams.
You'll need to update this page to mention the availability of managed connectors in certain serverless projects and 9.1+ ECH Obs/Sec navs.
That page is currently accurate for 9.0.
In 9.0:
- Serverless only supports self-managed connectors
- ECH only supports self-managed connectors
- What about other Stack deployment types? You can't run a managed connector on a self-managed deployment.
There was a problem hiding this comment.
tldr is self-managed connectors can send data to Elasticsearch instances wherever they may be deployed
There was a problem hiding this comment.
Managed connectors only send data to the serverless/hosted deployment they're deployed within
There was a problem hiding this comment.
I don't think this paragraph belongs under Setup btw
| Elastic's content connectors allow you to extract, transform, index, and sync data from third-party applications including Github, PagerDuty, Jira, OpsGenie, Teams, Google Drive, Slack, email, and more. To see a complete list of the available connectors, follow the setup instructions below. | ||
|
|
||
| ## Setup | ||
| {{stack}} supports two deployment methods: Elastic managed, and self-managed. {{sec-serverless}} only supports Elastic managed deployments. Self-managed deployments require you to manage the {{elastic-agent}} that forwards data to Elastic and allow you to customize the connector's code, whereas Elastic managed deployments use agentless technology and do not allow customization. |
There was a problem hiding this comment.
Connectors have two deployment methods: Elastic managed and self-managed.
Self-managed deployments require you to deploy the connector service on your own infrastructure (i.e. run some Python code on a server you manage). When you use managed connectors Elastic runs that Python service for you within your deployment.
Self-managed connectors can be customized, whereas Elastic managed connectors cannot.
I think the serverless distinction is a bit nuanced:
- You can use self-managed connectors to send data to Elasticsearch on serverless
- AFAICT you can now use managed connectors for Obs/Sec projects
Co-authored-by: florent-leborgne <[email protected]> Co-authored-by: Liam Thompson <[email protected]>
There was a problem hiding this comment.
Made a suggestion to clarify the managed versus self-managed issue, because self-managed connectors can send data to any Elasticsearch instance and can be managed independently of your ES instance.
Again I haven't seen the UI, so feel free to add to that section with useful information about the UI experience differences :)
|
|
||
| ## Setup | ||
|
|
||
| To learn about set up for self-managed connectors, refer to [Self managed connectors](elasticsearch://reference/search-connectors/self-managed-connectors.md). To set up an Elastic managed connector: |
There was a problem hiding this comment.
Maybe make this into tabs, with Managed instructions as the first tab and link to self-managed instructions elsewhere
| serverless: preview | ||
| --- | ||
|
|
||
| # Content connectors |
There was a problem hiding this comment.
General remark, I haven't seen the new security UI, so consider adding a screenshot to this page if it would be helpful here, especially if it differs from previous generation of connector UIs
|
|
||
| # Content connectors | ||
|
|
||
| Elastic's content connectors allow you to extract, transform, index, and sync data from third-party applications including Github, PagerDuty, Jira, Teams, Google Drive, Slack, email, and more ([view all connectors](elasticsearch://reference/search-connectors/index.md)). |
There was a problem hiding this comment.
PagerDuty isn't on that list, unless this is a new connector built by Security team?
| {{stack}} supports two deployment methods for your connectors: Elastic managed, and self-managed. Self-managed connectors require you to deploy on your own infrastructure (for example, run some Python code on a server you manage). When you use an Elastic managed connector, Elastic runs the infrastructure for you. Self-managed connectors can be customized, whereas Elastic managed connectors do not allow customization. | ||
|
|
||
| {{sec-serverless}} only supports Elastic managed connectors. {{stack}} deployments support either self-managed or Elastic managed deployments. |
There was a problem hiding this comment.
That's ok to leave out of scope of this issue for now, but I see here a good opportunity for a small comparison table to make it easier to understand the differences between both modes.
If you'd rather not do it right now, please create an issue :)
There was a problem hiding this comment.
The info should be good per #2113 (comment) at least, but yeah a table might be better format
Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: florent-leborgne <[email protected]>
5 participants
Fixes internal/34 by documenting the new Content connectors interface, and the setup process for Elastic managed content connectors.
Preview: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2113/solutions/security/get-started/content-connectors