github.com/verrazzano/verrazzano@v1.7.1/tools/psr/psrctl/README.md (about)

     1  # psrctl
     2  
     3  The PSR CLI is a tool to run and modify PSR test scenarios consisting of one or more `use cases`.
     4  
     5  You can run a PSR scenario against a live cluster using existing scenarios such as `opensearch-s1`:
     6  ```
     7  psrctl start -s ops-s1
     8  ```
     9  
    10  To create new scenarios, create a `scenario.yaml` file under `manifests/scenarios/myscenario` using the following convention:
    11  ```
    12  name: myscenario-1
    13  ID: ops-myscenario-1
    14  description: |
    15    This is a new scenario. It runs the use case opensearch/writelogs.yaml.
    16  usecases:
    17    - usecasePath: opensearch/writelogs.yaml
    18      overrideFile: writelogs.yaml
    19      description: write logs to STDOUT 10 times a second
    20  ```
    21  
    22  To start the above scenario, run:
    23  ```
    24  psrctl start -d manifests/scenarios/myscenario -s ops-myscenario-1
    25  ```
    26  The flag `-d` allows you to specify a scenario directory that is not compiled into the `psrctl` binary, such as the one created above.
    27  
    28  For newly created scenarios, a `usecase-overrides` directory must be provided with each override values for each `use case`.
    29  See the file structure of `manifests/scenarios/opensearch/s1` as an example.
    30  
    31  ## Building the CLI
    32  
    33  The binary will be located in `$GOPATH/bin`.
    34  
    35  Run `make install-cli` to build and install the `psrctl` CLI to your go path.
    36  
    37  ## Usage
    38  
    39  Use the following syntax to run `psrctl` commands from your terminal window.
    40  ```
    41  psrctl [command] [flags]
    42  ```
    43  
    44  ## Available Commands
    45  | Command   | Definition                                  |
    46  |-----------|---------------------------------------------|
    47  | `explain` | Describe PSR scenarios that can be started  |
    48  | `help`    | Help about any command                      |
    49  | `list`    | List the running PSR scenarios              |
    50  | `start`   | Start a PSR scenario                        |
    51  | `stop`    | Stop a PSR scenario                         |
    52  | `update`  | Update a running PSR scenario configuration |
    53  | `version` | PSR CLI version information                 |
    54  
    55  Run `psrctl --help` for additional usage information.