mirror of
https://github.com/planetmint/planetmint.git
synced 2025-03-30 15:08:31 +00:00
Removing some more remnants of bigchaindb
This commit is contained in:
Sangat Das
parent
e5489c95d2
commit
24f34f01cb
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
@ -9,6 +9,6 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
There are many ways you can contribute to the Planetmint project, some very easy and others more involved.
|
||||
|
||||
All of that is documented elsewhere: go to the "[Contributing to Planetmint" docs on ReadTheDocs](https://docs.bigchaindb.com/projects/contributing/en/latest/index.html).
|
||||
All of that is documented elsewhere: go to the "[Contributing to Planetmint" docs on ReadTheDocs](https://docs.planetmint.com/projects/contributing/en/latest/index.html).
|
||||
|
||||
Note: GitHub automatically links to this file (`.github/CONTRIBUTING.md`) when a contributor creates a new issue or pull request, so you shouldn't delete it. Just use it to point people to full and proper help elsewhere.
|
||||
|
||||
6
.github/ISSUE_TEMPLATE.md
vendored
6
.github/ISSUE_TEMPLATE.md
vendored
@ -1,9 +1,9 @@
|
||||
# Do you want to:
|
||||
|
||||
- make a bug report? Then read below about what should go in a bug report.
|
||||
- make a feature request or proposal? Then read [the page about how to make a feature request or proposal](https://docs.bigchaindb.com/projects/contributing/en/latest/ways-can-contribute/make-a-feature-request-or-proposal.html).
|
||||
- ask a question about Planetmint? Then [go to Gitter](https://gitter.im/bigchaindb/bigchaindb) (our chat room) and ask it there.
|
||||
- share your neat idea or realization? Then [go to Gitter](https://gitter.im/bigchaindb/bigchaindb) (our chat room) and share it there.
|
||||
- make a feature request or proposal? Then read [the page about how to make a feature request or proposal](https://docs.planetmint.com/projects/contributing/en/latest/ways-can-contribute/make-a-feature-request-or-proposal.html).
|
||||
- ask a question about Planetmint? Then [go to Gitter](https://gitter.im/planetmint/planetmint) (our chat room) and ask it there.
|
||||
- share your neat idea or realization? Then [go to Gitter](https://gitter.im/planetmint/planetmint) (our chat room) and share it there.
|
||||
|
||||
# What Should Go in a Bug Report
|
||||
|
||||
|
||||
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -15,4 +15,4 @@ Resolves #MMMM
|
||||
|
||||
## BEPs Implemented
|
||||
|
||||
What [BEPs](https://github.com/bigchaindb/beps) does this pull request implement, if any?
|
||||
What [BEPs](https://github.com/planetmint/beps) does this pull request implement, if any?
|
||||
|
||||
@ -21,5 +21,5 @@ repos:
|
||||
# list of error codes to check, see: http://www.pydocstyle.org/en/latest/error_codes.html
|
||||
args: ['--select=D204,D201,D209,D210,D212,D300,D403']
|
||||
|
||||
# negate the exclude to only apply the hooks to 'bigchaindb' and 'tests' folder
|
||||
exclude: '^(?!bigchaindb/)(?!tests/)(?!acceptance/)'
|
||||
# negate the exclude to only apply the hooks to 'planetmint' and 'tests' folder
|
||||
exclude: '^(?!planetmint/)(?!tests/)(?!acceptance/)'
|
||||
|
||||
916
CHANGELOG.md
916
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
@ -42,7 +42,7 @@ This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior directed at yourself or another community member may be
|
||||
reported by contacting a project maintainer at [contact@bigchaindb.com](mailto:contact@bigchaindb.com). All
|
||||
reported by contacting a project maintainer at [contact@planetmint.com](mailto:contact@planetmint.com). All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is appropriate to the circumstances. Maintainers are
|
||||
obligated to maintain confidentiality with regard to the reporter of an
|
||||
|
||||
@ -13,12 +13,12 @@ RUN apt-get -qq update \
|
||||
VOLUME ["/data", "/certs"]
|
||||
|
||||
ENV PYTHONUNBUFFERED 0
|
||||
ENV PLANETMINT_CONFIG_PATH /data/.bigchaindb
|
||||
ENV PLANETMINT_CONFIG_PATH /data/.planetmint
|
||||
ENV PLANETMINT_SERVER_BIND 0.0.0.0:9984
|
||||
ENV PLANETMINT_WSSERVER_HOST 0.0.0.0
|
||||
ENV PLANETMINT_WSSERVER_SCHEME ws
|
||||
ENV PLANETMINT_WSSERVER_ADVERTISED_HOST 0.0.0.0
|
||||
ENV PLANETMINT_WSSERVER_ADVERTISED_SCHEME ws
|
||||
ENV PLANETMINT_WSSERVER_ADVERTISED_PORT 9985
|
||||
ENTRYPOINT ["bigchaindb"]
|
||||
ENTRYPOINT ["planetmint"]
|
||||
CMD ["start"]
|
||||
|
||||
@ -27,4 +27,4 @@ ENV PLANETMINT_WSSERVER_ADVERTISED_SCHEME ws
|
||||
|
||||
ENV PLANETMINT_TENDERMINT_PORT 26657
|
||||
ARG backend
|
||||
RUN bigchaindb -y configure "$backend"
|
||||
RUN planetmint -y configure "$backend"
|
||||
@ -5,8 +5,8 @@
|
||||
For all the code and documentation in this repository, the copyright is owned by one or more of the following:
|
||||
|
||||
- Planetmint GmbH
|
||||
- A Planetmint contributor who agreed to a Planetmint Contributor License Agreement (CLA) with Planetmint GmbH. (See [BEP-16](https://github.com/bigchaindb/BEPs/tree/master/16).)
|
||||
- A Planetmint contributor who signed off on the Developer Certificate of Origin (DCO) for all their contributions. (See [BEP-24](https://github.com/bigchaindb/BEPs/tree/master/24).)
|
||||
- A Planetmint contributor who agreed to a Planetmint Contributor License Agreement (CLA) with Planetmint GmbH. (See [BEP-16](https://github.com/planetmint/BEPs/tree/master/16).)
|
||||
- A Planetmint contributor who signed off on the Developer Certificate of Origin (DCO) for all their contributions. (See [BEP-24](https://github.com/planetmint/BEPs/tree/master/24).)
|
||||
- (Rarely, see the **Exceptions Section** below) A third pary who licensed the code in question under an open source license.
|
||||
|
||||
## Code Licenses
|
||||
|
||||
@ -16,7 +16,7 @@ Our starting point is [PEP8](https://www.python.org/dev/peps/pep-0008/), the sta
|
||||
Planetmint uses Python 3.5+, so you can ignore all PEP8 guidelines specific to Python 2.
|
||||
|
||||
We use [pre-commit](http://pre-commit.com/) to check some of the rules below before every commit but not everything is realized yet.
|
||||
The hooks we use can be found in the [.pre-commit-config.yaml](https://github.com/bigchaindb/bigchaindb/blob/master/.pre-commit-config.yaml) file.
|
||||
The hooks we use can be found in the [.pre-commit-config.yaml](https://github.com/planetmint/planetmint/blob/master/.pre-commit-config.yaml) file.
|
||||
|
||||
### Python Docstrings
|
||||
|
||||
@ -86,12 +86,12 @@ we use the `format()` version. The [official Python documentation says](https://
|
||||
|
||||
We use [Flake8](http://flake8.pycqa.org/en/latest/index.html) to check our Python code style. Once you have it installed, you can run it using:
|
||||
```text
|
||||
flake8 --max-line-length 119 bigchaindb/
|
||||
flake8 --max-line-length 119 planetmint/
|
||||
```
|
||||
|
||||
|
||||
## Writing and Running (Python) Tests
|
||||
|
||||
The content of this section was moved to [`bigchaindb/tests/README.md`](https://github.com/bigchaindb/bigchaindb/blob/master/tests/README.md).
|
||||
The content of this section was moved to [`planetmint/tests/README.md`](https://github.com/planetmint/planetmint/blob/master/tests/README.md).
|
||||
|
||||
Note: We automatically run all tests on all pull requests (using Travis CI), so you should definitely run all tests locally before you submit a pull request. See the above-linked README file for instructions.
|
||||
|
||||
42
README.md
42
README.md
@ -10,12 +10,12 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
so show the latest GitHub release instead.
|
||||
--->
|
||||
|
||||
[](https://codecov.io/github/bigchaindb/bigchaindb?branch=master)
|
||||
[](https://github.com/bigchaindb/bigchaindb/releases)
|
||||
[](https://pypi.org/project/Planetmint/)
|
||||
[](https://travis-ci.com/bigchaindb/bigchaindb)
|
||||
[](https://docs.bigchaindb.com/projects/server/en/latest/)
|
||||
[](https://gitter.im/bigchaindb/bigchaindb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://codecov.io/github/planetmint/planetmint?branch=master)
|
||||
[](https://github.com/planetmint/planetmint/releases)
|
||||
[](https://pypi.org/project/Planetmint/)
|
||||
[](https://travis-ci.com/planetmint/planetmint)
|
||||
[](https://docs.planetmint.com/projects/server/en/latest/)
|
||||
[](https://gitter.im/planetmint/planetmint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
# Planetmint Server
|
||||
|
||||
@ -23,17 +23,17 @@ Planetmint is the blockchain database. This repository is for _BigchainDB Server
|
||||
|
||||
## The Basics
|
||||
|
||||
* [Try the Quickstart](https://docs.bigchaindb.com/projects/server/en/latest/quickstart.html)
|
||||
* [Read the Planetmint 2.0 whitepaper](https://www.bigchaindb.com/whitepaper/)
|
||||
* [Check out the _Hitchiker's Guide to BigchainDB_](https://www.bigchaindb.com/developers/guide/)
|
||||
* [Try the Quickstart](https://docs.planetmint.com/projects/server/en/latest/quickstart.html)
|
||||
* [Read the Planetmint 2.0 whitepaper](https://www.planetmint.com/whitepaper/)
|
||||
* [Check out the _Hitchiker's Guide to BigchainDB_](https://www.planetmint.com/developers/guide/)
|
||||
|
||||
## Run and Test Planetmint Server from the `master` Branch
|
||||
|
||||
Running and testing the latest version of Planetmint Server is easy. Make sure you have a recent version of [Docker Compose](https://docs.docker.com/compose/install/) installed. When you are ready, fire up a terminal and run:
|
||||
|
||||
```text
|
||||
git clone https://github.com/bigchaindb/bigchaindb.git
|
||||
cd bigchaindb
|
||||
git clone https://github.com/planetmint/planetmint.git
|
||||
cd planetmint
|
||||
make run
|
||||
```
|
||||
|
||||
@ -55,23 +55,23 @@ To view all commands available, run `make`.
|
||||
|
||||
## Links for Everyone
|
||||
|
||||
* [Planetmint.com](https://www.bigchaindb.com/) - the main Planetmint website, including newsletter signup
|
||||
* [Roadmap](https://github.com/bigchaindb/org/blob/master/ROADMAP.md)
|
||||
* [Blog](https://medium.com/the-bigchaindb-blog)
|
||||
* [Planetmint.com](https://www.planetmint.com/) - the main Planetmint website, including newsletter signup
|
||||
* [Roadmap](https://github.com/planetmint/org/blob/master/ROADMAP.md)
|
||||
* [Blog](https://medium.com/the-planetmint-blog)
|
||||
* [Twitter](https://twitter.com/Planetmint)
|
||||
|
||||
## Links for Developers
|
||||
|
||||
* [All Planetmint Documentation](https://docs.bigchaindb.com/en/latest/)
|
||||
* [Planetmint Server Documentation](https://docs.bigchaindb.com/projects/server/en/latest/index.html)
|
||||
* [All Planetmint Documentation](https://docs.planetmint.com/en/latest/)
|
||||
* [Planetmint Server Documentation](https://docs.planetmint.com/projects/server/en/latest/index.html)
|
||||
* [CONTRIBUTING.md](.github/CONTRIBUTING.md) - how to contribute
|
||||
* [Community guidelines](CODE_OF_CONDUCT.md)
|
||||
* [Open issues](https://github.com/bigchaindb/bigchaindb/issues)
|
||||
* [Open pull requests](https://github.com/bigchaindb/bigchaindb/pulls)
|
||||
* [Gitter chatroom](https://gitter.im/bigchaindb/bigchaindb)
|
||||
* [Open issues](https://github.com/planetmint/planetmint/issues)
|
||||
* [Open pull requests](https://github.com/planetmint/planetmint/pulls)
|
||||
* [Gitter chatroom](https://gitter.im/planetmint/planetmint)
|
||||
|
||||
## Legal
|
||||
|
||||
* [Licenses](LICENSES.md) - open source & open content
|
||||
* [Imprint](https://www.bigchaindb.com/imprint/)
|
||||
* [Contact Us](https://www.bigchaindb.com/contact/)
|
||||
* [Imprint](https://www.planetmint.com/imprint/)
|
||||
* [Contact Us](https://www.planetmint.com/contact/)
|
||||
|
||||
42
README_cn.md
42
README_cn.md
@ -10,12 +10,12 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
so show the latest GitHub release instead.
|
||||
--->
|
||||
|
||||
[](https://codecov.io/github/bigchaindb/bigchaindb?branch=master)
|
||||
[](https://github.com/bigchaindb/bigchaindb/releases)
|
||||
[](https://pypi.org/project/Planetmint/)
|
||||
[](https://travis-ci.com/bigchaindb/bigchaindb)
|
||||
[](https://docs.bigchaindb.com/projects/server/en/latest/)
|
||||
[](https://gitter.im/bigchaindb/bigchaindb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://codecov.io/github/planetmint/planetmint?branch=master)
|
||||
[](https://github.com/planetmint/planetmint/releases)
|
||||
[](https://pypi.org/project/Planetmint/)
|
||||
[](https://travis-ci.com/planetmint/planetmint)
|
||||
[](https://docs.planetmint.com/projects/server/en/latest/)
|
||||
[](https://gitter.im/planetmint/planetmint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
# Planetmint 服务器
|
||||
|
||||
@ -23,17 +23,17 @@ Planetmint 是区块链数据库. 这是 _BigchainDB 服务器_ 的仓库.
|
||||
|
||||
## 基础知识
|
||||
|
||||
* [尝试快速开始](https://docs.bigchaindb.com/projects/server/en/latest/quickstart.html)
|
||||
* [阅读 Planetmint 2.0 白皮书](https://www.bigchaindb.com/whitepaper/)
|
||||
* [查阅漫游指南](https://www.bigchaindb.com/developers/guide/)
|
||||
* [尝试快速开始](https://docs.planetmint.com/projects/server/en/latest/quickstart.html)
|
||||
* [阅读 Planetmint 2.0 白皮书](https://www.planetmint.com/whitepaper/)
|
||||
* [查阅漫游指南](https://www.planetmint.com/developers/guide/)
|
||||
|
||||
## 运行和测试 `master` 分支的 Planetmint 服务器
|
||||
|
||||
运行和测试最新版本的 Planetmint 服务器非常简单. 确认你有安装最新版本的 [Docker Compose](https://docs.docker.com/compose/install/). 当你准备好了, 打开一个终端并运行:
|
||||
|
||||
```text
|
||||
git clone https://github.com/bigchaindb/bigchaindb.git
|
||||
cd bigchaindb
|
||||
git clone https://github.com/planetmint/planetmint.git
|
||||
cd planetmint
|
||||
make run
|
||||
```
|
||||
|
||||
@ -55,23 +55,23 @@ Planetmint 应该可以通过 `http://localhost:9984/` 访问.
|
||||
|
||||
## 一般人员链接
|
||||
|
||||
* [Planetmint.com](https://www.bigchaindb.com/) - Planetmint 主网站, 包括新闻订阅
|
||||
* [路线图](https://github.com/bigchaindb/org/blob/master/ROADMAP.md)
|
||||
* [博客](https://medium.com/the-bigchaindb-blog)
|
||||
* [Planetmint.com](https://www.planetmint.com/) - Planetmint 主网站, 包括新闻订阅
|
||||
* [路线图](https://github.com/planetmint/org/blob/master/ROADMAP.md)
|
||||
* [博客](https://medium.com/the-planetmint-blog)
|
||||
* [推特](https://twitter.com/Planetmint)
|
||||
|
||||
## 开发人员链接
|
||||
|
||||
* [所有的 Planetmint 文档](https://docs.bigchaindb.com/en/latest/)
|
||||
* [Planetmint 服务器 文档](https://docs.bigchaindb.com/projects/server/en/latest/index.html)
|
||||
* [所有的 Planetmint 文档](https://docs.planetmint.com/en/latest/)
|
||||
* [Planetmint 服务器 文档](https://docs.planetmint.com/projects/server/en/latest/index.html)
|
||||
* [CONTRIBUTING.md](.github/CONTRIBUTING.md) - how to contribute
|
||||
* [社区指南](CODE_OF_CONDUCT.md)
|
||||
* [公开问题](https://github.com/bigchaindb/bigchaindb/issues)
|
||||
* [公开的 pull request](https://github.com/bigchaindb/bigchaindb/pulls)
|
||||
* [Gitter 聊天室](https://gitter.im/bigchaindb/bigchaindb)
|
||||
* [公开问题](https://github.com/planetmint/planetmint/issues)
|
||||
* [公开的 pull request](https://github.com/planetmint/planetmint/pulls)
|
||||
* [Gitter 聊天室](https://gitter.im/planetmint/planetmint)
|
||||
|
||||
## 法律声明
|
||||
|
||||
* [许可](LICENSES.md) - 开源代码 & 开源内容
|
||||
* [印记](https://www.bigchaindb.com/imprint/)
|
||||
* [联系我们](https://www.bigchaindb.com/contact/)
|
||||
* [印记](https://www.planetmint.com/imprint/)
|
||||
* [联系我们](https://www.planetmint.com/contact/)
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
[](https://codecov.io/github/bigchaindb/bigchaindb?branch=master)
|
||||
[](https://github.com/bigchaindb/bigchaindb/releases)
|
||||
[](https://pypi.org/project/Planetmint/)
|
||||
[](https://travis-ci.org/bigchaindb/bigchaindb)
|
||||
[](https://docs.bigchaindb.com/projects/server/en/latest/)
|
||||
[](https://gitter.im/bigchaindb/bigchaindb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://codecov.io/github/planetmint/planetmint?branch=master)
|
||||
[](https://github.com/planetmint/planetmint/releases)
|
||||
[](https://pypi.org/project/Planetmint/)
|
||||
[](https://travis-ci.org/planetmint/planetmint)
|
||||
[](https://docs.planetmint.com/projects/server/en/latest/)
|
||||
[](https://gitter.im/planetmint/planetmint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
|
||||
# Planetmint 서버
|
||||
|
||||
@ -11,17 +11,17 @@ BigchaingDB는 블록체인 데이터베이스입니다. 이 저장소는 _Bigch
|
||||
|
||||
### 기본 사항
|
||||
|
||||
* [빠른 시작 사용해보기](https://docs.bigchaindb.com/projects/server/en/latest/quickstart.html)
|
||||
* [Planetmint 2.0 백서 읽기](https://www.bigchaindb.com/whitepaper/)
|
||||
* [BigchainDB에 대한 _Hitchiker's Guide_를 확인십시오.](https://www.bigchaindb.com/developers/guide/)
|
||||
* [빠른 시작 사용해보기](https://docs.planetmint.com/projects/server/en/latest/quickstart.html)
|
||||
* [Planetmint 2.0 백서 읽기](https://www.planetmint.com/whitepaper/)
|
||||
* [BigchainDB에 대한 _Hitchiker's Guide_를 확인십시오.](https://www.planetmint.com/developers/guide/)
|
||||
|
||||
### `master` Branch에서 Planetmint 서버 실행 및 테스트
|
||||
|
||||
BigchaingDB 서버의 최신 버전을 실행하고 테스트하는 것은 어렵지 않습니다. [Docker Compose](https://docs.docker.com/compose/install/)의 최신 버전이 설치되어 있는지 확인하십시오. 준비가 되었다면, 터미널에서 다음을 실행하십시오.
|
||||
|
||||
```text
|
||||
git clone https://github.com/bigchaindb/bigchaindb.git
|
||||
cd bigchaindb
|
||||
git clone https://github.com/planetmint/planetmint.git
|
||||
cd planetmint
|
||||
make run
|
||||
```
|
||||
|
||||
@ -43,23 +43,23 @@ make run
|
||||
|
||||
### 모두를 위한 링크들
|
||||
|
||||
* [Planetmint.com ](https://www.bigchaindb.com/)- 뉴스 레터 가입을 포함하는 Planetmint 주요 웹 사이트
|
||||
* [로드맵](https://github.com/bigchaindb/org/blob/master/ROADMAP.md)
|
||||
* [블로그](https://medium.com/the-bigchaindb-blog)
|
||||
* [Planetmint.com ](https://www.planetmint.com/)- 뉴스 레터 가입을 포함하는 Planetmint 주요 웹 사이트
|
||||
* [로드맵](https://github.com/planetmint/org/blob/master/ROADMAP.md)
|
||||
* [블로그](https://medium.com/the-planetmint-blog)
|
||||
* [트위터](https://twitter.com/Planetmint)
|
||||
|
||||
### 개발자들을 위한 링크들
|
||||
|
||||
* [모든 Planetmint 문서](https://docs.bigchaindb.com/en/latest/)
|
||||
* [Planetmint 서버 문서](https://docs.bigchaindb.com/projects/server/en/latest/index.html)
|
||||
* [CONTRIBUTING.md](https://github.com/bigchaindb/bigchaindb/blob/master/.github/CONTRIBUTING.md) - 기여를 하는 방법
|
||||
* [커뮤니티 가이드라인](https://github.com/bigchaindb/bigchaindb/blob/master/CODE_OF_CONDUCT.md)
|
||||
* [이슈 작성](https://github.com/bigchaindb/bigchaindb/issues)
|
||||
* [pull request 하기](https://github.com/bigchaindb/bigchaindb/pulls)
|
||||
* [Gitter 채팅방](https://gitter.im/bigchaindb/bigchaindb)
|
||||
* [모든 Planetmint 문서](https://docs.planetmint.com/en/latest/)
|
||||
* [Planetmint 서버 문서](https://docs.planetmint.com/projects/server/en/latest/index.html)
|
||||
* [CONTRIBUTING.md](https://github.com/planetmint/planetmint/blob/master/.github/CONTRIBUTING.md) - 기여를 하는 방법
|
||||
* [커뮤니티 가이드라인](https://github.com/planetmint/planetmint/blob/master/CODE_OF_CONDUCT.md)
|
||||
* [이슈 작성](https://github.com/planetmint/planetmint/issues)
|
||||
* [pull request 하기](https://github.com/planetmint/planetmint/pulls)
|
||||
* [Gitter 채팅방](https://gitter.im/planetmint/planetmint)
|
||||
|
||||
### 합법
|
||||
|
||||
* [라이선스](https://github.com/bigchaindb/bigchaindb/blob/master/LICENSES.md) - 오픈 소스 & 오픈 콘텐츠
|
||||
* [발행](https://www.bigchaindb.com/imprint/)
|
||||
* [연락처](https://www.bigchaindb.com/contact/)
|
||||
* [라이선스](https://github.com/planetmint/planetmint/blob/master/LICENSES.md) - 오픈 소스 & 오픈 콘텐츠
|
||||
* [발행](https://www.planetmint.com/imprint/)
|
||||
* [연락처](https://www.planetmint.com/contact/)
|
||||
|
||||
@ -25,7 +25,7 @@ to [regular semantic versioning](http://semver.org/), but there's no hyphen, e.g
|
||||
|
||||
We use `0.9` and `0.9.0` as example version and short-version values below. You should replace those with the correct values for your new version.
|
||||
|
||||
We follow [BEP-1](https://github.com/bigchaindb/BEPs/tree/master/1), which is our variant of C4, the Collective Code Construction Contract, so a release is just a [tagged commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging) on the `master` branch, i.e. a label for a particular Git commit.
|
||||
We follow [BEP-1](https://github.com/planetmint/BEPs/tree/master/1), which is our variant of C4, the Collective Code Construction Contract, so a release is just a [tagged commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging) on the `master` branch, i.e. a label for a particular Git commit.
|
||||
|
||||
The following steps are what we do to release a new version of _BigchainDB Server_. The steps to release the Python Driver are similar but not the same.
|
||||
|
||||
@ -37,13 +37,13 @@ The following steps are what we do to release a new version of _BigchainDB Serve
|
||||
- Update all Docker image tags in all Kubernetes YAML files (in the `k8s/` directory).
|
||||
For example, in the files:
|
||||
|
||||
- `k8s/bigchaindb/bigchaindb-ss.yaml` and
|
||||
- `k8s/dev-setup/bigchaindb.yaml`
|
||||
- `k8s/planetmint/planetmint-ss.yaml` and
|
||||
- `k8s/dev-setup/planetmint.yaml`
|
||||
|
||||
find the line of the form `image: bigchaindb/bigchaindb:0.8.1` and change the version number to the new version number, e.g. `0.9.0`. (This is the Docker image that Kubernetes should pull from Docker Hub.)
|
||||
find the line of the form `image: planetmint/planetmint:0.8.1` and change the version number to the new version number, e.g. `0.9.0`. (This is the Docker image that Kubernetes should pull from Docker Hub.)
|
||||
Keep in mind that this is a _Docker image tag_ so our naming convention is
|
||||
a bit different; see Note 2 in the **Notes** section above.
|
||||
- In `bigchaindb/version.py`:
|
||||
- In `planetmint/version.py`:
|
||||
- update `__version__` to e.g. `0.9.0` (with no `.dev` on the end)
|
||||
- update `__short_version__` to e.g. `0.9` (with no `.dev` on the end)
|
||||
- In the docs about installing Planetmint (and Tendermint), and in the associated scripts, recommend/install a version of Tendermint that _actually works_ with the soon-to-be-released version of Planetmint. You can find all such references by doing a search for the previously-recommended version number, such as `0.31.5`.
|
||||
@ -51,7 +51,7 @@ The following steps are what we do to release a new version of _BigchainDB Serve
|
||||
|
||||
2. **Wait for all the tests to pass!**
|
||||
3. Merge the pull request into the `master` branch.
|
||||
4. Go to the [bigchaindb/bigchaindb Releases page on GitHub](https://github.com/bigchaindb/bigchaindb/releases)
|
||||
4. Go to the [planetmint/planetmint Releases page on GitHub](https://github.com/planetmint/planetmint/releases)
|
||||
and click the "Draft a new release" button.
|
||||
5. Fill in the details:
|
||||
- **Tag version:** version number preceded by `v`, e.g. `v0.9.1`
|
||||
@ -59,9 +59,9 @@ The following steps are what we do to release a new version of _BigchainDB Serve
|
||||
- **Title:** Same as tag version above, e.g `v0.9.1`
|
||||
- **Description:** The body of the changelog entry (Added, Changed, etc.)
|
||||
6. Click "Publish release" to publish the release on GitHub.
|
||||
7. On your local computer, make sure you're on the `master` branch and that it's up-to-date with the `master` branch in the bigchaindb/bigchaindb repository (e.g. `git pull upstream master`). We're going to use that to push a new `bigchaindb` package to PyPI.
|
||||
7. On your local computer, make sure you're on the `master` branch and that it's up-to-date with the `master` branch in the planetmint/planetmint repository (e.g. `git pull upstream master`). We're going to use that to push a new `planetmint` package to PyPI.
|
||||
8. Make sure you have a `~/.pypirc` file containing credentials for PyPI.
|
||||
9. Do `make release` to build and publish the new `bigchaindb` package on PyPI. For this step you need to have `twine` installed. If you get an error like `Makefile:135: recipe for target 'clean-pyc' failed` then try doing
|
||||
9. Do `make release` to build and publish the new `planetmint` package on PyPI. For this step you need to have `twine` installed. If you get an error like `Makefile:135: recipe for target 'clean-pyc' failed` then try doing
|
||||
```text
|
||||
sudo chown -R $(whoami):$(whoami) .
|
||||
```
|
||||
@ -80,8 +80,8 @@ The following steps are what we do to release a new version of _BigchainDB Serve
|
||||
3. Scroll to the bottom of the page and click "Save".
|
||||
11. Go to [Docker Hub](https://hub.docker.com/) and sign in, then:
|
||||
- Click on "Organizations"
|
||||
- Click on "bigchaindb"
|
||||
- Click on "bigchaindb/bigchaindb"
|
||||
- Click on "planetmint"
|
||||
- Click on "planetmint/planetmint"
|
||||
- Click on "Build Settings"
|
||||
- Find the row where "Docker Tag Name" equals `latest`
|
||||
and change the value of "Name" to the name (Git tag)
|
||||
|
||||
@ -7,8 +7,8 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
# Planetmint Roadmap
|
||||
|
||||
We moved the Planetmint Roadmap to the bigchaindb/org repository; see:
|
||||
We moved the Planetmint Roadmap to the planetmint/org repository; see:
|
||||
|
||||
[https://github.com/bigchaindb/org/blob/master/ROADMAP.md](https://github.com/bigchaindb/org/blob/master/ROADMAP.md)
|
||||
[https://github.com/planetmint/org/blob/master/ROADMAP.md](https://github.com/planetmint/org/blob/master/ROADMAP.md)
|
||||
|
||||
(We kept this file here to avoid breaking some links.)
|
||||
|
||||
@ -5,5 +5,5 @@ RUN pip install --upgrade \
|
||||
pycco \
|
||||
websocket-client~=0.47.0 \
|
||||
pytest~=3.0 \
|
||||
bigchaindb-driver~=0.6.2 \
|
||||
planetmint-driver~=0.6.2 \
|
||||
blns
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
# the remote system, and also checking the `outputs` of a given public key.
|
||||
#
|
||||
# This acceptance test is a rip-off of our
|
||||
# [tutorial](https://docs.bigchaindb.com/projects/py-driver/en/latest/usage.html).
|
||||
# [tutorial](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html).
|
||||
|
||||
# ## Imports
|
||||
# We need some utils from the `os` package, we will interact with
|
||||
@ -24,7 +24,7 @@
|
||||
import os
|
||||
|
||||
# For this test case we import and use the Python Driver.
|
||||
from bigchaindb_driver import BigchainDB
|
||||
from bigchaindb_driver import Planetmint
|
||||
from bigchaindb_driver.crypto import generate_keypair
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ def test_basic():
|
||||
# connect to localhost, but you can override this value using the env variable
|
||||
# called `PLANETMINT_ENDPOINT`, a valid value must include the schema:
|
||||
# `https://example.com:9984`
|
||||
bdb = BigchainDB(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
bdb = Planetmint(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
|
||||
# ## Create keypairs
|
||||
# This test requires the interaction between two actors with their own keypair.
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
# of a given transaction.
|
||||
#
|
||||
# This integration test is a rip-off of our
|
||||
# [tutorial](https://docs.bigchaindb.com/projects/py-driver/en/latest/usage.html).
|
||||
# [tutorial](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html).
|
||||
|
||||
# ## Imports
|
||||
# We need some utils from the `os` package, we will interact with
|
||||
@ -29,7 +29,7 @@ import pytest
|
||||
from bigchaindb_driver.exceptions import BadRequest
|
||||
|
||||
# For this test case we import and use the Python Driver.
|
||||
from bigchaindb_driver import BigchainDB
|
||||
from bigchaindb_driver import Planetmint
|
||||
from bigchaindb_driver.crypto import generate_keypair
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ def test_divisible_assets():
|
||||
# ## Set up a connection to Planetmint
|
||||
# Check [test_basic.py](./test_basic.html) to get some more details
|
||||
# about the endpoint.
|
||||
bdb = BigchainDB(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
bdb = Planetmint(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
|
||||
# Oh look, it is Alice again and she brought her friend Bob along.
|
||||
alice, bob = generate_keypair(), generate_keypair()
|
||||
|
||||
@ -12,12 +12,12 @@ from threading import Thread
|
||||
import queue
|
||||
|
||||
import bigchaindb_driver.exceptions
|
||||
from bigchaindb_driver import BigchainDB
|
||||
from bigchaindb_driver import Planetmint
|
||||
from bigchaindb_driver.crypto import generate_keypair
|
||||
|
||||
|
||||
def test_double_create():
|
||||
bdb = BigchainDB(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
bdb = Planetmint(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
alice = generate_keypair()
|
||||
|
||||
results = queue.Queue()
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
# of a given transaction.
|
||||
#
|
||||
# This integration test is a rip-off of our
|
||||
# [tutorial](https://docs.bigchaindb.com/projects/py-driver/en/latest/usage.html).
|
||||
# [tutorial](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html).
|
||||
|
||||
# ## Imports
|
||||
# We need some utils from the `os` package, we will interact with
|
||||
@ -25,7 +25,7 @@
|
||||
import os
|
||||
|
||||
# For this test case we import and use the Python Driver.
|
||||
from bigchaindb_driver import BigchainDB
|
||||
from bigchaindb_driver import Planetmint
|
||||
from bigchaindb_driver.crypto import generate_keypair
|
||||
|
||||
|
||||
@ -33,7 +33,7 @@ def test_multiple_owners():
|
||||
# ## Set up a connection to Planetmint
|
||||
# Check [test_basic.py](./test_basic.html) to get some more details
|
||||
# about the endpoint.
|
||||
bdb = BigchainDB(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
bdb = Planetmint(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
|
||||
# Hey Alice and Bob, nice to see you again!
|
||||
alice, bob = generate_keypair(), generate_keypair()
|
||||
|
||||
@ -24,7 +24,7 @@ from blns import blns
|
||||
import pytest
|
||||
|
||||
# For this test case we import and use the Python Driver.
|
||||
from bigchaindb_driver import BigchainDB
|
||||
from bigchaindb_driver import Planetmint
|
||||
from bigchaindb_driver.crypto import generate_keypair
|
||||
from bigchaindb_driver.exceptions import BadRequest
|
||||
|
||||
@ -36,7 +36,7 @@ def send_naughty_tx(asset, metadata):
|
||||
# ## Set up a connection to Planetmint
|
||||
# Check [test_basic.py](./test_basic.html) to get some more details
|
||||
# about the endpoint.
|
||||
bdb = BigchainDB(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
bdb = Planetmint(os.environ.get('PLANETMINT_ENDPOINT'))
|
||||
|
||||
# Here's Alice.
|
||||
alice = generate_keypair()
|
||||
|
||||
@ -27,7 +27,7 @@ from uuid import uuid4
|
||||
# [websocket](https://github.com/websocket-client/websocket-client) module
|
||||
from websocket import create_connection
|
||||
|
||||
from bigchaindb_driver import BigchainDB
|
||||
from bigchaindb_driver import Planetmint
|
||||
from bigchaindb_driver.crypto import generate_keypair
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ def test_stream():
|
||||
# *That's pretty bad, but let's do like this for now.*
|
||||
WS_ENDPOINT = 'ws://{}:9985/api/v1/streams/valid_transactions'.format(BDB_ENDPOINT.rsplit(':')[0])
|
||||
|
||||
bdb = BigchainDB(BDB_ENDPOINT)
|
||||
bdb = Planetmint(BDB_ENDPOINT)
|
||||
|
||||
# Hello to Alice again, she is pretty active in those tests, good job
|
||||
# Alice!
|
||||
|
||||
@ -25,7 +25,7 @@ coverage:
|
||||
ignore: # files and folders that will be removed during processing
|
||||
- "docs/*"
|
||||
- "tests/*"
|
||||
- "bigchaindb/version.py"
|
||||
- "planetmint/version.py"
|
||||
- "k8s/*"
|
||||
|
||||
comment:
|
||||
|
||||
@ -5,7 +5,7 @@ SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
--->
|
||||
|
||||
- [Documentation on ReadTheDocs](http://bigchaindb.readthedocs.org/)
|
||||
- [Documentation on ReadTheDocs](http://planetmint.readthedocs.org/)
|
||||
- [Planetmint Upgrade Guides](upgrade-guides/)
|
||||
|
||||
# The Planetmint Documentation Strategy
|
||||
|
||||
@ -127,9 +127,9 @@ if "%1" == "qthelp" (
|
||||
echo.
|
||||
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
||||
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\bigchaindb.qhcp
|
||||
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\planetmint.qhcp
|
||||
echo.To view the help file:
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\bigchaindb.ghc
|
||||
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\planetmint.ghc
|
||||
goto end
|
||||
)
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@ Planetmint can store data of any kind, but it's designed to be particularly good
|
||||
|
||||
.. note::
|
||||
|
||||
We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the section titled **A Note about Owners** in the relevant `Planetmint Transactions Spec <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_.
|
||||
We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the section titled **A Note about Owners** in the relevant `Planetmint Transactions Spec <https://github.com/planetmint/BEPs/tree/master/tx-specs/>`_.
|
||||
|
||||
# Production-Ready?
|
||||
|
||||
@ -52,7 +52,7 @@ A system could store data off-chain, e.g. in a third-party database, document st
|
||||
- Keep track of who has read permissions (or other permissions) in a third-party system. An example of how this could be done is described below.
|
||||
- Keep a permanent record of all requests made to the third-party system.
|
||||
- Store hashes of documents-stored-elsewhere, so that a change in any document can be detected.
|
||||
- Record all handshake-establishing requests and responses between two off-chain parties (e.g. a Diffie-Hellman key exchange), so as to prove that they established an encrypted tunnel (without giving readers access to that tunnel). There are more details about this idea in `the Privacy Protocols repository <https://github.com/bigchaindb/privacy-protocols>`_.
|
||||
- Record all handshake-establishing requests and responses between two off-chain parties (e.g. a Diffie-Hellman key exchange), so as to prove that they established an encrypted tunnel (without giving readers access to that tunnel). There are more details about this idea in `the Privacy Protocols repository <https://github.com/planetmint/privacy-protocols>`_.
|
||||
|
||||
A simple way to record who has read permission on a particular document would be for the third-party system (“DocPile”) to store a CREATE transaction in a Planetmint network for every document+user pair, to indicate that that user has read permissions for that document. The transaction could be signed by DocPile (or maybe by a document owner, as a variation). The asset data field would contain 1) the unique ID of the user and 2) the unique ID of the document. The one output on the CREATE transaction would only be transferable/spendable by DocPile (or, again, a document owner).
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ two kinds: CREATE transactions and TRANSFER transactions.
|
||||
|
||||
You can view the transaction specifications in Github, which describe transaction components and the conditions they have to fulfill in order to be valid.
|
||||
|
||||
[Planetmint Transactions Specs](https://github.com/bigchaindb/BEPs/tree/master/13/)
|
||||
[Planetmint Transactions Specs](https://github.com/planetmint/BEPs/tree/master/13/)
|
||||
|
||||
### CREATE Transactions
|
||||
|
||||
@ -44,7 +44,7 @@ Planetmint supports a variety of conditions.
|
||||
For details, see
|
||||
the section titled **Transaction Components: Conditions**
|
||||
in the relevant
|
||||
[Planetmint Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/13/).
|
||||
[Planetmint Transactions Spec](https://github.com/planetmint/BEPs/tree/master/13/).
|
||||
|
||||
|
||||
|
||||
@ -58,7 +58,7 @@ Loosely speaking, that list might be interpreted as the list of "owners."
|
||||
A more accurate word might be fulfillers, signers, controllers,
|
||||
or transfer-enablers.
|
||||
See the section titled **A Note about Owners**
|
||||
in the relevant [Planetmint Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/13/).
|
||||
in the relevant [Planetmint Transactions Spec](https://github.com/planetmint/BEPs/tree/master/13/).
|
||||
|
||||
A CREATE transaction must be signed by all the owners.
|
||||
(If you're looking for that signature,
|
||||
@ -120,7 +120,7 @@ of the outgoing paperclips (100).
|
||||
|
||||
When a node is asked to check if a transaction is valid, it checks several
|
||||
things. We documented those things in a post on *The Planetmint Blog*:
|
||||
["What is a Valid Transaction in Planetmint?"](https://blog.bigchaindb.com/what-is-a-valid-transaction-in-bigchaindb-9a1a075a9598)
|
||||
["What is a Valid Transaction in Planetmint?"](https://blog.planetmint.com/what-is-a-valid-transaction-in-planetmint-9a1a075a9598)
|
||||
(Note: That post was about Planetmint Server v1.0.0.)
|
||||
|
||||
### Example Transactions
|
||||
|
||||
@ -79,13 +79,13 @@ def get_old_new(url, old, new):
|
||||
filename = wget.download(url)
|
||||
rename(old, new)
|
||||
|
||||
get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/CODE_OF_CONDUCT.md',
|
||||
get_old_new('https://raw.githubusercontent.com/planetmint/planetmint/master/CODE_OF_CONDUCT.md',
|
||||
'CODE_OF_CONDUCT.md', 'contributing/cross-project-policies/code-of-conduct.md')
|
||||
|
||||
get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/RELEASE_PROCESS.md',
|
||||
get_old_new('https://raw.githubusercontent.com/planetmint/planetmint/master/RELEASE_PROCESS.md',
|
||||
'RELEASE_PROCESS.md', 'contributing/cross-project-policies/release-process.md')
|
||||
|
||||
get_old_new('https://raw.githubusercontent.com/bigchaindb/bigchaindb/master/PYTHON_STYLE_GUIDE.md',
|
||||
get_old_new('https://raw.githubusercontent.com/planetmint/planetmint/master/PYTHON_STYLE_GUIDE.md',
|
||||
'PYTHON_STYLE_GUIDE.md', 'contributing/cross-project-policies/python-style-guide.md')
|
||||
|
||||
suppress_warnings = ['misc.highlighting_failure']
|
||||
@ -372,7 +372,7 @@ latex_documents = [
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'bigchaindb', 'Planetmint Documentation',
|
||||
(master_doc, 'planetmint', 'Planetmint Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<!---
|
||||
Copyright © 2020 Interplanetary Database Association e.V.,
|
||||
BigchainDB and IPDB software contributors.
|
||||
Planetmint and IPDB software contributors.
|
||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
--->
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<!---
|
||||
Copyright © 2020 Interplanetary Database Association e.V.,
|
||||
BigchainDB and IPDB software contributors.
|
||||
Planetmint and IPDB software contributors.
|
||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
--->
|
||||
@ -13,7 +13,7 @@ This guide starts out with our general Python coding style guidelines and ends w
|
||||
|
||||
Our starting point is [PEP8](https://www.python.org/dev/peps/pep-0008/), the standard "Style Guide for Python Code." Many Python IDEs will check your code against PEP8. (Note that PEP8 isn't frozen; it actually changes over time, but slowly.)
|
||||
|
||||
BigchainDB uses Python 3.5+, so you can ignore all PEP8 guidelines specific to Python 2.
|
||||
Planetmint uses Python 3.5+, so you can ignore all PEP8 guidelines specific to Python 2.
|
||||
|
||||
We use [pre-commit](http://pre-commit.com/) to check some of the rules below before every commit but not everything is realized yet.
|
||||
The hooks we use can be found in the [.pre-commit-config.yaml](https://github.com/bigchaindb/bigchaindb/blob/master/.pre-commit-config.yaml) file.
|
||||
@ -30,7 +30,7 @@ PEP8 says some things about docstrings, but not what to put in them or how to st
|
||||
|
||||
PEP8 has some [maximum line length guidelines](https://www.python.org/dev/peps/pep-0008/#id17), starting with "Limit all lines to a maximum of 79 characters" but "for flowing long blocks of text with fewer structural restrictions (docstrings or comments), the line length should be limited to 72 characters."
|
||||
|
||||
We discussed this at length, and it seems that the consensus is: _try_ to keep line lengths less than 79/72 characters, unless you have a special situation where longer lines would improve readability. (The basic reason is that 79/72 works for everyone, and BigchainDB is an open source project.) As a hard limit, keep all lines less than 119 characters (which is the width of GitHub code review).
|
||||
We discussed this at length, and it seems that the consensus is: _try_ to keep line lengths less than 79/72 characters, unless you have a special situation where longer lines would improve readability. (The basic reason is that 79/72 works for everyone, and Planetmint is an open source project.) As a hard limit, keep all lines less than 119 characters (which is the width of GitHub code review).
|
||||
|
||||
### Single or Double Quotes?
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<!---
|
||||
Copyright © 2020 Interplanetary Database Association e.V.,
|
||||
BigchainDB and IPDB software contributors.
|
||||
Planetmint and IPDB software contributors.
|
||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
--->
|
||||
@ -9,7 +9,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
## Notes
|
||||
|
||||
BigchainDB follows
|
||||
Planetmint follows
|
||||
[the Python form of Semantic Versioning](https://packaging.python.org/tutorials/distributing-packages/#choosing-a-versioning-scheme)
|
||||
(i.e. MAJOR.MINOR.PATCH),
|
||||
which is almost identical
|
||||
@ -46,7 +46,7 @@ The following steps are what we do to release a new version of _BigchainDB Serve
|
||||
- In `bigchaindb/version.py`:
|
||||
- update `__version__` to e.g. `0.9.0` (with no `.dev` on the end)
|
||||
- update `__short_version__` to e.g. `0.9` (with no `.dev` on the end)
|
||||
- In the docs about installing BigchainDB (and Tendermint), and in the associated scripts, recommend/install a version of Tendermint that _actually works_ with the soon-to-be-released version of BigchainDB. You can find all such references by doing a search for the previously-recommended version number, such as `0.31.5`.
|
||||
- In the docs about installing Planetmint (and Tendermint), and in the associated scripts, recommend/install a version of Tendermint that _actually works_ with the soon-to-be-released version of Planetmint. You can find all such references by doing a search for the previously-recommended version number, such as `0.31.5`.
|
||||
- In `setup.py`, _maybe_ update the development status item in the `classifiers` list. For example, one allowed value is `"Development Status :: 5 - Production/Stable"`. The [allowed values are listed at pypi.python.org](https://pypi.python.org/pypi?%3Aaction=list_classifiers).
|
||||
|
||||
2. **Wait for all the tests to pass!**
|
||||
@ -65,7 +65,7 @@ The following steps are what we do to release a new version of _BigchainDB Serve
|
||||
```text
|
||||
sudo chown -R $(whoami):$(whoami) .
|
||||
```
|
||||
10. [Log in to readthedocs.org](https://readthedocs.org/accounts/login/) and go to the **BigchainDB Server** project, then:
|
||||
10. [Log in to readthedocs.org](https://readthedocs.org/accounts/login/) and go to the **Planetmint Server** project, then:
|
||||
- Click on "Builds", select "latest" from the drop-down menu, then click the "Build Version:" button.
|
||||
- Wait for the build of "latest" to finish. This can take a few minutes.
|
||||
- Go to Admin --> Advanced Settings
|
||||
@ -98,4 +98,4 @@ The following steps are what we do to release a new version of _BigchainDB Serve
|
||||
- If the release is an Alpha, Beta or Release Candidate release,
|
||||
then click on the "Trigger" button for that tag as well.
|
||||
|
||||
Congratulations, you have released a new version of BigchainDB Server!
|
||||
Congratulations, you have released a new version of Planetmint Server!
|
||||
|
||||
@ -25,7 +25,7 @@ Minimum resource requirements for a single node Planetmint dev setup. **The more
|
||||
|
||||
## Clone the Planetmint repository
|
||||
```text
|
||||
$ git clone https://github.com/bigchaindb/bigchaindb.git
|
||||
$ git clone https://github.com/planetmint/planetmint.git
|
||||
```
|
||||
|
||||
## Install dependencies
|
||||
@ -33,28 +33,28 @@ $ git clone https://github.com/bigchaindb/bigchaindb.git
|
||||
|
||||
You can also install `ansible` and other dependencies, if any, using the `boostrap.sh` script
|
||||
inside the Planetmint repository.
|
||||
Navigate to `bigchaindb/pkg/scripts` and run the `bootstrap.sh` script to install the dependencies
|
||||
Navigate to `planetmint/pkg/scripts` and run the `bootstrap.sh` script to install the dependencies
|
||||
for your OS. The script also checks if the OS you are running is compatible with the
|
||||
supported versions.
|
||||
|
||||
**Note**: `bootstrap.sh` only supports Ubuntu >= 16.04, CentOS >= 7 and Fedora >=24 and MacOSX.
|
||||
|
||||
```text
|
||||
$ cd bigchaindb/pkg/scripts/
|
||||
$ cd planetmint/pkg/scripts/
|
||||
$ bash bootstrap.sh --operation install
|
||||
```
|
||||
|
||||
### Planetmint Setup Configuration(s)
|
||||
#### Local Setup
|
||||
You can run the Ansible playbook `bigchaindb-start.yml` on your local dev machine and set up the Planetmint node where
|
||||
You can run the Ansible playbook `planetmint-start.yml` on your local dev machine and set up the Planetmint node where
|
||||
Planetmint can be run as a process or inside a Docker container(s) depending on your configuration.
|
||||
|
||||
Before, running the playbook locally, you need to update the `hosts` and `stack-config.yml` configuration, which will notify Ansible that we need to run the play locally.
|
||||
|
||||
##### Update Hosts
|
||||
Navigate to `bigchaindb/pkg/configuration/hosts` inside the Planetmint repository.
|
||||
Navigate to `planetmint/pkg/configuration/hosts` inside the Planetmint repository.
|
||||
```text
|
||||
$ cd bigchaindb/pkg/configuration/hosts
|
||||
$ cd planetmint/pkg/configuration/hosts
|
||||
```
|
||||
|
||||
Edit `all` configuration file:
|
||||
@ -64,9 +64,9 @@ Edit `all` configuration file:
|
||||
<HOSTNAME> ansible_connection=local
|
||||
```
|
||||
##### Update Configuration
|
||||
Navigate to `bigchaindb/pkg/configuration/vars` inside the Planetmint repository.
|
||||
Navigate to `planetmint/pkg/configuration/vars` inside the Planetmint repository.
|
||||
```text
|
||||
$ cd bigchaindb/pkg/configuration/vars/stack-config.yml
|
||||
$ cd planetmint/pkg/configuration/vars/stack-config.yml
|
||||
```
|
||||
|
||||
Edit `bdb-config.yml` configuration file as per your requirements, sample configuration file(s):
|
||||
@ -84,30 +84,30 @@ stack_type: "1"
|
||||
```
|
||||
|
||||
### Planetmint Setup
|
||||
Now, You can safely run the `bigchaindb-start.yml` playbook and everything will be taken care of by `Ansible`. To run the playbook please navigate to the `bigchaindb/pkg/configuration` directory inside the Planetmint repository and run the `bigchaindb-start.yml` playbook.
|
||||
Now, You can safely run the `planetmint-start.yml` playbook and everything will be taken care of by `Ansible`. To run the playbook please navigate to the `planetmint/pkg/configuration` directory inside the Planetmint repository and run the `planetmint-start.yml` playbook.
|
||||
|
||||
```text
|
||||
$ cd bigchaindb/pkg/configuration/
|
||||
$ cd planetmint/pkg/configuration/
|
||||
|
||||
$ ansible-playbook bigchaindb-start.yml -i hosts/all --extra-vars "operation=start home_path=$(pwd)"
|
||||
$ ansible-playbook planetmint-start.yml -i hosts/all --extra-vars "operation=start home_path=$(pwd)"
|
||||
```
|
||||
|
||||
After successful execution of the playbook, you can verify that Planetmint docker(s)/process(es) is(are) running.
|
||||
|
||||
Verify Planetmint process(es):
|
||||
```text
|
||||
$ ps -ef | grep bigchaindb
|
||||
$ ps -ef | grep planetmint
|
||||
```
|
||||
|
||||
OR
|
||||
|
||||
Verify Planetmint Docker(s):
|
||||
```text
|
||||
$ docker ps | grep bigchaindb
|
||||
$ docker ps | grep planetmint
|
||||
```
|
||||
|
||||
You can now send transactions and verify the functionality of your Planetmint node.
|
||||
See the [Planetmint Python Driver documentation](https://docs.bigchaindb.com/projects/py-driver/en/latest/index.html)
|
||||
See the [Planetmint Python Driver documentation](https://docs.planetmint.com/projects/py-driver/en/latest/index.html)
|
||||
for details on how to use it.
|
||||
|
||||
**Note**: The `bdb_root_url` can be be one of the following:
|
||||
@ -121,19 +121,19 @@ OR
|
||||
bdb_root_url = http://<HOST-IP>:<DOCKER-PUBLISHED-PORT>
|
||||
```
|
||||
|
||||
**Note**: Planetmint has [other drivers as well](http://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/index.html).
|
||||
**Note**: Planetmint has [other drivers as well](http://docs.planetmint.com/projects/server/en/latest/drivers-clients/index.html).
|
||||
|
||||
### Experimental: Running Ansible a Remote Dev/Host
|
||||
#### Remote Setup
|
||||
You can also run the Ansible playbook `bigchaindb-start.yml` on remote machine(s) and set up the Planetmint node where
|
||||
You can also run the Ansible playbook `planetmint-start.yml` on remote machine(s) and set up the Planetmint node where
|
||||
Planetmint can run as a process or inside a Docker container(s) depending on your configuration.
|
||||
|
||||
Before, running the playbook on a remote host, you need to update the `hosts` and `stack-config.yml` configuration, which will notify Ansible that we need to run the play on a remote host.
|
||||
|
||||
##### Update Remote Hosts
|
||||
Navigate to `bigchaindb/pkg/configuration/hosts` inside the Planetmint repository.
|
||||
Navigate to `planetmint/pkg/configuration/hosts` inside the Planetmint repository.
|
||||
```text
|
||||
$ cd bigchaindb/pkg/configuration/hosts
|
||||
$ cd planetmint/pkg/configuration/hosts
|
||||
```
|
||||
|
||||
Edit `all` configuration file:
|
||||
@ -148,9 +148,9 @@ Edit `all` configuration file:
|
||||
please consult [Ansible Documentation](http://docs.ansible.com/ansible/latest/intro_getting_started.html).
|
||||
|
||||
##### Update Remote Configuration
|
||||
Navigate to `bigchaindb/pkg/configuration/vars` inside the Planetmint repository.
|
||||
Navigate to `planetmint/pkg/configuration/vars` inside the Planetmint repository.
|
||||
```text
|
||||
$ cd bigchaindb/pkg/configuration/vars/stack-config.yml
|
||||
$ cd planetmint/pkg/configuration/vars/stack-config.yml
|
||||
```
|
||||
|
||||
Edit `stack-config.yml` configuration file as per your requirements, sample configuration file(s):
|
||||
@ -167,4 +167,4 @@ stack_type: "local"
|
||||
stack_type: "1"
|
||||
```
|
||||
|
||||
After, the configuration of remote hosts, [run the Ansible playbook and verify your deployment](#bigchaindb-setup-ansible).
|
||||
After, the configuration of remote hosts, [run the Ansible playbook and verify your deployment](#planetmint-setup-ansible).
|
||||
|
||||
@ -26,20 +26,20 @@ Minimum resource requirements for a single node Planetmint dev setup. **The more
|
||||
## Download the scripts
|
||||
> **Note**: If you're working on Planetmint Server code, on a branch based on
|
||||
> recent code, then you already have local recent versions of *stack.sh* and
|
||||
> *unstack.sh* in your bigchaindb/pkg/scripts/ directory. Otherwise you can
|
||||
> *unstack.sh* in your planetmint/pkg/scripts/ directory. Otherwise you can
|
||||
> get them using:
|
||||
|
||||
```text
|
||||
$ export GIT_BRANCH=master
|
||||
$ curl -fOL https://raw.githubusercontent.com/bigchaindb/bigchaindb/${GIT_BRANCH}/pkg/scripts/stack.sh
|
||||
$ curl -fOL https://raw.githubusercontent.com/planetmint/planetmint/${GIT_BRANCH}/pkg/scripts/stack.sh
|
||||
|
||||
# Optional
|
||||
$ curl -fOL https://raw.githubusercontent.com/bigchaindb/bigchaindb/${GIT_BRANCH}/pkg/scripts/unstack.sh
|
||||
$ curl -fOL https://raw.githubusercontent.com/planetmint/planetmint/${GIT_BRANCH}/pkg/scripts/unstack.sh
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
If you run `stack.sh` out of the box i.e. without any configuration changes, you will be able to deploy a 4 node
|
||||
Planetmint network with Docker containers, created from `master` branch of `bigchaindb/bigchaindb` repo and Tendermint version `0.22.8`.
|
||||
Planetmint network with Docker containers, created from `master` branch of `planetmint/planetmint` repo and Tendermint version `0.22.8`.
|
||||
|
||||
**Note**: Run `stack.sh` with either root or non-root user with sudo enabled.
|
||||
|
||||
@ -89,11 +89,11 @@ $ bash stack.sh -h
|
||||
of the instance(s) spawned. (default: ubuntu/xenial64)
|
||||
|
||||
ENV[STACK_REPO]
|
||||
(Optional) To configure bigchaindb repo to use, set STACK_REPO environment
|
||||
variable. (default: bigchaindb/bigchaindb)
|
||||
(Optional) To configure planetmint repo to use, set STACK_REPO environment
|
||||
variable. (default: planetmint/planetmint)
|
||||
|
||||
ENV[STACK_BRANCH]
|
||||
(Optional) To configure bigchaindb repo branch to use set STACK_BRANCH environment
|
||||
(Optional) To configure planetmint repo branch to use set STACK_BRANCH environment
|
||||
variable. (default: master)
|
||||
|
||||
ENV[TM_VERSION]
|
||||
@ -171,8 +171,8 @@ $ export STACK_SIZE=4
|
||||
$ export STACK_TYPE=docker
|
||||
|
||||
#Optional, repo to use for the network deployment
|
||||
# Default: bigchaindb/bigchaindb
|
||||
$ export STACK_REPO=bigchaindb/bigchaindb
|
||||
# Default: planetmint/planetmint
|
||||
$ export STACK_REPO=planetmint/planetmint
|
||||
|
||||
#Optional, codebase to use for the network deployment
|
||||
# Default: master
|
||||
@ -222,8 +222,8 @@ $ export STACK_VM_CPUS=1
|
||||
$ export STACK_BOX_NAME=ubuntu/xenial64
|
||||
|
||||
#Optional, repo to use for the network deployment
|
||||
# Default: bigchaindb/bigchaindb
|
||||
$ export STACK_REPO=bigchaindb/bigchaindb
|
||||
# Default: planetmint/planetmint
|
||||
$ export STACK_REPO=planetmint/planetmint
|
||||
|
||||
#Optional, codebase to use for the network deployment
|
||||
# Default: master
|
||||
|
||||
@ -112,8 +112,8 @@ $ tendermint unsafe_reset_all
|
||||
To install Planetmint from source (for dev), clone the repo and execute the following command, (it is better that you create a virtual env for this)
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/bigchaindb/bigchaindb.git
|
||||
$ cd bigchaindb
|
||||
$ git clone https://github.com/planetmint/planetmint.git
|
||||
$ cd planetmint
|
||||
$ pip install -e .[dev] # or pip install -e '.[dev]' # for zsh
|
||||
```
|
||||
|
||||
@ -132,7 +132,7 @@ One could mark a specific test and execute the same by appending `-m my_mark` to
|
||||
Although the above should prove sufficient in most cases but in case tests are failing on Travis CI then the following command can be used to possibly replicate the failure locally,
|
||||
|
||||
```bash
|
||||
$ docker-compose run --rm --no-deps bdb pytest -v --cov=bigchaindb
|
||||
$ docker-compose run --rm --no-deps bdb pytest -v --cov=planetmint
|
||||
```
|
||||
|
||||
NOTE: before executing the above command the user must ensure that they reset the Tendermint container by executing `tendermint usafe_reset_all` command in the Tendermint container.
|
||||
|
||||
@ -33,7 +33,7 @@ There are also other commands you can execute:
|
||||
The Planetmint `Makefile` is a wrapper around some `docker-compose` commands we use frequently. If you need a finer granularity to manage the containers, you can still use `docker-compose` directly. This part of the documentation explains how to do that.
|
||||
|
||||
```bash
|
||||
$ docker-compose build bigchaindb
|
||||
$ docker-compose build planetmint
|
||||
$ docker-compose up -d bdb
|
||||
```
|
||||
|
||||
@ -41,7 +41,7 @@ The above command will launch all 3 main required services/processes:
|
||||
|
||||
* ``mongodb``
|
||||
* ``tendermint``
|
||||
* ``bigchaindb``
|
||||
* ``planetmint``
|
||||
|
||||
To follow the logs of the ``tendermint`` service:
|
||||
|
||||
@ -49,10 +49,10 @@ To follow the logs of the ``tendermint`` service:
|
||||
$ docker-compose logs -f tendermint
|
||||
```
|
||||
|
||||
To follow the logs of the ``bigchaindb`` service:
|
||||
To follow the logs of the ``planetmint`` service:
|
||||
|
||||
```bash
|
||||
$ docker-compose logs -f bigchaindb
|
||||
$ docker-compose logs -f planetmint
|
||||
```
|
||||
|
||||
To follow the logs of the ``mongodb`` service:
|
||||
@ -81,18 +81,18 @@ $ docker-compose -f docker-compose.yml run --rm bdb-driver ipython
|
||||
Run all the tests using:
|
||||
|
||||
```bash
|
||||
$ docker-compose run --rm --no-deps bigchaindb pytest -v
|
||||
$ docker-compose run --rm --no-deps planetmint pytest -v
|
||||
```
|
||||
|
||||
Run tests from a file:
|
||||
|
||||
```bash
|
||||
$ docker-compose run --rm --no-deps bigchaindb pytest /path/to/file -v
|
||||
$ docker-compose run --rm --no-deps planetmint pytest /path/to/file -v
|
||||
```
|
||||
|
||||
Run specific tests:
|
||||
```bash
|
||||
$ docker-compose run --rm --no-deps bigchaindb pytest /path/to/file -k "<test_name>" -v
|
||||
$ docker-compose run --rm --no-deps planetmint pytest /path/to/file -k "<test_name>" -v
|
||||
```
|
||||
|
||||
### Building Docs
|
||||
|
||||
@ -21,7 +21,7 @@ Refresh Yourself about the C4 Process
|
||||
-------------------------------------
|
||||
|
||||
C4 is the Collective Code Construction Contract. It's quite short:
|
||||
`re-reading it will only take a few minutes <https://github.com/bigchaindb/BEPs/tree/master/1>`_.
|
||||
`re-reading it will only take a few minutes <https://github.com/planetmint/BEPs/tree/master/1>`_.
|
||||
|
||||
|
||||
Set Up Your Local Machine. Here's How.
|
||||
@ -69,7 +69,7 @@ Set Up Your Local Machine. Here's How.
|
||||
Before You Start Writing Code
|
||||
-----------------------------
|
||||
|
||||
Read `BEP-24 <https://github.com/bigchaindb/BEPs/tree/master/24>`_
|
||||
Read `BEP-24 <https://github.com/planetmint/BEPs/tree/master/24>`_
|
||||
so you know what to do to ensure that your changes (i.e. your future pull request) can be merged.
|
||||
It's easy and will save you some hassle later on.
|
||||
|
||||
@ -79,7 +79,7 @@ Start Writing Code
|
||||
|
||||
Use the Git `Fork and Pull Request Workflow <https://github.com/susam/gitpr>`_. Tip: You could print that page for reference.
|
||||
|
||||
Your Python code should follow `our Python Style Guide <https://github.com/bigchaindb/bigchaindb/blob/master/PYTHON_STYLE_GUIDE.md>`_.
|
||||
Your Python code should follow `our Python Style Guide <https://github.com/planetmint/planetmint/blob/master/PYTHON_STYLE_GUIDE.md>`_.
|
||||
Similarly for JavaScript.
|
||||
|
||||
Make sure `pre-commit <https://pre-commit.com/>`_ actually checks commits. Do:
|
||||
|
||||
@ -21,10 +21,10 @@ To write an issue, go to the relevant GitHub repository, click on the **Issues**
|
||||
People ask questions about Planetmint in the following places:
|
||||
|
||||
- Gitter
|
||||
- [bigchaindb/bigchaindb](https://gitter.im/planetmint/community)
|
||||
- [bigchaindb/js-bigchaindb-driver](https://gitter.im/planetmint/community))
|
||||
- [planetmint/planetmint](https://gitter.im/planetmint/community)
|
||||
- [planetmint/js-planetmint-driver](https://gitter.im/planetmint/community))
|
||||
- [Twitter](https://twitter.com/planetmint)
|
||||
- [Stack Overflow "bigchaindb"](https://stackoverflow.com/search?q=planetmint)
|
||||
- [Stack Overflow "planetmint"](https://stackoverflow.com/search?q=planetmint)
|
||||
|
||||
Feel free to hang out and answer some questions. People will be thankful.
|
||||
|
||||
|
||||
@ -11,9 +11,9 @@ Connectors to Planetmint are referred to as drivers within the community. A driv
|
||||
|
||||
These drivers were originally created by the original Planetmint team:
|
||||
|
||||
* `Python Driver <https://docs.bigchaindb.com/projects/py-driver/en/latest/index.html>`_
|
||||
* `JavaScript / Node.js Driver <https://github.com/bigchaindb/js-bigchaindb-driver>`_
|
||||
* `Java Driver <https://github.com/bigchaindb/java-bigchaindb-driver>`_
|
||||
* `Python Driver <https://docs.planetmint.com/projects/py-driver/en/latest/index.html>`_
|
||||
* `JavaScript / Node.js Driver <https://github.com/planetmint/js-planetmint-driver>`_
|
||||
* `Java Driver <https://github.com/planetmint/java-planetmint-driver>`_
|
||||
|
||||
These drivers and tools were created by the Planetmint community:
|
||||
|
||||
@ -23,9 +23,9 @@ These drivers and tools were created by the Planetmint community:
|
||||
but may still be useful.
|
||||
Others might not work with the latest version of Planetmint.
|
||||
|
||||
* `ANSI C driver <https://github.com/RiddleAndCode/bigchaindb-c-driver>`_, should also work with C++ (working as of June 2019)
|
||||
* `C# driver <https://github.com/Omnibasis/bigchaindb-csharp-driver>`_ (working as of May 2019)
|
||||
* `Haskell transaction builder <https://github.com/bigchaindb/bigchaindb-hs>`_
|
||||
* `ANSI C driver <https://github.com/RiddleAndCode/planetmint-c-driver>`_, should also work with C++ (working as of June 2019)
|
||||
* `C# driver <https://github.com/Omnibasis/planetmint-csharp-driver>`_ (working as of May 2019)
|
||||
* `Haskell transaction builder <https://github.com/planetmint/planetmint-hs>`_
|
||||
* `Go driver <https://github.com/zbo14/envoke/blob/master/bigchain/bigchain.go>`_
|
||||
* `Ruby driver <https://github.com/LicenseRocks/bigchaindb_ruby>`_
|
||||
* `Ruby library for preparing/signing transactions and submitting them or querying a Planetmint node (MIT licensed) <https://rubygems.org/gems/bigchaindb>`_
|
||||
* `Ruby driver <https://github.com/LicenseRocks/planetmint_ruby>`_
|
||||
* `Ruby library for preparing/signing transactions and submitting them or querying a Planetmint node (MIT licensed) <https://rubygems.org/gems/planetmint>`_
|
||||
|
||||
@ -21,7 +21,7 @@ More About Planetmint
|
||||
:maxdepth: 1
|
||||
|
||||
Planetmint Docs Home <self>
|
||||
about-bigchaindb
|
||||
about-planetmint
|
||||
terminology
|
||||
properties
|
||||
basic-usage
|
||||
|
||||
@ -18,7 +18,7 @@ If you set up a Planetmint node or reverse proxy yourself,
|
||||
and you're not sure what the API Root URL is,
|
||||
then see the last section of this page for help.
|
||||
|
||||
.. _bigchaindb-root-url:
|
||||
.. _planetmint-root-url:
|
||||
|
||||
Planetmint Root URL
|
||||
-------------------
|
||||
@ -59,7 +59,7 @@ Transactions Endpoint
|
||||
then one option is to connect to MongoDB directly (if possible)
|
||||
and do whatever queries MongoDB allows.
|
||||
For more about that option, see
|
||||
`the page about querying Planetmint <https://docs.bigchaindb.com/en/latest/query.html>`_.
|
||||
`the page about querying Planetmint <https://docs.planetmint.com/en/latest/query.html>`_.
|
||||
|
||||
.. http:get:: /api/v1/transactions/{transaction_id}
|
||||
|
||||
@ -172,11 +172,11 @@ Transactions Endpoint
|
||||
|
||||
The posted transaction should be valid.
|
||||
The relevant
|
||||
`Planetmint Transactions Spec <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
|
||||
`Planetmint Transactions Spec <https://github.com/planetmint/BEPs/tree/master/tx-specs/>`_
|
||||
explains how to build a valid transaction
|
||||
and how to check if a transaction is valid.
|
||||
One would normally use a driver such as the `Planetmint Python Driver
|
||||
<https://docs.bigchaindb.com/projects/py-driver/en/latest/index.html>`_
|
||||
<https://docs.planetmint.com/projects/py-driver/en/latest/index.html>`_
|
||||
to build a valid transaction.
|
||||
|
||||
.. note::
|
||||
@ -223,7 +223,7 @@ unspent outputs.
|
||||
then one option is to connect to MongoDB directly (if possible)
|
||||
and do whatever queries MongoDB allows.
|
||||
For more about that option, see
|
||||
`the page about querying Planetmint <https://docs.bigchaindb.com/en/latest/query.html>`_.
|
||||
`the page about querying Planetmint <https://docs.planetmint.com/en/latest/query.html>`_.
|
||||
|
||||
.. http:get:: /api/v1/outputs
|
||||
|
||||
@ -341,7 +341,7 @@ Assets
|
||||
then one option is to connect to MongoDB directly (if possible)
|
||||
and do whatever queries MongoDB allows.
|
||||
For more about that option, see
|
||||
`the page about querying Planetmint <https://docs.bigchaindb.com/en/latest/query.html>`_.
|
||||
`the page about querying Planetmint <https://docs.planetmint.com/en/latest/query.html>`_.
|
||||
|
||||
.. http:get:: /api/v1/assets
|
||||
|
||||
@ -377,7 +377,7 @@ Assets
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /api/v1/assets/?search=bigchaindb HTTP/1.1
|
||||
GET /api/v1/assets/?search=planetmint HTTP/1.1
|
||||
Host: example.com
|
||||
|
||||
**Example response**:
|
||||
@ -426,7 +426,7 @@ Assets
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /api/v1/assets?search=bigchaindb&limit=2 HTTP/1.1
|
||||
GET /api/v1/assets?search=planetmint&limit=2 HTTP/1.1
|
||||
Host: example.com
|
||||
|
||||
**Example response**:
|
||||
@ -465,7 +465,7 @@ Transaction Metadata
|
||||
then one option is to connect to MongoDB directly (if possible)
|
||||
and do whatever queries MongoDB allows.
|
||||
For more about that option, see
|
||||
`the page about querying Planetmint <https://docs.bigchaindb.com/en/latest/query.html>`_.
|
||||
`the page about querying Planetmint <https://docs.planetmint.com/en/latest/query.html>`_.
|
||||
|
||||
.. http:get:: /api/v1/metadata
|
||||
|
||||
@ -501,7 +501,7 @@ Transaction Metadata
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /api/v1/metadata/?search=bigchaindb HTTP/1.1
|
||||
GET /api/v1/metadata/?search=planetmint HTTP/1.1
|
||||
Host: example.com
|
||||
|
||||
**Example response**:
|
||||
@ -550,7 +550,7 @@ Transaction Metadata
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /api/v1/metadata?search=bigchaindb&limit=2 HTTP/1.1
|
||||
GET /api/v1/metadata?search=planetmint&limit=2 HTTP/1.1
|
||||
Host: example.com
|
||||
|
||||
**Example response**:
|
||||
@ -703,7 +703,7 @@ Blocks
|
||||
Determining the API Root URL
|
||||
----------------------------
|
||||
|
||||
When you start Planetmint Server using ``bigchaindb start``,
|
||||
When you start Planetmint Server using ``planetmint start``,
|
||||
an HTTP API is exposed at some address. The default is:
|
||||
|
||||
``http://localhost:9984/api/v1/``
|
||||
|
||||
@ -4,7 +4,7 @@ Content-Type: application/json
|
||||
{
|
||||
"assets": "/assets/",
|
||||
"blocks": "/blocks/",
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html",
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html",
|
||||
"metadata": "/metadata/",
|
||||
"outputs": "/outputs/",
|
||||
"streams": "ws://localhost:9985/api/v1/streams/valid_transactions",
|
||||
|
||||
@ -6,7 +6,7 @@ Content-Type: application/json
|
||||
"v1": {
|
||||
"assets": "/api/v1/assets/",
|
||||
"blocks": "/api/v1/blocks/",
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/http-client-server-api.html",
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/http-client-server-api.html",
|
||||
"metadata": "/api/v1/metadata/",
|
||||
"outputs": "/api/v1/outputs/",
|
||||
"streams": "ws://localhost:9985/api/v1/streams/valid_transactions",
|
||||
@ -14,7 +14,7 @@ Content-Type: application/json
|
||||
"validators": "/api/v1/validators"
|
||||
}
|
||||
},
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.9.0/",
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.9.0/",
|
||||
"software": "Planetmint",
|
||||
"version": "0.9.0"
|
||||
}
|
||||
|
||||
@ -82,7 +82,7 @@ All messages sent in a stream are in the JSON format.
|
||||
as a specific ``output``'s ``public_key``.
|
||||
|
||||
If you have specific use cases that you think would fit as part of this
|
||||
API, consider creating a new `BEP <https://github.com/bigchaindb/BEPs>`_.
|
||||
API, consider creating a new `BEP <https://github.com/planetmint/BEPs>`_.
|
||||
|
||||
Valid Transactions
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@ -9,6 +9,6 @@ Cryptography
|
||||
|
||||
Use the following link to find the Planetmint Transactions Spec (or Specs) that are relevant to you:
|
||||
|
||||
`Planetmint Transactions Specs <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
|
||||
`Planetmint Transactions Specs <https://github.com/planetmint/BEPs/tree/master/tx-specs/>`_
|
||||
|
||||
Then see the sections titled **Cryptographic Hashes** and **Cryptographic Keys and Signatures**.
|
||||
@ -7,4 +7,4 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
# Licenses
|
||||
|
||||
Information about how the Planetmint Server code and documentation are licensed can be found in [the LICENSES.md file](https://github.com/bigchaindb/bigchaindb/blob/master/LICENSES.md) of the bigchaindb/bigchaindb repository on GitHub.
|
||||
Information about how the Planetmint Server code and documentation are licensed can be found in [the LICENSES.md file](https://github.com/planetmint/planetmint/blob/master/LICENSES.md) of the planetmint/planetmint repository on GitHub.
|
||||
|
||||
@ -27,8 +27,8 @@ and [log rotation](https://docs.mongodb.com/v3.6/tutorial/rotate-log-files/).
|
||||
|
||||
Planetmint Server writes its logs to two files: normal logs and error logs. The names of those files, and their locations, are set as part of the Planetmint configuration settings. The default names and locations are:
|
||||
|
||||
- `~/bigchaindb.log`
|
||||
- `~/bigchaindb-errors.log`
|
||||
- `~/planetmint.log`
|
||||
- `~/planetmint-errors.log`
|
||||
|
||||
Log rotation is baked into Planetmint Server using Python's `logging` module. The logs for Planetmint Server are rotated when any of the above mentioned files exceeds 209715200 bytes (i.e. approximately 209 MB).
|
||||
|
||||
@ -43,7 +43,7 @@ Tendermint writes its logs to the files:
|
||||
|
||||
If you started Planetmint Server and Tendermint using Monit, as suggested by our guide on
|
||||
[How to Set Up a Planetmint Network](../network-setup/network-setup),
|
||||
then the logs will be written to `$HOME/.bigchaindb-monit/logs/`.
|
||||
then the logs will be written to `$HOME/.planetmint-monit/logs/`.
|
||||
|
||||
Moreover, if you started Planetmint Server and Tendermint using Monit,
|
||||
then Monit monitors the Tendermint log files.
|
||||
|
||||
@ -8,46 +8,46 @@
|
||||
Database Backend Interfaces
|
||||
###########################
|
||||
|
||||
.. automodule:: bigchaindb.backend
|
||||
.. automodule:: planetmint.backend
|
||||
:special-members: __init__
|
||||
|
||||
|
||||
Generic Interfaces
|
||||
==================
|
||||
|
||||
:mod:`bigchaindb.backend.connection`
|
||||
:mod:`planetmint.backend.connection`
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: bigchaindb.backend.connection
|
||||
.. automodule:: planetmint.backend.connection
|
||||
:special-members: __init__
|
||||
|
||||
:mod:`bigchaindb.backend.query`
|
||||
:mod:`planetmint.backend.query`
|
||||
-------------------------------
|
||||
.. automodule:: bigchaindb.backend.query
|
||||
.. automodule:: planetmint.backend.query
|
||||
|
||||
:mod:`bigchaindb.backend.schema`
|
||||
:mod:`planetmint.backend.schema`
|
||||
--------------------------------
|
||||
.. automodule:: bigchaindb.backend.schema
|
||||
.. automodule:: planetmint.backend.schema
|
||||
|
||||
:mod:`bigchaindb.backend.utils`
|
||||
:mod:`planetmint.backend.utils`
|
||||
-------------------------------
|
||||
.. automodule:: bigchaindb.backend.utils
|
||||
.. automodule:: planetmint.backend.utils
|
||||
|
||||
|
||||
MongoDB Backend
|
||||
===============
|
||||
|
||||
.. automodule:: bigchaindb.backend.localmongodb
|
||||
.. automodule:: planetmint.backend.localmongodb
|
||||
:special-members: __init__
|
||||
|
||||
:mod:`bigchaindb.backend.localmongodb.connection`
|
||||
:mod:`planetmint.backend.localmongodb.connection`
|
||||
-------------------------------------------------
|
||||
.. automodule:: bigchaindb.backend.localmongodb.connection
|
||||
.. automodule:: planetmint.backend.localmongodb.connection
|
||||
|
||||
:mod:`bigchaindb.backend.localmongodb.query`
|
||||
:mod:`planetmint.backend.localmongodb.query`
|
||||
--------------------------------------------
|
||||
.. automodule:: bigchaindb.backend.localmongodb.query
|
||||
.. automodule:: planetmint.backend.localmongodb.query
|
||||
|
||||
:mod:`bigchaindb.backend.localmongodb.schema`
|
||||
:mod:`planetmint.backend.localmongodb.schema`
|
||||
---------------------------------------------
|
||||
.. automodule:: bigchaindb.backend.localmongodb.schema
|
||||
.. automodule:: planetmint.backend.localmongodb.schema
|
||||
|
||||
@ -8,17 +8,17 @@
|
||||
Command Line Interface
|
||||
######################
|
||||
|
||||
.. automodule:: bigchaindb.commands
|
||||
.. automodule:: planetmint.commands
|
||||
:special-members: __init__
|
||||
|
||||
|
||||
:mod:`bigchaindb.commands.bigchaindb`
|
||||
:mod:`planetmint.commands.planetmint`
|
||||
-------------------------------------
|
||||
|
||||
.. automodule:: bigchaindb.commands.bigchaindb
|
||||
.. automodule:: planetmint.commands.planetmint
|
||||
|
||||
|
||||
:mod:`bigchaindb.commands.utils`
|
||||
:mod:`planetmint.commands.utils`
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: bigchaindb.commands.utils
|
||||
.. automodule:: planetmint.commands.utils
|
||||
|
||||
@ -20,7 +20,7 @@ in the Planetmint Server code, based on Python docstrings in the code itself.
|
||||
:maxdepth: 1
|
||||
|
||||
commands
|
||||
the-bigchaindb-class
|
||||
the-planetmint-class
|
||||
backend
|
||||
|
||||
|
||||
@ -8,4 +8,4 @@
|
||||
The Planetmint Class
|
||||
####################
|
||||
|
||||
.. autoclass:: bigchaindb.Planetmint
|
||||
.. autoclass:: planetmint.Planetmint
|
||||
|
||||
@ -2,6 +2,6 @@
|
||||
|
||||
You can find one of the installation methods with Ansible on GitHub at:
|
||||
|
||||
[Ansible script](https://github.com/bigchaindb/bigchaindb-node-ansible)
|
||||
[Ansible script](https://github.com/planetmint/planetmint-node-ansible)
|
||||
|
||||
It allows to install Planetmint, MongoDB, Tendermint, and python, and then connect nodes into a network. Current tested machine is Ubuntu 18.04.
|
||||
@ -15,5 +15,5 @@ There are several ways to setup a network. You can use the Kubernetes deployment
|
||||
networks
|
||||
network-setup
|
||||
k8s-deployment-template/index
|
||||
bigchaindb-node-ansible.md
|
||||
planetmint-node-ansible.md
|
||||
|
||||
@ -32,7 +32,7 @@ as described in these docs, it will include:
|
||||
<https://docs.microsoft.com/en-us/azure/operations-management-suite/>`_.
|
||||
|
||||
|
||||
.. _bigchaindb-node:
|
||||
.. _planetmint-node:
|
||||
|
||||
Planetmint Node Diagram
|
||||
-----------------------
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
.. _kubernetes-template-deploy-bigchaindb-network:
|
||||
.. _kubernetes-template-deploy-planetmint-network:
|
||||
|
||||
Kubernetes Template: Deploying a Planetmint network
|
||||
===================================================
|
||||
@ -44,9 +44,9 @@ to form a network.
|
||||
|
||||
|
||||
Below, we refer to multiple files by their directory and filename,
|
||||
such as ``bigchaindb/bigchaindb-ext-conn-svc.yaml``. Those files are located in the
|
||||
`bigchaindb/bigchaindb repository on GitHub
|
||||
<https://github.com/bigchaindb/bigchaindb/>`_ in the ``k8s/`` directory.
|
||||
such as ``planetmint/planetmint-ext-conn-svc.yaml``. Those files are located in the
|
||||
`planetmint/planetmint repository on GitHub
|
||||
<https://github.com/planetmint/planetmint/>`_ in the ``k8s/`` directory.
|
||||
Make sure you're getting those files from the appropriate Git branch on
|
||||
GitHub, i.e. the branch for the version of Planetmint that your Planetmint
|
||||
cluster is using.
|
||||
@ -62,7 +62,7 @@ cluster is using.
|
||||
Once a Planetmint network is started with a certain number of validators
|
||||
and a genesis file. Users cannot add new validator nodes dynamically.
|
||||
You can track the progress of this funtionality on our
|
||||
`github repository <https://github.com/bigchaindb/bigchaindb/milestones>`_.
|
||||
`github repository <https://github.com/planetmint/planetmint/milestones>`_.
|
||||
|
||||
|
||||
.. _pre-reqs-bdb-network:
|
||||
@ -229,7 +229,7 @@ the :doc:`deployment steps for each node <node-on-kubernetes>` N number of times
|
||||
the number of participants in the network.
|
||||
|
||||
In our Kubernetes deployment template for a single Planetmint node, we covered the basic configurations
|
||||
settings :ref:`here <how-to-configure-a-bigchaindb-node>`.
|
||||
settings :ref:`here <how-to-configure-a-planetmint-node>`.
|
||||
|
||||
Since, we index the ConfigMap and Secret Keys for the single site deployment, we need to update
|
||||
all the Kubernetes components to reflect the corresponding changes i.e. For each Kubernetes Service,
|
||||
@ -267,7 +267,7 @@ the ``mongo-node-1-ss.yaml`` and update the corresponding ConfigMapKeyRef.name o
|
||||
terminationGracePeriodSeconds: 10
|
||||
containers:
|
||||
- name: mongodb
|
||||
image: bigchaindb/mongodb:3.2
|
||||
image: planetmint/mongodb:3.2
|
||||
imagePullPolicy: IfNotPresent
|
||||
env:
|
||||
- name: MONGODB_FQDN
|
||||
@ -366,13 +366,13 @@ The above example is meant to be repeated for all the Kubernetes components of a
|
||||
|
||||
* ``mongodb/mongodb-node-X-ss.yaml``
|
||||
|
||||
* ``bigchaindb/bigchaindb-node-X-svc.yaml``
|
||||
* ``planetmint/planetmint-node-X-svc.yaml``
|
||||
|
||||
* ``bigchaindb/bigchaindb-node-X-sc.yaml``
|
||||
* ``planetmint/planetmint-node-X-sc.yaml``
|
||||
|
||||
* ``bigchaindb/bigchaindb-node-X-pvc.yaml``
|
||||
* ``planetmint/planetmint-node-X-pvc.yaml``
|
||||
|
||||
* ``bigchaindb/bigchaindb-node-X-ss.yaml``
|
||||
* ``planetmint/planetmint-node-X-ss.yaml``
|
||||
|
||||
* ``nginx-openresty/nginx-openresty-node-X-svc.yaml``
|
||||
|
||||
@ -408,7 +408,7 @@ described :ref:`above <pre-reqs-bdb-network>`:
|
||||
|
||||
* :ref:`Start the MongoDB Kubernetes Service <start-the-mongodb-kubernetes-service>`.
|
||||
|
||||
* :ref:`Start the Planetmint Kubernetes Service <start-the-bigchaindb-kubernetes-service>`.
|
||||
* :ref:`Start the Planetmint Kubernetes Service <start-the-planetmint-kubernetes-service>`.
|
||||
|
||||
* :ref:`Start the OpenResty Kubernetes Service <start-the-openresty-kubernetes-service>`.
|
||||
|
||||
@ -421,22 +421,22 @@ to talk to each other i.e. specifically the communication between the
|
||||
Planetmint peers. Set up networking between the clusters using
|
||||
`Kubernetes Services <https://kubernetes.io/docs/concepts/services-networking/service/>`_.
|
||||
|
||||
Assuming we have a Planetmint instance ``bigchaindb-instance-1`` residing in Azure data center location ``westeurope`` and we
|
||||
want to connect to ``bigchaindb-instance-2``, ``bigchaindb-instance-3``, and ``bigchaindb-instance-4`` located in Azure data centers
|
||||
Assuming we have a Planetmint instance ``planetmint-instance-1`` residing in Azure data center location ``westeurope`` and we
|
||||
want to connect to ``planetmint-instance-2``, ``planetmint-instance-3``, and ``planetmint-instance-4`` located in Azure data centers
|
||||
``eastus``, ``centralus`` and ``westus``, respectively. Unless you already have explicitly set up networking for
|
||||
``bigchaindb-instance-1`` to communicate with ``bigchaindb-instance-2/3/4`` and
|
||||
``planetmint-instance-1`` to communicate with ``planetmint-instance-2/3/4`` and
|
||||
vice versa, we will have to add a Kubernetes Service in each cluster to accomplish this goal in order to set up a
|
||||
Planetmint P2P network.
|
||||
It is similar to ensuring that there is a ``CNAME`` record in the DNS
|
||||
infrastructure to resolve ``bigchaindb-instance-X`` to the host where it is actually available.
|
||||
infrastructure to resolve ``planetmint-instance-X`` to the host where it is actually available.
|
||||
We can do this in Kubernetes using a Kubernetes Service of ``type``
|
||||
``ExternalName``.
|
||||
|
||||
* This configuration is located in the file ``bigchaindb/bigchaindb-ext-conn-svc.yaml``.
|
||||
* This configuration is located in the file ``planetmint/planetmint-ext-conn-svc.yaml``.
|
||||
|
||||
* Set the name of the ``metadata.name`` to the host name of the Planetmint instance you are trying to connect to.
|
||||
For instance if you are configuring this service on cluster with ``bigchaindb-instance-1`` then the ``metadata.name`` will
|
||||
be ``bigchaindb-instance-2`` and vice versa.
|
||||
For instance if you are configuring this service on cluster with ``planetmint-instance-1`` then the ``metadata.name`` will
|
||||
be ``planetmint-instance-2`` and vice versa.
|
||||
|
||||
* Set ``spec.ports.port[0]`` to the ``tm-p2p-port`` from the ConfigMap for the other cluster.
|
||||
|
||||
@ -452,7 +452,7 @@ We can do this in Kubernetes using a Kubernetes Service of ``type``
|
||||
|
||||
If you are not the system administrator of the cluster, you have to get in
|
||||
touch with the system administrator/s of the other ``n-1`` clusters and
|
||||
share with them your instance name (``bigchaindb-instance-name`` in the ConfigMap)
|
||||
share with them your instance name (``planetmint-instance-name`` in the ConfigMap)
|
||||
and the FQDN of the NGINX instance acting as Gateway(set in: :ref:`Assign DNS name to NGINX
|
||||
Public IP <assign-dns-name-to-nginx-public-ip>`).
|
||||
|
||||
|
||||
@ -42,7 +42,7 @@ Feel free change things to suit your needs or preferences.
|
||||
cloud-manager
|
||||
easy-rsa
|
||||
upgrade-on-kubernetes
|
||||
bigchaindb-network-on-kubernetes
|
||||
planetmint-network-on-kubernetes
|
||||
tectonic-azure
|
||||
troubleshoot
|
||||
architecture
|
||||
|
||||
@ -256,9 +256,9 @@ All logging messages containing the string "critical" but not "CriticalAddonsOnl
|
||||
|
||||
``Type=ContainerLog critical NOT(CriticalAddonsOnly)``
|
||||
|
||||
All logging messages from containers running the Docker image bigchaindb/nginx_3scale:1.3, containing the string "GET" but not the strings "Go-http-client" or "runscope" (where those exclusions filter out tests by Kubernetes and Runscope):
|
||||
All logging messages from containers running the Docker image planetmint/nginx_3scale:1.3, containing the string "GET" but not the strings "Go-http-client" or "runscope" (where those exclusions filter out tests by Kubernetes and Runscope):
|
||||
|
||||
``Type=ContainerLog Image="bigchaindb/nginx_3scale:1.3" GET NOT("Go-http-client") NOT(runscope)``
|
||||
``Type=ContainerLog Image="planetmint/nginx_3scale:1.3" GET NOT("Go-http-client") NOT(runscope)``
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
.. _how-to-configure-a-bigchaindb-node:
|
||||
.. _how-to-configure-a-planetmint-node:
|
||||
|
||||
How to Configure a Planetmint Node
|
||||
==================================
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
|
||||
Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
.. _kubernetes-template-deploy-a-single-bigchaindb-node:
|
||||
.. _kubernetes-template-deploy-a-single-planetmint-node:
|
||||
|
||||
Kubernetes Template: Deploy a Single Planetmint Node
|
||||
====================================================
|
||||
@ -26,7 +26,7 @@ It assumes you already have a running Kubernetes cluster.
|
||||
|
||||
Below, we refer to many files by their directory and filename,
|
||||
such as ``configuration/config-map.yaml``. Those files are files in the
|
||||
`bigchaindb/bigchaindb repository on GitHub <https://github.com/bigchaindb/bigchaindb/>`_
|
||||
`planetmint/planetmint repository on GitHub <https://github.com/planetmint/planetmint/>`_
|
||||
in the ``k8s/`` directory.
|
||||
Make sure you're getting those files from the appropriate Git branch on
|
||||
GitHub, i.e. the branch for the version of Planetmint that your Planetmint
|
||||
@ -132,7 +132,7 @@ That means you can visit the dashboard in your web browser at
|
||||
Step 3: Configure Your Planetmint Node
|
||||
--------------------------------------
|
||||
|
||||
See the page titled :ref:`how-to-configure-a-bigchaindb-node`.
|
||||
See the page titled :ref:`how-to-configure-a-planetmint-node`.
|
||||
|
||||
|
||||
.. _start-the-nginx-service:
|
||||
@ -166,7 +166,7 @@ Step 5: Assign DNS Name to the NGINX Public IP
|
||||
|
||||
* This step is required only if you are planning to set up multiple
|
||||
`Planetmint nodes
|
||||
<https://docs.bigchaindb.com/en/latest/terminology.html>`_ or are using
|
||||
<https://docs.planetmint.com/en/latest/terminology.html>`_ or are using
|
||||
HTTPS certificates tied to a domain.
|
||||
|
||||
* The following command can help you find out if the NGINX service started
|
||||
@ -214,7 +214,7 @@ Step 6: Start the MongoDB Kubernetes Service
|
||||
$ kubectl apply -f mongodb/mongo-svc.yaml
|
||||
|
||||
|
||||
.. _start-the-bigchaindb-kubernetes-service:
|
||||
.. _start-the-planetmint-kubernetes-service:
|
||||
|
||||
Step 7: Start the Planetmint Kubernetes Service
|
||||
-----------------------------------------------
|
||||
@ -223,7 +223,7 @@ Step 7: Start the Planetmint Kubernetes Service
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ kubectl apply -f bigchaindb/bigchaindb-svc.yaml
|
||||
$ kubectl apply -f planetmint/planetmint-svc.yaml
|
||||
|
||||
|
||||
.. _start-the-openresty-kubernetes-service:
|
||||
@ -437,7 +437,7 @@ Planetmint needs somewhere to store Tendermint data persistently, Tendermint use
|
||||
LevelDB as the persistent storage layer.
|
||||
|
||||
The Kubernetes template for configuration of Storage Class is located in the
|
||||
file ``bigchaindb/bigchaindb-sc.yaml``.
|
||||
file ``planetmint/planetmint-sc.yaml``.
|
||||
|
||||
Details about how to create a Azure Storage account and how Kubernetes Storage Class works
|
||||
are already covered in this document: :ref:`create-kubernetes-storage-class-mdb`.
|
||||
@ -446,7 +446,7 @@ Create the required storage classes using:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ kubectl apply -f bigchaindb/bigchaindb-sc.yaml
|
||||
$ kubectl apply -f planetmint/planetmint-sc.yaml
|
||||
|
||||
|
||||
You can check if it worked using ``kubectl get storageclasses``.
|
||||
@ -459,7 +459,7 @@ Step 15: Create Kubernetes Persistent Volume Claims for Planetmint
|
||||
Next, you will create two PersistentVolumeClaim objects ``tendermint-db-claim`` and
|
||||
``tendermint-config-db-claim``.
|
||||
|
||||
This configuration is located in the file ``bigchaindb/bigchaindb-pvc.yaml``.
|
||||
This configuration is located in the file ``planetmint/planetmint-pvc.yaml``.
|
||||
|
||||
Details about Kubernetes Persistent Volumes, Persistent Volume Claims
|
||||
and how they work with Azure are already covered in this
|
||||
@ -469,7 +469,7 @@ Create the required Persistent Volume Claims using:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ kubectl apply -f bigchaindb/bigchaindb-pvc.yaml
|
||||
$ kubectl apply -f planetmint/planetmint-pvc.yaml
|
||||
|
||||
You can check its status using:
|
||||
|
||||
@ -483,7 +483,7 @@ You can check its status using:
|
||||
Step 16: Start a Kubernetes StatefulSet for Planetmint
|
||||
------------------------------------------------------
|
||||
|
||||
* This configuration is located in the file ``bigchaindb/bigchaindb-ss.yaml``.
|
||||
* This configuration is located in the file ``planetmint/planetmint-ss.yaml``.
|
||||
|
||||
* Set the ``spec.serviceName`` to the value set in ``bdb-instance-name`` in
|
||||
the ConfigMap.
|
||||
@ -505,7 +505,7 @@ Step 16: Start a Kubernetes StatefulSet for Planetmint
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ kubectl apply -f bigchaindb/bigchaindb-ss.yaml
|
||||
$ kubectl apply -f planetmint/planetmint-ss.yaml
|
||||
|
||||
.. code:: bash
|
||||
|
||||
@ -570,7 +570,7 @@ Step 18(Optional): Start a Kubernetes Deployment for OpenResty
|
||||
- ``node-dns-server-ip``
|
||||
- ``openresty-backend-port``
|
||||
- ``ngx-bdb-instance-name``
|
||||
- ``bigchaindb-api-port``
|
||||
- ``planetmint-api-port``
|
||||
|
||||
* Create the OpenResty Deployment using:
|
||||
|
||||
@ -610,7 +610,7 @@ infrastructure to resolve ``bdb-instance-X`` to the host where it is actually av
|
||||
We can do this in Kubernetes using a Kubernetes Service of ``type``
|
||||
``ExternalName``.
|
||||
|
||||
* This configuration is located in the file ``bigchaindb/bigchaindb-ext-conn-svc.yaml``.
|
||||
* This configuration is located in the file ``planetmint/planetmint-ext-conn-svc.yaml``.
|
||||
|
||||
* Set the name of the ``metadata.name`` to the host name of the Planetmint instance you are trying to connect to.
|
||||
For instance if you are configuring this service on cluster with ``bdb-instance-1`` then the ``metadata.name`` will
|
||||
@ -646,17 +646,17 @@ Step 21.1: Testing Internally
|
||||
To test the setup of your Planetmint node, you could use a Docker container
|
||||
that provides utilities like ``nslookup``, ``curl`` and ``dig``.
|
||||
For example, you could use a container based on our
|
||||
`bigchaindb/toolbox <https://hub.docker.com/r/bigchaindb/toolbox/>`_ image.
|
||||
`planetmint/toolbox <https://hub.docker.com/r/planetmint/toolbox/>`_ image.
|
||||
(The corresponding
|
||||
`Dockerfile <https://github.com/bigchaindb/bigchaindb/blob/master/k8s/toolbox/Dockerfile>`_
|
||||
is in the ``bigchaindb/bigchaindb`` repository on GitHub.)
|
||||
`Dockerfile <https://github.com/planetmint/planetmint/blob/master/k8s/toolbox/Dockerfile>`_
|
||||
is in the ``planetmint/planetmint`` repository on GitHub.)
|
||||
You can use it as below to get started immediately:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
$ kubectl \
|
||||
run -it toolbox \
|
||||
--image bigchaindb/toolbox \
|
||||
--image planetmint/toolbox \
|
||||
--image-pull-policy=Always \
|
||||
--restart=Never --rm
|
||||
|
||||
|
||||
@ -31,7 +31,7 @@ container and looking at the syslog (the ``journalctl`` command should usually
|
||||
work).
|
||||
|
||||
This issue is resolved in
|
||||
`PR #1757 <https://github.com/bigchaindb/bigchaindb/pull/1757>`_.
|
||||
`PR #1757 <https://github.com/planetmint/planetmint/pull/1757>`_.
|
||||
|
||||
2. 502 Bad Gateway Error on Runscope Tests
|
||||
------------------------------------------
|
||||
|
||||
@ -145,7 +145,7 @@ then you will run a script which reads that file to generate some Kubernetes con
|
||||
you will send those config files to your Kubernetes cluster,
|
||||
and then you will deploy all the stuff that you need to have a Planetmint node.
|
||||
|
||||
⟶ Proceed to :ref:`deploy your Planetmint node <kubernetes-template-deploy-a-single-bigchaindb-node>`.
|
||||
⟶ Proceed to :ref:`deploy your Planetmint node <kubernetes-template-deploy-a-single-planetmint-node>`.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@ -173,10 +173,10 @@ Install Monit:
|
||||
sudo apt install monit
|
||||
```
|
||||
|
||||
If you installed the `bigchaindb` Python package as above, you should have the `bigchaindb-monit-config` script in your `PATH` now. Run the script to build a configuration file for Monit:
|
||||
If you installed the `planetmint` Python package as above, you should have the `planetmint-monit-config` script in your `PATH` now. Run the script to build a configuration file for Monit:
|
||||
|
||||
```
|
||||
bigchaindb-monit-config
|
||||
planetmint-monit-config
|
||||
```
|
||||
|
||||
Run Monit as a daemon, instructing it to wake up every second to check on processes:
|
||||
@ -185,23 +185,23 @@ Run Monit as a daemon, instructing it to wake up every second to check on proces
|
||||
monit -d 1
|
||||
```
|
||||
|
||||
Monit will run the Planetmint and Tendermint processes and restart them when they crash. If the root `bigchaindb_` process crashes, Monit will also restart the Tendermint process.
|
||||
Monit will run the Planetmint and Tendermint processes and restart them when they crash. If the root `planetmint_` process crashes, Monit will also restart the Tendermint process.
|
||||
|
||||
You can check the status by running `monit status` or `monit summary`.
|
||||
|
||||
By default, it will collect program logs into the `~/.bigchaindb-monit/logs` folder.
|
||||
By default, it will collect program logs into the `~/.planetmint-monit/logs` folder.
|
||||
|
||||
To learn more about Monit, use `monit -h` (help) or read [the Monit documentation][monit-manual].
|
||||
|
||||
Check `bigchaindb-monit-config -h` if you want to arrange a different folder for logs or some of the Monit internal artifacts.
|
||||
Check `planetmint-monit-config -h` if you want to arrange a different folder for logs or some of the Monit internal artifacts.
|
||||
|
||||
If you want to start and manage the Planetmint and Tendermint processes yourself, then look inside the file [bigchaindb/pkg/scripts/bigchaindb-monit-config](https://github.com/bigchaindb/bigchaindb/blob/master/pkg/scripts/bigchaindb-monit-config) to see how *it* starts Planetmint and Tendermint.
|
||||
If you want to start and manage the Planetmint and Tendermint processes yourself, then look inside the file [planetmint/pkg/scripts/planetmint-monit-config](https://github.com/planetmint/planetmint/blob/master/pkg/scripts/planetmint-monit-config) to see how *it* starts Planetmint and Tendermint.
|
||||
|
||||
## How Others Can Access Your Node
|
||||
|
||||
If you followed the above instructions, then your node should be publicly-accessible with Planetmint Root URL `https://hostname` or `http://hostname:9984`. That is, anyone can interact with your node using the [Planetmint HTTP API](../api/http-client-server-api) exposed at that address. The most common way to do that is to use one of the [Planetmint Drivers](../../drivers/index).
|
||||
|
||||
[bdb:software]: https://github.com/bigchaindb/bigchaindb/
|
||||
[bdb:software]: https://github.com/planetmint/planetmint/
|
||||
[bdb:pypi]: https://pypi.org/project/Planetmint/#history
|
||||
[tendermint:releases]: https://github.com/tendermint/tendermint/releases
|
||||
[monit]: https://www.mmonit.com/monit
|
||||
|
||||
@ -7,7 +7,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
# Planetmint Networks
|
||||
|
||||
A **Planetmint network** is a set of connected **Planetmint nodes**, managed by a **Planetmint consortium** (i.e. an organization). Those terms are defined in the [Planetmint Terminology page](https://docs.bigchaindb.com/en/latest/terminology.html).
|
||||
A **Planetmint network** is a set of connected **Planetmint nodes**, managed by a **Planetmint consortium** (i.e. an organization). Those terms are defined in the [Planetmint Terminology page](https://docs.planetmint.com/en/latest/terminology.html).
|
||||
|
||||
## Consortium Structure & Governance
|
||||
|
||||
@ -17,7 +17,7 @@ A governance process is required to make those decisions, and therefore one of t
|
||||
This documentation doesn't explain how to create a consortium, nor does it outline the possible governance processes.
|
||||
|
||||
It's worth noting that the decentralization of a Planetmint network depends,
|
||||
to some extent, on the decentralization of the associated consortium. See the pages about [decentralization](https://docs.bigchaindb.com/en/latest/decentralized.html) and [node diversity](https://docs.bigchaindb.com/en/latest/diversity.html).
|
||||
to some extent, on the decentralization of the associated consortium. See the pages about [decentralization](https://docs.planetmint.com/en/latest/decentralized.html) and [node diversity](https://docs.planetmint.com/en/latest/diversity.html).
|
||||
|
||||
## DNS Records and SSL Certificates
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
For those who like using Docker and wish to experiment with Planetmint in
|
||||
non-production environments, we currently maintain a Planetmint all-in-one
|
||||
Docker image and a
|
||||
`Dockerfile-all-in-one` that can be used to build an image for `bigchaindb`.
|
||||
`Dockerfile-all-in-one` that can be used to build an image for `planetmint`.
|
||||
|
||||
This image contains all the services required for a Planetmint node i.e.
|
||||
|
||||
@ -21,8 +21,8 @@ This image contains all the services required for a Planetmint node i.e.
|
||||
**Note:** **NOT for Production Use:** *This is an single node opinionated image not well suited for a network deployment.*
|
||||
*This image is to help quick deployment for early adopters, for a more standard approach please refer to one of our deployment guides:*
|
||||
|
||||
- [Planetmint developer setup guides](https://docs.bigchaindb.com/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/index.html).
|
||||
- [Planetmint with Kubernetes](http://docs.bigchaindb.com/projects/server/en/latest/k8s-deployment-template/index.html).
|
||||
- [Planetmint developer setup guides](https://docs.planetmint.com/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/index.html).
|
||||
- [Planetmint with Kubernetes](http://docs.planetmint.com/projects/server/en/latest/k8s-deployment-template/index.html).
|
||||
|
||||
## Prerequisite(s)
|
||||
- [Docker](https://docs.docker.com/engine/installation/)
|
||||
@ -33,19 +33,19 @@ With Docker installed, you can proceed as follows.
|
||||
|
||||
In a terminal shell, pull the latest version of the Planetmint all-in-one Docker image using:
|
||||
```text
|
||||
$ docker pull bigchaindb/bigchaindb:all-in-one
|
||||
$ docker pull planetmint/planetmint:all-in-one
|
||||
|
||||
$ docker run \
|
||||
--detach \
|
||||
--name bigchaindb \
|
||||
--name planetmint \
|
||||
--publish 9984:9984 \
|
||||
--publish 9985:9985 \
|
||||
--publish 27017:27017 \
|
||||
--publish 26657:26657 \
|
||||
--volume $HOME/bigchaindb_docker/mongodb/data/db:/data/db \
|
||||
--volume $HOME/bigchaindb_docker/mongodb/data/configdb:/data/configdb \
|
||||
--volume $HOME/bigchaindb_docker/tendermint:/tendermint \
|
||||
bigchaindb/bigchaindb:all-in-one
|
||||
--volume $HOME/planetmint_docker/mongodb/data/db:/data/db \
|
||||
--volume $HOME/planetmint_docker/mongodb/data/configdb:/data/configdb \
|
||||
--volume $HOME/planetmint_docker/tendermint:/tendermint \
|
||||
planetmint/planetmint:all-in-one
|
||||
```
|
||||
|
||||
Let's analyze that command:
|
||||
@ -57,18 +57,18 @@ Let's analyze that command:
|
||||
* `9985` Planetmint Websocket server
|
||||
* `27017` Default port for MongoDB
|
||||
* `26657` Tendermint RPC server
|
||||
* `--volume "$HOME/bigchaindb_docker/mongodb:/data"` map the host directory
|
||||
`$HOME/bigchaindb_docker/mongodb` to the container directory `/data`;
|
||||
* `--volume "$HOME/planetmint_docker/mongodb:/data"` map the host directory
|
||||
`$HOME/planetmint_docker/mongodb` to the container directory `/data`;
|
||||
this allows us to have the data persisted on the host machine,
|
||||
you can read more in the [official Docker
|
||||
documentation](https://docs.docker.com/engine/tutorials/dockervolumes)
|
||||
* `$HOME/bigchaindb_docker/tendermint:/tendermint` to persist Tendermint data.
|
||||
* `bigchaindb/bigchaindb:all-in-one` the image to use. All the options after the container name are passed on to the entrypoint inside the container.
|
||||
* `$HOME/planetmint_docker/tendermint:/tendermint` to persist Tendermint data.
|
||||
* `planetmint/planetmint:all-in-one` the image to use. All the options after the container name are passed on to the entrypoint inside the container.
|
||||
|
||||
## Verify
|
||||
|
||||
```text
|
||||
$ docker ps | grep bigchaindb
|
||||
$ docker ps | grep planetmint
|
||||
```
|
||||
|
||||
Send your first transaction using [Planetmint drivers](../../drivers/index).
|
||||
@ -80,8 +80,8 @@ Assuming you have Docker installed, you would proceed as follows.
|
||||
|
||||
In a terminal shell:
|
||||
```text
|
||||
git clone git@github.com:bigchaindb/bigchaindb.git
|
||||
cd bigchaindb/
|
||||
git clone git@github.com:planetmint/planetmint.git
|
||||
cd planetmint/
|
||||
```
|
||||
|
||||
Build the Docker image:
|
||||
|
||||
@ -7,20 +7,20 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
# Command Line Interface (CLI)
|
||||
|
||||
The command-line command to interact with Planetmint Server is `bigchaindb`.
|
||||
The command-line command to interact with Planetmint Server is `planetmint`.
|
||||
|
||||
|
||||
## bigchaindb \-\-help
|
||||
## planetmint \-\-help
|
||||
|
||||
Show help for the `bigchaindb` command. `bigchaindb -h` does the same thing.
|
||||
Show help for the `planetmint` command. `planetmint -h` does the same thing.
|
||||
|
||||
|
||||
## bigchaindb \-\-version
|
||||
## planetmint \-\-version
|
||||
|
||||
Show the version number. `bigchaindb -v` does the same thing.
|
||||
Show the version number. `planetmint -v` does the same thing.
|
||||
|
||||
|
||||
## bigchaindb configure
|
||||
## planetmint configure
|
||||
|
||||
Generate a local configuration file (which can be used to set some or all [Planetmint node configuration settings](configuration)). It will ask you for the values of some configuration settings.
|
||||
If you press Enter for a value, it will use the default value.
|
||||
@ -29,39 +29,39 @@ 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 localmongodb
|
||||
planetmint -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 Planetmint looks for a config file, if one isn't specified).
|
||||
If you don't use the `-c` command-line option, the file will be written to `$HOME/.planetmint` (the default location where Planetmint 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 configuration settings.
|
||||
```text
|
||||
bigchaindb -y configure localmongodb
|
||||
planetmint -y configure localmongodb
|
||||
```
|
||||
|
||||
|
||||
## bigchaindb show-config
|
||||
## planetmint show-config
|
||||
|
||||
Show the values of the [Planetmint node configuration settings](configuration).
|
||||
|
||||
|
||||
## bigchaindb init
|
||||
## planetmint init
|
||||
|
||||
Create a backend database (local MongoDB), all database tables/collections,
|
||||
various backend database indexes, and the genesis block.
|
||||
|
||||
|
||||
## bigchaindb drop
|
||||
## planetmint drop
|
||||
|
||||
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`
|
||||
If you want to force-drop the database (i.e. skipping the yes/no prompt), then use `planetmint -y drop`
|
||||
|
||||
|
||||
## bigchaindb start
|
||||
## planetmint start
|
||||
|
||||
Start Planetmint. 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`.
|
||||
Start Planetmint. It always begins by trying a `planetmint init` first. See the documentation for `planetmint init`.
|
||||
The database initialization step is optional and can be skipped by passing the `--no-init` flag, i.e. `planetmint start --no-init`.
|
||||
|
||||
### Options
|
||||
|
||||
@ -69,7 +69,7 @@ The log level for the console can be set via the option `--log-level` or its
|
||||
abbreviation `-l`. Example:
|
||||
|
||||
```bash
|
||||
$ bigchaindb --log-level INFO start
|
||||
$ planetmint --log-level INFO start
|
||||
```
|
||||
|
||||
The allowed levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`.
|
||||
@ -82,9 +82,9 @@ configuration file as documented under
|
||||
[Configuration Settings](configuration).
|
||||
|
||||
|
||||
## bigchaindb election
|
||||
## planetmint election
|
||||
|
||||
Manage elections to govern the Planetmint network. The specifics of the election process are defined in [BEP-18](https://github.com/bigchaindb/BEPs/tree/master/18).
|
||||
Manage elections to govern the Planetmint network. The specifics of the election process are defined in [BEP-18](https://github.com/planetmint/BEPs/tree/master/18).
|
||||
|
||||
Election management is broken into several subcommands. Below is the command line syntax for each of them.
|
||||
|
||||
@ -106,7 +106,7 @@ Create an election to add, update, or remove a validator.
|
||||
|
||||
|
||||
```bash
|
||||
$ bigchaindb election new upsert-validator <public-key> <power> <node-id> --private-key <path-to-the-private-key>
|
||||
$ planetmint election new upsert-validator <public-key> <power> <node-id> --private-key <path-to-the-private-key>
|
||||
```
|
||||
|
||||
- `<public-key>` is the public key of the node to be added/updated/removed. The encoding and type of the key have to match those specified in `genesis.json` in the supported Tendermint version.
|
||||
@ -117,7 +117,7 @@ $ bigchaindb election new upsert-validator <public-key> <power> <node-id> --priv
|
||||
Example:
|
||||
|
||||
```bash
|
||||
$ bigchaindb election new upsert-validator HHG0IQRybpT6nJMIWWFWhMczCLHt6xcm7eP52GnGuPY= 1 fb7140f03a4ffad899fabbbf655b97e0321add66 --private-key /home/user/.tendermint/config/priv_validator.json
|
||||
$ planetmint election new upsert-validator HHG0IQRybpT6nJMIWWFWhMczCLHt6xcm7eP52GnGuPY= 1 fb7140f03a4ffad899fabbbf655b97e0321add66 --private-key /home/user/.tendermint/config/priv_validator.json
|
||||
[SUCCESS] Submitted proposal with id: 04a067582cf03eba2b53b82e4adb5ece424474cbd4f7183780855a93ac5e3caa
|
||||
```
|
||||
|
||||
@ -126,7 +126,7 @@ Once `election_id` has been generated, the proposer should share it with other v
|
||||
|
||||
Note that election proposers do not automatically approve elections by proposing them.
|
||||
|
||||
For more details about how validator set changes work, refer to [BEP-21](https://github.com/bigchaindb/BEPs/tree/master/21).
|
||||
For more details about how validator set changes work, refer to [BEP-21](https://github.com/planetmint/BEPs/tree/master/21).
|
||||
|
||||
#### election new chain-migration
|
||||
|
||||
@ -134,7 +134,7 @@ Create an election to halt block production, to coordinate on making a Tendermin
|
||||
|
||||
|
||||
```bash
|
||||
$ bigchaindb election new chain-migration --private-key <path-to-the-private-key>
|
||||
$ planetmint election new chain-migration --private-key <path-to-the-private-key>
|
||||
```
|
||||
|
||||
- `<path-to-the-private-key>` is the path to the private key of the validator who proposes the election. Tendermint places it at `.tendermint/config/priv_validator.json`.
|
||||
@ -143,7 +143,7 @@ $ bigchaindb election new chain-migration --private-key <path-to-the-private-key
|
||||
Example:
|
||||
|
||||
```bash
|
||||
$ bigchaindb election new migration --private-key /home/user/.tendermint/config/priv_validator.json
|
||||
$ planetmint election new migration --private-key /home/user/.tendermint/config/priv_validator.json
|
||||
[SUCCESS] Submitted proposal with id: 04a067582cf03eba2b53b82e4adb5ece424474cbd4f7183780855a93ac5e3caa
|
||||
```
|
||||
|
||||
@ -151,7 +151,7 @@ Concluded chain migration elections halt block production at whichever block hei
|
||||
Afterwards, validators are supposed to upgrade Tendermint, set new `chain_id`, `app_hash`, and `validators` (to learn these values, use the [election show](#election-show) command) in `genesis.json`, make and save a MongoDB dump, and restart the system.
|
||||
|
||||
|
||||
For more details about how chain migrations work, refer to [Type 3 scenarios in BEP-42](https://github.com/bigchaindb/BEPs/tree/master/42).
|
||||
For more details about how chain migrations work, refer to [Type 3 scenarios in BEP-42](https://github.com/planetmint/BEPs/tree/master/42).
|
||||
|
||||
### election approve
|
||||
|
||||
@ -159,7 +159,7 @@ Approve an election by voting for it. The command places a `VOTE` transaction, s
|
||||
|
||||
|
||||
```bash
|
||||
$ bigchaindb election approve <election-id> --private-key <path-to-the-private-key>
|
||||
$ planetmint election approve <election-id> --private-key <path-to-the-private-key>
|
||||
```
|
||||
|
||||
- `election-id` is the election identifier the approval is given for.
|
||||
@ -167,7 +167,7 @@ $ bigchaindb election approve <election-id> --private-key <path-to-the-private-k
|
||||
|
||||
Example:
|
||||
```bash
|
||||
$ bigchaindb election approve 04a067582cf03eba2b53b82e4adb5ece424474cbd4f7183780855a93ac5e3caa --private-key /home/user/.tendermint/config/priv_validator.json
|
||||
$ planetmint election approve 04a067582cf03eba2b53b82e4adb5ece424474cbd4f7183780855a93ac5e3caa --private-key /home/user/.tendermint/config/priv_validator.json
|
||||
[SUCCESS] Your vote has been submitted
|
||||
```
|
||||
|
||||
@ -179,7 +179,7 @@ Retrieves the information about elections.
|
||||
|
||||
|
||||
```bash
|
||||
$ bigchaindb election show <election-id>
|
||||
$ planetmint election show <election-id>
|
||||
|
||||
status=<status>
|
||||
```
|
||||
@ -192,11 +192,11 @@ status=<status>
|
||||
|
||||
After a chain migration is concluded, the `show` command also outputs `chain_id`, `app_hash`, and `validators` for `genesis.json` of the new chain.
|
||||
|
||||
## bigchaindb tendermint-version
|
||||
## planetmint tendermint-version
|
||||
|
||||
Show the Tendermint versions supported by Planetmint server.
|
||||
```bash
|
||||
$ bigchaindb tendermint-version
|
||||
$ planetmint tendermint-version
|
||||
{
|
||||
"description": "Planetmint supports the following Tendermint version(s)",
|
||||
"tendermint": [
|
||||
|
||||
@ -2,6 +2,6 @@
|
||||
|
||||
You can find one of the installation methods with Ansible on GitHub at:
|
||||
|
||||
[Ansible script](https://github.com/bigchaindb/bigchaindb-node-ansible)
|
||||
[Ansible script](https://github.com/planetmint/planetmint-node-ansible)
|
||||
|
||||
It allows to install Planetmint, MongoDB, Tendermint, and python, and then connect nodes into a network. Current tested machine is Ubuntu 18.04.
|
||||
@ -21,13 +21,13 @@ The value of each setting is determined according to the following rules:
|
||||
* Otherwise, if it's set in a local config file, then use that value
|
||||
* Otherwise, use the default value
|
||||
|
||||
The local config file is `$HOME/.bigchaindb` by default (a file which might not even exist), but you can tell Planetmint to use a different file by using the `-c` command-line option, e.g. `bigchaindb -c path/to/config_file.json start`
|
||||
or using the `PLANETMINT_CONFIG_PATH` environment variable, e.g. `BIGHAINDB_CONFIG_PATH=.my_bigchaindb_config bigchaindb start`.
|
||||
The local config file is `$HOME/.planetmint` by default (a file which might not even exist), but you can tell Planetmint to use a different file by using the `-c` command-line option, e.g. `planetmint -c path/to/config_file.json start`
|
||||
or using the `PLANETMINT_CONFIG_PATH` environment variable, e.g. `BIGHAINDB_CONFIG_PATH=.my_planetmint_config planetmint start`.
|
||||
Note that the `-c` command line option will always take precedence if both the `PLANETMINT_CONFIG_PATH` and the `-c` command line option are used.
|
||||
|
||||
You can read the current default values in the file [bigchaindb/\_\_init\_\_.py](https://github.com/bigchaindb/bigchaindb/blob/master/bigchaindb/__init__.py). (The link is to the latest version.)
|
||||
You can read the current default values in the file [planetmint/\_\_init\_\_.py](https://github.com/planetmint/planetmint/blob/master/planetmint/__init__.py). (The link is to the latest version.)
|
||||
|
||||
Running `bigchaindb -y configure localmongodb` will generate a local config file in `$HOME/.bigchaindb` with all the default values.
|
||||
Running `planetmint -y configure localmongodb` will generate a local config file in `$HOME/.planetmint` with all the default values.
|
||||
|
||||
## database.*
|
||||
|
||||
@ -84,7 +84,7 @@ export PLANETMINT_DATABASE_MAX_TRIES=3
|
||||
|
||||
**Default values**
|
||||
|
||||
If (no environment variables were set and there's no local config file), or you used `bigchaindb -y configure localmongodb` to create a default local config file for a `localmongodb` backend, then the defaults will be:
|
||||
If (no environment variables were set and there's no local config file), or you used `planetmint -y configure localmongodb` to create a default local config file for a `localmongodb` backend, then the defaults will be:
|
||||
|
||||
```js
|
||||
"database": {
|
||||
@ -213,7 +213,7 @@ different from where Planetmint is running.
|
||||
|
||||
```text
|
||||
export PLANETMINT_WSSERVER_ADVERTISED_SCHEME=wss
|
||||
export PLANETMINT_WSSERVER_ADVERTISED_HOST=mybigchaindb.com
|
||||
export PLANETMINT_WSSERVER_ADVERTISED_HOST=myplanetmint.com
|
||||
export PLANETMINT_WSSERVER_ADVERTISED_PORT=443
|
||||
```
|
||||
|
||||
@ -222,7 +222,7 @@ export PLANETMINT_WSSERVER_ADVERTISED_PORT=443
|
||||
```js
|
||||
"wsserver": {
|
||||
"advertised_scheme": "wss",
|
||||
"advertised_host": "mybigchaindb.com",
|
||||
"advertised_host": "myplanetmint.com",
|
||||
"advertised_port": 443
|
||||
}
|
||||
```
|
||||
@ -246,8 +246,8 @@ The `log.*` settings are to configure logging.
|
||||
```js
|
||||
{
|
||||
"log": {
|
||||
"file": "/var/log/bigchaindb.log",
|
||||
"error_file": "/var/log/bigchaindb-errors.log",
|
||||
"file": "/var/log/planetmint.log",
|
||||
"error_file": "/var/log/planetmint-errors.log",
|
||||
"level_console": "info",
|
||||
"level_logfile": "info",
|
||||
"datefmt_console": "%Y-%m-%d %H:%M:%S",
|
||||
@ -263,8 +263,8 @@ The `log.*` settings are to configure logging.
|
||||
```js
|
||||
{
|
||||
"log": {
|
||||
"file": "~/bigchaindb.log",
|
||||
"error_file": "~/bigchaindb-errors.log",
|
||||
"file": "~/planetmint.log",
|
||||
"error_file": "~/planetmint-errors.log",
|
||||
"level_console": "info",
|
||||
"level_logfile": "info",
|
||||
"datefmt_console": "%Y-%m-%d %H:%M:%S",
|
||||
@ -278,7 +278,7 @@ The `log.*` settings are to configure logging.
|
||||
### log.file
|
||||
|
||||
The full path to the file where logs should be written.
|
||||
The user running `bigchaindb` must have write access to the
|
||||
The user running `planetmint` must have write access to the
|
||||
specified path.
|
||||
|
||||
**Log rotation:** Log files have a size limit of about 200 MB
|
||||
|
||||
@ -14,12 +14,12 @@ You can use the all-in-one docker solution, or install Tendermint, MongoDB, and
|
||||
|
||||
deploy-a-machine
|
||||
aws-setup
|
||||
all-in-one-bigchaindb
|
||||
bigchaindb-node-ansible
|
||||
all-in-one-planetmint
|
||||
planetmint-node-ansible
|
||||
set-up-node-software
|
||||
set-up-nginx
|
||||
configuration
|
||||
bigchaindb-cli
|
||||
planetmint-cli
|
||||
troubleshooting
|
||||
production-node/index
|
||||
release-notes
|
||||
|
||||
@ -9,7 +9,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
Be sure you know the key Planetmint terminology:
|
||||
|
||||
* [Planetmint node, Planetmint network and Planetmint consortium](https://docs.bigchaindb.com/en/latest/terminology.html)
|
||||
* [Planetmint node, Planetmint network and Planetmint consortium](https://docs.planetmint.com/en/latest/terminology.html)
|
||||
|
||||
Note that there are a few kinds of nodes:
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ Below, we note how a reverse proxy can be used
|
||||
to do some Planetmint-specific things.
|
||||
|
||||
You may also be interested in
|
||||
[our NGINX configuration file template](https://github.com/bigchaindb/nginx_3scale/blob/master/nginx.conf.template)
|
||||
[our NGINX configuration file template](https://github.com/planetmint/nginx_3scale/blob/master/nginx.conf.template)
|
||||
(open source, on GitHub).
|
||||
|
||||
|
||||
@ -55,4 +55,4 @@ For more information, see
|
||||
[the NGINX docs about client_max_body_size](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size).
|
||||
|
||||
Note: By enforcing a maximum transaction size, you
|
||||
[indirectly enforce a maximum crypto-conditions complexity](https://github.com/bigchaindb/bigchaindb/issues/356#issuecomment-288085251).
|
||||
[indirectly enforce a maximum crypto-conditions complexity](https://github.com/planetmint/planetmint/issues/356#issuecomment-288085251).
|
||||
|
||||
@ -9,8 +9,8 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
You can find a list of all Planetmint Server releases and release notes on GitHub at:
|
||||
|
||||
[https://github.com/bigchaindb/bigchaindb/releases](https://github.com/bigchaindb/bigchaindb/releases)
|
||||
[https://github.com/planetmint/planetmint/releases](https://github.com/planetmint/planetmint/releases)
|
||||
|
||||
The [CHANGELOG.md file](https://github.com/bigchaindb/bigchaindb/blob/master/CHANGELOG.md) contains much the same information, but it also has notes about what to expect in the _next_ release.
|
||||
The [CHANGELOG.md file](https://github.com/planetmint/planetmint/blob/master/CHANGELOG.md) contains much the same information, but it also has notes about what to expect in the _next_ release.
|
||||
|
||||
We also have [a roadmap document in ROADMAP.md](https://github.com/bigchaindb/org/blob/master/ROADMAP.md).
|
||||
We also have [a roadmap document in ROADMAP.md](https://github.com/planetmint/org/blob/master/ROADMAP.md).
|
||||
|
||||
@ -31,7 +31,7 @@ Get an SSL certificate for your node's subdomain (such as `bnode.example.com`).
|
||||
* Create a "PEM file" (text file) by concatenating your SSL certificate with all intermediate certificates (_in that order, with the intermediate certs last_).
|
||||
* Copy that PEM file into `/etc/nginx/ssl/cert.pem`
|
||||
* In the
|
||||
[bigchaindb/bigchaindb repository on GitHub](https://github.com/bigchaindb/bigchaindb),
|
||||
[planetmint/planetmint repository on GitHub](https://github.com/planetmint/planetmint),
|
||||
find the file `nginx/nginx.conf` and copy its contents to
|
||||
`/etc/nginx/nginx.conf` on your machine (i.e. replace the existing file there).
|
||||
* Edit that file (`/etc/nginx/nginx.conf`): replace the two instances of
|
||||
|
||||
@ -36,17 +36,17 @@ For example, to install version 2.2.2, you would do:
|
||||
|
||||
```
|
||||
# Change 2.0.0 to the latest version as explained above:
|
||||
sudo pip3 install bigchaindb==2.2.2
|
||||
sudo pip3 install planetmint==2.2.2
|
||||
```
|
||||
|
||||
Check that you installed the correct version of Planetmint Server using `bigchaindb --version`.
|
||||
Check that you installed the correct version of Planetmint Server using `planetmint --version`.
|
||||
|
||||
## Configure Planetmint Server
|
||||
|
||||
To configure Planetmint Server, run:
|
||||
|
||||
```
|
||||
bigchaindb configure
|
||||
planetmint configure
|
||||
```
|
||||
|
||||
The first question is ``API Server bind? (default `localhost:9984`)``.
|
||||
@ -58,7 +58,7 @@ The first question is ``API Server bind? (default `localhost:9984`)``.
|
||||
You can accept the default value for all other Planetmint config settings.
|
||||
|
||||
If you're using NGINX, then you should edit your Planetmint config file
|
||||
(in `$HOME/.bigchaindb` by default) and set the following values
|
||||
(in `$HOME/.planetmint` by default) and set the following values
|
||||
under `"wsserver"`:
|
||||
|
||||
```
|
||||
|
||||
@ -36,7 +36,7 @@ addr_book_strict = false
|
||||
|
||||
If you want to refresh your node back to a fresh empty state, then your best bet is to terminate it and deploy a new machine, but if that's not an option, then you can:
|
||||
|
||||
* drop the `bigchain` database in MongoDB using `bigchaindb drop` (but that only works if MongoDB is running)
|
||||
* drop the `bigchain` database in MongoDB using `planetmint drop` (but that only works if MongoDB is running)
|
||||
* reset Tendermint using `tendermint unsafe_reset_all`
|
||||
* delete the directory `$HOME/.tendermint`
|
||||
|
||||
@ -46,45 +46,45 @@ If you want to stop/kill Planetmint, you can do so by sending `SIGINT`, `SIGQUIT
|
||||
process(es). Depending on how you started Planetmint i.e. foreground or background. e.g. you started Planetmint in the background as mentioned above in the guide:
|
||||
|
||||
```bash
|
||||
$ nohup bigchaindb start 2>&1 > bigchaindb.log &
|
||||
$ nohup planetmint start 2>&1 > planetmint.log &
|
||||
|
||||
$ # Check the PID of the main Planetmint process
|
||||
$ ps -ef | grep bigchaindb
|
||||
<user> *<pid> <ppid> <C> <STIME> <tty> <time> bigchaindb
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> gunicorn: master [bigchaindb_gunicorn]
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> bigchaindb_ws
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> bigchaindb_ws_to_tendermint
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> bigchaindb_exchange
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [bigchaindb_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [bigchaindb_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [bigchaindb_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [bigchaindb_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [bigchaindb_gunicorn]
|
||||
$ ps -ef | grep planetmint
|
||||
<user> *<pid> <ppid> <C> <STIME> <tty> <time> planetmint
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> gunicorn: master [planetmint_gunicorn]
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> planetmint_ws
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> planetmint_ws_to_tendermint
|
||||
<user> <pid> <ppid>* <C> <STIME> <tty> <time> planetmint_exchange
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [planetmint_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [planetmint_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [planetmint_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [planetmint_gunicorn]
|
||||
<user> <pid> <ppid> <C> <STIME> <tty> <time> gunicorn: worker [planetmint_gunicorn]
|
||||
...
|
||||
|
||||
$ # Send any of the above mentioned signals to the parent/root process(marked with `*` for clarity)
|
||||
# Sending SIGINT
|
||||
$ kill -2 <bigchaindb_parent_pid>
|
||||
$ kill -2 <planetmint_parent_pid>
|
||||
|
||||
$ # OR
|
||||
|
||||
# Sending SIGTERM
|
||||
$ kill -15 <bigchaindb_parent_pid>
|
||||
$ kill -15 <planetmint_parent_pid>
|
||||
|
||||
$ # OR
|
||||
|
||||
# Sending SIGQUIT
|
||||
$ kill -3 <bigchaindb_parent_pid>
|
||||
$ kill -3 <planetmint_parent_pid>
|
||||
|
||||
# If you want to kill all the processes by name yourself
|
||||
$ pgrep bigchaindb | xargs kill -9
|
||||
$ pgrep planetmint | xargs kill -9
|
||||
```
|
||||
|
||||
If you started Planetmint in the foreground, a `Ctrl + C` or `Ctrl + Z` would shut down Planetmint.
|
||||
|
||||
## Member: Dynamically Add or Remove Validators
|
||||
|
||||
One member can make a proposal to call an election to add a validator, remove a validator, or change the voting power of a validator. They then share the election/proposal ID with all the other members. Once more than 2/3 of the voting power votes yes, the proposed change comes into effect. The commands to create a new election/proposal, to approve an election/proposal, and to get the current status of an election/proposal can be found in the documentation about the [bigchaindb election](../server-reference/bigchaindb-cli#bigchaindb-election) subcommands.
|
||||
One member can make a proposal to call an election to add a validator, remove a validator, or change the voting power of a validator. They then share the election/proposal ID with all the other members. Once more than 2/3 of the voting power votes yes, the proposed change comes into effect. The commands to create a new election/proposal, to approve an election/proposal, and to get the current status of an election/proposal can be found in the documentation about the [planetmint election](../server-reference/planetmint-cli#planetmint-election) subcommands.
|
||||
|
||||
## Logging
|
||||
|
||||
@ -92,4 +92,4 @@ See the page in the Appendices about [logging and log rotation](../appendices/lo
|
||||
|
||||
## Other Problems
|
||||
|
||||
If you're stuck, maybe [file a new issue on GitHub](https://github.com/bigchaindb/bigchaindb/issues/new). If your problem occurs often enough, we'll write about it here.
|
||||
If you're stuck, maybe [file a new issue on GitHub](https://github.com/planetmint/planetmint/issues/new). If your problem occurs often enough, we'll write about it here.
|
||||
@ -72,7 +72,7 @@ To develop an app that talks to a Planetmint network, you'll want a test network
|
||||
Create a transaction and post it to the test network:
|
||||
|
||||
<div class="buttondiv">
|
||||
<a class="button" href="https://www.bigchaindb.com/developers/getstarted/">Try Planetmint Now</a>
|
||||
<a class="button" href="https://www.planetmint.com/developers/getstarted/">Try Planetmint Now</a>
|
||||
</div>
|
||||
|
||||
<hr>
|
||||
|
||||
@ -14,8 +14,8 @@ BigchainDB는 모든 종류의 데이터를 저장할 수 있지만 자산 등
|
||||
* 자산 소유자는 자산을 신규 소유자에게 양도하려는 사람이 만족해야하는 조건을 지정할 수 있습니다. 예를 들어 5 명의 현재 소유자 중 최소 3 명이 TRANSFER 트랜잭션에 암호를 사용해야합니다.
|
||||
* BigchainDB는 TRANSFER 트랜잭션의 유효성을 검사하는 과정에서 조건이 충족되었는지 확인합니다. (또한 누구나 만족하는지 확인할 수 있습니다.)
|
||||
* BigchainDB는 자산의 이중 지출을 방지합니다.
|
||||
* 유효성이 검증 된 트랜잭션은 [변경불가능](https://github.com/bigchaindb/bigchaindb/blob/master/docs/root/source/korean/immutable-ko.md) 입니다.
|
||||
* 유효성이 검증 된 트랜잭션은 [변경불가능](https://github.com/planetmint/planetmint/blob/master/docs/root/source/korean/immutable-ko.md) 입니다.
|
||||
|
||||
Note
|
||||
|
||||
우리는 "소유자"라는 단어를 다소 느슨하게 사용했습니다. **보다 정확한 단어**는 이행자, 서명자, 조정자 또는 이전 가능 요소 일 수 있습니다. 관련 [Planetmint Transaction Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/)의 Owners에 대한 참고 사항 절을 참조하십시오.
|
||||
우리는 "소유자"라는 단어를 다소 느슨하게 사용했습니다. **보다 정확한 단어**는 이행자, 서명자, 조정자 또는 이전 가능 요소 일 수 있습니다. 관련 [Planetmint Transaction Spec](https://github.com/planetmint/BEPs/tree/master/tx-specs/)의 Owners에 대한 참고 사항 절을 참조하십시오.
|
||||
|
||||
@ -7,7 +7,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
# BigchainDB와 Byzantine Fault Tolerance
|
||||
|
||||
[Planetmint Server](https://docs.bigchaindb.com/projects/server/en/latest/index.html)
|
||||
[Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/index.html)
|
||||
는 블록체인 합의와 트랜잭션 복제에 [Tendermint](https://tendermint.com/)를 사용합니다.
|
||||
|
||||
그리고 Tendermint 는 [Byzantine Fault Tolerant (BFT)](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance).
|
||||
|
||||
@ -24,4 +24,4 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
1. **암호화폐의 표식**은 종종 메시지(예: 트랜잭션)가 도중에 손상되었는지 확인하고 메시지에 서명한 사용자를 확인하는 방법으로 사용됩니다. BigchainDB에서는 각 트랜잭션에 한 명 이상의 당사자가 서명해야 합니다
|
||||
1. **전체 또는 부분적 백업**은 때때로 자기 테이프 저장소, 기타 블록체인, 인쇄물 등에 기록될 수 있습니다.
|
||||
1. **강력한 보안** 노드 소유자는 강력한 보안 정책을 채택하고 적용할 수 있습니다.
|
||||
1. **노드 다양성.** 다양성으로 인해서 한 가지 요소(예: 자연 재해 또는 운영 체제 버그)가 상당 수의 노드를 손상시킬 수 없도록 합니다. [노드 다양성의 종류에 대한 섹션](https://github.com/bigchaindb/bigchaindb/blob/master/docs/root/source/korean/diversity-ko.md)을 참조하세요.
|
||||
1. **노드 다양성.** 다양성으로 인해서 한 가지 요소(예: 자연 재해 또는 운영 체제 버그)가 상당 수의 노드를 손상시킬 수 없도록 합니다. [노드 다양성의 종류에 대한 섹션](https://github.com/planetmint/planetmint/blob/master/docs/root/source/korean/diversity-ko.md)을 참조하세요.
|
||||
|
||||
@ -9,7 +9,7 @@ Planetmint 문서
|
||||
|
||||
블록체인 데이터베이스인 BigchainDB를 만나보세요.
|
||||
|
||||
`분산형 <https://github.com/bigchaindb/bigchaindb/blob/master/docs/root/source/korean/decentralized_kor.md>`_, `불변성 <https://github.com/bigchaindb/bigchaindb/blob/master/docs/root/source/korean/immutable-ko.md>`_ 및 `자산에 대한 네이티브 지원 <https://github.com/bigchaindb/bigchaindb/blob/master/docs/root/source/korean/assets_ko.md>`_ 을 포함한 일부 데이터베이스 특성들과 블록체인 특성을 가지고 있습니다.
|
||||
`분산형 <https://github.com/planetmint/planetmint/blob/master/docs/root/source/korean/decentralized_kor.md>`_, `불변성 <https://github.com/planetmint/planetmint/blob/master/docs/root/source/korean/immutable-ko.md>`_ 및 `자산에 대한 네이티브 지원 <https://github.com/planetmint/planetmint/blob/master/docs/root/source/korean/assets_ko.md>`_ 을 포함한 일부 데이터베이스 특성들과 블록체인 특성을 가지고 있습니다.
|
||||
|
||||
높은 수준에서, 사용자는 Planetmint HTTP API를 사용하는 Planetmint 네트워크(노드 집합) 또는 Planetmint 파이썬 드라이버와 같은 API용 래퍼로 통신할 수 있습니다. 각 Planetmint 노드는 Planetmint Server 및 다양한 다른 소프트웨어를 실행합니다. 더 자세한 사항은 용어 페이지에서 이러한 용어 중 일부를 설명합니다.
|
||||
|
||||
@ -56,22 +56,22 @@ Planetmint 문서
|
||||
</style>
|
||||
|
||||
<div class="buttondiv">
|
||||
<a class="button" href="http://bigchaindb.com/http-api">HTTP API 문서</a>
|
||||
<a class="button" href="http://planetmint.com/http-api">HTTP API 문서</a>
|
||||
</div>
|
||||
<div class="buttondiv">
|
||||
<a class="button" href="http://docs.bigchaindb.com/projects/contributing/en/latest/index.html">BigchainDB에 기여하는 법</a>
|
||||
<a class="button" href="http://docs.planetmint.com/projects/contributing/en/latest/index.html">BigchainDB에 기여하는 법</a>
|
||||
</div>
|
||||
<div class="buttondiv">
|
||||
<a class="button" href="http://docs.bigchaindb.com/projects/py-driver/en/latest/index.html">파이썬 드라이버 문서</a>
|
||||
<a class="button" href="http://docs.planetmint.com/projects/py-driver/en/latest/index.html">파이썬 드라이버 문서</a>
|
||||
</div>
|
||||
<div class="buttondiv">
|
||||
<a class="button" href="https://docs.bigchaindb.com/projects/js-driver/en/latest/index.html">자바스크립트 드라이버 문서</a>
|
||||
<a class="button" href="https://docs.planetmint.com/projects/js-driver/en/latest/index.html">자바스크립트 드라이버 문서</a>
|
||||
</div>
|
||||
<div class="buttondiv">
|
||||
<a class="button" href="http://docs.bigchaindb.com/projects/server/en/latest/index.html">서버 문서</a>
|
||||
<a class="button" href="http://docs.planetmint.com/projects/server/en/latest/index.html">서버 문서</a>
|
||||
</div>
|
||||
<div class="buttondiv">
|
||||
<a class="button" href="http://docs.bigchaindb.com/projects/server/en/latest/quickstart.html">서버 빠른 시작</a>
|
||||
<a class="button" href="http://docs.planetmint.com/projects/server/en/latest/quickstart.html">서버 빠른 시작</a>
|
||||
</div>
|
||||
|
||||
|
||||
@ -95,4 +95,4 @@ BigchainDB에 대한 추가 정보
|
||||
store-files_ko
|
||||
permissions-ko
|
||||
private-data-ko
|
||||
Data Models <https://docs.bigchaindb.com/projects/server/en/latest/data-models/index.html>
|
||||
Data Models <https://docs.planetmint.com/projects/server/en/latest/data-models/index.html>
|
||||
|
||||
@ -21,7 +21,7 @@ BigchainDB에서, 모든 출력에는 연관된 조건(crypto-condition)이 있
|
||||
- "…네 명 중 세 명이 서명해야 합니다."
|
||||
- "…Bob이 반드시 서명해야 하거나 Tom과 Sylvia 둘 모두가 서명해야 합니다."
|
||||
|
||||
자세한 내용은, [Planetmint Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/)관련 **트랜잭션 구성요소:조건** 섹션을 참조하세요.
|
||||
자세한 내용은, [Planetmint Transactions Spec](https://github.com/planetmint/BEPs/tree/master/tx-specs/)관련 **트랜잭션 구성요소:조건** 섹션을 참조하세요.
|
||||
|
||||
출력이 한번 소비되면 다시 사용할 수 없습니다: *아무도* 그렇게 할 권한이 없습니다. 즉, BigchainDB는 누구나 출력을 "이중 소비" 하도록 허용 하지 않습니다.
|
||||
|
||||
@ -52,8 +52,8 @@ Note
|
||||
|
||||
## 읽기 권한
|
||||
|
||||
다음 페이지를 참고하세요, [:doc:Planetmint, Privacy and Private Data](https://github.com/bigchaindb/bigchaindb/blob/master/docs/root/source/korean/private-data-ko.md).
|
||||
다음 페이지를 참고하세요, [:doc:Planetmint, Privacy and Private Data](https://github.com/planetmint/planetmint/blob/master/docs/root/source/korean/private-data-ko.md).
|
||||
|
||||
## 역할 기반 액세스 제어(RBAC)
|
||||
|
||||
2017년 9월에, 우리는 [Planetmint RBAC 하부 시스템을 정의 할 수 있는 방법에 대한 블로그 게시물](https://blog.bigchaindb.com/role-based-access-control-for-bigchaindb-assets-b7cada491997)을 게재 했습니다. 글을 쓴 시점(2018년 1월)에는 플러그인을 사용해야 해서, 표준 BigchainDB다음에서 사용가능한 [Planetmint Testnet](https://testnet.bigchaindb.com/) 를 사용 할 수 없었습니다. 이는 미래에 바뀔 수 있습니다. 만약 관심이 있다면, [BigchainDB로 연락하십시요.](https://www.bigchaindb.com/contact/)
|
||||
2017년 9월에, 우리는 [Planetmint RBAC 하부 시스템을 정의 할 수 있는 방법에 대한 블로그 게시물](https://blog.planetmint.com/role-based-access-control-for-planetmint-assets-b7cada491997)을 게재 했습니다. 글을 쓴 시점(2018년 1월)에는 플러그인을 사용해야 해서, 표준 BigchainDB다음에서 사용가능한 [Planetmint Testnet](https://testnet.planetmint.com/) 를 사용 할 수 없었습니다. 이는 미래에 바뀔 수 있습니다. 만약 관심이 있다면, [BigchainDB로 연락하십시요.](https://www.planetmint.com/contact/)
|
||||
|
||||
@ -26,7 +26,7 @@ Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
- 제3자 시스템에 읽기 권한 또는 기타 권한이 있는 사용자를 추적합니다. 이 작업을 수행하는 방법의 예는 아래에 있습니다.
|
||||
- 제3자 시스템에 대한 모든 요청을 영구적으로 기록합니다.
|
||||
- 모든 문서의 변경 사항을 감지 할 수 있도록, 다른 곳에 저장된 문서의 해시를 저장합니다.
|
||||
- 암호화 된 터널을 설정했다는 것을 증명할 수 있도록 두 개의 오프 체인 파티(예:Diffie-Hellman 키 교환) 간의 모든 핸드셰이크 설정 요청 및 응답을 기록합니다(독자가 해당 터널에 액세스하지 않고). 이 아이디어에 대한 자세한 내용은 [the Planetmint Privacy Protocols 저장소](https://github.com/bigchaindb/privacy-protocols)에 있습니다.
|
||||
- 암호화 된 터널을 설정했다는 것을 증명할 수 있도록 두 개의 오프 체인 파티(예:Diffie-Hellman 키 교환) 간의 모든 핸드셰이크 설정 요청 및 응답을 기록합니다(독자가 해당 터널에 액세스하지 않고). 이 아이디어에 대한 자세한 내용은 [the Planetmint Privacy Protocols 저장소](https://github.com/planetmint/privacy-protocols)에 있습니다.
|
||||
|
||||
특정 문서에 대한 읽기 권한을 가진 사람을 기록하는 간단한 방법은 제 3자 시스템(“Docpile“)이 모든 문서+사용자 쌍에 대해 BigchinDB 네트워크에 CREATE 트랜잭션을 저장하여 해당 사용자가 그 문서에 대한 읽기 권한을 가지고 있음을 나타낼 수 있습니다. 트랜잭션은 Docpile에 의해 서명 될 수 있습니다(또는 문서 소유자에 의해). 자산 데이터 필드는 1)사용자의 고유 ID 및 2)문서의 고유 ID를 포함합니다. CREATE 트랜잭션의 한 출력은 DocPile(또는 문서 소유자)에 의해서만 전송/소비 될 수 있습니다.
|
||||
|
||||
@ -44,7 +44,7 @@ DocPile은 CREATE → TRANSFER → TRANSFER → 사용자+문서 쌍에 대한 e
|
||||
## 체인에서 암호화 된 개인 데이터 저장
|
||||
|
||||
체인상에서 개인 데이터를 암호화하여 저장하는 방법에는 여러 가지가 있습니다. 모든 유스 케이스에는 고유한 목표와 제약이 있으며, 최상의 해결책은 유스 케이스에 달려있다.
|
||||
[Planetmint 컨설팅 팀](https://www.bigchaindb.com/services/), 우리의 파트너와 함께, 당신의유스 케이스에 가장 적합한 솔루션을 설계하는 데 도움을 줄 수 있습니다.
|
||||
[Planetmint 컨설팅 팀](https://www.planetmint.com/services/), 우리의 파트너와 함께, 당신의유스 케이스에 가장 적합한 솔루션을 설계하는 데 도움을 줄 수 있습니다.
|
||||
|
||||
아래에서는 다양한 암호화 기본 설정을 사용하여 가능한 시스템을 설정하는 예제를 설명합니다.
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ Planetmint 쿼리
|
||||
------------------------------
|
||||
|
||||
|
||||
Planetmint 블로그에 MongoDB 도구를 사용하여 Planetmint 노드의 MongoDB 데이터베이스를 쿼리하는 방법에 대한 게시물을 올렸습니다. 데이터에 대한 일부 특정 예제 쿼리가 주요 내용입니다. [여기서 확인하세요](https://blog.bigchaindb.com/using-mongodb-to-query-bigchaindb-data-3fc651e0861b)
|
||||
Planetmint 블로그에 MongoDB 도구를 사용하여 Planetmint 노드의 MongoDB 데이터베이스를 쿼리하는 방법에 대한 게시물을 올렸습니다. 데이터에 대한 일부 특정 예제 쿼리가 주요 내용입니다. [여기서 확인하세요](https://blog.planetmint.com/using-mongodb-to-query-planetmint-data-3fc651e0861b)
|
||||
|
||||
MongoDB에 연결하기
|
||||
-------------------------
|
||||
@ -162,7 +162,7 @@ metadata 컬렉션의 문서는 MongoDB가 추가한 `"_id"`필드와 거래에
|
||||
각 노드 operator는 외부 사용자가 자신의 로컬 MongoDB 데이터베이스에서 정보를 얻는 방법을 결정할 수 있습니다. 그들은 다음과 같은 것들을 보낼 수 있습니다:
|
||||
|
||||
- 외부유저를 쿼리 처리하는 로컬 MongoDB 데이터베이스 한된 제한된 권한을 가진 역할을 가진 MongoDB 사용자 예) read-only
|
||||
- 제한된 미리 정의된 쿼리 집합을 허용하는 제한된 HTTP API, [Planetmint 서버에서 제공하는 HTTP API](http://bigchaindb.com/http-api), 혹은Django, Express, Ruby on Rails, or ASP.NET.를 이용해 구현된 커스텀 HTTP API
|
||||
- 제한된 미리 정의된 쿼리 집합을 허용하는 제한된 HTTP API, [Planetmint 서버에서 제공하는 HTTP API](http://planetmint.com/http-api), 혹은Django, Express, Ruby on Rails, or ASP.NET.를 이용해 구현된 커스텀 HTTP API
|
||||
- 다른 API(예: GraphQL API) 제3자의 사용자 정의 코드 또는 코드를 사용하여 수행할 수 있습니다..
|
||||
|
||||
각 노드 operator는 로컬 MongoDB 데이터베이스에 대한 다른 레벨 또는 유형의 액세스를 노출할 수 있습니다.
|
||||
@ -197,6 +197,6 @@ Tendermint voting 파워가 0인 노드인 추종자 노드를 생성할 수 있
|
||||
|
||||
[MongoDB node.js 드라이버](https://mongodb.github.io/node-mongodb-native/?jmp=docs)와 같은 MongoDB 드라이버를 사용하여 다음 중 하나를 사용하여 노드의 MongoDB 데이터베이스에 연결할 수 있습니다. 여기 자바스크립트 쿼리 코드에 대한 링크가 있습니다.
|
||||
|
||||
- [The Planetmint JavaScript/Node.js driver source code](https://github.com/bigchaindb/js-bigchaindb-driver)
|
||||
- [Example code by @manolodewiner](https://github.com/manolodewiner/query-mongodb-bigchaindb/blob/master/queryMongo.js)
|
||||
- [More example code by @manolodewiner](https://github.com/bigchaindb/bigchaindb/issues/2315#issuecomment-392724279)
|
||||
- [The Planetmint JavaScript/Node.js driver source code](https://github.com/planetmint/js-planetmint-driver)
|
||||
- [Example code by @manolodewiner](https://github.com/manolodewiner/query-mongodb-planetmint/blob/master/queryMongo.js)
|
||||
- [More example code by @manolodewiner](https://github.com/planetmint/planetmint/issues/2315#issuecomment-392724279)
|
||||
@ -12,6 +12,6 @@ BigchainDB에는 스마트 계약 (즉, 컴퓨터 프로그램)의 소스 코드
|
||||
|
||||
BigchainDB는 대체 가능한 자산과 대체 할 수없는 자산 모두를 전송할 수있는 권한을 가진 사람을 시행하는 데 사용할 수 있습니다. 이중 지출을 막을 것입니다. 즉, ERC-20 (대체 가능한 토큰) 또는 ERC-721 (대체 할 수없는 토큰) 스마트 계약 대신 Planetmint 네트워크를 사용할 수 있습니다.
|
||||
|
||||
자산 이전 권한은 쓰기 권한으로 해석 될 수 있으므로 로그, 저널 또는 감사 내역에 기록 할 수있는 사람을 제어하는데 사용할 수 있습니다. [BigchainDB의 사용 권한](https://github.com/bigchaindb/bigchaindb/blob/master/docs/root/source/korean/permissions-ko.md)에 대한 자세한 내용은 페이지에서 확인하십시오.
|
||||
자산 이전 권한은 쓰기 권한으로 해석 될 수 있으므로 로그, 저널 또는 감사 내역에 기록 할 수있는 사람을 제어하는데 사용할 수 있습니다. [BigchainDB의 사용 권한](https://github.com/planetmint/planetmint/blob/master/docs/root/source/korean/permissions-ko.md)에 대한 자세한 내용은 페이지에서 확인하십시오.
|
||||
|
||||
Planetmint 네트워크는 oracles 또는 체인 간 통신 프로토콜을 통해 다른 블록 체인 네트워크에 연결할 수 있습니다. 이는 BigchainDB를 다른 블록 체인을 사용하여 임의의 스마트 계약을 실행하는 솔루션의 일부로 사용할 수 있음을 의미합니다.
|
||||
|
||||
@ -11,7 +11,7 @@ BigchainDB와 관련돈 몇 가지 전문화된 용어가 있습니다. 시작
|
||||
|
||||
## Planetmint 노드
|
||||
|
||||
**Planetmint 노드**는 [Planetmint 서버](https://docs.bigchaindb.com/projects/server/en/latest/introduction.html) 및 관련된 소프트웨어를 실행하는 시스템(또는 논리적인 시스템)입니다. 각각의 노드는 한 개인이나 조직에 의해 제어될 수 있습니다.
|
||||
**Planetmint 노드**는 [Planetmint 서버](https://docs.planetmint.com/projects/server/en/latest/introduction.html) 및 관련된 소프트웨어를 실행하는 시스템(또는 논리적인 시스템)입니다. 각각의 노드는 한 개인이나 조직에 의해 제어될 수 있습니다.
|
||||
|
||||
## Planetmint 네트워크
|
||||
|
||||
|
||||
@ -20,13 +20,13 @@ BigchainDB는 Planetmint Server v0.8.0부터 나눌 수있는 자산을 지원
|
||||
|
||||
CREATE 트랜잭션은 하나 이상의 출력을 가질 수 있습니다. 각 출력에는 관련 금액이 있습니다. 출력에 연결된 공유 수입니다. 예를 들어 자산이 50 개의 오크 나무로 구성되어있는 경우 한 출력에는 한 소유자 세트에 35 개의 오크 나무가 있고 다른 출력에는 다른 소유자 세트에는 15 개의 오크 나무가있을 수 있습니다.
|
||||
|
||||
또한 각 출력에는 연관된 조건이 있습니다. 출력을 전송 / 소비하기 위해 충족되어야하는 조건 (TRANSFER 트랜잭션에 의해). BigchainDB는 다양한 조건을 지원합니다. 자세한 내용은 관련 [Planetmint 트랜잭션 Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/)과 관련된 **트랜잭션 구성 요소 : 조건 섹션**을 참조하십시오.
|
||||
또한 각 출력에는 연관된 조건이 있습니다. 출력을 전송 / 소비하기 위해 충족되어야하는 조건 (TRANSFER 트랜잭션에 의해). BigchainDB는 다양한 조건을 지원합니다. 자세한 내용은 관련 [Planetmint 트랜잭션 Spec](https://github.com/planetmint/BEPs/tree/master/tx-specs/)과 관련된 **트랜잭션 구성 요소 : 조건 섹션**을 참조하십시오.
|
||||
|
||||
|
||||
|
||||
위의 예제에서는 Planetmint CREATE 트랜잭션 다이어그램을 보여줍니다. Pam은 자산 3 주를 소유 / 통제하고 다른 주식은 없습니다 (다른 산출물이 없으므로).
|
||||
|
||||
각 출력에는 해당 출력의 조건과 연관된 모든 공개 키 목록이 있습니다. 다시 말하면, 그 목록은 "소유자"의 목록으로 해석 될 수 있습니다.보다 정확한 단어는 이행자, 서명자, 컨트롤러 또는 이전 가능 요소 일 수 있습니다. 관련 [Planetmint Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/) **소유자에 관한 참고 사항** 섹션을 참조하십시오.
|
||||
각 출력에는 해당 출력의 조건과 연관된 모든 공개 키 목록이 있습니다. 다시 말하면, 그 목록은 "소유자"의 목록으로 해석 될 수 있습니다.보다 정확한 단어는 이행자, 서명자, 컨트롤러 또는 이전 가능 요소 일 수 있습니다. 관련 [Planetmint Transactions Spec](https://github.com/planetmint/BEPs/tree/master/tx-specs/) **소유자에 관한 참고 사항** 섹션을 참조하십시오.
|
||||
|
||||
CREATE 트랜잭션은 모든 소유자가 서명해야합니다. (만약 당신이 그 서명을 원한다면, 그것은 인코딩되었지만 하나의 입력의 "이행"에있다.)
|
||||
|
||||
@ -51,11 +51,11 @@ CREATE 트랜잭션은 모든 소유자가 서명해야합니다. (만약 당신
|
||||
## 트랜잭션 유효성
|
||||
|
||||
언제 트랜잭션이 유효한지 유효성을 검사하는 것에 관해 해당 블로그에 게시되어있습니다. *The Planetmint Blog*:
|
||||
["What is a Valid Transaction in Planetmint?"](https://blog.bigchaindb.com/what-is-a-valid-transaction-in-bigchaindb-9a1a075a9598) (Note: That post was about Planetmint Server v1.0.0.)
|
||||
["What is a Valid Transaction in Planetmint?"](https://blog.planetmint.com/what-is-a-valid-transaction-in-planetmint-9a1a075a9598) (Note: That post was about Planetmint Server v1.0.0.)
|
||||
|
||||
Each [Planetmint Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/) documents the conditions for a transaction (of that version) to be valid.
|
||||
Each [Planetmint Transactions Spec](https://github.com/planetmint/BEPs/tree/master/tx-specs/) documents the conditions for a transaction (of that version) to be valid.
|
||||
|
||||
## 트랜잭션 예시
|
||||
|
||||
아래의 [HTTP API 문서](https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html)와 [the Python 드라이버 문서](https://docs.bigchaindb.com/projects/py-driver/en/latest/usage.html)에는 예제 Planetmint 트랜잭션이 있습니다.
|
||||
아래의 [HTTP API 문서](https://docs.planetmint.com/projects/server/en/latest/http-client-server-api.html)와 [the Python 드라이버 문서](https://docs.planetmint.com/projects/py-driver/en/latest/usage.html)에는 예제 Planetmint 트랜잭션이 있습니다.
|
||||
.
|
||||
|
||||
@ -17,7 +17,7 @@ We wrote a blog post in The Planetmint Blog to show
|
||||
how to use some MongoDB tools to query a Planetmint node's MongoDB database.
|
||||
It includes some specific example queries for data
|
||||
about custom cars and their ownership histories.
|
||||
`Check it out <https://blog.bigchaindb.com/using-mongodb-to-query-bigchaindb-data-3fc651e0861b>`_.
|
||||
`Check it out <https://blog.planetmint.com/using-mongodb-to-query-planetmint-data-3fc651e0861b>`_.
|
||||
|
||||
How to Connect to MongoDB
|
||||
-------------------------
|
||||
@ -174,7 +174,7 @@ What a Node Operator Can Expose to External Users
|
||||
Each node operator can decide how they let external users get information from their local MongoDB database. They could expose:
|
||||
|
||||
- their local MonogoDB database itself to queries from external users, maybe as a MongoDB user with a role that has limited privileges, e.g. read-only.
|
||||
- a limited HTTP API, allowing a restricted set of predefined queries, such as `the HTTP API provided by Planetmint Server <http://bigchaindb.com/http-api>`_, or a custom HTTP API implemented using Django, Express, Ruby on Rails, or ASP.NET.
|
||||
- a limited HTTP API, allowing a restricted set of predefined queries, such as `the HTTP API provided by Planetmint Server <http://planetmint.com/http-api>`_, or a custom HTTP API implemented using Django, Express, Ruby on Rails, or ASP.NET.
|
||||
- some other API, such as a GraphQL API. They could do that using custom code or code from a third party.
|
||||
|
||||
Each node operator can expose a different level or type of access to their local MongoDB database.
|
||||
@ -224,6 +224,6 @@ of the MongoDB drivers, such as `the MongoDB Node.js driver
|
||||
Here are some links to example JavaScript code that queries a
|
||||
Planetmint node's MongoDB database:
|
||||
|
||||
- `The Planetmint JavaScript/Node.js driver source code <https://github.com/bigchaindb/js-bigchaindb-driver>`_
|
||||
- `Example code by @manolodewiner <https://github.com/manolodewiner/query-mongodb-bigchaindb/blob/master/queryMongo.js>`_
|
||||
- `More example code by @manolodewiner <https://github.com/bigchaindb/bigchaindb/issues/2315#issuecomment-392724279>`_
|
||||
- `The Planetmint JavaScript/Node.js driver source code <https://github.com/planetmint/js-planetmint-driver>`_
|
||||
- `Example code by @manolodewiner <https://github.com/manolodewiner/query-mongodb-planetmint/blob/master/queryMongo.js>`_
|
||||
- `More example code by @manolodewiner <https://github.com/planetmint/planetmint/issues/2315#issuecomment-392724279>`_
|
||||
|
||||
@ -11,7 +11,7 @@ There is some specialized terminology associated with Planetmint. To get started
|
||||
|
||||
### Planetmint Node
|
||||
|
||||
A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.bigchaindb.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization.
|
||||
A **Planetmint node** is a machine (or logical machine) running [Planetmint Server](https://docs.planetmint.com/projects/server/en/latest/introduction.html) and related software. Each node is controlled by one person or organization.
|
||||
|
||||
### Planetmint Network
|
||||
|
||||
@ -27,7 +27,7 @@ A BigchaindB network is just a bunch of connected nodes. A consortium is an orga
|
||||
|
||||
### Transactions
|
||||
|
||||
Are described in detail in `Planetmint Transactions Spec <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_ .
|
||||
Are described in detail in `Planetmint Transactions Spec <https://github.com/planetmint/BEPs/tree/master/tx-specs/>`_ .
|
||||
|
||||
## Permissions in Planetmint
|
||||
|
||||
@ -76,6 +76,6 @@ You could do more elaborate things too. As one example, each time someone writes
|
||||
|
||||
### Role-Based Access Control (RBAC)
|
||||
|
||||
In September 2017, we published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.bigchaindb.com/role-based-access-control-for-bigchaindb-assets-b7cada491997).
|
||||
In September 2017, we published a [blog post about how one can define an RBAC sub-system on top of Planetmint](https://blog.planetmint.com/role-based-access-control-for-planetmint-assets-b7cada491997).
|
||||
At the time of writing (January 2018), doing so required the use of a plugin, so it's not possible using standard Planetmint (which is what's available on the [IPDB Testnet](https://test.ipdb.io/>). That may change in the future.
|
||||
If you're interested, `contact IPDB <contact@ipdb.global>`_.
|
||||
|
||||
@ -15,11 +15,11 @@ For all future releases, we commit to not introduce breaking changes to the
|
||||
public interfaces of Planetmint's:
|
||||
|
||||
- [Data
|
||||
model](https://docs.bigchaindb.com/projects/server/en/latest/data-models/index.html)
|
||||
model](https://docs.planetmint.com/projects/server/en/latest/data-models/index.html)
|
||||
- [HTTP
|
||||
API](https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html)
|
||||
API](https://docs.planetmint.com/projects/server/en/latest/http-client-server-api.html)
|
||||
- [WebSocket Event Stream
|
||||
API](https://docs.bigchaindb.com/projects/server/en/latest/websocket-event-stream-api.html)
|
||||
API](https://docs.planetmint.com/projects/server/en/latest/websocket-event-stream-api.html)
|
||||
|
||||
|
||||
As we saw the version bump to v1.0 as our last chance in a while to fix minor
|
||||
@ -90,9 +90,9 @@ the 1.0 release, transactions with multiple inputs had a special signing
|
||||
protocol, which included reassembly of the transaction. This was identified as
|
||||
being unneeded, so now the payload that is signed is always just the serialized
|
||||
transaction, minus signatures. More details, take a look at the
|
||||
[Pull-Request](https://github.com/bigchaindb/bigchaindb/pull/1225) introducing
|
||||
[Pull-Request](https://github.com/planetmint/planetmint/pull/1225) introducing
|
||||
the change or at our updated [Handcrafting
|
||||
Transactions](https://docs.bigchaindb.com/projects/py-driver/en/latest/handcraft.html)
|
||||
Transactions](https://docs.planetmint.com/projects/py-driver/en/latest/handcraft.html)
|
||||
document.
|
||||
|
||||
|
||||
@ -106,7 +106,7 @@ transaction's inputs and outputs need to comply to this new version.
|
||||
Several of the language specific implementations have already been updated,
|
||||
including:
|
||||
|
||||
- [py-crypto-conditions](https://github.com/bigchaindb/cryptoconditions)
|
||||
- [py-crypto-conditions](https://github.com/planetmint/cryptoconditions)
|
||||
- [js-crypto-conditions](https://github.com/interledgerjs/five-bells-condition)
|
||||
- [java-crypto-conditions](https://github.com/interledger/java-crypto-conditions)
|
||||
|
||||
@ -160,8 +160,8 @@ changes done to them:
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#bigchaindb-root-url)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#bigchaindb-root-url)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#planetmint-root-url)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#planetmint-root-url)
|
||||
|
||||
|
||||
Changes:
|
||||
@ -186,7 +186,7 @@ Changes:
|
||||
{
|
||||
"_links": {
|
||||
"api_v1": "http://example.com:9984/api/v1/",
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.10.2/"
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.10.2/"
|
||||
},
|
||||
"keyring": [
|
||||
"6qHyZew94NMmUTYyHnkZsB8cxJYuRNEiEpXHe1ih9QX3",
|
||||
@ -201,7 +201,7 @@ Changes:
|
||||
{
|
||||
"api": {
|
||||
"v1": {
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.11.0.dev/http-client-server-api.html",
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.11.0.dev/http-client-server-api.html",
|
||||
"statuses": "/api/v1/statuses/",
|
||||
"streams": "ws://example.com:9985/api/v1/streams/valid_transactions",
|
||||
"transactions": "/api/v1/transactions/",
|
||||
@ -209,7 +209,7 @@ Changes:
|
||||
"outputs": "/api/v1/outputs/"
|
||||
}
|
||||
},
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.11.0.dev/",
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.11.0.dev/",
|
||||
"keyring": [
|
||||
"6qHyZew94NMmUTYyHnkZsB8cxJYuRNEiEpXHe1ih9QX3",
|
||||
"AdDuyrTyjrDt935YnFu4VBCVDhHtY2Y6rcy7x2TFeiRi"
|
||||
@ -224,8 +224,8 @@ Changes:
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#api-root-endpoint)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#api-root-endpoint)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#api-root-endpoint)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#api-root-endpoint)
|
||||
|
||||
Changes:
|
||||
|
||||
@ -245,7 +245,7 @@ Changes:
|
||||
// Old
|
||||
{
|
||||
"_links": {
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html",
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html",
|
||||
"self": "http://example.com:9984/api/v1/",
|
||||
"statuses": "http://example.com:9984/api/v1/statuses/",
|
||||
"streams_v1": "ws://example.com:9985/api/v1/streams/valid_tx",
|
||||
@ -255,7 +255,7 @@ Changes:
|
||||
|
||||
// New
|
||||
{
|
||||
"docs": "https://docs.bigchaindb.com/projects/server/en/v0.11.0.dev/http-client-server-api.html",
|
||||
"docs": "https://docs.planetmint.com/projects/server/en/v0.11.0.dev/http-client-server-api.html",
|
||||
"statuses": "/api/v1/statuses/",
|
||||
"streams": "ws://example.com:9985/api/v1/streams/valid_transactions",
|
||||
"transactions": "/api/v1/transactions/",
|
||||
@ -269,8 +269,8 @@ Changes:
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-transactions-tx_id)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-transactions-transaction_id)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-transactions-tx_id)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-transactions-transaction_id)
|
||||
|
||||
|
||||
Changes:
|
||||
@ -284,8 +284,8 @@ only return transactions included in blocks marked as `VALID`.
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#post--api-v1-transactions)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#post--api-v1-transactions)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#post--api-v1-transactions)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#post--api-v1-transactions)
|
||||
|
||||
|
||||
Changes:
|
||||
@ -299,8 +299,8 @@ Changes:
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-outputs?public_key=public_key)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-outputs?public_key=public_key)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-outputs?public_key=public_key)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-outputs?public_key=public_key)
|
||||
|
||||
|
||||
Changes:
|
||||
@ -334,17 +334,17 @@ transations' outputs:
|
||||
```
|
||||
|
||||
In the future, we're planning to [upgrade this endpoint
|
||||
further](https://github.com/bigchaindb/bigchaindb/blob/99499b1f8783719a082813912ac9a0d363ae278f/bdb-ip.md#6-a-new-outputs-endpoint)
|
||||
further](https://github.com/planetmint/planetmint/blob/99499b1f8783719a082813912ac9a0d363ae278f/bdb-ip.md#6-a-new-outputs-endpoint)
|
||||
to meet the requirements of [our
|
||||
users](https://github.com/bigchaindb/bigchaindb/issues/1227#issuecomment-307297473).
|
||||
users](https://github.com/planetmint/planetmint/issues/1227#issuecomment-307297473).
|
||||
|
||||
|
||||
### `GET /api/v1/statuses?tx_id`
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-statuses?tx_id=tx_id)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-statuses?transaction_id=transaction_id)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-statuses?tx_id=tx_id)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-statuses?transaction_id=transaction_id)
|
||||
|
||||
|
||||
Changes:
|
||||
@ -377,8 +377,8 @@ Changes:
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-statuses?block_id=block_id)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-statuses?block_id=block_id)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-statuses?block_id=block_id)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-statuses?block_id=block_id)
|
||||
|
||||
|
||||
Changes:
|
||||
@ -407,8 +407,8 @@ Changes:
|
||||
|
||||
Documentation:
|
||||
|
||||
- [Old](https://docs.bigchaindb.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-blocks?tx_id=tx_id&status=UNDECIDED|VALID|INVALID)
|
||||
- [New](https://docs.bigchaindb.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-blocks?transaction_id=transaction_id&status=UNDECIDED|VALID|INVALID)
|
||||
- [Old](https://docs.planetmint.com/projects/server/en/v0.10.2/http-client-server-api.html#get--api-v1-blocks?tx_id=tx_id&status=UNDECIDED|VALID|INVALID)
|
||||
- [New](https://docs.planetmint.com/projects/server/en/v1.0.0/http-client-server-api.html#get--api-v1-blocks?transaction_id=transaction_id&status=UNDECIDED|VALID|INVALID)
|
||||
|
||||
|
||||
Changes:
|
||||
|
||||
@ -70,28 +70,28 @@ data:
|
||||
openresty-backend-port: "8080"
|
||||
|
||||
# Planetmint configuration parameters
|
||||
# Refer https://docs.bigchaindb.com/projects/server/en/latest/server-reference/configuration.html
|
||||
# Refer https://docs.planetmint.com/projects/server/en/latest/server-reference/configuration.html
|
||||
|
||||
# bigchaindb-api-port is the port number on which Planetmint is listening
|
||||
# planetmint-api-port is the port number on which Planetmint is listening
|
||||
# for HTTP requests.
|
||||
bigchaindb-api-port: "9984"
|
||||
planetmint-api-port: "9984"
|
||||
|
||||
# bigchaindb-server-bind is the socket where Planetmint binds for API
|
||||
# planetmint-server-bind is the socket where Planetmint binds for API
|
||||
# requests.
|
||||
bigchaindb-server-bind: "0.0.0.0:9984"
|
||||
planetmint-server-bind: "0.0.0.0:9984"
|
||||
|
||||
# bigchaindb-ws-port and bigchaindb-ws-interface form the socket where
|
||||
# planetmint-ws-port and planetmint-ws-interface form the socket where
|
||||
# Planetmint binds for Websocket connections.
|
||||
bigchaindb-ws-port: "9985"
|
||||
bigchaindb-ws-interface: "0.0.0.0"
|
||||
planetmint-ws-port: "9985"
|
||||
planetmint-ws-interface: "0.0.0.0"
|
||||
|
||||
# bigchaindb-database-name is the database collection used by Planetmint with
|
||||
# planetmint-database-name is the database collection used by Planetmint with
|
||||
# the MongoDB backend.
|
||||
bigchaindb-database-name: "bigchain"
|
||||
planetmint-database-name: "bigchain"
|
||||
|
||||
# bigchaindb-wsserver-advertised-scheme is the protocol used to access the
|
||||
# planetmint-wsserver-advertised-scheme is the protocol used to access the
|
||||
# WebSocket API in Planetmint; can be 'ws' or 'wss' (default).
|
||||
bigchaindb-wsserver-advertised-scheme: "wss"
|
||||
planetmint-wsserver-advertised-scheme: "wss"
|
||||
|
||||
# Optional: Optimize storage engine(wired tiger)
|
||||
# cache size. e.g. (2048MB, 2GB, 1TB), otherwise
|
||||
@ -111,18 +111,18 @@ data:
|
||||
# Planetmint instance authentication user name
|
||||
bdb-user: "<user name>"
|
||||
|
||||
# bigchaindb-database-maxtries is the maximum number of times that Planetmint
|
||||
# planetmint-database-maxtries is the maximum number of times that Planetmint
|
||||
# will try to establish a connection with the database backend.
|
||||
# If it is set to 0, then it will try forever.
|
||||
bigchaindb-database-maxtries: "3"
|
||||
planetmint-database-maxtries: "3"
|
||||
|
||||
# bigchaindb-database-connection-timeout is the maximum number of
|
||||
# planetmint-database-connection-timeout is the maximum number of
|
||||
# milliseconds that Planetmint will wait before closing the connection while
|
||||
# connecting to the database backend.
|
||||
bigchaindb-database-connection-timeout: "5000"
|
||||
planetmint-database-connection-timeout: "5000"
|
||||
|
||||
# bigchaindb-log-level is the log level used to log to the console.
|
||||
bigchaindb-log-level: "debug"
|
||||
# planetmint-log-level is the log level used to log to the console.
|
||||
planetmint-log-level: "debug"
|
||||
|
||||
---
|
||||
apiVersion: v1
|
||||
|
||||
@ -38,8 +38,8 @@ spec:
|
||||
spec:
|
||||
terminationGracePeriodSeconds: 10
|
||||
containers:
|
||||
- name: bigchaindb
|
||||
image: bigchaindb/bigchaindb:2.2.2
|
||||
- name: planetmint
|
||||
image: planetmint/planetmint:2.2.2
|
||||
imagePullPolicy: Always
|
||||
args:
|
||||
- start
|
||||
|
||||
@ -45,7 +45,7 @@ spec:
|
||||
terminationGracePeriodSeconds: 10
|
||||
containers:
|
||||
- name: nginx-http
|
||||
image: bigchaindb/nginx_http:1.0
|
||||
image: planetmint/nginx_http:1.0
|
||||
imagePullPolicy: Always
|
||||
env:
|
||||
- name: CLUSTER_FRONTEND_PORT
|
||||
|
||||
@ -60,7 +60,7 @@ spec:
|
||||
terminationGracePeriodSeconds: 10
|
||||
containers:
|
||||
- name: nginx-https
|
||||
image: bigchaindb/nginx_https:1.0
|
||||
image: planetmint/nginx_https:1.0
|
||||
imagePullPolicy: Always
|
||||
env:
|
||||
- name: CLUSTER_FRONTEND_PORT
|
||||
|
||||
@ -49,7 +49,7 @@ spec:
|
||||
terminationGracePeriodSeconds: 10
|
||||
containers:
|
||||
- name: nginx-openresty
|
||||
image: bigchaindb/nginx_3scale:2.0
|
||||
image: planetmint/nginx_3scale:2.0
|
||||
imagePullPolicy: Always
|
||||
env:
|
||||
- name: DNS_SERVER
|
||||
|
||||
@ -10,7 +10,7 @@ To get the relevant NGINX logs:
|
||||
2. Create a new Log Search
|
||||
3. Use a search string such as:
|
||||
|
||||
Type=ContainerLog Image="bigchaindb/nginx_3scale:1.3" GET NOT("Go-http-client") NOT(runscope)
|
||||
Type=ContainerLog Image="planetmint/nginx_3scale:1.3" GET NOT("Go-http-client") NOT(runscope)
|
||||
|
||||
(This gets all logs from the NGINX container, only those with the word "GET",
|
||||
excluding those with the string "Go-http-client" [internal Kubernetes traffic],
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
# Dockerfile for MongoDB Monitoring Agent
|
||||
# Use it to create bigchaindb/mongodb-monitoring-agent
|
||||
# Use it to create planetmint/mongodb-monitoring-agent
|
||||
# on Docker Hub.
|
||||
|
||||
# "Never install the Monitoring Agent on the same server as a data bearing mongod instance."
|
||||
|
||||
@ -5,6 +5,6 @@
|
||||
# Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
|
||||
docker build -t bigchaindb/mongodb-monitoring-agent:2.2.2 .
|
||||
docker build -t planetmint/mongodb-monitoring-agent:2.2.2 .
|
||||
|
||||
docker push bigchaindb/mongodb-monitoring-agent:2.2.2
|
||||
docker push planetmint/mongodb-monitoring-agent:2.2.2
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
|
||||
############################################################
|
||||
# This config file defines a k8s Deployment for the #
|
||||
# bigchaindb/mongodb-monitoring-agent Docker image #
|
||||
# planetmint/mongodb-monitoring-agent Docker image #
|
||||
# #
|
||||
# It connects to a MongoDB instance in a separate pod, #
|
||||
# all remote MongoDB instances in the cluster, #
|
||||
@ -29,7 +29,7 @@ spec:
|
||||
terminationGracePeriodSeconds: 10
|
||||
containers:
|
||||
- name: mdb-mon
|
||||
image: bigchaindb/mongodb-monitoring-agent:2.2.2
|
||||
image: planetmint/mongodb-monitoring-agent:2.2.2
|
||||
imagePullPolicy: IfNotPresent
|
||||
env:
|
||||
- name: MMS_API_KEYFILE_PATH
|
||||
|
||||
@ -25,7 +25,7 @@ docker run \
|
||||
--volume=<host dir for mongodb data files>:/data/db \
|
||||
--volume=<host dir for mongodb config data files>:/data/configdb \
|
||||
--volume=<host dir with the required TLS certificates>:/mongo-ssl:ro \
|
||||
bigchaindb/mongodb:<version of container> \
|
||||
planetmint/mongodb:<version of container> \
|
||||
--mongodb-port <mongod port number for external connections> \
|
||||
--mongodb-key-file-path /mongo-ssl/<private key file name>.pem \
|
||||
--mongodb-ca-file-path /mongo-ssl/<ca certificate file name>.crt \
|
||||
|
||||
@ -5,5 +5,5 @@
|
||||
# Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
|
||||
docker build -t bigchaindb/localmongodb:2.2.2 .
|
||||
docker push bigchaindb/localmongodb:2.2.2
|
||||
docker build -t planetmint/localmongodb:2.2.2 .
|
||||
docker push planetmint/localmongodb:2.2.2
|
||||
|
||||
@ -26,7 +26,7 @@ spec:
|
||||
terminationGracePeriodSeconds: 10
|
||||
containers:
|
||||
- name: mongodb
|
||||
image: bigchaindb/localmongodb:2.2.2
|
||||
image: planetmint/localmongodb:2.2.2
|
||||
imagePullPolicy: Always
|
||||
env:
|
||||
- name: MONGODB_FQDN
|
||||
|
||||
@ -5,6 +5,6 @@
|
||||
# Code is Apache-2.0 and docs are CC-BY-4.0
|
||||
|
||||
|
||||
docker build -t bigchaindb/nginx_http:2.2.2
|
||||
docker build -t planetmint/nginx_http:2.2.2
|
||||
|
||||
docker push bigchaindb/nginx_http:2.2.2
|
||||
docker push planetmint/nginx_http:2.2.2
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user