node - 0.1.3 release plan

Reference


Milestones

Development team

Development leadProgram managerProject managerDevOpsPage owner
Chris Kirkwood-WattsMedha Parlikar (Unlicensed)Kelly FosterJeremy BuskKelly Foster


Marketing team

Marketing leadEvangelistContent owner
Lawrence LernerTBDTBD



Release summary

Simple overview

The Node.Void release introduces the node API layer and support for node-level metrics collection.

Technical overview

  • Node API layer
    • The node API returns communication statuses when asked to do so
    • Supports JSON API
    • Documentation for JSON API
  • Basic Node management operations:
    • Metrics collectable using Prometheus
    • Metrics for a locally running node displayable using local Grafana instance
    • Documentation for how to access and display these local metrics
      • Document starting and stopping local metrics production via the JSON API
      • HOW-TO for standing up an aggregator and visualizer for viewing one node's metric data
  • Integration tests are in place for any dependencies.
  • Release includes:
    • Docker image
    • Debian package and installer guide
    • RPM package and installer guide
    • tar.gz
    • .zip file

Metric for tracking success

  • Node Application layer is in place
  • The node can perform some basic operations pertaining to Node management
  • Users can download a debian package & rpm package in addition to the Docker image.
  • Release a tar.gz and zip file for the source code

What is special about this release?

The Node.Void release includes two improvements to the Node.Hello release. Node.Hello included only the communications layer. Node.Void adds an API layer and tools for collecting and displaying metrics on node performance.

The Node.Void release also introduces installation using Debian and RPM packages, in addition to the Docker image.

Are we doing something differently? If so, why are we doing it this way?

Before these features were available, what were developers able to do with RChain?

Prior to the Node.Void release developers using Node.Hello were only able to install using a Docker image, bring up a node, and attach it to the public test net to connect with other peers in the network.

After these features launch, what will developers be able (and not able) to do with RChain?

The Node.Void release supports developers doing the following:

  • Bring up a node and attach it to the public test net
  • Connect a node to other peers in the network
  • (What can you do with the API?)
  • Start and stop metrics production via the JSON API
  • Display metrics 

Developers using the Node.Void cannot do any of the following:

  • Send a message of their choosing to other nodes.
  • Run Rholang contracts.

Description of release packaging

Node.Void release packaging will include:

  • Docker image and installer guide
  • Debian package and installer guide
  • RMP package and installer guide
  • .zip file
  • tar.gz file

Where do developers go to learn more and get started?

Links to installation packages and information on getting started with metrics is available at https://developer.rchain.coop.

Where will bugs be filed?

Developers can report bugs here.

Where do developers go for support? What is the SLA? Who is on point?

Developers can post questions to the RChain developer forum: https://forum.rchain.coop. This forum is monitored and developers can expect a response within 24 hours.

What license will this be released under?

The Docker image will be released under the GPL 2.0 License

Ask Chris Kirkwood-Watts if we intend on including the JRE environment in the rpm or debian.  If not, we can release under Apache 2.0, but Kelly Foster, we will need to document the JRE version that has been tested with the node.

JIRA issues in this release