58 Commits

Author SHA1 Message Date
vrde
f157096699 Problem: No reason to check the BEP (+typo) (#2144)
Solution: Say why there is a link to the BEP, and fix a typo.
2018-03-23 14:39:15 +01:00
Ahmed Muawia Khan
9be68c972d Problem: standardize docker-compose workflows (#2130)
- Standardize docker-compose workflow
- Change docker-compose version to 2.1
  - why one might ask? because compose version
    3.0 does not support depends on and inherits
    like we want to and is more aimed towards migration to using
    `docker stack`, for our current strategy `2.1` is a better choice.
- change `bdb` service `bigchaindb` service
  - why? Introduced a new proxy service `bdb` which is just a dummy
    `busybox` image.
    - why? because this ensure via healthcheck of bigchaindb that BigchainDB
      has started properly and makes a `curl` to ensure HTTP API server is up
      and running.
      - why? Because we have had scenarios where BigchainDB is not started
        via docker compose and user has to check out the logs to find out what
        the problem might be. This ensure that bigchaindb is up and running.
- Does this change deployment workflow? No.
  - The only thing change is that if you want to run commands inside a bigchaindb
    container e.g. `pytest` now you have to run the following command:
    `docker-compose run --rm --no-deps bigchaindb pytest -v --cov=bigchaindb`
     as opposed to `docker-compose run --rm --no-deps bdb pytest -v --cov=bigchaindb`
- Remove env variable `BIGCHAINDB_START_TENDERMINT`
- Remove TENDERMINT_INTEGRATION.rst and move to the new docs
- Change mdb -> mongodb because the other services were named with
  full name.
- Add example to run specific tests or from a file
- Update config.toml for tendermint to use `bigchaindb` as proxy app
  instead of `bdb`
- Remove `network` directory because it is deprecated
- Add comment about why PYTHONBUFFERED is used
2018-03-21 12:42:43 +01:00
Vanshdeep Singh
ef26220c7f Problem: Docs for BEP#3 implementation not updated (#2123)
* Problem: Docs for BEP#3 implementation not updated

Solutions: Update docs for #2070 and #2106

* Problem: 'Validator update' docs language not clear

Solution: Re-write the documentation which explains when validators are updated

* Problem: Typos and BEP reference missing

Solution: Fix typos and add BEP reference
2018-03-21 09:23:08 +01:00
Troy McConaghy
86e7b2a881 Some minor copy-editing 2018-02-25 18:05:18 +01:00
Ahmed Muawia Khan
8e8e328205 Migrate CLI documentation
- Remove documentation for CLI commands that are not needed with
  Tendermint integration.
2018-02-23 14:53:28 +01:00
vrde
4157244df7 Problem: statsd config is no longer supported
Solution: remove monitoring code, completes #1138
2018-02-13 14:35:47 +01:00
kansi
220465f701 Added "--no-init" flag for "bigchaindb start" command 2017-11-07 14:55:05 +05:30
kansi
cf19a8cb93 Updated docs 2017-10-24 18:29:31 +05:30
kansi
fa345e5441 Updated server configuration docs. 2017-10-23 21:52:30 +05:30
kansi
6f5eef97a7 Updated server configuration docs 2017-10-23 14:31:12 +05:30
Krish
3ec4153375 Support for advertised host, port, scheme for Websockets (#1703)
* Support for advertised host, port, scheme for Websockets

* Update docs

* Add a docstring

* Set env vars in Dockerfile-dev too
2017-08-08 12:04:58 +02:00
Krish
ece195ff8d Deployment changes: (#1623)
Update MongoDB container tag to `3.0`.

Doc change to reflect bdb-config.bdb-user parameter usage.

Fix typo in configuration.md.

Add BIGCHAINDB_DATABASE_SSL parameter to bigchaindb-dep.yaml for
Kubernetes deployments.

Refer the the `bdb-user` parameter from ConfigMap in
bigchaindb-dep.yaml.

Consolidate all BigchainDB parameter values under the
`bdb-config` ConfigMap.

Remove `bdb-user` from secrets.yaml.
2017-07-03 15:55:43 +02:00
Troy McConaghy
1fc2c39157 Merge pull request #1567 from bigchaindb/minor-edits-to-config-settings-docs
Minor edits to configuration settings docs
2017-06-30 10:09:37 +02:00
libscott
70b60562d8 Document graphite configuration parameter (#1594)
* document graphite configuration parameter

* add example

* graphite settings docs follows wsserver

* Removed outer JSON braces @ graphite.host docs
2017-06-29 14:19:08 +02:00
Troy McConaghy
5bf1081f0a Merge pull request #1554 from bigchaindb/document-ws-scheme-setting
Added more docs about the wsserver.scheme config setting
2017-06-29 12:06:10 +02:00
Troy McConaghy
3ca11c1f69 Emphasize MongoDB over RethinkDB in configuration.md 2017-06-20 17:40:08 +02:00
Troy McConaghy
3229e2e262 docs: changed the * symbol to × for multiplication. 2017-06-20 17:32:22 +02:00
Troy McConaghy
3aeb20afd3 Changed some ticks to backticks in configuration.md 2017-06-20 17:27:51 +02:00
Troy McConaghy
9e247f9318 Removed all mentions of BIGCHAINDB_SERVER_THREADS 2017-06-20 17:22:40 +02:00
Krish
01474c002c Update docs with SSL environment variables (#1536)
* Update docs with TLS env variables

* Document ssl, login and password env vars

* Update docs and add default values in example configuration
2017-06-16 15:27:56 +02:00
Troy McConaghy
e41ac6c634 Added docs about the wsserver.scheme config setting 2017-06-16 13:22:01 +02:00
tim
bd0d79d399 Allow scheme configuration for ws-server 2017-06-16 09:55:46 +02:00
Rodolphe Marques
54ab3b5e37 Update documentation on configuration 2017-06-01 15:20:00 +02:00
Scott Sadler
954df20dac documentation fix 2017-05-22 12:50:51 +02:00
Scott Sadler
5de15c33ec disable threads in web workers 2017-05-19 14:05:28 +02:00
Troy McConaghy
411e682a6c added docs for wssserver.host and .port 2017-04-19 11:21:59 +02:00
Sylvain Bellemare
8206a4a18c Update docs 2017-04-18 16:21:02 +02:00
Sylvain Bellemare
4c0fc52e9e Document error log file setting and log rotation 2017-04-18 16:21:02 +02:00
Troy McConaghy
d7ccc7c00f Merge branch 'master' into docs/1170/move-http-api-docs-to-top-level-section 2017-04-18 14:34:53 +02:00
Troy McConaghy
dea6ac56ba Merge remote-tracking branch 'origin/master' into docs-re-2-new-database-config-settings 2017-04-18 11:34:05 +02:00
Troy McConaghy
6921b1386c docs: noted that rethinkdb doesn't use database.connection_timeout setting yet 2017-04-18 10:53:27 +02:00
Sylvain Bellemare
a65c8799dd Document gunicorn loglevel setting 2017-04-18 10:46:21 +02:00
Troy McConaghy
59be30187f Merge branch 'master' into docs/1170/move-http-api-docs-to-top-level-section 2017-04-18 10:43:02 +02:00
Troy McConaghy
93baa922c8 Made the consensus plugin an undocumented feature 2017-04-13 09:56:03 +02:00
Troy McConaghy
8964ba33b4 updated links to the HTTP API docs in this repo 2017-04-10 15:14:18 +02:00
Troy McConaghy
9fd40682f2 docs re: database.connection_timeout and database.max_tries 2017-03-24 15:38:27 +01:00
Sylvain Bellemare
9987041ac0 Add note about case insensitivity of log levels 2017-03-21 16:17:32 +01:00
Sylvain Bellemare
45ae58448f Correct wording 2017-03-21 16:17:32 +01:00
Sylvain Bellemare
3a81270101 Add link to configuration file settings 2017-03-21 16:17:32 +01:00
Sylvain Bellemare
4338637983 Add docs for allowed log levels for cmd line 2017-03-21 16:17:32 +01:00
Sylvain Bellemare
d867983a89 Document cmd line option for the log level 2017-03-21 16:17:32 +01:00
Sylvain Bellemare
05db44a636 Add documentation for log configuration 2017-03-21 16:17:32 +01:00
Troy McConaghy
042133faf8 removed docs about 'bigchaindb load' command 2017-03-11 14:00:01 +01:00
libscott
c9ba7e6243 Merge branch 'master' into master 2017-02-22 12:20:35 +01:00
Troy McConaghy
be72875330 docs: added some clarification to the replica set setting 2017-02-19 15:27:21 +01:00
Troy McConaghy
8ec2c6bc34 Docs: fixed errors in some documented config settings defaults 2017-02-17 12:15:50 +01:00
Troy McConaghy
85128a0634 append 'rethinkdb' to 'bigchaindb -y configure' in some docs 2017-02-06 18:01:38 +01:00
Troy McConaghy
105d0172da Minor fixes to the bigchaindb CLI docs 2017-02-03 11:31:24 +01:00
Rodolphe Marques
2fe9c47b63 Feat/990/cleanup monitoring code (#1138)
* remove statsd dependencie

* remove monitoring related code

* removed statsd configuration

* fixed tests

* Removed monitoring docker compose file.

Remove statsd settings from test fixture.
Removed statsd related code from benchmarking tests

* removed monitoring related documentation

* remove unused import
2017-02-03 10:28:28 +01:00
Rodolphe Marques
69068fc919 Document how to run BigchainDB with MongoDB (#1116)
* Document changes in the configure command.

Document new add/remove replicas commands.

* updated quickstart with mongodb instructions

* Docs on how to setup mongodb dev node with and without docker.

Update replSet option in docker-compose

* Fixed typo.

More explicit on how to run the tests.

* Fixed typo in mongodb docker instructions.

More explicit about requiring mongodb 3.4+
2017-01-31 13:53:36 +01:00