Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.7 KB

README.md

File metadata and controls

70 lines (47 loc) · 2.7 KB
Raw

rally-teams

This repository contains the default teams for the Elasticsearch benchmarking tool Rally.

Currently it consists only of individual "cars", which describe the configuration of a single Elasticsearch node in Rally.

You should not need to use this repository directly, except if you want to look under the hood or create your own teams.

Versioning Scheme

Refer to the official Rally docs for more details.

How to Contribute

If you want to contribute a car, please ensure that it works against the master version of Elasticsearch (i.e. submit PRs against the master branch). We can then check whether it's feasible to backport the car to earlier Elasticsearch versions.

See all details in the contributor guidelines.

Backporting changes

If you are a contributor with direct commit access to this repository then please backport your changes. This ensures that cars do not work only for the latest master version of Elasticsearch but also for older versions. Apply backports with cherry-picks. Below you can find a walkthrough:

Assume we've pushed commit abc123 to master and want to backport it. This is a change to the my_new_car car. Let's check what branches are available for backporting:

daniel@io:teams/default ‹master›$ git branch -r
  origin/1
  origin/2
  origin/5
  origin/HEAD -> origin/master
  origin/master

We'll go backwards starting from branch 5, then branch 2 and finally branch 1. After applying a change, we will test whether the car works as is for an older version of Elasticsearch.

git checkout 5
git cherry-pick abc123

# test the change now with an Elasticsearch 5.x distribution
esrally race --car=my_new_car --distribution-version=5.4.3 --test-mode

# push the change
git push origin 5

Continue the same steps now on the branches 2 and 1.

License

This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.

Copyright 2017-2019 Elasticsearch https://www.elastic.co

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.