Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 3.25 KB

README.md

File metadata and controls

88 lines (57 loc) · 3.25 KB
Raw

provisioning-backend

Provisioning backend service for cloud.redhat.com.

Components

  • pbapi - API backend service
  • pbworker - backend job processing worker
  • pbmigrate - database migration tool with embedded SQL scripts

Building

Particular version of Go and tools are required for successful build. The install-go make target will use already installed version of go to perform go download commend to install Go into $HOME/sdk.

make install-go
make install-tools
make build

Configuration

Configuration is done via configuration files in config/ directory, see config/api.env.example file for list of options with documentation. The application expects config/app.env file to be present, other programs from this git repo also look up additional file which will override values:

  • pbworker looks up config/worker.env
  • pbmigrate looks up config/migrate.env
  • typesctl looks up config/typesctl.env
  • integration (DAO) tests look up config/test.env

Environmental variables always override any values from configuration files, or can be used for complete configuration of the application without any .env file.

Finally, when running the app in Clowder environment, some configuration values are overwritten by those from Clowder. See consoleDot shared library for more details.

Development setup

To run all the components from this repository, you will need:

  • Go compiler
  • PostgreSQL server with UUID module
  • GNU Makefile
dnf install postgresql-server postgresql-contrib
make run

Code style

We run go fmt, goimports, go vet and golangci-lint lint suite via GitHub Actions. To run them locally do:

make install-tools
make fmt lint

Make sure to set your editor to use goimports formatting style of code.

Migrations

Migrations can be found in internal/db/migrations in SQL format, the only supported database platform is PostgreSQL. To create a new migration:

make generate-migration MIGRATION_NAME=add_new_column

We currently do not allow down migrations, so delete the down.sql file and do not commit it into git (it will fail build).

To apply migrations, build and run pbmigrate binary. This is exactly what application performs during startup. The pbmigrate utility also supports seeding initial data. There are files available in internal/db/seeds with various seed configurations. Feel free to create your own configuration which you may or may not want to commit into git. When you set DB_SEED_SCRIPT configuration variable, the migration tool will execute all statements from that file. By default, the variable is empty, meaning no data will be seeded.

Building container

podman build -t pb .
podman run --name pb1 --rm -ti -p 8000:8000 -p 5000:5000 pb
curl http://localhost:8000
curl http://localhost:5000/metrics

Contributing

Check out CONTRIBUTING.md

License

GNU GPL 3.0, see LICENSE