Sealights Agent Framework

September 13, 2022 ยท View on GitHub

The Sealights Agent Framework causes an application to be automatically configured to work with Sealights Service.

Detection CriterionExistence of a single bound sealights service. The existence of a sealights service defined by the VCAP_SERVICES payload containing a service name, label or tag with sealights as a substring.
Tagssealights-agent=<version>
Tags are printed to standard output by the buildpack detect script

User-Provided Service

When binding Sealights using a user-provided service, it must have name or tag with sealights in it. The credential payload can contain the following entries.

NameDescription
tokenA Sealights Agent token
proxySpecify a HTTP proxy used to communicate with the Sealights backend. Required when a corporate network prohibits communication to cloud services. The default is to have no proxy configured. This does not inherit from http_proxy/https_proxy or http.proxyHost/https.proxyHost, you must set this specifically if a proxy is needed.
lab_idSpecify a Sealights Lab ID

All fields above except the agent token may be also specified in the Configuration Section below.

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.

The framework can be configured by modifying the config/sealights_agent.yml file. The framework uses the Repository utility support and so it supports the version syntax defined there.

NameDescription
build_session_idSealights Build Session ID for the application. Leave blank to use the value embedded in the jar/war artifacts
proxySpecify a HTTP proxy used to communicate with the Sealights backend. Required when a corporate network prohibits communication to cloud services. The default is to have no proxy configured. This does not inherit from http_proxy/https_proxy or http.proxyHost/https.proxyHost, you must set this specifically if a proxy is needed.
lab_idSpecify a Sealights Lab ID
auto_upgradeEnable/disable agent auto-upgrade. Off by default
versionThe version of Auto-reconfiguration to use. Candidate versions can be found in this listing. If auto_upgrade is turned on, a different version may be downloaded and used at runtime

Configuration settings will take precedence over the ones specified in the User-Provided Service, if those are defined.

Troubleshooting and Support

For additional documentation and support, visit the official Sealights Java agents documentation page