Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc (jkube-kit/doc) : Add documentation for SimpleDockerfileGenerator #2804

Merged
merged 1 commit into from
Apr 16, 2024
Merged

doc (jkube-kit/doc) : Add documentation for SimpleDockerfileGenerator #2804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions jkube-kit/doc/src/main/asciidoc/inc/_generator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ All default generators examine the build information for certain aspects and gen
|===
| Generator | Name | Description

| <<generator-simple-dockerfile, Simple Dockerfile>>
| `dockerfile-simple`
| Generator for creating Image when user places `Dockerfile` in project base directory.

| <<generator-java-exec,Java Applications>>
| `java-exec`
| Generic generator for flat classpath and fat-jar Java applications
Expand Down Expand Up @@ -67,6 +71,7 @@ endif::[]

include::generator/_options_common.adoc[]

include::generator/_simple_dockerfile.adoc[]
include::generator/_java_exec.adoc[]
include::generator/_spring_boot.adoc[]
include::generator/_thorntail_v2.adoc[]
Expand Down
11 changes: 11 additions & 0 deletions jkube-kit/doc/src/main/asciidoc/inc/generator/_simple_dockerfile.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[[generator-simple-dockerfile]]
=== Simple Dockerfile

Simple Dockerfile generator is responsible for creating an opinionated image configuration when user places `Dockerfile` in project's base directory.

This generator gets activated when these conditions are met:

- `Dockerfile` is placed in project's base directory
- Either `image` configuration is not provided, or `image` configuration provided does not have `build` configured.

Image built with this configuration would use the `Dockerfile` for https://docs.docker.com/reference/cli/docker/image/build/[docker build] and project base directory as https://docs.docker.com/build/building/context/#filesystem-contexts[docker context directory].