mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-08 14:21:14 +00:00
lint: add markdown linter (#5254)
This commit is contained in:
@@ -16,14 +16,14 @@ Tendermint has some tools that are associated with it for:
|
||||
|
||||
## Benchmarking
|
||||
|
||||
- https://github.com/informalsystems/tm-load-test
|
||||
- <https://github.com/informalsystems/tm-load-test>
|
||||
|
||||
`tm-load-test` is a distributed load testing tool (and framework) for load
|
||||
testing Tendermint networks.
|
||||
|
||||
## Testnets
|
||||
|
||||
- https://github.com/informalsystems/testnets
|
||||
- <https://github.com/informalsystems/testnets>
|
||||
|
||||
This repository contains various different configurations of test networks for,
|
||||
and relating to, Tendermint.
|
||||
|
||||
@@ -16,7 +16,7 @@ tendermint debug kill <pid> </path/to/out.zip> --home=</path/to/app.d>
|
||||
will write debug info into a compressed archive. The archive will contain the
|
||||
following:
|
||||
|
||||
```
|
||||
```sh
|
||||
├── config.toml
|
||||
├── consensus_state.json
|
||||
├── net_info.json
|
||||
@@ -29,7 +29,7 @@ Under the hood, `debug kill` fetches info from `/status`, `/net_info`, and
|
||||
`/dump_consensus_state` HTTP endpoints, and kills the process with `-6`, which
|
||||
catches the go-routine dump.
|
||||
|
||||
## tendermint debug dump
|
||||
## Tendermint debug dump
|
||||
|
||||
Also, the `debug dump` sub-command allows you to dump debugging data into
|
||||
compressed archives at a regular interval. These archives contain the goroutine
|
||||
@@ -44,7 +44,7 @@ will perform similarly to `kill` except it only polls the node and
|
||||
dumps debugging data every frequency seconds to a compressed archive under a
|
||||
given destination directory. Each archive will contain:
|
||||
|
||||
```
|
||||
```sh
|
||||
├── consensus_state.json
|
||||
├── goroutine.out
|
||||
├── heap.out
|
||||
|
||||
@@ -21,10 +21,12 @@ When executed, `tm-signer-harness`:
|
||||
error.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Requires the same prerequisites as for building
|
||||
[Tendermint](https://github.com/tendermint/tendermint).
|
||||
|
||||
## Building
|
||||
|
||||
From the `tools/tm-signer-harness` directory in your Tendermint source
|
||||
repository, simply run:
|
||||
|
||||
@@ -36,6 +38,7 @@ make install
|
||||
```
|
||||
|
||||
## Docker Image
|
||||
|
||||
To build a Docker image containing the `tm-signer-harness`, also from the
|
||||
`tools/tm-signer-harness` directory of your Tendermint source repo, simply run:
|
||||
|
||||
@@ -44,6 +47,7 @@ make docker-image
|
||||
```
|
||||
|
||||
## Running against KMS
|
||||
|
||||
As an example of how to use `tm-signer-harness`, the following instructions show
|
||||
you how to execute its tests against [KMS](https://github.com/tendermint/kms).
|
||||
For this example, we will make use of the **software signing module in KMS**, as
|
||||
@@ -51,6 +55,7 @@ the hardware signing module requires a physical
|
||||
[YubiHSM](https://www.yubico.com/products/yubihsm/) device.
|
||||
|
||||
### Step 1: Install KMS on your local machine
|
||||
|
||||
See the [KMS repo](https://github.com/tendermint/kms) for details on how to set
|
||||
KMS up on your local machine.
|
||||
|
||||
@@ -62,6 +67,7 @@ cargo install tmkms
|
||||
```
|
||||
|
||||
### Step 2: Make keys for KMS
|
||||
|
||||
The KMS software signing module needs a key with which to sign messages. In our
|
||||
example, we will simply export a signing key from our local Tendermint instance.
|
||||
|
||||
@@ -85,6 +91,7 @@ tmkms keygen secret_connection.key
|
||||
```
|
||||
|
||||
### Step 3: Configure and run KMS
|
||||
|
||||
KMS needs some configuration to tell it to use the softer signing module as well
|
||||
as the `signing.key` file we just generated. Save the following to a file called
|
||||
`tmkms.toml`:
|
||||
@@ -111,6 +118,7 @@ This will start KMS, which will repeatedly try to connect to
|
||||
`tcp://127.0.0.1:61219` until it is successful.
|
||||
|
||||
### Step 4: Run tm-signer-harness
|
||||
|
||||
Now we get to run the signer test harness:
|
||||
|
||||
```bash
|
||||
@@ -124,10 +132,12 @@ should now exit with a 0 exit code. If they are somehow not compatible, it
|
||||
should exit with a meaningful non-zero exit code (see the exit codes below).
|
||||
|
||||
### Step 5: Shut down KMS
|
||||
|
||||
Simply hit Ctrl+Break on your KMS instance (or use the `kill` command in Linux)
|
||||
to terminate it gracefully.
|
||||
|
||||
## Exit Code Meanings
|
||||
|
||||
The following list shows the various exit codes from `tm-signer-harness` and
|
||||
their meanings:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user