Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 5.89 KB

challenge005.md

File metadata and controls

77 lines (53 loc) · 5.89 KB
Raw

Stake Wars Challenge 005

Published on: July 17 2020

Automatically deploy nearcore using a CI/CD pipeline. This challenge is designed to have validators build and deploy their own node from the source code, instead of using the precompiled binaries provided by NEAR. The result is having multiple teams that can independently build and test new releases of the node, to improve the quality and security of the network as a whole.

To participate, validators will be asked to build and deploy a specific branch/tag of nearcore, and keeping their nodes up to date.

If you already run a professional validator setup, and you have CI/CD experience, you don't need any further instructions.

If you want to test yourself and use this as a learning opportunity, the list of available tools to accomplish can be very long:

  • Jenkins
  • Terraform
  • Gitlab
  • Github Actions
  • Cloud provider tools (Google Cloud Build, Azure Pipelines, AWS CodePipeline...)

You may want to read this article if you need some basic knowledge on CI/CD.

Acceptance Criteria

  1. Build nearcore
  2. Run tests
  3. Deploy the node

1.Build nearcore

Subscribe to Nearcore releases, and automatically build the artifact from the source code as soon as there's a new version of the node. Every release is tagged as follows:

  • BetaNet releases of nearcore will be mapped with the tag x.y.z-beta
  • TestNet releases of nearcore will be mapped with the tag x.y.z-rc

More information is available in the official documentation, in the contribution section and in the develop section

2.Run tests

Once your artifact is deployed, you may want to test its networking functionality and existing applications. Some examples can be found in nearcore scripts

Some examples are:

  • deploy multiple nodes in localnet mode (an example is in the nearup repo) and test the capacity to connect and synchronize with the network
  • attach your own local services (helper, wallet, explorer)
  • send transactions, deploy/call/view smart contracts
  • execute load tests and measure the performance

The outcomes of these tests will help you decide if you want to deploy this release or not. NEAR will take in serious consideration the feedback of validators who setup their own suite of tests and find bugs or errors in new releases.

3.Deploy the node

With the merge of nearcore PR #2701, NEAR Protocol can run different builds of the node within the same network. You can then decide which deployment stragy adopt (e.g. Blue/Green or a Canary) and merge the node keys from the previous release to the newer one.

This process may require intermediate steps, such as database migration or state resync (by deleting the ~/.near/betanet/data folder).

Additional considerations

In the upcoming weeks we will introduce special builds, with tags specifically for Stake Wars Challenge 005 participants. We will measure the reactivity of valdiators to newer releases, and the capacity to identify bugs or test failures prior to the node deployment.

Contribution Opportunities

Do you want to earn extra tokens? We have contribution opportunities available below!

Follow the Validator channel on NEAR Portal, you will find a list of available contributions to earn tokens. In order to participate, you will have to specify:

  • the title of the contribution you made
  • the type of document you released
  • a clear reference to the available contribution below

Once your work is reviewed, you will be added to the list below. Please note that rewards in tokens will need to pass basic KYC checks from NEAR Foundation, and comply with regulations.

Heads up: If you can't see/write in the Validator Portal, be sure that you filled up the Challenge 004 contact form, so we can send you an invitation email.

List of available contributions

Title Abstract Contributor Date Link NEAR Tokens Maintenance Language
Release a CI Pipeline doc Create an article or a commented Github script to explain and execute an automated building and testing of a new release of nearcore. Before starting the project request approval in the NEAR portal. masknetgoal634 August 5 2020 Github Actions 3,500 15% EN
Release a CI Pipeline doc Same as above @abellinii August 6 2020 Github 3,500 15% EN
Release a CD Pipeline doc Create an article and a Github document/script to explain and execute an automated deployment of a new release of nearcore. Before starting the project request approval in the NEAR portal. @abellinii Jul 29 2020 Terraform 3,000 15% EN
Release a CD Pipeline doc Same as the above masknetgoal634 August 5 2020 Github Actions 3,000 15% EN
Write a localnet tutorial Create a tutorial on how to automatically deploy and boot your own NEAR network, using it to test a new release of nearcore. @abellinii August 6 2020 Medium 1,500 10% EN

Previous Challenge

Create your warchest to dynamically keep one seat: challenge004