Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Elastic connector integration #10898

Merged
merged 9 commits into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@
/packages/digital_guardian @elastic/security-service-integrations
/packages/docker @elastic/obs-cloudnative-monitoring
/packages/elastic_agent @elastic/elastic-agent
/packages/elastic_connectors @elastic/ingestion-team
jedrazb marked this conversation as resolved.
Show resolved Hide resolved
/packages/elastic_package_registry @elastic/ecosystem
/packages/elasticsearch @elastic/stack-monitoring
/packages/enterprisesearch @elastic/stack-monitoring
Expand Down
93 changes: 93 additions & 0 deletions packages/elastic_connectors/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
Elastic License 2.0

URL: https://www.elastic.co/licensing/elastic-license

## Acceptance

By using the software, you agree to all of the terms and conditions below.

## Copyright License

The licensor grants you a non-exclusive, royalty-free, worldwide,
non-sublicensable, non-transferable license to use, copy, distribute, make
available, and prepare derivative works of the software, in each case subject to
the limitations and conditions below.

## Limitations

You may not provide the software to third parties as a hosted or managed
service, where the service provides users with access to any substantial set of
the features or functionality of the software.

You may not move, change, disable, or circumvent the license key functionality
in the software, and you may not remove or obscure any functionality in the
software that is protected by the license key.

You may not alter, remove, or obscure any licensing, copyright, or other notices
of the licensor in the software. Any use of the licensor’s trademarks is subject
to applicable law.

## Patents

The licensor grants you a license, under any patent claims the licensor can
license, or becomes able to license, to make, have made, use, sell, offer for
sale, import and have imported the software, in each case subject to the
limitations and conditions in this license. This license does not cover any
patent claims that you cause to be infringed by modifications or additions to
the software. If you or your company make any written claim that the software
infringes or contributes to infringement of any patent, your patent license for
the software granted under these terms ends immediately. If your company makes
such a claim, your patent license ends immediately for work on behalf of your
company.

## Notices

You must ensure that anyone who gets a copy of any part of the software from you
also gets a copy of these terms.

If you modify the software, you must include in any modified copies of the
software prominent notices stating that you have modified the software.

## No Other Rights

These terms do not imply any licenses other than those expressly granted in
these terms.

## Termination

If you use the software in violation of these terms, such use is not licensed,
and your licenses will automatically terminate. If the licensor provides you
with a notice of your violation, and you cease all violation of this license no
later than 30 days after you receive that notice, your licenses will be
reinstated retroactively. However, if you violate these terms after such
reinstatement, any additional violation of these terms will cause your licenses
to terminate automatically and permanently.

## No Liability

*As far as the law allows, the software comes as is, without any warranty or
condition, and the licensor will not be liable to you for any damages arising
out of these terms or the use or nature of the software, under any kind of
legal claim.*

## Definitions

The **licensor** is the entity offering these terms, and the **software** is the
software the licensor makes available under these terms, including any portion
of it.

**you** refers to the individual or entity agreeing to these terms.

**your company** is any legal entity, sole proprietorship, or other kind of
organization that you work for, plus all organizations that have control over,
are under the control of, or are under common control with that
organization. **control** means ownership of substantially all the assets of an
entity, or the power to direct its management and policies by vote, contract, or
otherwise. Control can be direct or indirect.

**your licenses** are all the licenses granted to you for the software under
these terms.

**use** means anything you do with the software requiring one of your licenses.

**trademark** means trademarks, service marks, and similar rights.
6 changes: 6 additions & 0 deletions packages/elastic_connectors/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# newer versions go on top
- version: 0.0.1
changes:
- description: Initial draft of the package
type: enhancement
link: https://github.com/elastic/integrations/pull/10898
13 changes: 13 additions & 0 deletions packages/elastic_connectors/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# Elastic Connectors

A connector is a type of Elastic integration that syncs data from an original data source to an **Elasticsearch index**. Connectors enable you to create searchable, read-only replicas of your data sources.

Connectors extract the original files, records, or objects; and transforms them into Elasticsearch documents.

## Connectors references

The following connectors are available as Elastic-managed connectors:

- [Github](https://www.elastic.co/guide/en/enterprise-search/current/connectors-github.html)
- [Google Drive](https://www.elastic.co/guide/en/enterprise-search/current/connectors-google-drive.html)
11 changes: 11 additions & 0 deletions packages/elastic_connectors/img/connectors-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions packages/elastic_connectors/img/service_type/github.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions packages/elastic_connectors/manifest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
format_version: 3.2.1
name: elastic_connectors
title: "Elastic Connectors"
version: 0.0.1
jedrazb marked this conversation as resolved.
Show resolved Hide resolved
source:
license: "Elastic-2.0"
description: "Sync data from source to the Elasticsearch index."
type: integration
categories:
- connector
conditions:
kibana:
version: "^9.0.0"
seanstory marked this conversation as resolved.
Show resolved Hide resolved
elastic:
subscription: "basic"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CC @danajuratoni - I expect we actually want this platinum+, but since it'll only be accessible through Agentless (cloud and serverless) maybe this doesn't matter?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seanstory This should be standard (I confirmed with Dana). Looking at integration manifest only 4 options are supported in enum: basic, gold, platinum and enterprise. So I think in such a case: basic == standard?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expect we actually want this platinum+, but since it'll only be accessible through Agentless (cloud and serverless) maybe this doesn't matter?

This is a great place to get our wires crossed, so I'd like to double check:

  • licensing for Elastic managed connectors (i.e. Agentless connectors) should remain unchanged. This means Standard on Elastic Cloud hosted.
  • licensing for connectors on Agent (i.e. self-managed connectors via Agent) is not part of 9.0, but should be equivalent to self-managed connector clients. This would mean likely Platinum+ for self-managed connectors via Agent, final decision to be made in the future / if and when we'll add support.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The approach we took makes it hard if not impossible for users to run this on agent so I wouldn't worry about the self-managed agent case. But I'm following up on this thread.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"standard" == "platinum" IIRC. Standard is our lowest tier in cloud, but it's still a paid tier, to it's higher than basic.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤯 Good point, Sean. We need to verify that the cloud standard license is included if we enforce platinum in the integration definition.

screenshots:
- src: /img/google-drive-connector-screenshot.png
title: Google Drive Connector Screenshot
size: 3824×1808
type: image/png
icons:
- src: /img/connectors-logo.svg
title: Connectors Logo
size: 32x32
type: image/svg+xml
policy_templates:
- name: github
title: GitHub & GitHub Enterprise Server Connector
icons:
- src: /img/service_type/github.svg
title: Google Drive logo
size: 32x32
type: image/svg+xml
description: Use a connector to sync data from your GitHub data source.
deployment_modes:
default:
enabled: false
agentless:
Copy link
Contributor

@eyalkraft eyalkraft Sep 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI we'll soon require some owner tags as part of this section.
It's not yet part of the spec but you can follow here to add it when it'll be added to the spec:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this won't block us from merging, will just be something we need to add to a todo list?

enabled: true
inputs:
- type: connectors-py
title: GitHub & GitHub Enterprise Server Connector
description: Connectors syncs data from an original data source to an Elasticsearch index.
- name: google_drive
title: Google Drive Connector
icons:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: going forward it is recommended to have screenshots per policy_template

- src: /img/service_type/google_drive.svg
title: Google Drive logo
size: 32x32
type: image/svg+xml
description: Use a connector to sync from your Google Drive data source.
deployment_modes:
default:
enabled: false
agentless:
enabled: true
inputs:
- type: connectors-py
title: Google Drive Connector
description: Connectors syncs data from an original data source to an Elasticsearch index.
owner:
github: elastic/ingestion-team
type: elastic