Mirroristas/planetmint
2
0
Fork 0
mirror of https://github.com/planetmint/planetmint.git synced 2026-02-27 13:23:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removing some more remnants of bigchaindb

Browse Source
This commit is contained in:
Sangat Das
2022-01-20 08:13:25 +00:00
parent e5489c95d2
commit 24f34f01cb
206 changed files with 1381 additions and 1381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-ansible.md
View File

@@ -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).

22
docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-dev-network-stack.md
View File

@@ -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

6
docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-as-processes.md
View File

@@ -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.

14
docs/root/source/contributing/dev-setup-coding-and-contribution-process/run-node-with-docker-compose.md
View File

@@ -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

6
docs/root/source/contributing/dev-setup-coding-and-contribution-process/write-code.rst
View File

@@ -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: