clearmatics / init-ceremony

Autonity initial ceremony

⚠️ Archived ⚠️

Autonity initial ceremony was used as part of the workflow to generate genesis files on the fly during re-genesis events. This workflow is no longer used and this repository is ready for archive.

External Dependencies

• kube-apiserver v1.14.6

Usage:

usage: main.py [-h] [-k {pod,remote,non_k8s}]
               [--genesis-template PATH_GENESIS_TEMPLATE]
               [--genesis-cm CM_GENESIS] [--dns DNS_RESOLVERS]
               [--namespace NAMESPACE]

Resolve by fqdn:// records from genesis-template.json and write enode:// to genesis.json

optional arguments:
  -h, --help                               show this help message and exit
  -k {pod,remote,non_k8s}                  Type of connection to kube-apiserver: pod or remote (default: non_k8s)
  --genesis-template PATH_GENESIS_TEMPLATE Path to genesis template json file (default: /autonity/genesis-template.json)
  --genesis-cm CM_GENESIS                  Name for genesis ConfigMap (default: genesis)
  --dns DNS_RESOLVERS                      List of DNS resolvers (default: 1.1.1.1,8.8.8.8)
  --namespace NAMESPACE                    Kubernetes namespace.

Example records for one validator node

• FQDN in genesis.json:

  {
    "enode": "fqdn://validator1.example.com",
    "type": "validator",
    "stake": 50000
  }

• DNS records

  type	name	value	TTL
  A	validator1.example.com	203.0.113.1	1 min
  TXT	validator1.example.com	p=30303; k=ad840ab412c026b098291f5ab56f923214469c61d4a8be41334c9a00e2dc84a8ff9a5035b3683184ea79902436454a7a00e966de45ff46dbd118e426edd4b2d0	1 min

Docker usage

docker run -v $(pwd)/genesis-template.json:/autonity/genesis-template.json -ti --rm ghcr.io/clearmatics/init-ceremony \
  --genesis-template "/autonity/genesis-template.json" \
  --dns 1.1.1.1,8.8.8.8

init-ceremony's Issues

Mark repository ready for archive

Description

With recent Helm chart updates, this repository now legacy. The Bakerloo network currently still requires access to assets, so assets will be archived only once the Bakerloo network is running the latest Helm Chart. DevNet has already been covered.

Pre-requisites

• DevNet to run Helm chart >= 1.6.1
• Bakerloo to run Helm chart >= 1.6.1

Acceptance criteria

• Delete all GitHub Container Registry older style packages
• Delete all GitHub Packages
• Update Readme with archive status
• Notify Org owner to archive this repository

[GitHub Container Registry] Create init-ceremony image

Problem

As part of the migration from DockerHub to GitHub Container Registry, this issue will outline configuration steps needed for the move.

Implementation

This issue will outline configuration steps for the the container/settings section, extend GitHub Actions to direct the artefacts to the new registry and update any related documentations. The detailed steps can be found in the acceptance criteria below.

Acceptance Criteria

• Issue GitHub PAT from @clearmaticsrobot with r/w access to packages. Named: GitHub Actions init-ceremony
• Add to GitHub Secret CR_PAT
• Add to Dockerfile the label

  LABEL org.opencontainers.image.source https://github.com/clearmatics/autonity-init
  

• Pull, create new tag and push latest [needed for enabling the container service for this repository]

  docker pull clearmatics/init-ceremony:latest
  docker tag clearmatics/init-ceremony:latest ghcr.io/clearmatics/init-ceremony:latest
  docker push ghcr.io/clearmatics/init-ceremony:latest
  

• As the clearmaticsrobot user, set public access for container repository clearmatics/init-ceremony
• Create GitHub Action for building docker image
• Update other references which point to DockerHub to point to the new GHCR location
• The following versions exist in the new repository location: latest, v1.0.0

Future Steps

• Ensure pipelines are still functioning