https://github.com/concourse/concourse-bosh-release
Concourse BOSH release
https://github.com/concourse/concourse-bosh-release
Last synced: 5 months ago
JSON representation
Concourse BOSH release
- Host: GitHub
- URL: https://github.com/concourse/concourse-bosh-release
- Owner: concourse
- License: apache-2.0
- Created: 2018-09-10T19:32:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2026-01-21T02:05:27.000Z (5 months ago)
- Last Synced: 2026-01-21T03:57:24.911Z (5 months ago)
- Language: HTML
- Homepage:
- Size: 33.5 MB
- Stars: 29
- Watchers: 11
- Forks: 55
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Notice: NOTICE.md
Awesome Lists containing this project
README
# concourse-bosh-release
> A [BOSH](https://bosh.io) release for the `concourse` binary.
This repository contains the official BOSH release of
[Concourse](https://concourse-ci.org). It packages up the `concourse` binary
and exposes all flags via properties on the `web` and `worker` jobs. These jobs
represent the [`web` node](https://concourse-ci.org/concourse-web.html) and the
[`worker` node](https://concourse-ci.org/concourse-worker.html), respectively.
## Requirements
- [Bosh CLI V2](https://bosh.io/docs/cli-v2.html#install)
## Usage
Check out the [`concourse-bosh-deployment`
repository](https://github.com/concourse/concourse-bosh-deployment) 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](https://bosh.io/docs/) first.
If you're just looking to get Concourse running quickly and kick the tires, you
may want to try the [Quick Start](https://concourse-ci.org/install.html)
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//` 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.
## Tests
Some Ruby RSpec tests were added in [#183](https://github.com/concourse/concourse-bosh-release/pull/183). You can run them by:
```sh
bundle install
bundle exec rspec --init
bundle exec rspec
```