OpenSearch Benchmark (OSB) comes packaged with several workloads that are included in this repository. This guide provides a brief overview of the organization of this repository as well as how OSB uses these workloads.
- What do branches represent
- How does OSB select which branch to use
- Force OSB to use a Specific Branch
Don't worry, these numbers are not the same numbers in the series Lost. Each branch -- main, 6, 7, 1, 2, 3 -- is associated with a specific major version of OpenSearch or Elasticsearch and contains variations of each workload.
OSB has a mechanism to detect the major version of the target cluster.
Based off the major version it detects:
- OSB will select workloads from branches
1,2, or3if the target cluster has an OpenSearch major version of 1.X.X, 2.X.X, or 3.X.X respectively. - OSB will select workloads from branches
6or7if the target cluster has an Elasticsearch major versions 6.X.X or 7.X.X respectively.
If OSB cannot determine the major version or if the major version does not exist as a branch in the repository, OSB will select workloads from main branch as a last resort.
Users can force OSB to use a specific branch by specifying --distribution-version=X.X.X. For example, if a user is testing a cluster with OpenSearch version 2.0.0 but wants to use the workloads associated with OpenSearch version 1.X.X, they can supply --distribution-version=1.0.0 when invoking OSB.
However, it's not recommended to force testing workloads from a branch that is greater than the target cluster's major version (e.g. testing workloads from branch 2 on OpenSearch cluster 1.X.X). This can cause issues as earlier versions might not have operations that are included in later version workloads.