-
Notifications
You must be signed in to change notification settings - Fork 145
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
Connectors CLI tool #1616
Connectors CLI tool #1616
Conversation
291bf9c
to
d20917f
Compare
1884956
to
4f5f278
Compare
8af68aa
to
8092e82
Compare
CI seems to be red due to failing tests :/ I'll start the review of actual code, cause it seems like a problem in tests, but won't put approval cause it'll be dismissed anyway for now :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing PR! I left a couple questions/nits/suggestions, but I love the direction of it and what it allows us to do
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥
* Rename the tool * Create main parser
* Introduce connectors list command * Read existing config
3cf7087
to
b1ecb79
Compare
💔 Failed to create backport PR(s)The backport operation could not be completed due to the following error: The backport PRs will be merged automatically after passing CI. To backport manually run: |
Part of https://github.com/elastic/enterprise-search-team/issues/6245
This PR will introduce a new connector CLI.
Motivation
This tool aims to streamline data management processes, providing engineers with a faster and more efficient way to work with Connectors and Search indices, ultimately enhancing their productivity and workflow.
Usage
Installation
Before you start using you need to regenerate scripts by running
make clean install
Print help page
Run
./bin/connectors --help
to get detailed information about the tool.Usage: connectors [OPTIONS] COMMAND [ARGS]... Options: -v, --version Show the version and exit. -c, --config FILENAME --help Show this message and exit. Commands: connector Connectors management index Search indices management job Sync jobs management login Authenticate Connectors CLI with an Elasticsearch instance
You can also print a help page for specific commands e.g.
./bin/connectors job --help
Connecting to an Elasticsearch instance
To start using the tool you need to authenticate with your Elasticsearch instance. Run
./bin/connector login
and provide credentials. The result of the successful command is a file in.ci/config.yml
. It's up to you where to store this file, however, you need to specify it using./bin/connectors -c path_to_your_configuration command
.Known limitations
Checklists
Pre-Review Checklist
v7.13.2
,v7.14.0
,v8.0.0
)Changes Requiring Extra Attention
Release Note
We have added a new Connectors CLI (technical preview). The CLI is designed to streamline and automate the management of Elastic Connectors. You can use it for scripting and automation in your own infrastructure as it can connect to any Elasticsearch instance.
Known limitations: