(archive) Node.Void release plan

Newer version available

New version available as of 5 March 2018. See current document node - 0.1.3 release plan.

Goals:

Create the Node Application Layer and support for metrics collection

Done when:

  • Node Application layer is in place
  • The node can perform some basic operations pertaining to Node management
  • Bootstrap node (master node) collects metrics about nodes in the network
  • 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
  • Version #0.2

In more detail:

  • Node Application 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
  • Stretch goal: centralized metrics aggregation:
    • Metrics aggregated up to a central location (on rchain.me domain, probably)
    • Nodes either push automatically to a known place or they register themselves as available for scraping
  • 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
    • Stretch goal- tarball with runnable script and all JAVA dependencies, but not JVM 
      • Note: if this doesn't fall out of work with sbt magic then we won't do it

Out of Scope:

  • Integration with the interpreter
  • Any functionality pertaining to blockchain, incl. history in the storage layer
  • Cryptography library
  • System processes in the storage layer
  • Foreign function interface
ProjectRChain wiki
Dev LeadChris Kirkwood-Watts
Program LeadMedha Parlikar (Unlicensed)
MarketingLawrence Lerner
Status

IN PROGRESS

Start Date 
Completion DateMarch 15, 2018

Dates to Note:

MilestoneDateNotes
Sprint 3 ends
 

Sprint 4 ends
 
Development done
Release from Development
 
Merge to master, build packages
Membership Demo
 

Launch
 
Public announcement

Tickets:

key summary assignee status
Loading...
Refresh

Launch Readiness

Development

DescriptionResponsibleStatus/AnswerGo/No Go
Are we Code CompleteDev Leadtypically Yes or no
Are all issues / tasks in the project marked as complete?Program Leadtypically Yes or No, review issue list and obtain statuses on all items.
What is the test programDev/Test LeadDescribe the testing program (Create a page as part of this release for the testing program if needed)
  • Does the code build automatically?
  • Is the code in Source Control?
  • Have we merged to Master?
Dev LeadCode needs to be in GitHub and under Continuous Integration.
Are there any known issues or limitations with the product?Dev LeadIf yes, describe where the issues are documented
Are any of the issues potential blockers?Dev LeadIf needed, review the open issues for the version in question. If issues exist, plan to fix or document. Reschedule the launch if needed.
How is the release packaged and installed?Dev LeadDescribe how the release will be delivered to customers, how customers will install the package. (Maybe this needs to be a requirement specified up front.)
Have we shown the release to the membership?Program LeadPre-release demo of the release should be given to the membership

Have we documented the release?

  • Are there installation Instructions?
  • User Guide?
  • Tutorials?
  • Technical / API documentation?
Dev Lead/ Program LeadDescribe the technical documentation that will be delivered as part of the release.
Link to file issuesProgram ManagerHow will bugs against the release be tracked. Provide a link to file issues here. Also provide a link to query issues against the release here.


Customer Facing Teams

DescriptionResponsibleStatus / AnswerGo / No Go
What is the Marketing PlanMarketingProvide a link to the marketing program, and indicate if all items are complete.
What is the Support ProgramProgram LeadDescribe how users will obtain support for the product. How will the support program be staffed, what is the SLA for support.
Documentation ProgramProgram LeadDescribe the external documentation plan. Provide a link if needed. How will the technical documentation be exposed to users. What format will the documentation take.
MetricsProgram Lead

Describe how the success of the release will be measured. What are the KPI's - these should map back to the goals of the release. How will the KPI's be collected and published.


LicensingProgram LeadWhat license is the release licensed under?