Skip to content

Latest commit

 

History

History
57 lines (33 loc) · 3.78 KB

README.md

File metadata and controls

57 lines (33 loc) · 3.78 KB
Raw

Building Platform Packages using Docker

Building the Image

After every change to your formulae, perform the following from the root of the Git repository (not from support/build/_docker/) to rebuild the images for each stack:

$ docker build --pull --tag heroku-php-build-heroku-24-amd64 --platform linux/amd64 --file $(pwd)/support/build/_docker/heroku-24.Dockerfile .
$ docker build --pull --tag heroku-php-build-heroku-24-arm64 --platform linux/arm64 --file $(pwd)/support/build/_docker/heroku-24.Dockerfile .
$ docker build --pull --tag heroku-php-build-heroku-22 --file $(pwd)/support/build/_docker/heroku-22.Dockerfile .
$ docker build --pull --tag heroku-php-build-heroku-20 --file $(pwd)/support/build/_docker/heroku-20.Dockerfile .

Configuration

File env.default contains a list of required env vars, some with default values. You can copy this file to a location outside the buildpack and modify it with the values you desire and pass its location with --env-file, or pass the env vars to docker run using --env.

Out of the box, each Dockerfile has the correct values predefined for S3_BUCKET, S3_PREFIX, and S3_REGION. If you're building your own packages, you'll likely want to change S3_BUCKET and S3_PREFIX to match your info. Instead of setting AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY into that file, it is recommended to pass them to docker run through the environment, or explicitly using --env, in order to prevent accidental commits of credentials.

Using the Image

From the root of the Git repository (not from support/build/_docker/), you can e.g. bash into each of the images you built using their tag:

docker run --rm -ti heroku-php-build-heroku-24-amd64 bash
docker run --rm -ti heroku-php-build-heroku-24-arm64 bash
docker run --rm -ti heroku-php-build-heroku-22 bash
docker run --rm -ti heroku-php-build-heroku-20 bash

You then have a shell where you can run bob build, deploy.sh and so forth. You can of course also invoke these programs directly with docker run.

The support/build/_util/ directory is on $PATH in the image.

Passing AWS credentials to the container

If you want to deploy packages and thus need to pass AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, you can either pass them explicitly, through your environment, or through an env file.

Passing credentials explicitly

docker run --rm -ti -e AWS_ACCESS_KEY_ID=... -e AWS_SECRET_ACCESS_KEY=... heroku-php-build-heroku-22 bash

Passing credentials through the environment

The two environment variables AWS_ACCESS_KEY_IDand AWS_SECRET_ACCESS_KEY are defined in support/build/_docker/env.default, without values. This will cause Docker to "forward" values for these variables from the current environment, so you can pass them in:

AWS_ACCESS_KEY_ID=... AWS_SECRET_ACCESS_KEY=... docker run --rm -ti --env-file=support/build/_docker/env.default heroku-php-build-heroku-22 bash

or

export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
docker run --rm -ti --env-file=support/build/_docker/env.default heroku-php-build-heroku-22 bash

Passing credentials through a separate env file

This method is the easiest for users who want to build packages in their own S3 bucket, as they will have to adjust the S3_BUCKET and S3_PREFIX environment variable values anyway from their default values.

For this method, it is important to keep the credentials file in a location outside the buildpack, so that your credentials aren't accidentally committed. Copy support/build/_docker/env.default to a safe location outside the buildpack directory, and insert your values for AWS_ACCESS_KEY_IDand AWS_SECRET_ACCESS_KEY.

docker run --rm -ti --env-file=../SOMEPATHOUTSIDE/s3.env heroku-php-build-heroku-22 bash