From a7cf7e6af6db90eae3bb72ff05a3adb91b5f80ff Mon Sep 17 00:00:00 2001 From: Eli Battat Date: Wed, 30 Aug 2023 11:48:08 +0300 Subject: [PATCH] update readme --- README.md | 8 +++++--- docs/source/podman.md | 6 ++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ef4067a14..49f1b59d1 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ----------------- # Benchmark-Runner: Running benchmarks -[![Actions Status](https://github.com/redhat-performance/benchmark-runner/workflows/CI/badge.svg)](https://github.com/redhat-performance/benchmark-runner/actions) +[![Actions Status](https://github.com/redhat-performance/benchmark-runner/actions/workflows/Perf_Env_Build_Test_CI.yml/badge.svg)](https://github.com/redhat-performance/benchmark-runner/actions) [![PyPI Latest Release](https://img.shields.io/pypi/v/benchmark-runner.svg)](https://pypi.org/project/benchmark-runner/) [![Container Repository on Quay](https://quay.io/repository/projectquay/quay/status "Container Repository on Quay")](https://quay.io/repository/ebattat/benchmark-runner?tab=tags) [![Coverage Status](https://coveralls.io/repos/github/redhat-performance/benchmark-runner/badge.svg?branch=main)](https://coveralls.io/github/redhat-performance/benchmark-runner?branch=main&kill_cache=1) @@ -57,18 +57,20 @@ _**Table of Contents**_ The following options may be passed via command line flags or set in the environment: -**mandatory:** WORKLOAD=$WORKLOAD - **mandatory:** KUBEADMIN_PASSWORD=$KUBEADMIN_PASSWORD **mandatory:** $KUBECONFIG [ kubeconfig file path] +**mandatory:** WORKLOAD=$WORKLOAD + Choose one from the following list: `['stressng_pod', 'stressng_vm', 'stressng_kata', 'uperf_pod', 'uperf_vm', 'uperf_kata', 'hammerdb_pod_mariadb', 'hammerdb_vm_mariadb', 'hammerdb_kata_mariadb', 'hammerdb_pod_mariadb_lso', 'hammerdb_vm_mariadb_lso', 'hammerdb_kata_mariadb_lso', 'hammerdb_pod_postgres', 'hammerdb_vm_postgres', 'hammerdb_kata_postgres', 'hammerdb_pod_postgres_lso', 'hammerdb_vm_postgres_lso', 'hammerdb_kata_postgres_lso', 'hammerdb_pod_mssql', 'hammerdb_vm_mssql', 'hammerdb_kata_mssql', 'hammerdb_pod_mssql_lso', 'hammerdb_vm_mssql_lso', 'hammerdb_kata_mssql_lso', 'vdbench_pod', 'vdbench_kata', 'vdbench_vm', 'clusterbuster', 'bootstorm_vm']` ** clusterbuster workloads: cpusoaker, files, fio, uperf. for more details [see](https://github.com/RobertKrawitz/OpenShift4-tools) +Not mandatory: + **auto:** NAMESPACE=benchmark-operator [ The default namespace is benchmark-operator ] **auto:** ODF_PVC=True [ True=ODF PVC storage, False=Ephemeral storage, default True ] diff --git a/docs/source/podman.md b/docs/source/podman.md index 298405dc9..420e333f1 100644 --- a/docs/source/podman.md +++ b/docs/source/podman.md @@ -3,12 +3,12 @@ The following options may be passed via command line flags or set in the environment: -**mandatory:** WORKLOAD=$WORKLOAD - **mandatory:** KUBEADMIN_PASSWORD=$KUBEADMIN_PASSWORD **mandatory:** $KUBECONFIG [ kubeconfig file path] +**mandatory:** WORKLOAD=$WORKLOAD + Choose one from the following list: `['stressng_pod', 'stressng_vm', 'stressng_kata', 'uperf_pod', 'uperf_vm', 'uperf_kata', 'hammerdb_pod_mariadb', 'hammerdb_vm_mariadb', 'hammerdb_kata_mariadb', 'hammerdb_pod_mariadb_lso', 'hammerdb_vm_mariadb_lso', 'hammerdb_kata_mariadb_lso', 'hammerdb_pod_postgres', 'hammerdb_vm_postgres', 'hammerdb_kata_postgres', 'hammerdb_pod_postgres_lso', 'hammerdb_vm_postgres_lso', 'hammerdb_kata_postgres_lso', 'hammerdb_pod_mssql', 'hammerdb_vm_mssql', 'hammerdb_kata_mssql', 'hammerdb_pod_mssql_lso', 'hammerdb_vm_mssql_lso', 'hammerdb_kata_mssql_lso', 'vdbench_pod', 'vdbench_kata', 'vdbench_vm', 'clusterbuster', 'bootstorm_vm']` @@ -17,6 +17,8 @@ Choose one from the following list: ** clusterbuster workloads: cpusoaker, files, fio, uperf. For more details [see](https://github.com/RobertKrawitz/OpenShift4-tools) +Not mandatory: + **auto:** NAMESPACE=benchmark-operator [ The default namespace is benchmark-operator ] **auto:** ODF_PVC=True [ True=ODF PVC storage, False=Ephemeral storage, default True ]