Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jromero/java-buildpack-client
Prototype of a simple buildpack (https://buildpacks.io/) client for java..
https://github.com/jromero/java-buildpack-client
Last synced: about 1 month ago
JSON representation
Prototype of a simple buildpack (https://buildpacks.io/) client for java..
- Host: GitHub
- URL: https://github.com/jromero/java-buildpack-client
- Owner: jromero
- License: apache-2.0
- Created: 2021-08-13T13:53:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-13T21:20:54.000Z (over 3 years ago)
- Last Synced: 2024-10-13T11:11:00.594Z (3 months ago)
- Language: Java
- Size: 31.3 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# java-buildpack-client
Prototype of a simple buildpack (https://buildpacks.io/) client for java..
This project represents a simple implementation of the buildpack platform spec,
and can be used to build projects using specified buildpacks.
The client uses the combined `creator` lifecycle phase from from the buildpack to
drive the entire build. A fluent interface is provided to allow creation & configuration
of the build to be performed.
A very simple build can be performed with as little as..
```
BuildpackBuilder.get()
.withContent(new File("/home/user/java-project"))
.withFinalImage("test/testimage:latest")
.build();
```
This will use the default builder image from (https://packeto.io) to handle the build
of the project in the `/home/user/java-project` folder. The resulting image will
be stored in the local docker daemon as `test/testimage:latest`
## Overview
The [`BuildpackBuilder`](src/main/java/dev/snowdrop/buildpack/BuildpackBuilder.java) offers other configuration methods to customise behavior.
- run/build Image can be specified
- docker socket location can be configured
- cache volume names for build/launch can be specified, and optionally auto deleted after the build
- `creator` debug level can be set
- pull timeout can be configured in seconds
Options exist, but are not (yet) active, for..
- use docker registry instead of daemon (requires additional auth config, not implemented yet)
- passing Env content to the build stage (not implemented yet)
A variety of methods are supported for adding content to be build, content is combined in the order
passed, allowing for sparse source directories, or multiple project dirs to be combined.
- File/Directory, with prefix. Eg, take this directory /home/fish/wibble, and make it appear in the application content as /prodcode
- String Content, with path. Eg, take this String content "FISH" and make it appear in the application content as /prodcode/fish.txt
- InputStream Content, with path. Similar to String, except with data pulled from an InputStream.
- [`ContainerEntry`](src/main/java/dev/snowdrop/buildpack/docker/ContainerEntry.java) interface, for custom integration.
Output from the Builpack execution is available via the `BuildpackBuilder.LogReader` interface, which can be optionally be passed
to the `build` invocation. The `build` signature that doesn't accept a `LogReader` supplies it's own default reader that will pass
messages to stdout/stderr.
Build/RunImages will be pulled as required.
The builder will use docker via the `DOCKER_HOST` env var, if configured, or via the platform appropriate docker socket if not.
Alternatively, dockerHost can be directly configured on the builder itself. If the docker host starts with `unix://` the path to the
docker socket is extracted and used during the build phase. If unset, this defaults to `/var/run/docker/sock`
## How To:
Want to try out this project? well, it's not in maven central yet, and the packages/api are not fixed in stone yet, so be aware! But here are the basic steps to get you up and running.
1. Add Jitpack.io repository to your project's pom.
```
jitpack.io
https://jitpack.io
```
2. Add this project as a dependency via jitpack.
```
dev.snowdrop
buildpack-client
x.y.z-SNAPSHOT
```
3. Instantiate a BuildpackBuilder
```
BuildpackBuilder bpb = BuildpackBuilder.get();
```
4. Define the content to be built..
```
bpb = bpb.withContent(new File("/path/to/the/project/to/build));
```
5. Configure the name/tags for the image to create
```
bpb = bpb.withFinalImage("myorg/myimage:mytag");
```
6. Invoke the build
```
bpb.build();
```
Or.. combine all the above steps into a single callchain..
```
BuildpackBuilder.get()
.withContent(new File("/path/to/the/project/to/build))
.withFinalImage("myorg/myimage:mytag")
.build();
```
There are many more ways to customize & configure the BuildpackBuilder, take a look at the [interface](src/main/java/dev/snowdrop/buildpack/BuildpackBuilder.java) to see everything thats currently possible.
A demo project has been created to play with the Java `BuildpackBuilder` [here](https://github.com/snowdrop/java-buildpack-demo) :-)
Most likely if you are using this to integrate to existing tooling, you will want to supply a custom LogReader to receive the messages output by BuildPacks during the build. You may also want to associate cache names to a project, to enable faster rebuilds for a given project.
## FAQ:
**Will this work with Podman?:**
Not yet. Once the regular `pack` cli works with Podman, I'll revisit this and ensure it works too.
**Does this work on Windows?:**
Yes.. it's supposed to!
Tested with Win10 + Docker on WSL2
**Does this work on Linux?:**
Yes.. with Docker (real docker, not podman pretending to be docker).
Tested with Ubuntu + Docker