[CLI] Add documentation #2031
[CLI] Add documentation #2031
Conversation
There was a problem hiding this comment.
Not related to this PR.
When we run make clean install, we also install elastic-ingest, which is used to
- run the connector service (
./bin/elastic-ingest) - list all the available sources (
./bin/elastic-ingest --action list) - get the default configuration of a service type (
./bin/elastic-ingest --action config --service-type mongodb) - clean up sync jobs (
./bin/elastic-ingest --action cleanup)
WDYT if we merge the above functionalities into the CLI so we only need to install one connectors.
|
|
||
| Examples | ||
| ```bash | ||
| ./bin/connectors job list -- <connector_id> |
There was a problem hiding this comment.
Is it a common practice to use -- to specify an ID? I also see -- in Job start example below which is not used for an ID.
There was a problem hiding this comment.
It's not super common however it helps to avoid errors when an Elasticsearch document starts with -. See https://github.com/elastic/enterprise-search-team/issues/6440 to get more information.
Yes, this is a good idea. We can probably move everything related to "connector service" under "./bin/connectorts service" namespace. |
vidok
force-pushed
the
dmitrii/6506-cli-documentation
branch
from
d620640 to
95f8350
Compare
Co-authored-by: Dmitriy Burlutskiy <[email protected]>
Closes https://github.com/elastic/enterprise-search-team/issues/6506
This adds a Connectors CLI documentation page.
Checklists
Pre-Review Checklist
v7.13.2,v7.14.0,v8.0.0)