github.com/weaviate/weaviate@v1.24.6/test/benchmark/remote/README.md (about)

     1  This folder contains scripts to help execute the benchmark remotely on a GCP
     2  VM.
     3  
     4  ## Requirements
     5  
     6  - Bash
     7  - gcloud (logged in and permissions to `semi-automated-benchmarking` project
     8  - terraform
     9  
    10  ## Usage
    11  
    12  From the root folder run
    13  
    14  ```
    15  test/benchmark/remote/run.sh --all
    16  ```
    17  
    18  To run the whole benchmark suite. The `--all` command will:
    19  
    20  - Check that `gcloud` and `terraform` are installed locally
    21  - Spin up a machine in GCP
    22  - Install the dependencies on this machine
    23  - Clone Weaviate
    24  - Check out the same commit that is check out locally
    25  - Run the benchmarks script
    26  - Copy the results file to the local machine
    27  - Destroy the machine
    28  
    29  If any of the command fails the machine will be destroyed.
    30  
    31  ## Debugging
    32  
    33  You can also run all commands individually, simply run the command without
    34  parameters to list all possible options.
    35  
    36  To do all steps (including spinning up a machine) that happen _before_ running
    37  the benchmarks you can invoke it with the `--prepare` option. To get an
    38  interactive ssh session into the machine, use `--ssh`. To destroy the machine
    39  at an arbitrary point run `--delete_machine`.
    40  
    41  ## Run on arbitrary branch
    42  
    43  *Note: Checking out a branch that does not yet have the scripts from this
    44  folder, will fail. You need a branch created after this script was initially
    45  built or has been rebased on top of it.*
    46  
    47  ```
    48  test/benchmark/remote/run.sh --prepare
    49  test/benchmark/remote/run.sh --checkout <name-of-your-branch-or-commit>
    50  test/benchmark/remote/run.sh --benchmark
    51  test/benchmark/remote/run.sh --delete_machine
    52  ```