Installing OpenBOS¶

Installing openBOS consists of building the docker images that collectively make up the kernel and the drivers you want to use.

Prework¶

To install openBOS you'll need docker. If you don't have it install it. Follow the instruction here.

Once installed, grant docker access to the Docker socket.

sudo usermod -aG docker $USER

Cloning the repo¶

Presently, the repo is private. To access it, make sure your public ssh key has been added to your github profile so this operation works. For a refresher review this page.

Start by cloning the repo:

git clone --recursive git@github.com:jamesryancoleman/bos.git bos

This project is designed to be run rootless. So you'll need to update your docker host environment variable to reflect that.

Depending on the specifics of your docker installation you may need to change where the orchestrator binds to the docker socks:

orchestrator:
    build: 
        context: ./services
        dockerfile: ./ochestrator/docker/Dockerfile
    container_name: ${ORCHESTRATOR_CONTAINER_NAME}
    restart: always
    env_vile:
        - .env
    environment:
        - 

Launching the system¶

When the repo is cloned launch the kernel services with:

docker compose up sysmod devctrl history orchestrator forecast events cli jupyter spog -d

You may get an error that part 80 is already in use on ubuntu. If so disable the apache service (pre-installed in Ubuntu) or re change the spog port in your docker-compose.yml file.

BOPTEST Support¶

If you want to use openBOS with BOPTEST follow the github instructions to install and launch the BOPTEST. For example:

git clone https://github.com/ibpsa/project1-boptest.git boptest 
cd boptest/
docker compose up web worker provision

Once docker is up. You'll need to launch the boptest driver

docker compose up boptest -d

the External Reference format for boptest points using the provided driver is: boptest://bestest_air/zon_weaSta_reaWeaTDryBul_y. Where the uri parts correspond to boptest://[TEST_CASE]/[REST_API_POINT_NAME]