Run your service locally with Caproni

This guide will cover running a Theseus-generated service locally with caproni up, iterating with hot-reload via caproni run, and working against the in-cluster dependencies provisioned from gitlab-dev-stack.

This page is largely a stub. — see Documentation gaps for the full outline. Contributions welcome. In the meantime, the Caproni documentation covers local development.

Deploy a Fairway chart with Caproni

Caproni natively supports deploying Helm charts. When you use Fairway to define infrastructure configuration, Fairway will ultimately generate a chart for your application.

Ideally, the generated charts are stored, for example, as an OCI image. To deploy charts while developing and changing the Fairway manifest, you can use the repository that contains the manifest to generate the chart on demand.

Add a deployer for your application to your caproni.yaml and add an edit mode repository.

deployers:
  my-app:
    repository: my-app
    type: helm
    helm:
      namespace: default
      release:
        name: my-app
        chart: ./repos/my-app/chart

repositories:
  my-app:
    edit_mode: true
    repository: https://gitlab.com/gitlab-org/quality/tooling/fairway-chart-demo
    directory: ./repos/my-app

After the repository is cloned with caproni update, you can generate the charts using Fairway by running the following command in the ./repos/my-app directory:

fairway generate --app-version 1.31 --chart-version 1.31 fairway.yaml

In this case, version 1.31 is the version of the demo image (nginxinc/nginx-unprivileged) used in the fairway-chart-demo repository.