-
Notifications
You must be signed in to change notification settings - Fork 542
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc (jkube-kit/doc) : Add documentation for SimpleDockerfileGenerator
Signed-off-by: Rohan Kumar <rohaan@redhat.com>
- Loading branch information
1 parent
c4ee9d4
commit c5ff3f5
Showing
2 changed files
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
jkube-kit/doc/src/main/asciidoc/inc/generator/_simple_dockerfile.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]. |