From 8e8e328205beb1ae8375a2612ff1e486ed03be50 Mon Sep 17 00:00:00 2001 From: Ahmed Muawia Khan Date: Fri, 23 Feb 2018 14:53:28 +0100 Subject: [PATCH 1/2] Migrate CLI documentation - Remove documentation for CLI commands that are not needed with Tendermint integration. --- .../source/server-reference/bigchaindb-cli.md | 81 +++---------------- 1 file changed, 11 insertions(+), 70 deletions(-) diff --git a/docs/server/source/server-reference/bigchaindb-cli.md b/docs/server/source/server-reference/bigchaindb-cli.md index 790cb453..00bee5c6 100644 --- a/docs/server/source/server-reference/bigchaindb-cli.md +++ b/docs/server/source/server-reference/bigchaindb-cli.md @@ -15,22 +15,21 @@ Show the version number. `bigchaindb -v` does the same thing. ## bigchaindb configure -Generate a local configuration file (which can be used to set some or all [BigchainDB node configuration settings](configuration.html)). It will auto-generate a public-private keypair and then ask you for the values of other configuration settings. If you press Enter for a value, it will use the default value. +Generate a local configuration file (which can be used to set some or all [BigchainDB node configuration settings](configuration.html)). It will ask you for the values of other configuration settings. +If you press Enter for a value, it will use the default value. -Since BigchainDB supports multiple databases you need to always specify the -database backend that you want to use. At this point only two database backends -are supported: `rethinkdb` and `mongodb`. +At this point only one database backend is supported: `localmongodb`. If you use the `-c` command-line option, it will generate the file at the specified path: ```text -bigchaindb -c path/to/new_config.json configure rethinkdb +bigchaindb -c path/to/new_config.json configure localmongodb ``` If you don't use the `-c` command-line option, the file will be written to `$HOME/.bigchaindb` (the default location where BigchainDB looks for a config file, if one isn't specified). -If you use the `-y` command-line option, then there won't be any interactive prompts: it will just generate a keypair and use the default values for all the other configuration settings. +If you use the `-y` command-line option, then there won't be any interactive prompts: it will use the default values for all the other configuration settings. ```text -bigchaindb -y configure rethinkdb +bigchaindb -y configure localmongodb ``` @@ -39,32 +38,23 @@ bigchaindb -y configure rethinkdb Show the values of the [BigchainDB node configuration settings](configuration.html). -## bigchaindb export-my-pubkey - -Write the node's public key (i.e. one of its configuration values) to standard output (stdout). - - ## bigchaindb init -Create a backend database (RethinkDB or MongoDB), -all database tables/collections, -various backend database indexes, -and the genesis block. +Create a backend database (Local MongoDB), all database tables/collections, +various backend database indexes, and the genesis block. ## bigchaindb drop -Drop (erase) the backend database (a RethinkDB or MongoDB database). +Drop (erase) the backend database (a Local MongoDB database). You will be prompted to make sure. If you want to force-drop the database (i.e. skipping the yes/no prompt), then use `bigchaindb -y drop` ## bigchaindb start -Start BigchainDB. It always begins by trying a `bigchaindb init` first. See the note in the documentation for `bigchaindb init`. The database initialization step is optional and can be skipped by passing the `--no-init` flag i.e. `bigchaindb start --no-init`. -You can also use the `--dev-start-rethinkdb` command line option to automatically start rethinkdb with bigchaindb if rethinkdb is not already running, -e.g. `bigchaindb --dev-start-rethinkdb start`. Note that this will also shutdown rethinkdb when the bigchaindb process stops. -The option `--dev-allow-temp-keypair` will generate a keypair on the fly if no keypair is found, this is useful when you want to run a temporary instance of BigchainDB in a Docker container, for example. +Start BigchainDB. It always begins by trying a `bigchaindb init` first. See the note in the documentation for `bigchaindb init`. +The database initialization step is optional and can be skipped by passing the `--no-init` flag i.e. `bigchaindb start --no-init`. ### Options The log level for the console can be set via the option `--log-level` or its @@ -82,52 +72,3 @@ section of Python's documentation. For a more fine-grained control over the logging configuration you can use the configuration file as documented under [Configuration Settings](configuration.html). - -## bigchaindb set-shards - -This command is specific to RethinkDB so it will only run if BigchainDB is -configured with `rethinkdb` as the backend. - -If RethinkDB is the backend database, then: -```text -$ bigchaindb set-shards 4 -``` - -will set the number of shards (in all RethinkDB tables) to 4. - - -## bigchaindb set-replicas - -This command is specific to RethinkDB so it will only run if BigchainDB is -configured with `rethinkdb` as the backend. - -If RethinkDB is the backend database, then: -```text -$ bigchaindb set-replicas 3 -``` - -will set the number of replicas (of each shard) to 3 -(i.e. it will set the replication factor to 3). - - -## bigchaindb add-replicas - -This command is specific to MongoDB so it will only run if BigchainDB is -configured with `mongodb` as the backend. - -This command is used to add nodes to a BigchainDB cluster. It accepts a list of -space separated hosts in the form _hostname:port_: -```text -$ bigchaindb add-replicas server1.com:27017 server2.com:27017 server3.com:27017 -``` - -## bigchaindb remove-replicas - -This command is specific to MongoDB so it will only run if BigchainDB is -configured with `mongodb` as the backend. - -This command is used to remove nodes from a BigchainDB cluster. It accepts a -list of space separated hosts in the form _hostname:port_: -```text -$ bigchaindb remove-replicas server1.com:27017 server2.com:27017 server3.com:27017 -``` From 86e7b2a881a08c34285b0bc735e0a2dc75db4068 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Sun, 25 Feb 2018 18:05:18 +0100 Subject: [PATCH 2/2] Some minor copy-editing --- .../source/server-reference/bigchaindb-cli.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/server/source/server-reference/bigchaindb-cli.md b/docs/server/source/server-reference/bigchaindb-cli.md index 00bee5c6..de7407e0 100644 --- a/docs/server/source/server-reference/bigchaindb-cli.md +++ b/docs/server/source/server-reference/bigchaindb-cli.md @@ -15,10 +15,10 @@ Show the version number. `bigchaindb -v` does the same thing. ## bigchaindb configure -Generate a local configuration file (which can be used to set some or all [BigchainDB node configuration settings](configuration.html)). It will ask you for the values of other configuration settings. +Generate a local configuration file (which can be used to set some or all [BigchainDB node configuration settings](configuration.html)). It will ask you for the values of some configuration settings. If you press Enter for a value, it will use the default value. -At this point only one database backend is supported: `localmongodb`. +At this point, only one database backend is supported: `localmongodb`. If you use the `-c` command-line option, it will generate the file at the specified path: ```text @@ -27,7 +27,7 @@ bigchaindb -c path/to/new_config.json configure localmongodb If you don't use the `-c` command-line option, the file will be written to `$HOME/.bigchaindb` (the default location where BigchainDB looks for a config file, if one isn't specified). -If you use the `-y` command-line option, then there won't be any interactive prompts: it will use the default values for all the other configuration settings. +If you use the `-y` command-line option, then there won't be any interactive prompts: it will use the default values for all the configuration settings. ```text bigchaindb -y configure localmongodb ``` @@ -40,23 +40,24 @@ Show the values of the [BigchainDB node configuration settings](configuration.ht ## bigchaindb init -Create a backend database (Local MongoDB), all database tables/collections, +Create a backend database (local MongoDB), all database tables/collections, various backend database indexes, and the genesis block. ## bigchaindb drop -Drop (erase) the backend database (a Local MongoDB database). +Drop (erase) the backend database (the local MongoDB database used by this node). You will be prompted to make sure. If you want to force-drop the database (i.e. skipping the yes/no prompt), then use `bigchaindb -y drop` ## bigchaindb start -Start BigchainDB. It always begins by trying a `bigchaindb init` first. See the note in the documentation for `bigchaindb init`. -The database initialization step is optional and can be skipped by passing the `--no-init` flag i.e. `bigchaindb start --no-init`. +Start BigchainDB. It always begins by trying a `bigchaindb init` first. See the documentation for `bigchaindb init`. +The database initialization step is optional and can be skipped by passing the `--no-init` flag, i.e. `bigchaindb start --no-init`. ### Options + The log level for the console can be set via the option `--log-level` or its abbreviation `-l`. Example: @@ -64,7 +65,7 @@ abbreviation `-l`. Example: $ bigchaindb --log-level INFO start ``` -The allowed levels are `DEBUG`, `INFO` , `WARNING`, `ERROR`, and `CRITICAL`. +The allowed levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. For an explanation regarding these levels please consult the [Logging Levels](https://docs.python.org/3.6/library/logging.html#levels) section of Python's documentation.