Skip to content

Commit

Permalink
Clarify docs around kafka:fail
Browse files Browse the repository at this point in the history
  • Loading branch information
Maciek Sakrejda committed Apr 27, 2017
1 parent 9346fc6 commit 376409e
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions commands/fail.js
Expand Up @@ -32,12 +32,13 @@ module.exports = {
command: 'fail',
description: 'triggers failure on one node in the cluster',
help: `
Triggers failure on one node in the cluster.
Triggers failure on one Kafka broker in the cluster by stopping the underlying
instance and allowing Heroku automation to recover it.
Examples:
$ heroku kafka:fail
$ heroku kafka:fail HEROKU_KAFKA_BROWN_URL
$ heroku kafka:fail kafka-aerodynamic-32763
`,
needsApp: true,
needsAuth: true,
Expand All @@ -46,10 +47,10 @@ module.exports = {
],
flags: [
{ name: 'catastrophic',
description: 'induce unrecoverable server failure on the single node',
description: 'terminate the underlying instance instead and allow automation to replace it',
hasValue: false },
{ name: 'zookeeper',
description: 'induce failure on zookeeper node rather than on Kafka itself',
description: 'induce failure on one of the cluter\'s Zookeeper nodes instead',
hasValue: false },
{ name: 'confirm',
description: 'pass the app name to skip the manual confirmation prompt',
Expand Down

0 comments on commit 376409e

Please sign in to comment.