-
Notifications
You must be signed in to change notification settings - Fork 445
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for added Generators to Kubernetes Gradle Plugin
+ Add documentation for Quarkus, OpenLiberty, Micronaut generators + Fix invalid references, they can be added later when their documentation is added Signed-off-by: Rohan Kumar <rohaan@redhat.com>
- Loading branch information
1 parent
be8514f
commit fd859ce
Showing
12 changed files
with
72 additions
and
12 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
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
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
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
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
8 changes: 8 additions & 0 deletions
8
gradle-plugin/doc/src/main/asciidoc/inc/generator/_micronaut.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,8 @@ | ||
[[generator-micronaut]] | ||
=== Micronaut Generator | ||
|
||
The Micronaut generator (named `micronaut`) detects a Micronaut project by analyzing the plugin | ||
dependencies searching for `io.micronaut.application:io.micronaut.application.gradle.plugin`. | ||
|
||
This generator is based on the <<generator-java-exec, Java Application>> Generator and inherits all | ||
of its configuration values. |
11 changes: 11 additions & 0 deletions
11
gradle-plugin/doc/src/main/asciidoc/inc/generator/_openliberty.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-openliberty]] | ||
=== Open Liberty | ||
|
||
The Open Liberty generator runs when the Open Liberty plugin is enabled in the gradle build. It can done via two ways as specified in https://github.com/OpenLiberty/ci.gradle#usage[OpenLiberty Gradle Plugin docs]: | ||
|
||
- Within `apply plugin:` section as `liberty` | ||
- Within `plugins` section as `io.openliberty.tools.gradle.Liberty` | ||
|
||
The generator is similar to the <<generator-java-exec,java-exec generator>>. It supports the <<generator-options-common, common generator options>> and the <<generator-java-exec-options, `java-exec` options>>. | ||
|
||
For Open Liberty, the default value of webPort is 9080. |
5 changes: 3 additions & 2 deletions
5
gradle-plugin/doc/src/main/asciidoc/inc/generator/_overview.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
20 changes: 20 additions & 0 deletions
20
gradle-plugin/doc/src/main/asciidoc/inc/generator/_quarkus.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,20 @@ | ||
[[generator-quarkus]] | ||
=== Quarkus | ||
|
||
The `Quarkus` generator detects Quarkus based projects looking at project `build.gradle`: | ||
|
||
The base images chosen are: | ||
[[generator-quarkus-from]] | ||
.Webapp Base Images | ||
[cols="1,4,4"] | ||
|=== | ||
| | Docker Build | S2I Build | ||
|
||
| *Native* | ||
| `registry.access.redhat.com/ubi8/ubi-minimal:8.1` | ||
| `quay.io/quarkus/ubi-quarkus-native-binary-s2i` | ||
|
||
| *Normal Build* | ||
| `quay.io/jkube/jkube-java` | ||
| `quay.io/jkube/jkube-java` | ||
|=== |
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
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
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