mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-30 05:51:02 +00:00
Denis Pisarev
3c50838dc3
* change (CI): markdown link checker * Fix some invalid doc links (re-run of cargo-unleash gen-readme w/ fixes). * Fix some invalid doc links * Fix some invalid doc links * Fix some links * Fix some links * Apply @bkchr suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Fix more links * Fix more links * typo * Fix more links * Fix more links * Ignore valid link .. check wrongly sees it as invalid * Fix style issue * Fix style issue * change (CI): update style guide link * change (lib): suggestions Co-authored-by: Dan Forbes <dan@danforbes.dev> Co-authored-by: Steve Degosserie <steve@parity.io> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
<!-- markdown-link-check-disable -->
|
|
chaostest
|
|
=========
|
|
|
|
A cli for chaos testing on substrate
|
|
|
|
[](https://oclif.io)
|
|
[](https://npmjs.org/package/chaostest)
|
|
[](https://npmjs.org/package/chaostest)
|
|
|
|
<!-- toc -->
|
|
* [Usage](#usage)
|
|
* [Commands](#commands)
|
|
<!-- tocstop -->
|
|
# Usage
|
|
<!-- usage -->
|
|
```sh-session
|
|
$ npm install -g chaostest // yarn add global chaostest
|
|
$ chaostest COMMAND
|
|
running command...
|
|
$ chaostest (-v|--version|version)
|
|
chaostest/0.0.0 darwin-x64 node-v8.16.0
|
|
$ chaostest --help [COMMAND]
|
|
USAGE
|
|
$ chaostest COMMAND
|
|
...
|
|
```
|
|
<!-- usagestop -->
|
|
# Commands
|
|
<!-- commands -->
|
|
* [`chaostest spawn`](#chaostest-spawn)
|
|
* [`chaostest singlenodeheight`](#chaostest-singlenodeheight)
|
|
* [`chaostest clean`](#chaostest-clean)
|
|
|
|
## `chaostest spawn`
|
|
|
|
Spawn a testnet based on your local k8s configuration. Could be either a dev node, a two node alicebob chain or a customized chain with various validators/fullnodes.
|
|
|
|
```
|
|
USAGE
|
|
$ chaostest spawn [ARGUMENTS] [FLAGS]
|
|
|
|
Arguments
|
|
dev, a single fullnode in --dev mode
|
|
alicebob, a two nodes private chain with Alice as bootnode and Bob as validator
|
|
[chainName], a customized chain deployed with -v numbers of validators and -n numbers of fullnodes
|
|
|
|
Flags
|
|
--image, -i, the image tag of the certain substrate version you want to deploy
|
|
--port, -p, the port to expose when image is deployed in a pod
|
|
--namespace, the desired namespace to deploy on
|
|
--validator, -v, the number of substrate validators to deploy
|
|
--node, -n, the number of full nodes, if not set but exists, default to 1
|
|
|
|
DESCRIPTION
|
|
...
|
|
Extra documentation goes here
|
|
```
|
|
|
|
_See code: [src/commands/spawn/index.js](https://github.com/paritytech/substrate/blob/master/.maintain/chaostest/src/commands/spawn/index.js)_
|
|
|
|
## `chaostest singlenodeheight`
|
|
|
|
Test against a fullnode on --dev mode to check if it can successfully produce blocks to a certain height.
|
|
|
|
```
|
|
USAGE
|
|
$ chaostest singlenodeheight [FLAGS]
|
|
|
|
FLAGS
|
|
-h , the desired height of blocks to check if reachable, this only works with integers smaller than 2^6
|
|
-t, the wait time out before it halts the polling
|
|
```
|
|
|
|
_See code: [src/commands/singlenodeheight/index.js](https://github.com/paritytech/substrate/blob/master/.maintain/chaostest/src/commands/singlenodeheight/index.js)_
|
|
|
|
## `chaostest clean`
|
|
|
|
Clean up the k8s deployment by namespace.
|
|
|
|
```
|
|
USAGE
|
|
$ chaostest clean [FLAGS]
|
|
|
|
FLAGS
|
|
-n , the desired namespace to delete on your k8s cluster
|
|
```
|
|
|
|
_See code: [src/commands/clean/index.js](https://github.com/paritytech/substrate/blob/master/.maintain/chaostest/src/commands/clean/index.js)_
|
|
<!-- commandsstop -->
|