qpc-github / buildpacks

Builders and buildpacks designed to run on Google Cloud's container platforms

Google Cloud's buildpacks

This repository contains a set of builders and buildpacks designed to run on Google Cloud's container platforms: Cloud Run, GKE, Anthos, and Compute Engine running Container-Optimized OS. They are also used as the build system for App Engine and Cloud Functions. They are 100% compatible with Cloud Native Buildpacks.

To start using Google Cloud's buildpacks

• Read our documentation on Google Cloud's buildpacks
• Try building an application or building a function with Google Cloud's buildpacks

Additional tooling

The Google Cloud's buildpacks project provides builder images suitable for use with pack, kpack, tekton, skaffold, and other tools that support the Buildpacks v3 specification.

Additional Configurations

Google Cloud's buildpacks can be configured in a few ways:

• Setting Environment Variables
• Google Cloud-specific configurations
• Custom Build and Run images
• Language specific configurations for:
  • Node.js
  • Python
  • Go
  • Java
  • Ruby

App Engine and Cloud Function Builders and Buildpacks

These builders create container images designed to run on Google Cloud's App Engine and Functions services. Most of the buildpacks are identical to those in the general builder.

Compared to the general builder, there are two primary differences. First, there are additional buildpacks which add transformations specific to each service. Second, in order to optimize execution speed, each language has a separate builder.

As an example, in order to build a Docker container image for Google App Engine Java17 runtime you can use:

pack build <app-name>  --builder gcr.io/gae-runtimes/buildpacks/java17/builder

If you rely on a custom App Engine entrypoint in your app.yaml, you can use:

pack build <app-name>  --builder gcr.io/gae-runtimes/buildpacks/java17/builder  --env GOOGLE_ENTRYPOINT="your entry point command"

The application container image can then be executed locally:

docker run --rm -p 8080:8080 <app-name>

Locally, your application might depend on App Engine enviroment variables that would need to be set in the local environment.

Learn more about Cloud Native Buildpacks

This project implements the Cloud Native Buildpacks specification. To read more, see Cloud Native Buildpacks project documentation.

For those new to buildpacks, these concepts are good starting points:

• Builder A container image that contains buildpacks and detection order in which builds are executed.
• Buildpack An executable that "inspects your app source code and formulates a plan to build and run your application".
• Buildpack Group Several buildpacks which together provide support for a specific language or framework.
• Run Image The container image that serves as the base for the built application.

Support

Google Cloud's buildpacks are only officially supported when used with Google Cloud products. Customers of Google Cloud can use standard support channels for help using buildpacks with Google Cloud Products.

Security

For information on reporting security vulnerabilities, see SECURITY.md.

Get involved with the community

We welcome contributions! Here's how you can contribute:

• Browse issues or file an issue
• Contribute:
  • Read the contributing guide before starting work on an issue
  • Try to fix good first issues
  • Help out on issues that need help
  • Join in on discussion issues

License

See LICENSE.