<h1 align="center">Kafka Connect Manager</h1>
<p align="center">A tool to manage Apache Kafka Connect connectors and tasks</p>
**Usage**:
```console
$ kcm [OPTIONS] COMMAND [ARGS]...
```
**Options**:
* `--host TEXT`: Connect worker host [env var: CONNECT_HOST; default: http://localhost:8083]
* `--install-completion`: Install completion for the current shell.
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
* `--help`: Show this message and exit.
**Commands**:
* `add`: Register new connector Supporting environment...
* `list`: List all connectors
* `status`: Get status connector
* `update`: Update connector configuration
* `watch`: Actively monitor your connectors health
## `kcm add`
Register new connector
Supporting environment variable expansion in JSON file.
A connector requires a name and configuration, we take both of them separately.
For example:
```json
{
"name": "MySinkConnector",
"config": {
"connector.class": "com.mongodb.kafka.connect.MongoSinkConnector",
"connection.uri": "${MONGODB_URL}"
}
}
```
**Usage**:
```console
$ kcm add [OPTIONS]
```
**Options**:
* `-f, --file FILE`: Config JSON file path [required]
* `--help`: Show this message and exit.
## `kcm list`
List all connectors
**Usage**:
```console
$ kcm list [OPTIONS]
```
**Options**:
* `--type [all|sink|source]`: Type of connectors to list [default: all]
* `--help`: Show this message and exit.
## `kcm status`
Get status connector
**Usage**:
```console
$ kcm status [OPTIONS]
```
**Options**:
* `--connector TEXT`: Name of connector [required]
* `--help`: Show this message and exit.
## `kcm update`
Update connector configuration
**Usage**:
```console
$ kcm update [OPTIONS] CONNECTOR
```
**Arguments**:
* `CONNECTOR`: Connector name [required]
**Options**:
* `-f, --file FILE`: Config JSON file path [required]
* `--help`: Show this message and exit.
## `kcm watch`
Actively monitor your connectors health
**Usage**:
```console
$ kcm watch [OPTIONS] [CONNECTORS]...
```
**Arguments**:
* `[CONNECTORS]...`: Connectors to monitor
**Options**:
* `--refresh-interval INTEGER`: Refresh interval [default: 5]
* `--help`: Show this message and exit.
Raw data
{
"_id": null,
"home_page": "https://github.com/khan-ajamal/kafka-connect-manager",
"name": "kafka-connect-manager",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "kafka,kafka connect",
"author": "Ajamal Khan",
"author_email": "13559558+khan-ajamal@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/18/d2/768f0212d3690c0478cf080459164459b440939be624defd7718b05d2a00/kafka_connect_manager-0.5.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Kafka Connect Manager</h1>\n<p align=\"center\">A tool to manage Apache Kafka Connect connectors and tasks</p>\n\n**Usage**:\n\n```console\n$ kcm [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n* `--host TEXT`: Connect worker host [env var: CONNECT_HOST; default: http://localhost:8083]\n* `--install-completion`: Install completion for the current shell.\n* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n* `--help`: Show this message and exit.\n\n**Commands**:\n\n* `add`: Register new connector Supporting environment...\n* `list`: List all connectors\n* `status`: Get status connector\n* `update`: Update connector configuration\n* `watch`: Actively monitor your connectors health\n\n## `kcm add`\n\nRegister new connector\n\nSupporting environment variable expansion in JSON file.\n\nA connector requires a name and configuration, we take both of them separately.\n\nFor example:\n\n```json\n{\n \"name\": \"MySinkConnector\",\n \"config\": {\n \"connector.class\": \"com.mongodb.kafka.connect.MongoSinkConnector\",\n \"connection.uri\": \"${MONGODB_URL}\"\n }\n}\n```\n\n**Usage**:\n\n```console\n$ kcm add [OPTIONS]\n```\n\n**Options**:\n\n* `-f, --file FILE`: Config JSON file path [required]\n* `--help`: Show this message and exit.\n\n## `kcm list`\n\nList all connectors\n\n**Usage**:\n\n```console\n$ kcm list [OPTIONS]\n```\n\n**Options**:\n\n* `--type [all|sink|source]`: Type of connectors to list [default: all]\n* `--help`: Show this message and exit.\n\n## `kcm status`\n\nGet status connector\n\n**Usage**:\n\n```console\n$ kcm status [OPTIONS]\n```\n\n**Options**:\n\n* `--connector TEXT`: Name of connector [required]\n* `--help`: Show this message and exit.\n\n## `kcm update`\n\nUpdate connector configuration\n\n**Usage**:\n\n```console\n$ kcm update [OPTIONS] CONNECTOR\n```\n\n**Arguments**:\n\n* `CONNECTOR`: Connector name [required]\n\n**Options**:\n\n* `-f, --file FILE`: Config JSON file path [required]\n* `--help`: Show this message and exit.\n\n## `kcm watch`\n\nActively monitor your connectors health\n\n\n\n**Usage**:\n\n```console\n$ kcm watch [OPTIONS] [CONNECTORS]...\n```\n\n**Arguments**:\n\n* `[CONNECTORS]...`: Connectors to monitor\n\n**Options**:\n\n* `--refresh-interval INTEGER`: Refresh interval [default: 5]\n* `--help`: Show this message and exit.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool to manage Apache Kafka Connect connectors and tasks using asyncio",
"version": "0.5.1",
"split_keywords": [
"kafka",
"kafka connect"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e32e8aceae325f1956fccfa13eaabe77",
"sha256": "64800a972625fe4bd9e24155ac486017c1fc88d554bbfa462f18c87a06c6e13b"
},
"downloads": -1,
"filename": "kafka_connect_manager-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e32e8aceae325f1956fccfa13eaabe77",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 9349,
"upload_time": "2022-12-09T08:39:32",
"upload_time_iso_8601": "2022-12-09T08:39:32.121945Z",
"url": "https://files.pythonhosted.org/packages/47/94/62f9b110b0df3358a619bd7fad2c3f1d7c1354486ef83c4532ff54998962/kafka_connect_manager-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "48296d9c108be6719b9c9e2523a9bd97",
"sha256": "2559bf5843c259811d019f9b298ceb161b7c05b15e8b8fb8320fcc690c5ae69d"
},
"downloads": -1,
"filename": "kafka_connect_manager-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "48296d9c108be6719b9c9e2523a9bd97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 8246,
"upload_time": "2022-12-09T08:39:33",
"upload_time_iso_8601": "2022-12-09T08:39:33.582031Z",
"url": "https://files.pythonhosted.org/packages/18/d2/768f0212d3690c0478cf080459164459b440939be624defd7718b05d2a00/kafka_connect_manager-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-09 08:39:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "khan-ajamal",
"github_project": "kafka-connect-manager",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kafka-connect-manager"
}
JSON
