Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 1.87 KB

README.md

File metadata and controls

52 lines (33 loc) · 1.87 KB
Raw

concourse-bosh-release

A BOSH release for the concourse binary.

This repository contains the official BOSH release of Concourse. It packages up the concourse binary and exposes all flags via properties on the web and worker jobs. These jobs represent the web node and the worker node, respectively.

Requirements

Usage

Check out the concourse-bosh-deployment repository repository for a stub manifest and various ops files.

If you're not familiar with BOSH, you may want to check out the BOSH documentation first.

If you're just looking to get Concourse running quickly and kick the tires, you may want to try the Quick Start instead.

Developing

To add new Concourse flags/env vars to one of the job specs, do the following:

  1. Update the spec file located in the relevant jobs/<job>/ directory
  2. Run ./scripts/generate-job-templates to add the flags to the job template(s)

Note about default values

When adding a new Concourse flag, don't define a default value that mirrors a default set by the Concourse binary.

Instead, mention the default in the description. This prevents the possibility of drift if the Concourse binary default value changes.

containerd.max_containers:
    env: CONCOURSE_CONTAINERD_MAX_CONTAINERS
    description: |
      Maximum container capacity. 0 means no limit. Defaults to 250.

We understand that the comment stating the binary's default can become stale. The current solution is a suboptimal one. It may be improved in the future by generating a list of the default values from the binary.