You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ This project is a goto reference for the following scenarios :
44
44
To use Docker versions below 20.10, download an earlier Mendix Docker Buildpack release, such as [v2.3.2](https://github.com/mendix/docker-mendix-buildpack/releases/tag/v2.3.2)
45
45
* For preparing, a local installation of `curl`
46
46
* For local testing, make sure you can run the [docker-compose command](https://docs.docker.com/compose/install/)
47
-
* A Mendix app based on Mendix 7 or a later version
47
+
* A Mendix app based on Mendix 8 or a later version
When building the the `rootfs-builder.dockerfile` file, you can provide the following additional arguments:
84
+
85
+
-**CF_BUILDPACK** is a version of CloudFoundry buildpack. Defaults to `v5.0.0`. For stable pipelines, it's recommended to use a fixed **v5.0.0** version. Other Cloud Foundry buildpacks might not work with this version of Docker Buildpack.
86
+
-**CF_BUILDPACK_URL** specifies the URL where the CF buildpack should be downloaded from (for example, a local mirror). Defaults to `https://github.com/mendix/cf-mendix-buildpack/releases/download/${CF_BUILDPACK}/cf-mendix-buildpack.zip`. Specifying **CF_BUILDPACK_URL** will override the version from **CF_BUILDPACK**.
87
+
-**BUILDPACK_XTRACE** can be used to enable CF Buildpack [debug logging](https://github.com/mendix/cf-mendix-buildpack#logging-and-debugging). Set this variable to `true` to enable debug logging.
88
+
83
89
### Compile an app
84
90
85
91
Before running the container, it is necessary to build the image with your application. This buildpack contains Dockerfile with a script that will compile your application using [cf-mendix-buildpack](https://github.com/mendix/cf-mendix-buildpack/).
@@ -95,9 +101,7 @@ For build you can provide next arguments:
95
101
-**BUILD_PATH** indicates where the application model is located. It is a root directory of an unzipped .MDA or .MPK file. In the latter case, this is the directory where your .MPR file is located. Must be within [build context](https://docs.docker.com/engine/reference/commandline/build/#extended-description). Defaults to `./project`.
96
102
-**ROOTFS_IMAGE** is a type of rootfs image. Defaults to `mendix-rootfs:app` (a locally prebuilt image).
97
103
-**BUILDER_ROOTFS_IMAGE** is a type of rootfs image used for downloading the Mendix app dependencies and compiling the Mendix app from source. Defaults to `mendix-rootfs:builder` (a locally prebuilt image).
98
-
-**CF_BUILDPACK** is a version of CloudFoundry buildpack. Defaults to `v4.30.17`. For stable pipelines, it's recommended to use a fixed version from **v4.30.17** and later. CloudFoundry buildpack versions below **v4.30.17** are not supported.
99
104
-**EXCLUDE_LOGFILTER** will exclude the `mendix-logfilter` binary from the resulting Docker image if set to `true`. Defaults to `true`. Excluding `mendix-logfilter` will reduce the image size and remove a component that's not commonly used; the `LOG_RATELIMIT` environment variable option will be disabled.
100
-
-**CF_BUILDPACK_URL** specifies the URL where the CF buildpack should be downloaded from (for example, a local mirror). Defaults to `https://github.com/mendix/cf-mendix-buildpack/releases/download/${CF_BUILDPACK}/cf-mendix-buildpack.zip`. Specifying **CF_BUILDPACK_URL** will override the version from **CF_BUILDPACK**.
101
105
-**BLOBSTORE** can be used to specify an alternative buildpack resource server (instead of the default Mendix CDN). For more information, see the [CF Buildpack offline settings](https://github.com/mendix/cf-mendix-buildpack#offline-buildpack-settings).
102
106
-**BUILDPACK_XTRACE** can be used to enable CF Buildpack [debug logging](https://github.com/mendix/cf-mendix-buildpack#logging-and-debugging). Set this variable to `true` to enable debug logging.
Copy file name to clipboardExpand all lines: upgrading-from-v4.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ Docker Buildpack v5 contains some breaking changes and will require some changes
4
4
5
5
* rootfs images are no longer published to Docker Hub.
6
6
* rootfs images are now based on [Red Hat Universal Base Image 8 minimal](https://developers.redhat.com/articles/ubi-faq) image.
7
+
* CF Buildpack is packaged directly into the build image.
8
+
* Mendix 7 and older versions are no longer supported. To use Docker Buildpack v5, upgrade your app to Mendix 8 or a later version.
7
9
8
10
## Building rootfs images
9
11
@@ -15,7 +17,7 @@ In the past, Docker Buildpack offered two types of rootfs images: `bionic` and `
15
17
With Docker Buildpack v5, all images are now based on ubi8-minimal:
16
18
17
19
*`app` images contain only components that are required to run an app. Build-time components such as `tar`, compilers or Mono prerequisites are excluded - reducing the image size and excluding components that could increase the number of unpatched CVEs in the final image
18
-
*`builder` images contain additional components that are only required when compiling a Mendix app.
20
+
*`builder` images contain CF Buildpack and additional components that are only required when compiling a Mendix app.
19
21
20
22
You will need to update your pipelines to build these prerequisite images and (optionally) push them to your private registry.
21
23
@@ -32,6 +34,7 @@ In this case, your build pipeline needs to be adjusted:
2. When building the Mendix app itself, use the default values for `ROOTFS_IMAGE` and `BUILDER_ROOTFS_IMAGE` (remove any custom `--build-arg ROOTFS_IMAGE=...` and `--build-arg BUILDER_ROOTFS_IMAGE=...` arguments from the `docker build` command)
37
+
3. If you need to use a specific version of CF Buildpack via `CF_BUILDPACK` or `CF_BUILDPACK_URL` arguments, these arguments should be specified when building the `rootfs-builder.dockerfile` image, **not** your app image.
35
38
36
39
### Option 2: build rootfs images centrally
37
40
@@ -55,6 +58,7 @@ In this case, you need to make the following changes in your CI/CD process:
3. If you need to use a specific version of CF Buildpack via `CF_BUILDPACK` or `CF_BUILDPACK_URL` arguments, these arguments should be specified when building the `rootfs-builder.dockerfile` image, **not** your app image.
0 commit comments