From 2600684999991f5e1e9f746a8ab9290a3e2af731 Mon Sep 17 00:00:00 2001 From: Greg Fitzgerald Date: Tue, 6 Nov 2018 08:06:36 -0700 Subject: [PATCH] Move testnet docs into readme Also, described testnet and testnet-perf as stable instead of beta. --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++- doc/testnet.md | 52 --------------------------------------------- 2 files changed, 56 insertions(+), 53 deletions(-) delete mode 100644 doc/testnet.md diff --git a/README.md b/README.md index e233278486..211ee013c4 100644 --- a/README.md +++ b/README.md @@ -310,7 +310,7 @@ To emulate all the tests that will run on a Pull Request, run: $ ./ci/run-local.sh ``` -Debugging +Fullnode Debugging --- There are some useful debug messages in the code, you can enable them on a per-module and per-level @@ -337,6 +337,60 @@ thread apply all bt This will dump all the threads stack traces into gdb.txt + +Testnet Debugging +--- + +We maintain several testnets: + +* `testnet` - public stable channel testnet accessible via testnet.solana.com. Runs 24/7 +* `testnet-perf` - permissioned stable channel testnet running a 24/7 soak test. +* `testnet-master` - public edge channel testnet accessible via master.testnet.solana.com. Runs 24/7 +* `testnet-master-perf` - permissioned edge channel testnet running a multi-hour soak test weekday mornings. + +## Deploy process + +They are deployed with the `ci/testnet-manager.sh` script through a list of [scheduled +buildkite jobs](https://buildkite.com/solana-labs/testnet-management/settings/schedules). +Each testnet can be manually manipulated from buildkite as well. The `-perf` +testnets use a release tarball while the non`-perf` builds use the snap build +(we've observed that the snap build runs slower than a tarball but this has yet +to be root caused). + +## Where are the testnet logs? + +Attach to the testnet first by running one of: +```bash +$ net/gce.sh config testnet-solana-com +$ net/gce.sh config master-testnet-solana-com +$ net/gce.sh config perf-testnet-solana-com +``` + +Then run: +```bash +$ net/ssh.sh +``` +for log location details + +## How do I reset the testnet? +Manually trigger the [testnet-management](https://buildkite.com/solana-labs/testnet-management) pipeline +and when prompted select the desired testnet + +## How can I scale the tx generation rate? + +Increase the TX rate by increasing the number of cores on the client machine which is running +`bench-tps` or run multiple clients. Decrease by lowering cores or using the rayon env +variable `RAYON_NUM_THREADS=` + +## How can I test a change on the testnet? + +Currently, a merged PR is the only way to test a change on the testnet. But you +can run your own testnet using the scripts in the `net/` directory. + +## Adjusting the number of clients or validators on the testnet +Edit `ci/testnet-manager.sh` + + Benchmarking --- @@ -388,3 +442,4 @@ problem is solved by this code?" On the other hand, if a test does fail and you better way to solve the same problem, a Pull Request with your solution would most certainly be welcome! Likewise, if rewriting a test can better communicate what code it's protecting, please send us that patch! + diff --git a/doc/testnet.md b/doc/testnet.md deleted file mode 100644 index 9da70681b1..0000000000 --- a/doc/testnet.md +++ /dev/null @@ -1,52 +0,0 @@ -# TestNet debugging info - -Currently we have three testnets: -* `testnet` - public beta channel testnet accessible via testnet.solana.com. Runs 24/7 -* `testnet-perf` - private beta channel testnet with clients trying to flood the network -with transactions until failure. Runs 24/7 -* `testnet-msater` - public edge channel testnet accessible via master.testnet.solana.com. Runs 24/7 -* `testnet-master-perf` - private edge channel testnet with clients trying to flood the network -with transactions until failure. Runs on weekday mornings for a couple hours - -## Deploy process - -They are deployed with the `ci/testnet-manager.sh` script through a list of [scheduled -buildkite jobs](https://buildkite.com/solana-labs/testnet-management/settings/schedules). -Each testnet can be manually manipulated from buildkite as well. The `-perf` -testnets use a release tarball while the non`-perf` builds use the snap build -(we've observed that the snap build runs slower than a tarball but this has yet -to be root caused). - -## Where are the testnet logs? - -Attach to the testnet first by running one of: -```bash -$ net/gce.sh config testnet-solana-com -$ net/gce.sh config master-testnet-solana-com -$ net/gce.sh config perf-testnet-solana-com -``` - -Then run: -```bash -$ net/ssh.sh -``` -for log location details - -## How do I reset the testnet? -Manually trigger the [testnet-management](https://buildkite.com/solana-labs/testnet-management) pipeline -and when prompted select the desired testnet - -## How can I scale the tx generation rate? - -Increase the TX rate by increasing the number of cores on the client machine which is running -`bench-tps` or run multiple clients. Decrease by lowering cores or using the rayon env -variable `RAYON_NUM_THREADS=` - -## How can I test a change on the testnet? - -Currently, a merged PR is the only way to test a change on the testnet. But you -can run your own testnet using the scripts in the `net/` directory. - -## Adjusting the number of clients or validators on the testnet -Edit `ci/testnet-manager.sh` -