BP-27: New BookKeeper CLI

[sijie]

BP

This is the master ticket for tracking BP-27:

BookieShell is becoming a gaint class to contain all the sub command. It is a good time to think about how to break this class down:

• group the commands into categories, e.g. bookie, cluster, metadata.
• break this class into smaller classes for different commands, and improve the testability
• it is probably good to rethink using jcommander to implement this.

This BP proposes refactoring the bookkeeper commands in BookieShell in new CLI tool.

Proposal PR - #1093

[jiazhai]

made a rough group based on the 4 groups: bookie, cluster, metadata, client.

## bookie
Done： lastmark

Todo:

- CMD_BOOKIEFORMAT
 // Formats the local data present in current bookie server.
class BookieFormatCmd extends MyCommand

- CMD_RECOVER
 // Recover command for ledger data recovery for failed bookie.
class RecoverCmd extends MyCommand

- CMD_READLOG
 // Command to read entry log files.
class ReadLogCmd extends MyCommand

- CMD_READLOGMETADATA
// Command to print metadata of entrylog.

class ReadLogMetadataCmd extends MyCommand

- CMD_READJOURNAL
// Command to read journal files.

class ReadJournalCmd extends MyCommand

- CMD_LISTFILESONDISC
List the files in JournalDirectory/LedgerDirectories/IndexDirectories
class ListDiskFilesCmd extends MyCommand

- CMD_DECOMMISSIONBOOKIE
// Command to trigger AuditTask by resetting lostBookieRecoveryDelay and then make sure the
// ledgers stored in the bookie are properly replicated.
class DecommissionBookieCmd extends MyCommand


## cluster
done： listBookies

Todo:
- CMD_BOOKIEINFO
// Command to retrieve bookie information like free disk space, etc from all the bookies in the cluster.
class BookieInfoCmd extends MyCommand

- CMD_INITNEWCLUSTER
// Intializes new cluster by creating required znodes for the cluster.
class InitNewCluster extends MyCommand

- CMD_NUKEEXISTINGCLUSTER
// Nuke bookkeeper metadata of existing cluster in zookeeper.
class NukeExistingCluster extends MyCommand {
}

- CMD_LEDGER
//  dump ledger index entries into readable format.
class LedgerCmd extends MyCommand {

- CMD_READ_LEDGER_ENTRIES
// Command for reading ledger entries.
class ReadLedgerEntriesCmd extends MyCommand {

- CMD_LISTLEDGERS
// Command to list all ledgers in the cluster.
class ListLedgersCmd extends MyCommand

- CMD_LEDGERMETADATA
// Print the metadata for a ledger.
class LedgerMetadataCmd extends MyCommand

-  CMD_LISTUNDERREPLICATED
// Command for listing underreplicated ledgers.
class ListUnderreplicatedCmd extends MyCommand

- CMD_WHATISINSTANCEID
// Prints the instanceid of the cluster.
class WhatIsInstanceId extends MyCommand

- CMD_AUTORECOVERY
// Command for administration of autorecovery.
// Enable or disable autorecovery in the cluster.
class AutoRecoveryCmd extends MyCommand

- CMD_TRIGGERAUDIT
// Command to trigger AuditTask by resetting lostBookieRecoveryDelay to its current value.
class TriggerAuditCmd extends MyCommand


## client
done： simpletest

TODO:
- CMD_BOOKIESANITYTEST
// Command to run a bookie sanity test.
class BookieSanityTestCmd extends MyCommand

- CMD_UPDATELEDGER
// Update bookie id in ledgers
class UpdateLedgerCmd extends MyCommand

- CMD_DELETELEDGER
// Command to delete a given ledger.
class DeleteLedgerCmd extends MyCommand


## metadata
Todo:
- CMD_METAFORMAT
// Format the bookkeeper metadata present in zookeeper.
class MetaFormatCmd extends MyCommand

- CMD_INITBOOKIE
// Initializes bookie, by making sure that the journalDir, ledgerDirs and
// indexDirs are empty and there is no registered Bookie with this BookieId.
class InitBookieCmd extends MyCommand

- CMD_WHOISAUDITOR
// Print which node has the auditor lock.
class WhoIsAuditorCmd extends MyCommand

- CMD_UPDATECOOKIE,
// Update cookie command.
class UpdateCookieCmd extends MyCommand

- CMD_LOSTBOOKIERECOVERYDELAY
// Setter and Getter for LostBookieRecoveryDelay value (in seconds) in Zookeeper.
class LostBookieRecoveryDelayCmd extends MyCommand

- CMD_CONVERT_TO_DB_STORAGE
// Convert bookie indexes from InterleavedStorage to DbLedgerStorage format.
class ConvertToDbStorageCmd extends MyCommand

- CMD_CONVERT_TO_INTERLEAVED_STORAGE
// Convert bookie indexes from DbLedgerStorage to InterleavedStorage format.
class ConvertToInterleavedStorageCmd extends MyCommand

- CMD_REBUILD_DB_LEDGER_LOCATIONS_INDEX
// Rebuild DbLedgerStorage locations index.
class RebuildDbLedgerLocationsIndexCmd extends MyCommand

[sijie]

All the bookkeeper CLI commands have been implemented in bkctl. Close it now.