🚨 NOTICE 🚨

Effective May 17th 2021 the default branch will change from master to main. Run the following commands to update a local clone:

git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -

sigsci-cloudfoundry-buildpack

Cloud Foundry multi-buildpack for Signal Sciences agent integration

This is a supply-buildpack for Cloud Foundry that provides integration with the Signal Sciences agent for any programming language supported by the platform, and requiring zero application code changes.

Using the Signal Sciences buildpack

Application developers will need to specify the buildpack with the cf push command. From the docs:

cf push YOUR-APP -b https://github.com/signalsciences/sigsci-cloudfoundry-buildpack.git -b APP_BUILDPACK

Windows support

Support is available for Windows stemcells. Deploying to a windows environment is similar to linux:

cf push YOUR-APP -s windows -b https://github.com/signalsciences/sigsci-cloudfoundry-buildpack.git -b APP_BUILDPACK

In almost all cases, it will be used in conjunction with the following buildpacks:

binary-buildpack: binary-buildpack - for console apps, .net core, .exe
hwc-buildpack: hwc-buildpack - legacy ASP.NET / WCF

Configuration

To configure the Signal Sciences agent the following environment variables must be set:

SIGSCI_ACCESSKEYID (required)

SIGSCI_SECRETACCESSKEY (required)

SIGSCI_REVERSE_PROXY_UPSTREAM (optional, default: 127.0.0.1:8081)

SIGSCI_AGENT_VERSION (optional, default: latest)

SIGSCI_SERVER_HOSTNAME (optional)

SIGSCI_AGENT_DOWNLOAD_URL (optional, NOTE: This needs to be a fully qualified http(s) path to a tar, gzipped agent file)

NOTE: If SIGSCI_AGENT_DOWNLOAD_URL is set, then SIGSCI_AGENT_VERSION will be ignored, and SIGSCI_DISABLE_CHECKSUM_INTEGRITY_CHECK will be implied.

Set environment variables using the cf command:

cf set-env YOUR-APP <variable name> "<value>"

In order to have these changes take effect, you must at least re-stage your app:

cf restage YOUR-APP

Signal Sciences Agent

Every time this buildpack runs it will download and install the latest version of the Signal Sciences agent, unless a version is specified in the app's SIGSCI_AGENT_VERSION environment var.

Releasing the Buildpack

Follow these steps to release a new version of the buildpack:

Merge your changes to master.
Create a new release on the releases page.
Upon creation of the release, a workflow should execute.
The workflow will create a tar.gz archive of the bin/ and lib/ directories, and upload it to the release created in step #2.

signalsciences / sigsci-cloudfoundry-buildpack