Deployment: Document for Node Admins

[ashcherbakov]

Acceptance Criteria:

• The goal of that ticket is to provide basic documentations touching all important points that node admins should be aware of at the beginning. The documents will be finalized and extended in the scope of Deployment: Finalize documentation #223.
• Extend existing how-to documents to run a node by the must-have configs and options defined in Deployment: Design and recommendation for production deployment #100 and Deployment: IaC - Design #246:
  • Configuration for Validators, Sentries and Observers (https://docs.tendermint.com/master/nodes/validators.html#validator-node-configuration). Sentries and Observers are considered the same here.
  • TLS setup and guidelines
  • Trusted link between nodes
  • Mention TMKMS and HSM
  • Mention Health&Monitoring
  • Describe default config parameters to be changed/adjusted
  • HSM for Account keys
• Consider extending or improving existing documentation
  • https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/docs/running-node.md
  • https://github.com/zigbee-alliance/distributed-compliance-ledger/tree/master/docs/advanced
• Consider creation an easy-to-follow step-by-step guideline.
• The document will be used by Node Admins
• The document may reference helper scripts (existing ones and ones defined in the scope of Deployment: IaC - Ansible #220, Deployment: Health&Monitoring  #221, Deployment: IaC - Terraform #222).
• Must reference all scripts and IaC created in the scope of Deployment: IaC - Ansible #220, Deployment: Health&Monitoring  #221, Deployment: IaC - Terraform #222.
• Include docs about Health & Monitoring

[ashcherbakov]

I think we can have the following documents.

The main goal is to structure the docs in two dimensions:

1. Architecture use cases:
   • genesis-vn + optional sentry + optional on
   • vn + optional sentry + optional on
   • on-only
2. Technical options
   • manual (with run_dcl_node sub-option)
   • ansible
   • aws+terraform+ansible

Add new docs

/docs/running-node.md
docs/launch-ceremony

/doc/running-node-manual/prerequisites
/doc/running-node-manual/full-node
/doc/running-node-manual/genesis-vn
/doc/running-node-manual/vn
/doc/running-node-manual/sentry
/doc/running-node-manual/on

/doc/running-node-aws-terraform-ansible/prerequsites
/doc/running-node-aws-terraform-ansible/deployment

/doc/running-node-ansible/prerequsites
/doc/running-node-ansible/genesis-vn
/doc/running-node-ansible/sentry
/doc/running-node-ansible/on

• docs/running-node.md
• /doc/running-node-manual
  • combine existing running-node and and running-xxx-node from advanced folder
  • keep the run_dcl_node script for now
  • for the steps that are covered by run_dcl_node do the following: make them as one section, and mention that these steps can be done either manually (as described in advanced docs), or by using a run_dcl_node script
• docs/launch-ceremony
  • basically the same as test net launch doc, but node configuration should point to a running-node doc (to not copy the same steps again). This doc is rather an orchestration for multiple participants.

All technical docs should have the following structure:
-Easy-to-follow steps

• every step should provide a command that can be easily copy-pasted
• every step should be started with a generic version of a command
• then it should contain a specific version of the command for every production net (Test Net for now)
• The steps should consider the case of adding a node to an existing network. State sync is the recommended option, but mention other options from the running-node-in-existing-network.md.

Move docs

• running-node-in-existing-network.md - move to advanced

Remove docs

• advanced/running-xxx-node
• deployment/persistent_chains/testnet-2.0/ - they will be covered by new running node docs. Do not remove it right now, but probably later.

Modify docs

• docs/running-node.md
  • modify existing document to be an index for other running-node documents (options)
• README to point to the correct docs and mention IaC
• how-to.md
  • in particular, https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/docs/how-to.md#node-admin-instructions-setting-up-a-new-validator-node section to point to the correct docs
• https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/deployment/README.md
• https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/deployment/ansible/README.md