108 Commits

Author SHA1 Message Date
Troy McConaghy
009cbe4e11
Copy-edited the log rotation page (docs) (#2546)
* Copy-edited the log rotation page (docs)

* Fix and add some hyperlinks re/ logging.

* Add back the section/link to log-rotation.html

* Correct the location of BigchainDB logs. Omit mention of bigchaindb-benchmark.log

* Revive notes re BigchainDB Server log rotation
2018-09-28 09:19:20 +02:00
Muawia Khan
eb139fba00 Remove benchmark logging (#2565).
* Problem: Benchmark logging is not needed.

* Solution: Clean it up.
2018-09-20 14:30:30 +02:00
Muawia Khan
5a440843b6 Problem: No log rotation when BigchainDB and Tendermint started with Monit (#2528)
* Log rotation for tendermint and BigchainDB using Monit

* Change file size from 100KB used for testing to 200 MB for test envs

* Add docs for log rotation

* remove --consensus.create_empty_blocks from monit start

Because already taken care of in the config file

* do not run bigchaindb with debug flag instead use config file

* Address comments I

- Rephrase log rotation to imply monit is not default
- Add statement to explain where bigchaindb log files are created
- Fix HTML comment
- Add log rotation to index

* Address comments II
2018-09-12 11:14:51 +02:00
Troy McConaghy
f8bb29535a
Problem: Code Reference docs hidden in appendices (#2473)
Solution: Move the Code Reference docs into their own section
2018-09-04 12:17:27 +02:00
Troy McConaghy
bd49a3804f
Problem: Docs say "BigchainDB cluster" but IRL we say "BigchainDB network" (#2471)
Solution: Edit the docs to say "BigchainDB network" instead
2018-08-17 16:04:58 +02:00
Troy McConaghy
abdd23f5a6 Problem: Source files contain no license info (#2455)
* Problem: Source files contain no license info

Solution: Add comments with SPDX license info to source files

* Python 3 files don't need # -*- coding: utf-8 -*-
2018-08-16 12:31:32 +02:00
Troy McConaghy
9b4273a987
Problem: Docs: 'Production Deployment Template' not a good name anymore (#2440)
Solution: Rename that section to 'Kubernetes Deployment Template'
2018-08-07 13:20:47 +02:00
Troy McConaghy
e0676306b7 Problem: old page in Appendices is redundant (#2388)
Solution: remove the old Appendices page about installing OS-level dependencies
2018-08-06 11:37:28 +02:00
Muawia Khan
66b243a2b4 Problem: People request all-in-one BigchainDB container (#2424).
Solution: Provide a stand-alone all-in-one BigchainDB container.

* Document it.
* Clarify that the image is not suited for joining a network.
2018-08-02 14:05:23 +02:00
Zachary Bowen
2386ca9d71 Refactor tendermint directory to project root (#2401)
* Problem: core.py contains an unused class, `Bigchain`

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

* Problem: core.py contains an unused class, `Bigchain`

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

* Fixed flake8 complaint about too many blank lines

* Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI...

Sorry in advance!

* Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI...

Sorry in advance!

* Updating from master changed BigchainDB.process_post_response to a private method, so I had to align with that.

* Fixed a couple stale references to bigchaindb.Bigchain in docstrings

* Missed a reference to `Bigchain` in a patch call...

* Problem: BigchainDB class should be part of project root

Solution: Removed the /tendermint directory and moved its contents to project root

* Problem: Flake8 complained that imports were not at the top of the file

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

* Problem: Stale reference to /tendermint directory in the index

Solution: Removed the references to /tendermint

* Problem: Flake8 complaining of unused import in __init__.py

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

* Problem: Stale references to `bigchaindb.tendermint.BigchainDB` in the rst files cause Sphinx to fail

Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

* Problem: Stale reference to the `tendermint` directory in an @patch in a disabled test

Solution: Updated the @patch for completeness

* Problem: BigchainDB class should be part of project root

Solution: Removed the /tendermint directory and moved its contents to project root

* Problem: Flake8 complained that imports were not at the top of the file

Solution: Had to play around with the order of imports to avoid cyclic dependencies, but its working and style compliant now

* Problem: Stale reference to /tendermint directory in the index

Solution: Removed the references to /tendermint

* Problem: Flake8 complaining of unused import in __init__.py

Solution: The import is there so I can import App directly from bigchaindb, rather than from bigchaindb.core (which I think improves code readability. I added a # noqa to silence Flake8.

* Problem: Stale references to `bigchaindb.tendermint.BigchainDB` in the rst files cause Sphinx to fail

Solution: Updated the autodoc files to use `bigchaindb.BigchainDB` instead

* Problem: Stale reference to the `tendermint` directory in an @patch in a disabled test

Solution: Updated the @patch for completeness
2018-07-25 16:59:25 +02:00
Zachary Bowen
4d2e58416c Problem: Bigchain class is unused and redundant (#2366)
* Problem: core.py contains an unused class, `Bigchain`

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

* Problem: core.py contains an unused class, `Bigchain`

Solution: Remove core.py. Refactor BigchainDB Class to remove inheritance from Bigchain.

* Fixed flake8 complaint about too many blank lines

* Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI...

Sorry in advance!

* Attempting to fix Sphinx docs. This may result in some redundant commits, as I don't know what I'm doing, and I can't experiment without running the CI...

Sorry in advance!

* Updating from master changed BigchainDB.process_post_response to a private method, so I had to align with that.

* Fixed a couple stale references to bigchaindb.Bigchain in docstrings

* Missed a reference to `Bigchain` in a patch call...

* Merge with master and re-do some changes
2018-07-10 17:34:51 +02:00
Vanshdeep Singh
c7503f5689 Problem: Support for latest Tendermint missing (#2375)
Solution: Upgrade to py-abci 0.5.1 to use latest Tendermint
2018-07-10 14:16:02 +02:00
Muawia Khan
1bad851e07
Problem: Tendermint configuration not present in BigchainDB config (#2342)
* Problem: Tendermint configuration not present in BigchainDB config

* Handle tendermint configurations properly

- Update docs

* Nitpick

* Missed some conflicts

* Make changes in tendermint/lib.py instead of deprecated core.py

- Also remove redundant info from docs about default values

* Fix docsserver automethod
2018-06-29 18:45:22 +05:00
Troy McConaghy
1753a7019b Problem: Appendices page 'The Bigchain Class' not Updated for Tendermint (#2330)
* Fixed 2 PEP257 compliance errors

* Upgrade Tendermint to 0.19.7 except for Docker image, which is still at 0.19.2

* In the Appendices, update page re/ The Bigchain Class
2018-06-04 12:19:04 +02:00
Muawia Khan
10e55aa4e7
Problem: No automated way to set up a dev/test network (#2300)
* Problem: No automated way to set up a dev/test network

* Problem: docs not updated for stack, ansible and docker based dev environments

* Problem: Using apt triggers java runtime installation on MacOS

- Update pre_tasks in ansible
- Update bigchaindb-stop playbook to handle pre_tasks

* Update Tendermint version to 0.19.3 from 0.19.2

* Update tendermint version to 0.19.3 everywhere else

* Problem: Sphinx warns about duplicate section labels

Solution: Don't use sphinx.ext.autosectionlabel

* Problem: Sphinx complains that run-node-with-docker not in any TOC

Solution: Add run-node-with-docker to a TOC (i.e. to an index.rst file)

* Tendermint has not tagged `0.19.3` container

* Problem: Internal hyperlinks to new pages not working

Solution: Add .html to the ends of the filename strings

* Problem: Invalid script imports

* Problem: Invalid comparison for supported OS version

* Addressing comments I

* Problem: No way to configure dev/forked repo for developers

* Problem: Docs not updated with STACK_REPO parameter

* Addressing comments II
2018-05-31 16:56:45 +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
Sylvain Bellemare
12f603b8d2 Problem: There are no docs for the tendermint integration API
Solution: Add docs for the tendermint integration in Appendices for now.
2018-02-26 16:26:40 +01:00
Ahmed Muawia Khan
669b2d586b Merge branch 'tendermint' into tendermint-docs-k8s-dep 2018-02-21 11:48:02 +01:00
Troy McConaghy
7f94242f85 Update all docs re/ votes when Tendermint integrated 2018-02-16 16:24:44 +01:00
muawiakh
c4e752d379 Address comments
- Use aafigure to render text -> HTML/image
- Update some docs
2018-01-12 18:16:05 +01:00
Troy McConaghy
c0b32213e4 Updated all refs to the IPDB Transaction Spec & its URL 2018-01-10 14:40:34 +01:00
muawiakh
14892fc839 Template for BigchainDB + Tendermint Kubernetes Deployment
- Template doc for BigchainDB + Tendermint single node
- Template doc for BigchainDB + Tendermint network
- Remove autosectionlabel extension from docs/server/source/conf.py
  - Removed this extension because this does not allow two different
    documents to have same headings, because it auto-indexes
- Fix and explicitly label headings and references.
2018-01-10 14:20:32 +01:00
muawiakh
4792b94201 Fix typo in firewall docs
- inbount -> inbound
2017-12-12 13:37:57 +01:00
Troy McConaghy
fbd85301e1
Merge pull request #1921 from bigchaindb/docs/update-firewall-page
Updated the Notes for Firewall Setup page in docs
2017-12-12 10:35:03 +01:00
Troy McConaghy
e0b454953c
Merge branch 'tendermint' into rm-aws-deployment-tools-and-docs 2017-12-06 14:14:04 +01:00
Troy McConaghy
c8e2f59413
Merge pull request #1933 from bigchaindb/docs/1927/remove-azure-quickstart-template-docs
Remove Azure Quickstart Template Docs
2017-12-06 13:56:57 +01:00
Troy McConaghy
b36df932a5 Removed appendices/install-latest-pip.md 2017-12-05 13:47:24 +01:00
Troy McConaghy
c5443dc477 Removed Azure Quickstart Template docs 2017-12-05 11:27:08 +01:00
Troy McConaghy
1a5bb073e3 Remove rethinkdb-backup.md 2017-12-01 15:27:55 +01:00
Troy McConaghy
b1276020b3 Updated the Notes for Firewall Setup page in docs 2017-12-01 14:26:28 +01:00
Troy McConaghy
91dcce1a45 Removed some fully-removeable pages from Appendices 2017-12-01 11:16:35 +01:00
Troy McConaghy
b237a021c6 Removed old AWS testing cluster stuff including docs 2017-11-30 17:50:22 +01:00
Troy McConaghy
b52f094efa Revised several pages to point to replacement in the IPDB Transaction Spec 2017-11-28 12:16:44 +01:00
Troy McConaghy
f23a2c4042 Removed appendix page w/ tx JSON Schema files & updated transaction-model.rst page 2017-11-23 14:45:23 +01:00
Troy McConaghy
35fa8d7d19 Updated all code/docs referencing the transaction schema files by name 2017-11-21 14:12:13 +01:00
Troy McConaghy
01796b0660
Merge branch 'master' into update-blocks-and-votes-docs 2017-11-16 18:27:08 +01:00
Ahmed Muawia Khan
7b2b343138
Merge pull request #1790 from bigchaindb/multi-node-automation
Automation of multi node BigchainDB deployment for dev/test
2017-11-16 16:56:21 +01:00
muawiakh
cd98591851 Address comments on docs and some typos 2017-11-16 12:53:36 +01:00
muawiakh
b2b644db3d Fix minor docs comments 2017-11-16 12:51:46 +01:00
muawiakh
20147562f6 Fix docs build issue 2017-11-16 12:51:46 +01:00
muawiakh
0f68c41b89 Addressing comments and updating some documentation 2017-11-16 12:51:46 +01:00
muawiakh
241af47a32 Automation of multi node BigchainDB deployment for dev/test
- Setup single/multi node BigchainDB cluster using
  - Vagrant
  - Ansible
- Updated documentation
2017-11-16 12:51:46 +01:00
muawiakh
b4ca495967 Remove redundant redirections to different docker installation pages(s)
- All the instructions are common now
- Remove redundant files
- address comments
2017-11-16 12:14:11 +01:00
muawiakh
47f872df0f Integrate some other changes 2017-11-16 11:45:46 +01:00
muawiakh
7906edcebf Update quickstart guide for 'docker for mac' users 2017-11-16 11:45:46 +01:00
Troy McConaghy
c6c89bfcba Added page about the transaction schema files 2017-11-15 11:18:07 +01:00
Troy McConaghy
b3ccb09e01 Changed title of the page about vote.yaml 2017-11-15 11:17:41 +01:00
Troy McConaghy
31a0bc846b Updated docs about blocks and votes 2017-11-14 15:51:36 +01:00
kansi
220465f701 Added "--no-init" flag for "bigchaindb start" command 2017-11-07 14:55:05 +05:30