strimzi-kafka-cli


Namestrimzi-kafka-cli JSON
Version 0.1.0a23 PyPI version JSON
download
home_pagehttps://github.com/systemcraftsman/strimzi-kafka-cli
SummaryCommand Line Interface for Strimzi Kafka Operator
upload_time2020-07-10 23:04:09
maintainer
docs_urlNone
author
requires_python>=3.5
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Build](https://github.com/systemcraftsman/strimzi-kafka-cli/workflows/Build/badge.svg) ![Deploy](https://github.com/systemcraftsman/strimzi-kafka-cli/workflows/Deploy/badge.svg)

![strimzi cli](https://raw.githubusercontent.com/systemcraftsman/strimzi-kafka-cli/master/logo/strimzi_cli.png)

# Strimzi Kafka CLI

Strimzi Kafka CLI is a CLI that helps traditional Apache Kafka users
-mostly administrators- to easily adapt [Strimzi](https://strimzi.io/),
a [Kubernetes
operator](https://operatorhub.io/operator/strimzi-kafka-operator) for
[Apache Kafka](https://kafka.apache.org/).

Intention here is to ramp up Strimzi usage by creating a similar CLI
experience with traditional Apache Kafka binaries. For example:

| Native Command                             | Strimzi CLI Command  |
| ------------------------------------------ | -------------------- |
| $KAFKA\_HOME/bin/kafka-topics.sh           | kfk topics           |
| $KAFKA\_HOME/bin/kafka-configs.sh          | kfk configs          |
| $KAFKA\_HOME/bin/kafka-console-consumer.sh | kfk console-consumer |
| ... | ... |

**kfk** command stands for the usual **kafka-**\* prefix of the
Apache Kafka runnable files which are located in *bin* directory. There
are options provided like *topics*, *console-consumer*, etc. which also
mostly stand for the rest of the runnable file names like
*kafka-topic.sh*.

However, because of the nature of Strimzi and its capabilities, there
are also unusual options like *clusters* which is used for
cluster configuration or *users* which is used for user management and
configuration.

Following is the high-level output of the Strimzi Kafka CLI:

``` bash
Usage: kfk [OPTIONS] COMMAND [ARGS]...

  Strimzi Kafka CLI

Options:
  --help  Show this message and exit.

Commands:
  acls              This tool helps to manage ACLs on Kafka.
  clusters          The kafka cluster(s) to be created, altered or...
  configs           Add/Remove entity config for a topic, client, user or...
  console-consumer  The console consumer is a tool that reads data from...
  console-producer  The console producer is a tool that reads data from...
  topics            The kafka topic(s) to be created, altered or described.
  users             The kafka user(s) to be created, altered or described.
  version           Prints the version of Strimzi Kafka CLI
```

## Installation

Strimzi Kafka CLI can be installed via pip (python package installer).

``` bash
pip install strimzi-kafka-cli
```
Project requires: Python >=3.5

## Dependencies
### Python Dependencies
Please see [requirements.txt](https://github.com/systemcraftsman/strimzi-kafka-cli/blob/master/requirements.txt) file.
### External Dependencies
- kubectl: kfk will automatically download kubectl binary which is configurable to use which kubectl version to use. (Pls see [issue-19](https://github.com/systemcraftsman/strimzi-kafka-cli/issues/19))
- Strimzi binaries: kfk will download it automatically. The yaml templates are used for create actions. This is configurable to use which binaries path to use. (Pls see [issue-19](https://github.com/systemcraftsman/strimzi-kafka-cli/issues/19))


More info will be added soon.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/systemcraftsman/strimzi-kafka-cli",
    "name": "strimzi-kafka-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/16/1a/8a9c4b974de65a80152fa83f8208317bef8350c3f92f46748172202b4105/strimzi-kafka-cli-0.1.0a23.tar.gz",
    "platform": "",
    "description": "![Build](https://github.com/systemcraftsman/strimzi-kafka-cli/workflows/Build/badge.svg) ![Deploy](https://github.com/systemcraftsman/strimzi-kafka-cli/workflows/Deploy/badge.svg)\n\n![strimzi cli](https://raw.githubusercontent.com/systemcraftsman/strimzi-kafka-cli/master/logo/strimzi_cli.png)\n\n# Strimzi Kafka CLI\n\nStrimzi Kafka CLI is a CLI that helps traditional Apache Kafka users\n-mostly administrators- to easily adapt [Strimzi](https://strimzi.io/),\na [Kubernetes\noperator](https://operatorhub.io/operator/strimzi-kafka-operator) for\n[Apache Kafka](https://kafka.apache.org/).\n\nIntention here is to ramp up Strimzi usage by creating a similar CLI\nexperience with traditional Apache Kafka binaries. For example:\n\n| Native Command                             | Strimzi CLI Command  |\n| ------------------------------------------ | -------------------- |\n| $KAFKA\\_HOME/bin/kafka-topics.sh           | kfk topics           |\n| $KAFKA\\_HOME/bin/kafka-configs.sh          | kfk configs          |\n| $KAFKA\\_HOME/bin/kafka-console-consumer.sh | kfk console-consumer |\n| ... | ... |\n\n**kfk** command stands for the usual **kafka-**\\* prefix of the\nApache Kafka runnable files which are located in *bin* directory. There\nare options provided like *topics*, *console-consumer*, etc. which also\nmostly stand for the rest of the runnable file names like\n*kafka-topic.sh*.\n\nHowever, because of the nature of Strimzi and its capabilities, there\nare also unusual options like *clusters* which is used for\ncluster configuration or *users* which is used for user management and\nconfiguration.\n\nFollowing is the high-level output of the Strimzi Kafka CLI:\n\n``` bash\nUsage: kfk [OPTIONS] COMMAND [ARGS]...\n\n  Strimzi Kafka CLI\n\nOptions:\n  --help  Show this message and exit.\n\nCommands:\n  acls              This tool helps to manage ACLs on Kafka.\n  clusters          The kafka cluster(s) to be created, altered or...\n  configs           Add/Remove entity config for a topic, client, user or...\n  console-consumer  The console consumer is a tool that reads data from...\n  console-producer  The console producer is a tool that reads data from...\n  topics            The kafka topic(s) to be created, altered or described.\n  users             The kafka user(s) to be created, altered or described.\n  version           Prints the version of Strimzi Kafka CLI\n```\n\n## Installation\n\nStrimzi Kafka CLI can be installed via pip (python package installer).\n\n``` bash\npip install strimzi-kafka-cli\n```\nProject requires: Python >=3.5\n\n## Dependencies\n### Python Dependencies\nPlease see [requirements.txt](https://github.com/systemcraftsman/strimzi-kafka-cli/blob/master/requirements.txt) file.\n### External Dependencies\n- kubectl: kfk will automatically download kubectl binary which is configurable to use which kubectl version to use. (Pls see [issue-19](https://github.com/systemcraftsman/strimzi-kafka-cli/issues/19))\n- Strimzi binaries: kfk will download it automatically. The yaml templates are used for create actions. This is configurable to use which binaries path to use. (Pls see [issue-19](https://github.com/systemcraftsman/strimzi-kafka-cli/issues/19))\n\n\nMore info will be added soon.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Command Line Interface for Strimzi Kafka Operator",
    "version": "0.1.0a23",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6c21dd58084e4403e08c8d3c6e616c13",
                "sha256": "29ef05e6a410b2331574f7545b4a4b940b5bb823103516b03246d4bd6588d7bf"
            },
            "downloads": -1,
            "filename": "strimzi_kafka_cli-0.1.0a23-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6c21dd58084e4403e08c8d3c6e616c13",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 19489,
            "upload_time": "2020-07-10T23:04:08",
            "upload_time_iso_8601": "2020-07-10T23:04:08.500039Z",
            "url": "https://files.pythonhosted.org/packages/82/7f/3f7a07fc843080304575e9c51b8044d3dfd547490a1628cb4948073606c3/strimzi_kafka_cli-0.1.0a23-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d0209640e5d59eeaba05ebb962f9407d",
                "sha256": "76a574bd1c1a2cb7600b66cd7151e976bb5678686cb6329147f76886934f7a0d"
            },
            "downloads": -1,
            "filename": "strimzi-kafka-cli-0.1.0a23.tar.gz",
            "has_sig": false,
            "md5_digest": "d0209640e5d59eeaba05ebb962f9407d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 11903,
            "upload_time": "2020-07-10T23:04:09",
            "upload_time_iso_8601": "2020-07-10T23:04:09.612268Z",
            "url": "https://files.pythonhosted.org/packages/16/1a/8a9c4b974de65a80152fa83f8208317bef8350c3f92f46748172202b4105/strimzi-kafka-cli-0.1.0a23.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-07-10 23:04:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "systemcraftsman",
    "error": "Could not fetch GitHub repository",
    "lcname": "strimzi-kafka-cli"
}
        
Elapsed time: 0.12389s