Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 2.63 KB

quick_start.md

File metadata and controls

81 lines (60 loc) · 2.63 KB

Quick start: run the Audit Service

Create a custom configuration file at ~/.gen3/audit-service/audit-service-config.yaml. Add the following to your configuration file:

DB_DATABASE: audit_test

Create the database:

psql -U postgres -c "create database audit_test"

Run the database schema migration:

alembic upgrade head

Run the server with auto-reloading:

python run.py
OR
uvicorn audit.asgi:app --reload

Try out the API at: http://localhost:8000/docs.

Quickstart with Helm

You can now deploy individual services via Helm!

If you are looking to deploy all Gen3 services, that can be done via the Gen3 Helm chart. Instructions for deploying all Gen3 services with Helm can be found here.

To deploy the audit service:

helm repo add gen3 https://helm.gen3.org
helm repo update
helm upgrade --install gen3/audit

These commands will add the Gen3 helm chart repo and install the audit service to your Kubernetes cluster.

Deploying audit this way will use the defaults that are defined in this values.yaml file

You can learn more about these values by accessing the audit README.md

If you would like to override any of the default values, simply copy the above values.yaml file into a local file and make any changes needed.

To deploy the service independant of other services (for testing purposes), you can set the .postgres.separate value to "true". This will deploy the service with its own instance of Postgres:

  postgres:
    separate: true

You can then supply your new values file with the following command:

helm upgrade --install gen3/audit -f values.yaml

If you are using Docker Build to create new images for testing, you can deploy them via Helm by replacing the .image.repository value with the name of your local image. You will also want to set the .image.pullPolicy to "never" so kubernetes will look locally for your image. Here is an example:

image:
  repository: <image name from docker image ls>
  pullPolicy: Never
  # Overrides the image tag whose default is the chart appVersion.
  tag: ""

Re-run the following command to update your helm deployment to use the new image:

helm upgrade --install gen3/audit

You can also store your images in a local registry. Kind and Minikube are popular for their local registries: