1296 Commits

Author SHA1 Message Date
Troy McConaghy
298ff8a3fd Problem: We continue to be asked about production-readiness (#2316)
Solution: Add more explanation to the docs page about production-readiness
2018-05-29 17:47:59 +02:00
vrde
340d0a2ea1
Problem: no instructions on simple network setup (#2296)
Solution: write a step-by-step tutorial on who should do what.
2018-05-24 01:39:03 +02:00
Troy McConaghy
acc2710d7b Problem: There are old links to the IPDB tx spec (#2290)
Solution: Replace those links with appropriate links to the BigchainDB Transactions Specs
2018-05-24 01:36:43 +02:00
Lev Berman
89b28b8471 Remove unsupported backends (#2289)
* Problem: RethinkDB, change feed, old mongo, admin interface are not supported any longer.

Solution: Remove unsupported functionality. Bring the MongoDB backend implementation completely to the localmongodb package. Fix the test setup.

* Problem: Nothing depends on multipipes any longer.

Solution: Remove multipipes from setup.py.

* Problem: The how-to-run-tests doc uses --database-backend.

Solution: Do not include the --database-backend option into the documented pytest usage.

* Problem: The backends docs are outdated.

Solution: Document MongoDB as the default and only backend for BigchainDB.

* Problem: The inputs fixtures uses old blocks API.

Solution: Change the inputs fixtures to use the new blocks API.

* Problem: rethinkdb package is not used anymore.

Solution: Remove the rethinkdb dependency from setup.py.

* Problem: The abci-marked tests use outdated Mongo conn.

Solution: Replace MongoDBConnection with LocalMongoDBConnection for them.
2018-05-23 11:34:00 +02:00
Troy McConaghy
b9bceb7e3a Problem: Broken hyperlink in write-code.rst (#2288)
Solution: Fix the broken link
2018-05-14 09:57:48 +02:00
vrde
31bae195e7 Problem: acceptance-test suite is not documented (#2267)
* Problem: acceptance-test suite is not documented

Solution: add README.md in the root of the acceptance tests, unify
`Makefile` and commands, remove more cached files when `make clean` is
ran.

* Problem: documentation does not mention Makefile

Solution: update docs with our new and shiny commands
2018-05-11 09:50:08 +02:00
Troy McConaghy
722401ada9 Problem: How do I store files in BigchainDB? (#2259)
Solution: Write a new root docs page about how to store files in BigchainDB.
2018-05-08 10:35:21 +02:00
Artus Vranken
9020348073 Fixed the doc link to "node-on-kubernetes" (#2263) 2018-05-05 17:12:26 +02:00
Lev Berman
e271ae9e5b Problem: the Tendermint install instructions are outdated (#2260)
Solution: post the link to the relevant Tendermint documentation page
2018-05-03 15:48:55 +02:00
Vanshdeep Singh
cf36a6fe47 Problem: Multi-threading not enabled (#2258)
Solution: Enable multi-threading
2018-05-03 11:52:54 +02:00
Ahmed Muawia Khan
fd48abebae
Problem: Tendermint 0.19.0 missing crucial fixes (#2253) 2018-05-02 14:39:41 +02:00
Ahmed Muawia Khan
5ce0538c61 Problem: Old --p2p.seeds is now --p2p.persistent_peers (#2249)
Solution
As per Tendermint 0.16.0 , --p2p.seeds is now --p2p.persistent_peers. Update bigchaindb/tendermint container to use that configuration. Also disable --p2p.pex, we currently don't want the peer exchange.
2018-04-30 17:42:14 +02:00
Ahmed Muawia Khan
dbabe94887 Problem: BigchainDB and Tendermint inconsistencies because disjoint services (#2242)
Solution
Since BigchainDB and Tendermint are so tightly coupled we need to introduce a process supervisor to make them act like a single microservice, so that if BigchainDB crashes, Tendermint does as well and both are restarted and Tendermint requests a connection towards the proxy app.

In Kubernetes, they can be exposed as part of a one POD.
For BigchainDB as a system service/process, we need to introduce a process supervisor such as systemd.
This PR only solves the former.

Changes
Upgrade deployment from Tendermint v0.12.0 to v0.19.0
Update some documentation
Fix nginx-http entrypoint issues.
Update generate-configs.sh script to handle config generation without https-certificates.
Update Dockerfile to process dependency links introduced by abci
Integrate BigchainDB and Tendermint as a single microservice.
This required making BigchainDB to be exposed as a statefulset.
Introduce new liveness probe checks.
Issues Resolved
Partially fixes #2232
2018-04-27 15:54:47 +02:00
Troy McConaghy
d066bfe132
Problem: No docs explaining use of MongoDB for querying (#2193)
* Problem: No docs explaining use of MongoDB for querying

Solution: Start a new root docs page explaining how a node operator can use the full power of MongoDB's query engine, and can expose as much of that as they like to end users.

* Finished first draft of new docs page 'Querying BigchainDB'
2018-04-23 19:30:45 +02:00
Ahmed Muawia Khan
8c1ee8329e Problem: Typo with get kube-dns IP (#2181) 2018-04-05 17:56:30 +02:00
Troy McConaghy
c8682a1d89 Problem: bigchaindb upsert-validator labelled "insecure" (#2180)
Solution: Remove the "insecure" label from the docs on `bigchaindb upsert-validator`
2018-04-05 17:47:11 +02:00
Troy McConaghy
58432807a0 Problem: No link back to Root Docs from Contrib. Docs (#2170)
Solution: Add a link back to the Root Docs from the 'Contributing to BigchainDB' Docs
2018-04-03 12:28:47 +02:00
Troy McConaghy
ef7a276aad Problem: Some links in Quickstart page are broken or wrong (#2171)
Solution: Update the links in the Quickstart page of the BigchainDB Server docs
2018-04-03 12:26:47 +02:00
Troy McConaghy
55fafef577 Problem: There were more broken links to CONTRIBUTING.md (#2172)
Solution: Fix those links by linking directly to the new 'Contributing to BigchainDB' docs
2018-04-03 12:17:11 +02:00
Troy McConaghy
ec5f66ba4f Problem: Issue #2217 is unresolved (#2169)
* Problem: Some docs still say to run MongoDB w/ replica set

Solution: Update the relevant docs

* Problem: A docs mention of upsert-validator wasn't linked to BEP-3.

Solution: Link that docs mention to BEP-3 on GitHub.
2018-04-03 12:14:36 +02:00
vrde
8086f75ec8 Problem: there are no events for invalid blocks (#2163)
Solution: update the documentation to reflect this. I've also removed
the documentation about the event plugin API. That part needs to be
refactored to work properly with BigchainDB 2.0. We can reintroduce it
later.
2018-04-03 12:12:33 +02:00
Vanshdeep Singh
0f86e7d368 Problem: Multi-threading not configured (#2165)
* Problem: Multi-threading not configured

Solution: Auto-generate multi-threading config with default threads and workers set to 1

* Problem: Documentation not updated for multi-threading

Solution: Updated necessary docs
2018-03-29 16:26:54 +02:00
Ahmed Muawia Khan
b4401d27e4
Merge pull request #2156 from ttmc/reorder-developer-contrib-process-pages
Problem: The order of the dev contrib docs was weird
2018-03-29 12:01:40 +02:00
Troy McConaghy
42f9160f46
Merge pull request #2154 from ttmc/update-marketing-copy
Problem: Some marketing copy (text blurbs) was old
2018-03-28 14:33:55 +02:00
Ahmed Muawia Khan
5162a0a163 Problem: Invalid command to get kube-dns IP 2018-03-27 19:44:00 +02:00
Troy McConaghy
3d1f341c44 Remove accidentally-pasted URL from docs 2018-03-27 16:41:26 +02:00
Troy McConaghy
8ce48f75a1 Renamed 2 files/pages of notes on running a node 2018-03-27 16:38:58 +02:00
Troy McConaghy
75caf76c62 Problem: The order of the dev contrib docs was weird
Solution: Reorder & relabel those pages
2018-03-27 12:02:33 +02:00
Troy McConaghy
3f2d40f670
Merge pull request #2155 from ttmc/clarify-contributing-docs
Problem: Docs re contributing needed editing & reorg
2018-03-27 10:34:15 +02:00
Troy McConaghy
4fb963d149 Don't include docs fetched-at-build-time in Git repo 2018-03-27 10:27:27 +02:00
Troy McConaghy
3566c97873 Problem: Docs re contributing needed editing & reorg
Solution: Edit & reorg them
2018-03-27 10:18:51 +02:00
Troy McConaghy
dea76f7c91
Merge pull request #2141 from muawiakh/update-dns-server
Problem: Cluster DNS and Health check terminology is incorrect
2018-03-26 16:37:49 +02:00
Ahmed Muawia Khan
a8e68c3706 Replace clusters Web UI to k8s cluster web ui 2018-03-26 16:00:25 +02:00
Ahmed Muawia Khan
339078ae68 Address comments
- remove confusion between NODE-IP<->CLUSTER-IP just replace with IP
- remove confusion between node<->cluster just replace with Kubernetes
  cluster
2018-03-26 15:37:05 +02:00
Troy McConaghy
d1bc21809e Problem: Some marketing copy (text blurbs) was old
Solution: Update the marketing copy!
2018-03-25 13:28:21 +02:00
Troy McConaghy
ff62675c01
THE blockchain database. 2018-03-24 06:01:12 +01:00
Troy McConaghy
1d053bbad8
Two fixes to root docs home page
- Added a button to link to the new "Contributing to BigchainDB" docs
- Changed the opening tag line
2018-03-24 05:40:14 +01:00
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
Ahmed Muawia Khan
cf543d8f41 Problem: docs build failing
Solution: Fix docs build
2018-03-21 11:15:25 +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
Ahmed Muawia Khan
757b4fc14c Remove cluster-dns 2018-03-20 19:34:01 +01:00
Troy McConaghy
24119a1b73 Problem: Was getting Shared Workspace Protocol from old location
Solution: Get it from new location in bigchaindb/BEPs
2018-03-15 13:44:22 +01:00
Troy McConaghy
c5054e7239 Problem: Unclear how Travis and Codecov get configured
Solution: Document where Travis and Codecov look for configuration settings and setup.
2018-03-14 13:06:52 +01:00
Troy McConaghy
f54090af6d Cleanup 'Ways to Contribute' even more 2018-03-14 01:40:05 +01:00
Troy McConaghy
d4e8f415a1 Add JS and Python style guides to policies 2018-03-14 00:48:10 +01:00
Troy McConaghy
0e29517145 Revisions to: Contributing to BigchainDB (docs) 2018-03-12 14:23:49 +01:00
Troy McConaghy
5283c32abb
Under den Linden -> Unter 2018-03-07 12:40:12 +01:00
Troy McConaghy
9180d00282
codding -> coding 2018-03-07 12:37:08 +01:00
Troy McConaghy
cf53ce8d32 First draft of new docset on Contributing to BigchainDB 2018-03-06 23:55:18 +01:00