Component & Deployment Database

Page about component & deployment databases

Component Database

Resources

Backend API/CLI to the MongoDB component database: eed-web-application/build-environment-builder (github.com)

API Documentation: Swagger UI (stanford.edu)

Other Notes

1. cbs - core build system
2. docker-compose.yml file is used to create the database locally (for development purposes). Where you would use a 'docker compose up' command to execute

README.md (Since there isn't one on the repo)

How to build:

Disclaimer: I've only tried this on vscode, since the repo already made support to create the development environment for vscode using (devcontainer.json)

1. Open up the repo in vscode, and you will be prompted to open up the devcontainer.
   1. Click yes, give it a few minutes to setup, it will run docker-compose.yml which will setup the mongodb locally
2. Now that your development environment is setup, open up a terminal in vscode. Which should open you in the container, at folder '/workspace'
3. Do a 'make build'
   
   At the moment there is errors
   1. I solved the vcs status error by
      1. do a git status
      2. follow the command it outputs
         
      3. Got rid of the error:
         
   2. I solved the malformed import path "-o": leading dash by
      1. Edit line 8 in makefile 
         Original: go build ./... -o cbs
         New: go build -o cbs ./...
   3. Then it should be able to run
4. Example
   
   

How to run:

TBD

1. Component list
   1. ./build-environment-builder component -h
   2. Specify a label (endpoint), but seems that no labels are configured. Check configure.go with the "add your map here" I think you specify the yaml
   3. Seems like this only works in vscode dev container, because the server is running there (update: Maybe not actually, since when you do docker ps, you'll see the containers that were started because of vscode (Which runs docker compose up))
      1. I first did a './build-environment-builder configure endpoint --label=dev --url=http://cbs:8080/api/' to create a label (endpoint)
      2. Then when i try to use it when listing components: './build-environment-builder component list --label=dev', it seems to connect to server, but gives error, probably because i have no components in it
      3. tip: do an 'echo=$EDITOR' and if you dont have anything specified, set it to vim. Otherwise, in this next step, when you create a component, it'll open up in nano.
      4. './build-environment-builder component list --label=dev'
      5. Left off here

Deployment Database

TBD