Skip to content

Latest commit

 

History

History
124 lines (84 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

124 lines (84 loc) · 3.7 KB
Raw

Contributing

Setup

  1. Make sure all prerequisite dependencies are installed:

  2. Start the Database and RabbitMQ services:

task start-db
  1. Install dependencies, run migrations, generate encryption keys, and seed the database:
task setup

Starting the dev server

Start the Hatchet engine, API server, dashboard, and Prisma studio:

task start-dev

Creating and testing workflows

To create and test workflows, run the examples in the ./examples directory.

You will need to add the tenant (output from the task seed-dev command) to the .env file in each example directory. An example .env file for the ./examples/simple directory can be generated via:

alias get_token='go run ./cmd/hatchet-admin token create --name local --tenant-id 707d0855-80ab-4e1f-a156-f1c4546cbf52'

cat > ./examples/simple/.env <<EOF
HATCHET_CLIENT_TENANT_ID=707d0855-80ab-4e1f-a156-f1c4546cbf52
HATCHET_CLIENT_TLS_ROOT_CA_FILE=../../hack/dev/certs/ca.cert
HATCHET_CLIENT_TLS_SERVER_NAME=cluster
HATCHET_CLIENT_TOKEN="$(get_token)"
EOF

This example can then be run via go run main.go from the ./examples/simple directory.

Logging

You can set the following logging formats to configure your logging:

# info, debug, error, etc
SERVER_LOGGER_LEVEL=debug

# json or console
SERVER_LOGGER_FORMAT=json

DATABASE_LOGGER_LEVEL=debug
DATABASE_LOGGER_FORMAT=console

OpenTelemetry

You can set the following to enable distributed tracing:

SERVER_OTEL_SERVICE_NAME=engine
SERVER_OTEL_COLLECTOR_URL=<collector-url>

# optional
OTEL_EXPORTER_OTLP_HEADERS=<optional-headers>

# optional
OTEL_EXPORTER_OTLP_ENDPOINT=<collector-url>

CloudKMS

CloudKMS can be used to generate master encryption keys:

gcloud kms keyrings create "development" --location "global"
gcloud kms keys create "development" --location "global" --keyring "development" --purpose "encryption"
gcloud kms keys list --location "global" --keyring "development"

From the last step, copy the Key URI and set the following environment variable:

SERVER_ENCRYPTION_CLOUDKMS_KEY_URI=gcp-kms://projects/<PROJECT>/locations/global/keyRings/development/cryptoKeys/development

Generate a service account in GCP which can encrypt/decrypt on CloudKMS, then download a service account JSON file and set it via:

SERVER_ENCRYPTION_CLOUDKMS_CREDENTIALS_JSON='{...}'

Issues

Query engine leakage

Sometimes the spawned query engines from Prisma don't get killed when hot reloading. You can run task kill-query-engines on OSX to kill the query engines.

Make sure you call .Disconnect on the database config object when writing CLI commands which interact with the database. If you don't, and you try to wrap these CLI commands in a new command, it will never exit, for example:

export HATCHET_CLIENT_TOKEN="$(go run ./cmd/hatchet-admin token create --tenant-id <tenant>)"

Working with Database Models

  1. Add or modify the model schema in ./prisma/schema.prisma
  2. Create or modify the required SQL queries in ./pkg/repository/prisma/dbsqlc
  3. Add new queries files to ./pkg/repository/prisma/dbsqlc/sqlc.yaml
  4. Create a new migration file with task prisma-migrate
  5. Generate Go with task generate-all