diff --git a/docs/source/bigchaindb-cli.md b/docs/source/bigchaindb-cli.md index 37822717..d154e118 100644 --- a/docs/source/bigchaindb-cli.md +++ b/docs/source/bigchaindb-cli.md @@ -1,6 +1,6 @@ # The BigchainDB Command Line Interface (CLI) -There are some command-line commands for working with BigchainDB: `bigchaindb` and `bigchaindb-benchmark`. This section provides an overview of those commands. +The command to interact with BigchainDB is `bigchaindb`. This section provides an overview of the command. ## bigchaindb @@ -37,10 +37,9 @@ This command drops (erases) the RethinkDB database. You will be prompted to make This command starts BigchainDB. It always begins by trying a `bigchaindb init` first. See the note in the documentation for `bigchaindb init`. -## bigchaindb-benchmark +## bigchaindb load -The `bigchaindb-benchmark` command is used to run benchmarking tests. You can learn more about it using: +The command is used to run benchmarking tests. You can learn more about it using: ```text -$ bigchaindb-benchmark -h -$ bigchaindb-benchmark load -h +$ bigchaindb load -h ``` diff --git a/docs/source/installing-server.md b/docs/source/installing-server.md index e1465b98..09967238 100644 --- a/docs/source/installing-server.md +++ b/docs/source/installing-server.md @@ -111,9 +111,9 @@ If it's the first time you've run `bigchaindb start`, then it creates the databa **NOT for Production Use** -For those who like using Docker and wish to experiment with BigchainDB in non-production environments, we currently maintain a `dockerfile` that can be used to build an image for `bigchaindb`, along with a `docker-compose.yml` file to manage a "standalone node", consisting mainly of two containers: one for RethinkDB, and another for BigchainDB. +For those who like using Docker and wish to experiment with BigchainDB in non-production environments, we currently maintain a `dockerfile` that can be used to build an image for `bigchaindb`. -Assuming you have `docker` and `docker-compose` installed, you would proceed as follows. +Assuming you have `docker` installed, you would proceed as follows. In a terminal shell: ```text @@ -122,41 +122,41 @@ $ git clone git@github.com:bigchaindb/bigchaindb.git Build the Docker image: ```text -$ docker-compose build +$ docker build --tag local-bigchaindb . ``` -then do a one-time configuration step to create the config file; it will be -stored on your host machine under ` ~/.bigchaindb_docker/config`: +then do a one-time configuration step to create the config file; we will use +the `-y` option to accept all the default values. The configuration file will +be stored on your host machine under ` ~/bigchaindb_docker/.bigchaindb`: ```text -$ docker-compose run --rm bigchaindb bigchaindb configure -Starting bigchaindb_rethinkdb-data_1 +$ docker run --rm -v "$HOME/bigchaindb_docker:/data" -ti local-bigchaindb -y configure Generating keypair -API Server bind? (default `localhost:9984`): -Database host? (default `localhost`): rethinkdb -Database port? (default `28015`): -Database name? (default `bigchain`): -Statsd host? (default `localhost`): statsd -Statsd port? (default `8125`): -Statsd rate? (default `0.01`): +Configuration written to /data/.bigchaindb Ready to go! ``` -As shown above, make sure that you set the database and statsd hosts to their -corresponding service names (`rethinkdb`, `statsd`), defined in`docker-compose.yml` -and `docker-compose-monitor.yml`. - You can then start it up (in the background, as a daemon) using: ```text -$ docker-compose up -d +$ BIGCHAIN_CID=$(docker run -d -v "$HOME/bigchaindb_docker:/data" local-bigchaindb) ``` -then you can load test transactions via: +then you can load test transactions (using the `-m` option to enable using all +the cores in the host machine) via: ```text -$ docker-compose run --rm bigchaindb bigchaindb-benchmark load +$ docker exec -d $BIGCHAIN_CID load -m ``` +You can see BigchainDB processing your transactions running: +```text +$ docker logs -f $BIGCHAIN_CID +``` + + If you're on Linux, you can probably view the RethinkDB dashboard at: -[http://localhost:58080/](http://localhost:58080/) +[http://localhost:8080/](http://localhost:8080/) -If that doesn't work, then replace `localhost` with the IP or hostname of the machine running the Docker engine. If you are running docker-machine (e.g.: on Mac OS X) this will be the IP of the Docker machine (`docker-machine ip machine_name`). +If that doesn't work, then replace `localhost` with the IP or hostname of the +machine running the Docker engine. If you are running docker-machine (e.g.: on +Mac OS X) this will be the IP of the Docker machine (`docker-machine ip +machine_name`). diff --git a/docs/source/monitoring.md b/docs/source/monitoring.md index b5b9ca58..4fb53072 100644 --- a/docs/source/monitoring.md +++ b/docs/source/monitoring.md @@ -22,11 +22,11 @@ then point a browser tab to: The login and password are `admin` by default. If BigchainDB is running and processing transactions, you should see analytics—if not, [start BigchainDB](installing-server.html#run-bigchaindb) and load some test transactions: ```text -$ bigchaindb-benchmark load +$ bigchaindb load ``` then refresh the page after a few seconds. If you're not interested in monitoring, don't worry: BigchainDB will function just fine without any monitoring setup. -Feel free to modify the [custom Grafana dashboard](https://github.com/rhsimplex/grafana-bigchaindb-docker/blob/master/bigchaindb_dashboard.js) to your liking! \ No newline at end of file +Feel free to modify the [custom Grafana dashboard](https://github.com/rhsimplex/grafana-bigchaindb-docker/blob/master/bigchaindb_dashboard.js) to your liking! diff --git a/docs/source/running-unit-tests.md b/docs/source/running-unit-tests.md index e20a0fc2..9b0ea505 100644 --- a/docs/source/running-unit-tests.md +++ b/docs/source/running-unit-tests.md @@ -18,16 +18,3 @@ $ python setup.py test (Aside: How does the above command work? The documentation for [pytest-runner](https://pypi.python.org/pypi/pytest-runner) explains. We use [pytest](http://pytest.org/latest/) to write all unit tests.) -### Using docker-compose to Run the Tests - -You can also use `docker-compose` to run the unit tests. (You don't have to start RethinkDB first: `docker-compose` does that on its own, when it reads the `docker-compose.yml` file.) - -First, build the images (~once), using: -```text -$ docker-compose build -``` - -then run the unit tests using: -```text -$ docker-compose run --rm bigchaindb py.test -v -```