Skip to content

Commit

Permalink
Update cli docs (#1757)
Browse files Browse the repository at this point in the history
* add loadtest commands

* devnet wiz commands

* devnet wiz commands

* devnet wiz commands

* update validate docs

* update validate docs

* update devnet docs

* update logs docs

* update logs docs

* update loadtest docs

* update pagination

* fix lint

* fix lint

---------

Co-authored-by: Lavinia Talpas <103824766+laviniat1996@users.noreply.github.com>
  • Loading branch information
sukantoraymond and laviniat1996 authored May 4, 2024
1 parent 05d8d80 commit 65f32bb
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/tooling/cli-create-nodes/node-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ tags: [Tooling, Avalanche-CLI]
description: This page demonstrates how to execute a SSH command on all nodes of a Cluster using the Avalanche-CLI.
pagination_label: Execute a SSH command on all nodes of a Cluster.
sidebar_label: Execute a SSH command on a Cluster
sidebar_position: 6
sidebar_position: 7
---

# Execute a SSH command on a Cluster
Expand Down
60 changes: 60 additions & 0 deletions docs/tooling/cli-create-nodes/run-loadtest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
tags: [Tooling, Avalanche-CLI]
description: This page demonstrates how to run load test on a Subnet deployed on a cluster of cloud-based validators using Avalanche-CLI.
pagination_label: Run Load Test using Avalanche-CLI
sidebar_label: Run Load Test
sidebar_position: 3
---

# Run Load Test With Avalanche-CLI

This page demonstrates how to run load test on a Subnet deployed on a cluster of cloud-based validators using Avalanche-CLI.

## Prerequisites

Before we begin, you will need to have:

- Created an AWS account and have an updated AWS `credentials` file in home directory with [default] profile
or set up your GCP account according to [here](/tooling/cli-create-nodes/create-a-validator-gcp.md#prerequisites)
- Created a cluster of cloud servers with monitoring enabled
- Deployed a Subnet into the cluster
- Added the cloud servers as validator nodes in the Subnet

## Run Load Test

When the load test command is run, a new cloud server will be created to run the load test. The
created cloud server is referred by the name `<loadtestName>` and you can use any name of your
choice.

To start load test, run:

```shell
avalanche node loadtest start <loadtestName> <clusterName> <subnetName>
```

Next, you will need to provide the load test Git repository URL, load test Git Branch, the command
to build the load test binary and the command to run the load test binary.

We will use an example of running load test on a Subnet running custom VM MorpheusVM built with
[HyperSDK](https://github.com/ava-labs/hypersdk/tree/main/examples/morpheusvm).

The following settings will be used:

- Load Test Repo URL: `https://github.com/ava-labs/hypersdk/`
- Load Test Branch: `vryx-poc`
- Load Test Build Script: `cd /home/ubuntu/hypersdk/examples/morpheusvm; CGO_CFLAGS=\"-O -D__BLST_PORTABLE__\" go build -o ~/simulator ./cmd/morpheus-cli`
- Load Test Run Script: `/home/ubuntu/simulator spam run ed25519 --accounts=10000000 --txs-per-second=100000 --min-capacity=15000 --step-size=1000 --s-zipf=1.0001 --v-zipf=2.7 --conns-per-host=10 --cluster-info=/home/ubuntu/clusterInfo.yaml --private-key=323b1d8f4eed5f0da9da93071b034f2dce9d2d22692c172f3cb252a64ddfafd01b057de320297c29ad0c1f589ea216869cf1938d88c9fbd70d6748323dbf2fa7`

Once the command is run, you will be able to see the logs from the load test in the cluster's
Grafana URL like the example below:

![Centralized Logs](/img/centralized-logs.png)

## Stop Load Test

To stop the load test process on the load test instance `<loadtestName>` and terminate the load test
instance, run:

```shell
avalanche node loadtest stop <loadtestName>
```
1 change: 1 addition & 0 deletions docs/tooling/cli-create-nodes/setup-a-devnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ ALPHA WARNING: This command is currently in experimental mode. Proceed at your o
Before we begin, you will need to have:

- Created an AWS account and have an updated AWS `credentials` file in home directory with [default] profile
or set up your GCP account according to [here](/tooling/cli-create-nodes/create-a-validator-gcp.md#prerequisites)

Note: the tutorial uses AWS hosts, but Devnets can also be created and operated in other supported
cloud providers, such as GCP.
Expand Down
2 changes: 1 addition & 1 deletion docs/tooling/cli-create-nodes/stop-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ tags: [Tooling, Avalanche-CLI]
description: This page provides instructions for halting cloud server nodes established by Avalanche-CLI.
pagination_label: Terminate Nodes Originally Created with Avalanche-CLI
sidebar_label: Terminate All Nodes
sidebar_position: 7
sidebar_position: 8
---
# Terminate Nodes Created By Avalanche-CLI

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ tags: [Tooling, Avalanche-CLI]
description: This page demonstrates how to deploy a blockchain run with a custom virtual machine using cloud-based validators using the Avalanche-CLI.
pagination_label: Deploy a Custom VM to a set of Cloud-Based validators using Avalanche-CLI
sidebar_label: Deploy a Custom VM
sidebar_position: 5
sidebar_position: 6
---

# Deploy a Custom VM Using Avalanche-CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/tooling/cli-create-nodes/validate-primary-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ tags: [Tooling, Avalanche-CLI]
description: This page demonstrates how to configure nodes to validate the Avalanche Primary Network. Validation via Avalanche-CLI is currently only supported on Fuji.
pagination_label: Configure Nodes to Validate the Primary Network with Avalanche-CLI
sidebar_label: Validate the Primary Network
sidebar_position: 4
sidebar_position: 5
---

# Configure Nodes to Validate the Primary Network with Avalanche-CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/tooling/cli-create-nodes/validate-subnets.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ tags: [Tooling, Avalanche-CLI]
description: This page demonstrates how to configure nodes to validate an Avalanche Subnet. Validation via Avalanche-CLI is currently only supported on Fuji.
pagination_label: Configure Nodes to Validate a Subnet with Avalanche-CLI
sidebar_label: Validate a Subnet
sidebar_position: 3
sidebar_position: 4
---

# Configure a Node to Validate a Subnet with Avalanche-CLI
Expand Down

0 comments on commit 65f32bb

Please sign in to comment.