https://github.com/cloudfoundry/haproxy-boshrelease
A BOSH release for haproxy (based on cf-release's haproxy job)
https://github.com/cloudfoundry/haproxy-boshrelease
cff-wg-app-runtime-platform
Last synced: about 1 month ago
JSON representation
A BOSH release for haproxy (based on cf-release's haproxy job)
- Host: GitHub
- URL: https://github.com/cloudfoundry/haproxy-boshrelease
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2015-05-29T20:24:18.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2026-04-30T04:43:36.000Z (about 1 month ago)
- Last Synced: 2026-04-30T06:18:50.675Z (about 1 month ago)
- Topics: cff-wg-app-runtime-platform
- Language: Ruby
- Homepage:
- Size: 4.81 MB
- Stars: 36
- Watchers: 36
- Forks: 84
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
- Notice: NOTICE
Awesome Lists containing this project
- awesome-network-stuff - **20**星 - release's haproxy job) (<a id="d03d494700077f6a65092985c06bf8e8"></a>工具 / <a id="d3069cac6097830d12f5933c9c8b7a77"></a>HAProxy)
README
# BOSH Release for HAProxy
Questions? Pop in our [slack channel](https://cloudfoundry.slack.com/messages/haproxy-boshrelease/)!
This BOSH release is an attempt to get a more customizable/secure HAProxy release than what
is provided in [cf-release](https://github.com/cloudfoundry/cf-release). It allows users to
blocklist internal-only domains, preventing potential Host header spoofing from allowing
unauthorized access of internal APIs. It also allows for better control over HAProxy's
timeouts, for greater resiliency under heavy load.
## Usage
To deploy this BOSH release:
```bash
git clone https://github.com/cloudfoundry-community/haproxy-boshrelease.git
cd haproxy-boshrelease
export BOSH_ENVIRONMENT=
export BOSH_DEPLOYMENT=haproxy
bosh deploy manifests/haproxy.yml \
-v haproxy-backend-port=80 \
-v "haproxy-backend-servers=[10.10.10.10,10.10.10.11]"
```
To make alterations to the deployment you can use the `bosh deploy [-o operator-file.yml]` flag to provide [operations files](https://bosh.io/docs/cli-ops-files.html).
## Documentation
- [External Certificates](/docs/external_certs.md) - Using HAProxy with additional external certificates
- [Mutual TLS](/docs/mutual_tls.md) - Mutual TLS configuration
- [Rate Limiting](/docs/rate_limiting.md) - Client IP based rate limiting
- [Keepalived](/docs/keepalived.md) - Keepalived integration for high availability
- [Core Dumps](/docs/coredumps.md) - Enabling core dumps for HAProxy debugging
- [Dependency Updates](/docs/version-bumps.md) - How to bump dependency versions
- [Release Process](/docs/release-process.md) - How to create a new release
## Development
Feel free to contribute back to this via a pull request on a feature branch! Once merged, we'll
cut a new final release for you.
### Unit Tests and Linting
#### PR Validation
PRs will be automatically tested by https://concourse.arp.cloudfoundry.org/teams/main/pipelines/haproxy-boshrelease once a maintainer has labeled the PR with the `run-ci` label
#### Local Test Execution
Unit/RSpec tests and linters can be run locally to verify correct functionality before pushing to the CI system.
If you change any ERB logic in the jobs directory, please add a corresponding test to `spec`.
```bash
# install the necessary dependencies, once
bundle package
```
```bash
# run the rspec / unit tests for the configuration generation
cd haproxy_boshrelease
bundle install
bundle exec rake spec
```
```bash
# run the linter (rubocop) to identify any issues
cd haproxy_boshrelease
bundle install
bundle exec rake lint
```
```bash
# watch the tests while developing
cd haproxy_boshrelease
bundle install
bundle exec guard
```
#### Test Debugging
Unit/RSpec tests can also be debugged/stepped through when needed. See for example the [VSCode rdbg Ruby Debugger](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) extension. You can follow the "Launch without configuration" instructions for the extension, just set the "Debug command line" input to `bundle exec rspec `.
### Acceptance Tests
See [acceptance-tests README](/acceptance-tests/README.md).