# Doris compose Use doris compose to create doris docker compose clusters. ## Requirements 1. The doris image should contains: ``` /opt/apache-doris/{fe, be, cloud} ``` if don't create cloud cluster, the image no need to contains the cloud pkg. if build doris use `sh build.sh --fe --be --cloud`, then its output satisfy with all above, then run command in doris root ``` docker build -f docker/runtime/doris-compose/Dockerfile -t . ``` will generate a image. 2. Install the dependent python library in 'docker/runtime/doris-compose/requirements.txt' ``` python -m pip install --user -r docker/runtime/doris-compose/requirements.txt ``` ## Usage ### Create a cluster or recreate its containers ``` python docker/runtime/doris-compose/doris-compose.py up --add-fe-num --add-be-num --fe-id --be-id ... [ --cloud ] ``` if it's a new cluster, must specific the image. add fe/be nodes with the specific image, or update existing nodes with `--fe-id`, `--be-id` For create a cloud cluster, steps are as below: 1. Write cloud s3 store config file, its default path is '/tmp/doris/cloud.ini'. It's defined in environment variable DORIS_CLOUD_CFG_FILE, user can change this env var to change its path. A Example file is locate in 'docker/runtime/doris-compose/resource/cloud.ini.example'. 2. Use doris compose up command with option '--cloud' to create a new cloud cluster. The simplest way to create a cloud cluster: ``` python docker/runtime/doris-compose/doris-compose.py up --cloud ``` It will create 1 fdb, 1 meta service server, 1 recycler, 3 fe and 3 be. ### Remove node from the cluster ``` python docker/runtime/doris-compose/doris-compose.py down --fe-id --be-id [--clean] [--drop-force] ``` Down the containers and remove it from the DB. For BE, if specific drop force, it will send dropp sql to FE, otherwise it will send decommission sql to FE. If specific `--clean`, it will delete its data too. ### Start, stop, restart specific nodes ``` python docker/runtime/doris-compose/doris-compose.py start --fe-id --be-id python docker/runtime/doris-compose/doris-compose.py restart --fe-id --be-id ``` ### List doris cluster ``` python docker/runtime/doris-compose/doris-compose.py ls ``` if specific cluster names, it will list all the cluster's nodes. Otherwise it will just list summary of each clusters. There are more options about doris-compose. Just try ``` python docker/runtime/doris-compose/doris-compose.py -h ``` ### Generate regression custom conf file ``` python docker/runtime/doris-compose/doris-compose.py config [-q] [--connect-follow-fe] ``` Generate regression-conf-custom.groovy to connect to the specific docker cluster. ### Setup cloud multi clusters test env steps: 1. Create a new cluster: `python doris-compose.py up my-cluster my-image --add-fe-num 2 --add-be-num 4 --cloud` 2. Generate regression-conf-custom.groovy: `python doris-compose.py config my-cluster --connect-follow-fe` 3. Run regression test: `bash run-regression-test.sh --run -times 1 -parallel 1 -suiteParallel 1 -d cloud/multi_cluster`