mkchain
Helper program to generate values for the Tezos chain Helm chart
Prerequisites
To run mkchain, you must either have docker or pytezos installed.
Installing Docker
To be consistent with other documentation in this project, we describe how to install docker with minikube. We need to install:
- [docker](https://docs.docker.com/get-docker/),
- [minikube](https://minikube.sigs.k8s.io/docs/),
- [helm](https://helm.sh/),
- and `python3`.
Start minikube and configure your shell environment to use minikube's Docker daemon:
minikube start
eval $(minikube docker-env)
Installing pytezos
This is documented at: https://pytezos.org/quick_start.html#requirements
Install mkchain
mkdir mkchain && cd mkchain
python3 -m venv .venv
. .venv/bin/activate
pip install wheel && pip install mkchain
Set unbuffered IO for python:
export PYTHONUNBUFFERED=x
Generate Helm Values
Set as an environment variable the name you would like to give to your chain:
export CHAIN_NAME=my-chain
Your chain is uniquely defined by a set of values such as bootstrap account keys, chain id, timestamp...
To generate these values run:
mkchain $CHAIN_NAME
This command will create a yaml file in your current working directory: <$CHAIN_NAME>_values.yaml
mkchain parameters
You can explicitly specify some values by:
- passing CLI parameters to
mkchain - directly modifying the values yaml file generated by
mkchain - passing arguments to helm install or helm upgrade commands using the
--setflag, which will selectively override the current yaml values
| YAML Key | mkchain argument | Description | Default |
|---|---|---|---|
| -h | mkchain help message | ||
| -v | mkchain version | ||
| --number-of-bakers | Number of baking nodes in the cluster | 1 | |
| --number-of-nodes | Number of non-baking nodes in the cluster | 0 | |
| bootstrap_peers | --bootstrap-peers | Peer ips to connect to | [] |
| expected_proof_of_work | --expected-proof-of-work | Node identity generation difficulty | 0 |
| images.octez | --octez-docker-image | Version of the Octez docker image to run | tezos/tezos:v17.3 |
| --use-docker (--no...) | Use (or don't use) docker to generate keys rather than pytezos | autodetect |
Create Tezos Chain
Make sure you have the Tezos Helm chart repo:
helm repo add oxheadalpha https://oxheadalpha.github.io/tezos-helm-charts
Then install the Tezos Helm chart:
helm install $CHAIN_NAME oxheadalpha/tezos-chain \
--values ./${CHAIN_NAME}_values.yaml \
--namespace oxheadalpha --create-namespace
1 maintainer
Metadata
1 maintainer
Release files for mkchain 6.25.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkchain-6.25.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / mkchain-6.25.0-py3-none-any.whl
| Download URL | mkchain-6.25.0-py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
358509db12d7709aee42f9b6aacd6550a0d1f69c974253cbfab0d458892377b0
|
|
BLAKE2b-256 checksum How to use checksums |
45256de30f3c47a9bfde728e76a47df58177436f7f20932a135bea2e84a0b8f0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for mkchain 6.25.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
