From c5ff3f5841e4fa95f5e9e7fb6e2621c54f987b46 Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Tue, 12 Mar 2024 20:39:27 +0530 Subject: [PATCH] doc (jkube-kit/doc) : Add documentation for SimpleDockerfileGenerator Signed-off-by: Rohan Kumar --- jkube-kit/doc/src/main/asciidoc/inc/_generator.adoc | 5 +++++ .../asciidoc/inc/generator/_simple_dockerfile.adoc | 11 +++++++++++ 2 files changed, 16 insertions(+) create mode 100644 jkube-kit/doc/src/main/asciidoc/inc/generator/_simple_dockerfile.adoc diff --git a/jkube-kit/doc/src/main/asciidoc/inc/_generator.adoc b/jkube-kit/doc/src/main/asciidoc/inc/_generator.adoc index 44a1d5a9ee..391081cc59 100644 --- a/jkube-kit/doc/src/main/asciidoc/inc/_generator.adoc +++ b/jkube-kit/doc/src/main/asciidoc/inc/_generator.adoc @@ -14,6 +14,10 @@ All default generators examine the build information for certain aspects and gen |=== | Generator | Name | Description +| <> +| `dockerfile-simple` +| Generator for creating Image when user places `Dockerfile` in project base directory. + | <> | `java-exec` | Generic generator for flat classpath and fat-jar Java applications @@ -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[] diff --git a/jkube-kit/doc/src/main/asciidoc/inc/generator/_simple_dockerfile.adoc b/jkube-kit/doc/src/main/asciidoc/inc/generator/_simple_dockerfile.adoc new file mode 100644 index 0000000000..d642773ff5 --- /dev/null +++ b/jkube-kit/doc/src/main/asciidoc/inc/generator/_simple_dockerfile.adoc @@ -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].