Networks & Federations¶
There are several ways to setup a network. You can use the Kubernetes deployment template in this section, or use the Ansible solution in the Contributing section. Also, you can setup a single node on your machine and connect to an existing network.
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.
Consortium Structure & Governance¶
The consortium might be a company, a foundation, a cooperative, or some other form of organization. It must make many decisions, e.g. How will new members be added? Who can read the stored data? What kind of data will be stored? A governance process is required to make those decisions, and therefore one of the first steps for any new consortium is to specify its governance process (if one doesn’t already exist). 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 and node diversity.
DNS Records and SSL Certificates¶
We now describe how we set up the external (public-facing) DNS records for a Planetmint network. Your consortium may opt to do it differently. There were several goals:
Allow external users/clients to connect directly to any Planetmint node in the network (over the internet), if they want.
Each Planetmint node operator should get an SSL certificate for their Planetmint node, so that their Planetmint node can serve the Planetmint HTTP API via HTTPS. (The same certificate might also be used to serve the WebSocket API.)
There should be no sharing of SSL certificates among Planetmint node operators.
Optional: Allow clients to connect to a “random” Planetmint node in the network at one particular domain (or subdomain).
Node Operator Responsibilities¶
Register a domain (or use one that you already have) for your Planetmint node. You can use a subdomain if you like. For example, you might opt to use
Get an SSL certificate for your domain or subdomain, and properly install it in your node (e.g. in your NGINX instance).
Create a DNS A Record mapping your domain or subdomain to the public IP address of your node (i.e. the one that serves the Planetmint HTTP API).
Optional: The consortium managing the Planetmint network could register a domain name and set up CNAME records mapping that domain name (or one of its subdomains) to each of the nodes in the network. For example, if the consortium registered
bdbnetwork.io, they could set up CNAME records like the following:
CNAME record mapping
CNAME record mapping
CNAME record mapping
How to Set Up a Planetmint Network¶
You can setup or connect to a network once you have a single node running. Until now, everything could be done by a node operator, by themselves. Now the node operators, also called Members, must share some information with each other, so they can form a network.
There is one special Member who helps coordinate everyone: the Coordinator.
Member: Connect to the Other Members¶
At this point the Member should have received the
The Member must copy the
into their local
Every Member now shares the same
genesis_time (used to identify the Network),
and the same list of
Each Member must edit their
and make the following changes:
moniker = "Name of our node" create_empty_blocks = false log_level = "main:info,state:info,*:error" persistent_peers = "<Member 1 node id>@<Member 1 hostname>:26656,\ <Member 2 node id>@<Member 2 hostname>:26656,\ <Member N node id>@<Member N hostname>:26656," send_rate = 102400000 recv_rate = 102400000 recheck = false
Note: The list of
persistent_peers doesn’t have to include all nodes
in the network.
Member: Start Tarantool¶
You install Tarantool as described here.
You can start it using the command
tarantool.To run it in the background (so it will continue running after you logout), you can have to create a listener
Member: Start Planetmint and Tendermint Using Monit¶
This section describes how to manage the Planetmint and Tendermint processes using Monit, a small open-source utility for managing and monitoring Unix processes. Planetmint and Tendermint are managed together, because if Planetmint is stopped (or crashes) and is restarted, Tendermint won’t try reconnecting to it. (That’s not a bug. It’s just how Tendermint works.)
sudo apt install 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:
Run Monit as a daemon, instructing it to wake up every second to check on processes:
monit -d 1
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
By default, it will collect program logs into the
To learn more about Monit, use
monit -h (help) or read the Monit documentation.
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 planetmint/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
http://hostname:9984. That is, anyone can interact with your node using the Planetmint HTTP API exposed at that address. The most common way to do that is to use one of the Planetmint Drivers.
Kubernetes Deployment Template¶
A highly-available Kubernetes cluster requires at least five virtual machines (three for the master and two for your app’s containers). Therefore we don’t recommend using Kubernetes to run a Planetmint node if that’s the only thing the Kubernetes cluster will be running. Instead, see our Node Setup. If your organization already has a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful.
This section outlines a way to deploy a Planetmint node (or Planetmint network) on Microsoft Azure using Kubernetes. You may choose to use it as a template or reference for your own deployment, but we make no claim that it is suitable for your purposes. Feel free change things to suit your needs or preferences.