Open iGxnon opened 3 months ago
hi @iGxnon would like to take on this task
OK, this issue is assigned to you @rohansx. Thank you for your contribution.
@Phoenix500526, kindly review PR #699 and inform me if any modifications are necessary. Once confirmed, I will proceed with the documentation process.
Description about the feature
Background
Currently, our testing framework uses some bash scripts to start a cluster of containers and configure some network and other environments.
https://github.com/xline-kv/Xline/blob/72f3cf9f0210c175ad36e77b4dedcdf39774a329/scripts/benchmark.sh#L88-L107
https://github.com/xline-kv/Xline/blob/72f3cf9f0210c175ad36e77b4dedcdf39774a329/scripts/benchmark.sh#L143-L150
And the best solution for these functions at present is to use docker-compose, just provide a docker-compose.yml file to manage these resources.
Issues
Due to different configurations, both
benchmark.sh
andquick_start.sh
have their own startup scripts, which the script sections we really want to merge. We experienced a failure of thebenchmark.sh
script because startup scripts are stale.How to ?
Write a docker-compose script like the following in
ci/docker-compose.yml
to start a cluster.Not only can it be provided to users as a quick start, but also during testing and deployment, only one command is needed:
docker-compose -f ci/docker-compose.yml up -d
. And you can destroy all resources by runningdocker-compose -f ci/docker-compose.yml down
.This is the first step that needs to be done. Subsequently, tools related to testing can be mounted in
/mnt
, and operations such as configuring container networks need to be configured in a separate script. Finally, the quick start document needs to be updated,quick_start.sh
should be deleted, andbenchmark.sh
andvalidation.sh
need to be refactored.Code of Conduct