dev.md

Developer Guide

You need these requirementes to be installed on your machine:

• infraboxcli
• docker
• python 2.7

Setup development environment

Install all the python packages you need for development.

pip install pipenv
pipenv install

To activate the environment every time you open a new shell:

pipenv shell

Build Images

To build all images run:

infrabox run ib
./ib.py images build

If you want to build them for another registry (default is localhost:5000) use the --registry and the --tag option:

./ib.py images build --registry myregistry --tag mytag

You may also filter which images to build with the --filter option. It takes a regular expression and every image name matchin the regex will be build.

./ib.py images build --filter api # builds only api
./ib.py images build --filter '.*' # builds all, default

Push Image

After building the images you may want to push them to a registry.

./ib.py images push

It also takes the --registry, --tag and --filter options like images build does.

Starting Service

During development you may want to start several services separately to test your changes. You can start services like this:

./ib.py services start <service_name>

Services to start are storage, opa, api and dashboard-client.

Generate Changelog

If you want to create a new changelog file, run:

./ib.py changelog create

Please, not that you should have your CHANGELOG_GITHUB_TOKEN path variable specified. Otherwise, you may want to explicitly specify your token within a command:

./ib.py changelog create --token=YOUR_TOKEN_HERE

See the service's READMEs for details:

• Storage
• Open Policy Agent
• API
• Dashboard UI