Commit Graph

55 Commits

Author SHA1 Message Date
Rajini Sivaram 7e23d3b38e KAFKA-6476: Documentation for dynamic broker configuration (#4558)
Docs for dynamic broker configuration (KIP-226)
2018-02-14 22:10:33 +00:00
Manikumar Reddy 3f32570dc9 KAFKA-6452; Add documentation for delegation token authentication
Author: Manikumar Reddy <manikumar.reddy@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #4490 from omkreddy/KAFKA-6452-TOKEN-DOCS

(cherry picked from commit ed971fd434)
Signed-off-by: Jun Rao <junrao@gmail.com>
2018-02-05 11:07:36 -08:00
Jakub Scholz 93ab94d7ed MINOR: Add authorizer.class.name to the security section in documentation (#4310) 2018-01-26 11:40:35 -08:00
Manikumar Reddy b088822134 KAFKA-5764; Add toLowerCase support to sasl.kerberos.principal.to.local rule (KIP-203)
Author: Manikumar Reddy <manikumar.reddy@gmail.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #3800 from omkreddy/KAFKA-5764-REGEX
2017-12-12 15:47:57 -08:00
Manikumar Reddy adb9d5ae76 MINOR: Add missing semicolon to example jaas configuration
Author: Manikumar Reddy <manikumar.reddy@gmail.com>

Reviewers: Rajini Sivaram <rajinisivaram@googlemail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #4101 from omkreddy/SCRAM-DOCS
2017-10-26 14:24:29 +01:00
Manikumar Reddy 83bdcdbaef MINOR: Refer consistently to server.properties in security docs
Author: Manikumar Reddy <manikumar.reddy@gmail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #3788 from omkreddy/RULE-DOC
2017-09-19 05:33:02 +01:00
ppatierno 1d2d0bac9e MINOR: Fixed misleading reference to HTTPS instead of SSL support in the doc
Author: ppatierno <ppatierno@live.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #3487 from ppatierno/ssl-doc-https
2017-07-20 20:16:15 -07:00
Manikumar Reddy O d06a0db8b8 MINOR: Specify keyalg RSA for SSL key generation commands
Author: Manikumar Reddy O <manikumar.reddy@gmail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #3305 from omkreddy/ssl-doc
2017-06-12 22:43:58 +01:00
Guozhang Wang 57b0d0fe57 MINOR: syntax brush for java / bash / json / text
Author: Guozhang Wang <wangguoz@gmail.com>

Reviewers: Derrick Or <derrickor@gmail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #3214 from guozhangwang/KMinor-doc-java-brush
2017-06-07 15:17:25 +01:00
xinlihua f0745cd514 KAFKA-4603: Disallow abbreviations in OptionParser constructor
KAFKA-4603 the command parsed error
Using "new OptionParser" might result in parse error

Change all the OptionParser constructor in Kafka into "new OptionParser(false)"

Author: xinlihua <xin.lihua1@zte.com.cn>
Author: unknown <00067310@A23338408.zte.intra>
Author: auroraxlh <xin.lihua1@zte.com.cn>
Author: xin <xin.lihua1@zte.com.cn>

Reviewers: Damian Guy, Guozhang Wang

Closes #2349 from auroraxlh/fix_OptionParser_bug
2017-05-30 13:53:32 -07:00
sunnykrgupta d2f5589afc MINOR: Fix typo in consumer ACL example
Author: sunnykrgupta <sunnygupta.kr@gmail.com>

Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #2839 from sunnykrGupta/trunk
2017-04-11 11:28:58 +01:00
shuguo zheng 1ce6aa5503 KAFKA-4964; Use correct keystore/trustore name in documentation
Author: shuguo zheng <zheng.shuguo@zte.com.cn>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #2749 from zhengsg/local
2017-03-31 11:08:12 +01:00
Manikumar Reddy O 81721f8c53 MINOR: Doc change related to ZK sasl configs
Author: Manikumar Reddy O <manikumar.reddy@gmail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #2620 from omkreddy/MINOR-ZK-CHANGE
2017-03-30 13:50:46 +01:00
Ryan P 05690f0c85 MINOR: Fix zookeeper-security-migration documentation example
Incorrect option in example

https://github.com/apache/kafka/blob/trunk/core/src/main/scala/kafka/admin/ZkSecurityMigrator.scala#L71

Author: Ryan P <ryan.n.pridgeon@gmail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #2714 from rnpridgeon/patch-1
2017-03-21 09:52:16 +00:00
Grant Henke b5dd39dda6 KAFKA-4525; Kafka should not require SSL truststore password
Author: Grant Henke <ghenke@cloudera.com>

Reviewers: Rajini Sivaram <rajinisivaram@googlemail.com>, Ismael Juma <ismael@juma.me.uk>

Closes #2246 from granthenke/truststore-password
2017-02-10 02:57:35 +00:00
Rajini Sivaram 666abafcc5 KAFKA-4589; SASL/SCRAM documentation
Author: Rajini Sivaram <rajinisivaram@googlemail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>, Gwen Shapira <cshapi@gmail.com>, Sriharsha Chintalapani <harsha@hortonworks.com>, Jun Rao <junrao@gmail.com>

Closes #2369 from rajinisivaram/KAFKA-4589
2017-01-19 08:35:39 -08:00
Rajini Sivaram b4d8668d6d KAFKA-4363; Documentation for sasl.jaas.config property
Author: Rajini Sivaram <rajinisivaram@googlemail.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #2316 from rajinisivaram/KAFKA-4363
2017-01-17 11:16:29 +00:00
Ismael Juma 76169f9e24 KAFKA-3284: Remove beta label from security documentation
4 release cycles (0.9.0.0, 0.10.0.0, 0.10.1.0, 0.10.2.0) should be enough
to remove the beta label.

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2286 from ijuma/kafka-3284-security-beta-label
2016-12-22 08:15:21 -08:00
Derrick Or 53428694a6 Separate Streams documentation and setup docs with easy to set variables
- Seperate Streams documentation out to a standalone page.
- Setup templates to use handlebars.js
- Create template variables to swap in frequently updated values like version number from a single file templateData.js

Author: Derrick Or <derrickor@gmail.com>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #2245 from derrickdoo/docTemplates
2016-12-13 17:59:49 -08:00
Ismael Juma 079ea89b36 KAFKA-4417: Update build dependencies for 0.10.2 cycle
Notes on the updates:
* Gradle to 3.2: better incremental build and faster IDE import times (https://docs.gradle.org/3.2/release-notes)
* zkclient to 0.10: it now uses slf4j-api instead of log4j
* zookeeper to 3.4.9: a few important bug fixes (http://zookeeper.apache.org/doc/r3.4.9/releasenotes.html)
* jackson to 2.8.5: lots of updates (https://github.com/FasterXML/jackson/wiki/Jackson-Release-2.6, https://github.com/FasterXML/jackson/wiki/Jackson-Release-2.7, https://github.com/FasterXML/jackson/wiki/Jackson-Release-2.8)
* jersey to 2.24: bug fixes (https://jersey.java.net/release-notes/2.23.html, https://jersey.java.net/release-notes/2.24.html)
* jopt to 5.0.3: minor improvements, the major version bump is due to requiring Java 7 instead of 6 (https://pholser.github.io/jopt-simple/changes.html)
* argparse4j to 0.7.0: minor tweaks and improvements (https://github.com/tatsuhiro-t/argparse4j/blob/argparse4j-0.6.0/NEWS, https://github.com/tatsuhiro-t/argparse4j/blob/argparse4j-0.7.0/NEWS)
* Gradle plugins
* bcpkix to 1.55: quite a few additions, but nothing that matters to us (http://www.bouncycastle.org/releasenotes.html)

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #2144 from ijuma/gradle-3.2-and-deps
2016-11-17 14:43:00 -08:00
Vahid Hashemian e972d2afd3 MINOR: Fix typos in documentation
And improve readability by adding proper punctuations.

Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #2002 from vahidhashemian/doc/fix_typos
2016-10-10 15:58:37 -07:00
Vahid Hashemian d2a267b111 KAFKA-3697; Clean up website documentation of client usage
This is to imply that the Java consumer/producer are the recommended consumer/producer now.

Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1921 from vahidhashemian/KAFKA-3697
2016-09-29 19:37:20 -07:00
Ismael Juma 61d3378bc8 MINOR: Remove no longer required --new-consumer switch in docs
Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Jason Gustafson <jason@confluent.io>

Closes #1905 from ijuma/no-new-consumer-switch-in-examples
2016-09-27 16:49:46 -07:00
Samuel Taylor f153407c42 MINOR: Fix typos in security section
1. I think the instructions in step 2 of the security section which describe adding the CA to server/client truststores are swapped. That is, the instruction that says to add the CA to the server truststore adds it to the client truststore (and vice versa).
2. "clients keys" should be possessive ("clients' keys").

This contribution is my original work, and I license the work to the project under the project's open source license.

Author: Samuel Taylor <staylor@square-root.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #1651 from ssaamm/trunk
2016-08-22 23:16:56 +01:00
Todd Palino 104d2154b6 KAFKA-4050; Allow configuration of the PRNG used for SSL
Add an optional configuration for the SecureRandom PRNG implementation, with the default behavior being the same (use the default implementation in the JDK/JRE).

Author: Todd Palino <Todd Palino>

Reviewers: Grant Henke <granthenke@gmail.com>, Ismael Juma <ismael@juma.me.uk>, Joel Koshy <jjkoshy@gmail.com>, Jiangjie Qin <becket.qin@gmail.com>, Rajini Sivaram <rajinisivaram@googlemail.com>

Closes #1747 from toddpalino/trunk
2016-08-19 11:05:39 -07:00
Ryan P c89707f315 KAFKA-3667; Improve Section 7.2 Encryption and Authentication using SSL to include proper hostname verification configuration
By default Kafka is configured to allow ssl communication without hostname verification. This docs has been amended to include instructions on how to set that up in the event clients would like to take a more conservative approach.

Author: Ryan P <ryan.n.pridgeon@gmail.com>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>, Ismael Juma <ismael@juma.me.uk>

Closes #1384 from rnpridgeon/KAFKA-3667
2016-08-03 10:15:36 +01:00
Filipe Azevedo 4c6d7ed95a KAFKA-3838; Update zkClient to 0.9 and Zookeeper to 3.4.8
Author: Filipe Azevedo <filipe@azevedo.io>

Reviewers: Flavio Junqueira <fpj@apache.org>, Ismael Juma <ismael@juma.me.uk>

Closes #1512 from mangas/trunk
2016-06-17 08:51:55 +02:00
Ismael Juma c699b1a914 MINOR: Use `--force` instead of `--yes` in `AclCommand`
To be consistent with `ConfigCommand` and `TopicCommand`.

No release includes this option yet, so we can simply change it.

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Mickael Maison, Grant Henke

Closes #1430 from ijuma/use-force-instead-of-yes-in-acl-command and squashes the following commits:

bdf3a57 [Ismael Juma] Update `AclCommandTest`
78b8467 [Ismael Juma] Change variable name to `forceOpt`
0bb27af [Ismael Juma] Use `--force` instead of `--yes` in `AclCommand`
2016-05-26 09:58:59 -07:00
Mickael Maison 5653249e08 KAFKA-3732: Add an auto accept option to kafka-acls.sh
Added a new argument to AclCommand: --yes. When set, automatically answer yes to prompts

Author: Mickael Maison <mickael.maison@gmail.com>

Reviewers: Gwen Shapira

Closes #1406 from mimaison/KAFKA-3732
2016-05-25 11:25:04 -07:00
Sriharsha Chintalapani dee3880666 MINOR: Specify keyalg RSA for SSL key generation
Author: Sriharsha Chintalapani <harsha@hortonworks.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #1416 from harshach/ssl-doc-fix
2016-05-22 10:01:32 +01:00
Ismael Juma 2ce3285297 MINOR: Move `Incorporating Security Features in a Running Cluster` to its own section under `Security`
It was previously in the SASL section (probably by mistake).

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Sriharsha Chintalapani <schintalapani@hortonworks.com>

Closes #1405 from ijuma/fix-security-upgrade-location-in-docs
2016-05-19 17:16:37 +01:00
Rajini Sivaram abac51dc0b KAFKA-3517; Add documentation for SASL/PLAIN
Documentation corresponding to KIP-43 - SASL/PLAIN and multiple mechanism support.

Author: Rajini Sivaram <rajinisivaram@googlemail.com>

Reviewers: Magnus Edenhill <apache_m@edenhill.se>, Jun Rao <junrao@gmail.com>

Closes #1232 from rajinisivaram/KAFKA-3517
2016-05-03 09:49:23 -07:00
Jun Rao 5caa800e21 trivial fix to authorization CLI table 2016-02-19 09:41:37 -08:00
Sasaki Toru 1faab034b1 MINOR: Remove multi-byte charactor in docs
There are multi-byte characters In quickstart.html and security.html.
This PR will fix it.

Author: Sasaki Toru <sasakitoa@nttdata.co.jp>

Reviewers: Grant Henke

Closes #897 from sasakitoa/remove_multi_byte_character
2016-02-10 12:50:57 -07:00
Ben Stopford 962aec1a78 MINOR: Add Rolling Upgrade Notes to Security Docs
And added info about the krb5.conf file as we don't appear to mention that in the current docs

Author: Ben Stopford <benstopford@gmail.com>

Reviewers: Ismael Juma

Closes #625 from benstopford/security_docs
2016-01-28 20:42:51 -08:00
Ismael Juma a40a2a260a MINOR: Fix syntax used for comment in JAAS config file
Simple fix, but important because the incorrect syntax causes the server not to start.

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Grant Henke, Guozhang Wang

Closes #819 from ijuma/fix-jaas-comment-syntax
2016-01-27 10:12:58 -08:00
Vahid Hashemian d00cf520fb MINOR: Improve Kafka documentation
Improve the documentation by fixing typos, punctuations, and correcting the content.

Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Grant Henke <granthenke@gmail.com>, Ewen Cheslack-Postava <ewen@confluent.io>

Closes #778 from vahidhashemian/typo05/fix_documentation_typos
2016-01-23 22:26:53 -08:00
Tom Graves 401ae7707c KAFKA-3095: Add documentation on format of sasl.kerberos.principal.to.local.rules
Add some basic documentation about the format, a link to get more detailed information and an example usage.  I didn't want to make a huge section on the format since it documented elsewhere but I can expand is folks want.

https://issues.apache.org/jira/browse/KAFKA-3095

Author: Tom Graves <tgraves@yahoo-inc.com>

Reviewers: Gwen Shapira

Closes #776 from tgravescs/KAFKA-3095
2016-01-18 10:03:47 -08:00
Ismael Juma 36f5c46a5c MINOR: Security doc fixes
Simple fixes that have tripped users.

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Ewen Cheslack-Postava <ewen@confluent.io>

Closes #745 from ijuma/security-doc-improvements
2016-01-08 16:08:38 -08:00
BINLEI XUE 9f33bfe19c Minor: fix sasl.kerberos.service.name
sasl.kerberos.service.name surround by double quote didn't work, have to remove.

Author: BINLEI XUE <kongpo0412@gmail.com>

Reviewers: Gwen Shapira

Closes #720 from secjex/patch-1
2015-12-30 08:00:43 -08:00
Jun Rao 3e0333d692 trivial change: revert incorrect change to ssl.key.password 2015-11-20 16:31:05 -08:00
Jun Rao a7726ee651 trivial change to 0.9.0 docs to fix incorrect ssl.key.password 2015-11-20 13:47:27 -08:00
Ismael Juma c7c7f4cfa7 MINOR: Documentation improvements
* Fix typo in api.html
* Mark security features as beta quality (similar to new consumer). Is there better wording?
* Improve wording and clarify things in a number of places
* Improve layout of `pre` blocks (tested locally, which doesn't seem to use the same stylesheets as the deployed version)
* Use producer.config in console-producer.sh command
* Improve SASL documentation structure

Author: Ismael Juma <ismael@juma.me.uk>

Reviewers: Jun Rao, Magnus Edenhill, Gwen Shapira

Closes #550 from ijuma/documentation-improvements
2015-11-19 07:59:03 -08:00
Jun Rao 17c6f33126 trivial fix to 0.9.0 docs 2015-11-17 19:05:53 -08:00
Parth Brahmbhatt dacd21ec4e KAFKA-2852; Updating the Authorizer CLI to use a consistent way to specify a list of values for a config options.
…ecify a list of values for a config options.

Author: Parth Brahmbhatt <brahmbhatt.parth@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #545 from Parth-Brahmbhatt/KAFKA-2852
2015-11-17 17:46:59 -08:00
Jun Rao ae315264db trivial doc change for building customized user name 2015-11-16 17:57:59 -08:00
Grant Henke 6cbd97597c KAFKA-2809; Improve documentation linking
Often it is useful to link to a specific header within the documentation. Especially when referencing docs in the mailing lists.

This adds anchors and links for all headers in the docs.

Author: Grant Henke <granthenke@gmail.com>

Reviewers: Jun Rao <junrao@gmail.com>

Closes #498 from granthenke/doc-links
2015-11-16 14:14:17 -08:00
Jun Rao 599a31c245 trivial 0.9.0 doc changes to AclCommand 2015-11-13 17:42:50 -08:00
Jun Rao 5d87eac856 additional trivial 0.9.0 doc changes 2015-11-13 14:18:02 -08:00
Jun Rao 397306cdfe trivial doc changes 2015-11-13 10:34:15 -08:00