Managing Custom Buildpacks

Page last updated:

This topic describes how an admin can manage additional buildpacks in Cloud Foundry. If your application uses a language or framework that the Cloud Foundry system buildpacks do not support, you can:

Add a Buildpack

Note: You must be an administrator for your Cloud Foundry org to run the commands discussed in this section.

To add a buildpack, run:

$ cf create-buildpack BUILDPACK PATH POSITION [--enable|--disable]

The arguments to cf create-buildpack specify the following:

  • buildpack specifies the buildpack name.

  • path specifies where to find the buildpack. The path can point to a zip file, the URL of a zip file, or a local directory.

  • position specifies where to place the buildpack in the detection priority list. See Buildpack Detection.

  • enable or disable specifies whether to allow apps to be pushed with the buildpack. This argument is optional, and defaults to enable. While a buildpack is disabled, app developers cannot push apps using that buildpack.

To confirm that you have successfully added a buildpack, run cf buildpacks.

The following example shows the output from running the cf buildpacks command after the administrator added a Python buildpack:

$ cf buildpacks
Getting buildpacks...

buildpack          position   enabled   locked   filename
ruby_buildpack     1          true      false    buildpack_ruby_v46-245-g2fc4ad8.zip
nodejs_buildpack   2          true      false    buildpack_nodejs_v8-177-g2b0a5cf.zip
java_buildpack     3          true      false    buildpack_java_v2.1.zip
python_buildpack   4          true      false    buildpack_python_v2.7.6.zip

Rename a Buildpack

$ cf rename-buildpack BUILDPACK_NAME NEW_BUILDPACK_NAME

For more information on renaming a buildpack, see the CLI documentation.

Update a Buildpack

$ cf update-buildpack BUILDPACK [-p PATH] [-i POSITION] [--enable|--disable] [--lock|--unlock]

For more information on updating a buildpack, see the CLI documentation.

Delete a Buildpack

$ cf delete-buildpack BUILDPACK [-f]

For more information on deleting a buildpack, see the CLI documentation.

Disabling Custom Buildpacks

You can disable custom buildpacks for an entire deployment by setting the cc.disable_custom_buildpacks property to false in your Cloud Foundry deployment manifest. See the Deploying Cloud Foundry section for more information about creating and editing a manifest.

View the source for this page in GitHub