Skip to content

Commit

Permalink
doc (jkube-kit/doc) : Add documentation for SimpleDockerfileGenerator
Browse files Browse the repository at this point in the history
Signed-off-by: Rohan Kumar <rohaan@redhat.com>
  • Loading branch information
rohanKanojia committed Mar 12, 2024
1 parent c4ee9d4 commit c5ff3f5
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
5 changes: 5 additions & 0 deletions jkube-kit/doc/src/main/asciidoc/inc/_generator.adoc
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
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].

0 comments on commit c5ff3f5

Please sign in to comment.