From 00c18dec6e246f716b0c48818d15158ed1bd2e69 Mon Sep 17 00:00:00 2001 From: Zelin Hao Date: Tue, 20 Jun 2023 14:47:31 -0700 Subject: [PATCH] Update README for distribution level BWC tests Signed-off-by: Zelin Hao --- src/test_workflow/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/test_workflow/README.md b/src/test_workflow/README.md index a040275877..643de69cea 100644 --- a/src/test_workflow/README.md +++ b/src/test_workflow/README.md @@ -110,6 +110,17 @@ To run OpenSearch Dashboards BWC tests. opensearch-dashboards=https://ci.opensearch.org/ci/dbc/distribution-build-opensearch-dashboards/1.3.5/4056/linux/x64/tar ``` +#### BWC tests on distribution bundle level + +The BWC tests running on distribution level are using the same framework from OpenSearch. The test cluster is spin up with the `latest` distribution bundle of provided version exclusively when the project is initialized with property `-PcustomDistributionDownloadType=bundle`. + +The distribution bundle will be obtained with this format URL: `https://ci.opensearch.org/ci/dbc/distribution-build-opensearch/1.3.2/latest/linux/x64/tar/dist/opensearch/opensearch-1.3.2-linux-x64.tar.gz` +This URL pattern starts to be supported as far as `v1.3.2` so The distribution bundle set up in the test cluster can be all versions after version `v1.3.2`. + +On CI level for plugins, security certificates need to be manually imported when spinning up the test cluster as security plugin is included in the distribution bundle. When upgrading the version within the test cluster, `nextNodeToNextVersion` is used for a single node upgrade and `goToNextVersion` is for a full restart upgrade. + +See [anomaly-detection#766](https://github.com/opensearch-project/anomaly-detection/pull/766) or [observability#1366](https://github.com/opensearch-project/observability/pull/1366) for more information. + ### Performance Tests TODO: Add instructions for running performance tests with `test.sh`