concertio/optimizer-studio repository overview

⁠How to use optimizer-studio Docker container

create a .env file to be used with docker with --env-file or with docker-compose, or provide the environment variables hereunder using docker run -e (-e argument):

1. In case you are not running in community edition, obtain optimizer-studio license key and enter it in the .env file here:

   OPTIMIZER_LICENSE_KEY=<REPLACE WITH YOUR LICENSE KEY>
   

   Copy

   otherwise remark or remove that line from your .env file

2. obtain your optimizer.concertio.com project settings, namely:

   • project_guid: <your project GUID> (in knobs.yaml under global_settings)
   • web_service_token: <your token here>

   and just place them as well in the .env file here:

   OPTIMIZER_STUDIO_WEB_TOKEN=<ADD YOUR WEB TOKEN HERE>
   OPTIMIZER_STUDIO_PROJECT_GUID=<ADD YOUR PROJECT GUID HERE>
   

   Copy

3. mount your knobs.yaml file to /root/optimizer/knobs.yaml. this file shall contain your knobs and metrics defined for the experiment

4. mount your workload.sh script to /root/optimizer/workload.sh. this file shall contain your actual workload script. make sure to first chmod +x ./workload.sh so it will have execution permissions.

⁠Running the container

docker run --env-file ./.env --rm -ti --name optimize-studio --mount type=bind,src=`pwd`/knobs.yaml,dst=/root/optimizer/knobs.yaml \
    --mount type=bind,src=`pwd`/workload.sh,dst=/root/optimizer/workload.sh concertio/optimizer-studio:3.18.0