/apt-buildpack

Primary LanguageGoMIT LicenseMIT

Cloud Foundry Experimental Apt Buildpack

CF Slack Join us on Slack

A Cloud Foundry buildpack for apps requiring custom apt packages.

Buildpack User Documentation

The apt buildpack can be used to install deb packages prior to use in another buildpack. To configure which packages to install, provide apt.yml in your application and include a list of packages to install, eg:

---
packages:
- ascii
- libxml
- https://example.com/exciting.deb

If you would like to use custom apt repositories, you can add keys and repos to the apt.yml, eg:

---
keys:
- https://example.com/public.key
repos:
- deb http://apt.example.com stable main
packages:
- ascii
- libxml

Building the Buildpack

To build this buildpack, run the following command from the buildpack's directory:

  1. Source the .envrc file in the buildpack directory.

    source .envrc

    To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

  2. Install buildpack-packager

    (cd src/apt/vendor/github.com/cloudfoundry/libbuildpack/packager/buildpack-packager && go install)
  3. Build the buildpack

    buildpack-packager
  4. Use in Cloud Foundry

    Upload the buildpack to your Cloud Foundry and optionally specify it by name

    cf create-buildpack [BUILDPACK_NAME] [BUILDPACK_ZIP_FILE_PATH] 1
    cf push my_app [-b BUILDPACK_NAME]

Testing

Buildpacks use the Cutlass framework for running integration tests.

To test this buildpack, run the following command from the buildpack's directory:

  1. Source the .envrc file in the buildpack directory.

    source .envrc

    To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

  2. Run unit tests

    ./scripts/unit.sh
  3. Run integration tests

    ./scripts/integration.sh

More information can be found on Github cutlass.

Contributing

Find our guidelines here.

Help and Support

Join the #buildpacks channel in our Slack community

Reporting Issues

Open an issue on this project

Active Development

The project backlog is on Pivotal Tracker

Disclaimer

This buildpack is experimental and not yet intended for production use.