lucperkins commented on a change in pull request #369: Issue 362: [documentation] update command line tools URL: https://github.com/apache/bookkeeper/pull/369#discussion_r130935149
########## File path: site/_data/cli/shell.yaml ########## @@ -1,67 +1,157 @@ commands: - name: autorecovery + description: Enable or disable autorecovery in the cluster. options: - flag: -enable - description: Enables autorecovery + description: Enable auto recovery of underreplicated ledgers - flag: -disable - description: Disables autorecovery + description: Disable auto recovery of underreplicated ledgers - name: bookieFormat + description: Format the current server contents. options: - flag: -nonInteractive + description: Whether to confirm if old data exists..? - flag: -force + description: If [nonInteractive] is specified, then whether to force delete the old data without prompt..? - flag: -deleteCookie + description: Delete its cookie on zookeeper +- name: bookieinfo + description: Retrieve bookie info such as free and total disk space. - name: bookiesanity + description: Sanity test for local bookie. Create ledger and write/reads entries on local bookie. options: - flag: -entries N + description: Total entries to be added for the test (default 10) - flag: -timeout N + description: Timeout for write/read operations in seconds (default 1) +- name: decommissionbookie + description: Force trigger the Audittask and make sure all the ledgers stored in the decommissioning bookie are replicated. +- name: deleteledger + description: Delete a ledger + options: + - flag: -ledgerid N + description: Ledger ID + - flag: -force + description: Whether to force delete the Ledger without prompt..? +- name: expandstorage + description: Add new empty ledger/index directories. Update the directories info in the conf file before running the command. - name: help description: Displays the help message. - name: lastmark + description: Print last log marker. - name: ledger + description: Dump ledger index entries into readable format. options: - flag: -m LEDGER_ID + description: Print meta information - name: ledgermetadata + description: Print the metadata for a ledger. options: - - flag: -ledgerid LEDGER_ID + - flag: -ledgerid N + description: Ledger ID - name: listbookies + description: List the bookies, which are running as either readwrite or readonly mode. options: - flag: -readwrite + description: Print readwrite bookies - flag: -readonly + description: Print readonly bookies - flag: -hostnames + description: Also print hostname of the bookie +- name: listfilesondisc + description: List the files in JournalDirectory/LedgerDirectories/IndexDirectories. + options: + - flag: -journal + description: Print list of Journal Files + - flag: -entrylog + description: Print list of EntryLog Files + - flag: -index + description: Print list of Index files - name: listledgers + description: List all ledgers on the cluster (this may take a long time). options: - flag: -meta + description: Print metadata - name: listunderreplicated + description: List ledgers marked as underreplicated, with optional options to specify missingreplica (BookieId) and to exclude missingreplica. Review comment: "missingreplica" should be two words (missing replica) ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
