Skip to content

Commit

Permalink
doc (quickstarts/gradle) : Add quickstart metadata in README for proc…
Browse files Browse the repository at this point in the history
…essing in website (eclipse-jkube#1050)

Add quickstart metadata in all README.md files of all quickstarts.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
  • Loading branch information
rohanKanojia committed May 16, 2022
1 parent 0aa660f commit b778ede
Show file tree
Hide file tree
Showing 25 changed files with 171 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "Gradle :: Docker File Provided Context and Assembly"
description: |
Spring Boot Web application with a single @RestController.
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
Also provides example on how to configure Docker Context directory and assembly name.
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "Gradle :: Docker File Provided Context and File"
description: |
Spring Boot Web application with a single @RestController.
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
Also provides example on how to configure Docker Context directory and Dockerfile path.
---
7 changes: 7 additions & 0 deletions quickstarts/gradle/docker-file-provided-context-dir/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "Gradle :: Docker File Provided Context Dir"
description: |
Spring Boot Web application with a single @RestController.
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
Also provides example on how to configure Docker Context directory.
---
7 changes: 7 additions & 0 deletions quickstarts/gradle/docker-file-provided-docker-file/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "Gradle :: Docker File Provided Docker File"
description: |
Spring Boot Web application with a single @RestController.
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
Also provides example on how to configure Docker Context directory and interpolation filter delimiter.
---
6 changes: 6 additions & 0 deletions quickstarts/gradle/docker-file-simple/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
name: "Gradle :: Docker File Simple"
description: |
Spring Boot Web application with a single @RestController.
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
---
# Eclipse JKube sample with simple Dockerfile mode

You can build your Docker images with just providing one `Dockerfile` in your project root directory and Eclipse JKube
Expand Down
6 changes: 6 additions & 0 deletions quickstarts/gradle/groovy-dsl-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: "Gradle :: Groovy DSL Config"
description: |
Apache Camel application.
Demonstrates how to configure Eclipse JKube build and resource properties using Groovy DSL elements in the project's build.gradle plugin configuration.
---
8 changes: 8 additions & 0 deletions quickstarts/gradle/micronaut-customized-image/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: "Gradle :: Micronaut Customized Image"
description: |
Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).
Includes configuration to enable health check probes (livenessProbe &amp; readinessProbe) using JKube's
powerful resource fragments and micronaut-management feature.
Groovy DSL based image configuration compatible with OpenShift and Kubernetes.
---
4 changes: 4 additions & 0 deletions quickstarts/gradle/micronaut/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
name: "Gradle :: Micronaut"
description: Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).
---
# Eclipse JKube Micronaut quickstart

Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
name: "Gradle :: Open Liberty with Legacy Plugin syntax"
description: |
JAX-RS application deployed with OpenLiberty and Eclipse JKube using old style Gradle syntax for plugin declaration.
The application contains a single endpoint (/hello) that prints 'Hello, World.'.
---
# Eclipse JKube OpenLiberty Gradle Quickstart

This is a demo gradle application based on OpenLiberty framework which can be deployed to Kubernetes with the help of Kubernetes Gradle Plugin.
Expand Down
6 changes: 6 additions & 0 deletions quickstarts/gradle/openliberty/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
name: "Gradle :: Open Liberty"
description: |
JAX-RS application deployed with OpenLiberty and Eclipse JKube.
The application contains a single endpoint (/hello) that prints 'Hello, World.'.
---
# Eclipse JKube OpenLiberty Gradle Quickstart

This is a demo gradle application based on OpenLiberty framework which can be deployed to
Expand Down
7 changes: 7 additions & 0 deletions quickstarts/gradle/quarkus-customized-image/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
name: "Gradle :: Quarkus Customized Image"
description: |
Quarkus application with a single JAX-RS endpoint.
Demonstrates how to build a Quarkus container image based on a Red Hat container image private registry.
Uses a pull secret from Red Hat Registry Service Accounts to authenticate.
---
# Eclipse JKube Quarkus with Customized Image Quickstart

A simple REST application demonstrating usage of Eclipse JKube with Quarkus
Expand Down
23 changes: 19 additions & 4 deletions quickstarts/gradle/quarkus/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
name: "Gradle :: Quarkus"
description: |
Quarkus application with a single JAX-RS endpoint.
Demonstrates how to package the project using JVM mode or Native image mode.
Demonstrates how to build a Quarkus project container with Eclipse JKube's S2I, Docker and JIB build strategies.
---
# Eclipse JKube Quarkus Quickstart

A simple REST application demonstrating usage of Eclipse JKube with Quarkus.
Expand Down Expand Up @@ -90,7 +97,15 @@ On invoking this, you can see it in browser:
```shell
$ eval $(minikube -p minikube docker-env)
$ ./gradlew clean build -Pquarkus.package.type=native -Pquarkus.native.remote-container-build=true
$ ./gradlew k8sBuild
$ ./gradlew build k8sResource
$ ./gradlew k8sApply
```
$ ./gradlew k8sBuild k8sResource k8sApply
```

### JIB

```shell
$ eval $(minikube -p minikube docker-env)
$ ./gradlew clean build -Pquarkus.package.type=native -Pquarkus.native.remote-container-build=true
$ ./gradlew k8sBuild -Pjkube.build.strategy=jib
$ docker load -i ./build/docker/gradle/quarkus/1.7.0/tmp/docker-build.tar
$ ./gradlew k8sResource k8sApply
```
7 changes: 7 additions & 0 deletions quickstarts/gradle/spring-boot-camel-complete/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "Gradle :: Spring Boot - Camel"
description: |
Spring Boot application with Camel Spring Boot integration.
Programmatically (RouteBuilder) declares 2 routes to log messages and process orders.
Declares an Apache Camel servlet REST endpoint.
---
8 changes: 8 additions & 0 deletions quickstarts/gradle/spring-boot-crd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: "Gradle :: Spring Boot - Custom Resources"
description: |
Spring Boot application using K8s Custom Resources.
Declares a "Framework" Custom Resource Definition.
Initializes cluster with sample data.
Declares an endpoint to consume Custom Resource data stored in the cluster.
---
6 changes: 6 additions & 0 deletions quickstarts/gradle/spring-boot-helm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: "Gradle :: Spring Boot - Helm"
description: |
Spring Boot application with a single REST endpoint.
Demonstrates how to generate Helm chart (YAML) files using Eclipse JKube's k8sHelm Gradle task.
---
7 changes: 7 additions & 0 deletions quickstarts/gradle/spring-boot-watch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "Gradle :: Spring Boot Watch"
description: |
Spring Boot application with a single REST endpoint.
Demonstrates how to watch for source changes using Eclipse JKube's k8sWatch task.
Application gets live reloaded in the cluster each time the project is recompiled (gradle build).
---
6 changes: 6 additions & 0 deletions quickstarts/gradle/spring-boot-with-jib-assembly/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: "Gradle :: Spring Boot JIB"
description: |
Spring Boot application with a single REST endpoint.
Demonstrates how to build a project using Eclipse JKube JIB build strategy.
---
6 changes: 6 additions & 0 deletions quickstarts/gradle/spring-boot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: "Gradle :: Spring Boot Web"
description: |
Spring Boot Web application with a single @RestController.
Shows how to deploy Spring Boot applications to Kubernetes and OpenShift using Eclipse JKube.
---
4 changes: 4 additions & 0 deletions quickstarts/gradle/spring-boot/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ plugins {
group = 'org.eclipse.jkube.quickstarts.gradle'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'
description = """\
Spring Boot Web application with a single @RestController.
Shows how to deploy Spring Boot applications to Kubernetes and OpenShift using Eclipse JKube.
"""

repositories {
mavenCentral()
Expand Down
5 changes: 5 additions & 0 deletions quickstarts/gradle/thorntail/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
name: "Gradle :: Thorntail"
description: |
Java web application with a single JAX-RS endpoint packaged with Thorntail.
---
5 changes: 5 additions & 0 deletions quickstarts/gradle/vertx/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
name: "Gradle :: Vertx Web"
description: |
Eclipse Vert.x example application declaring a Simple AbstractVerticle.
---
# Vertx sample for Eclipse JKube gradle plugins
This is a sample project to use Eclipse JKube plugins.

Expand Down
6 changes: 6 additions & 0 deletions quickstarts/gradle/webapp-custom/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
name: "Gradle :: Custom Webapp"
description: |
Java Web Application with a static index.html resource.
Demonstrates how to use Eclipse JKube with a war project to build a container image based on a custom image instead of the defaults Tomcat/Jetty/Wildfly.
---
# Eclipse JKube Webapp custom
This quick start showcases how to use Eclipse JKube with a war project to build a container image based on a custom image instead of the defaults Tomcat/Jetty/Wildfly.

Expand Down
7 changes: 7 additions & 0 deletions quickstarts/gradle/webapp-jetty/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
name: "Gradle :: Webapp :: Jetty"
description: |
Java Web Application with a static index.html resource.
Demonstrates building container image with war project.
It also tries to detect WAR builds and select container image based on configuration specified in build.gradle
---
# Eclipse JKube Webapp - Jetty
This quick start showcases how to use Eclipse JKube with a war project to build a container image.
The webapp generator tries to detect WAR builds and selects a base servlet container image based on the configuration found in the `build.gradle`. A Tomcat base image is selected by default.
Expand Down
8 changes: 8 additions & 0 deletions quickstarts/gradle/webapp-wildfly/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
name: "Gradle :: Webapp :: Wildfly"
description: |
Java Web Application with a static index.html resource.
Demonstrates how to create a container image with an embedded WildFly server using Eclipse JKube.
WildFly is used instead of Apache Tomcat because there is a WildFly persistence.xml and -ds.xml configuration.
Eclipse JKube detects this file and chooses a WildFly specific base container image.
---
# Eclipse JKube Webapp Wildfly Sample
This quick start showcases how to use Eclipse JKube with a Wildfly war project.
Demonstrates how to create a container image with an embedded WildFly server using Eclipse JKube.
Expand Down
6 changes: 6 additions & 0 deletions quickstarts/gradle/webapp/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
name: "Gradle :: Webapp"
description: |
Java Web Application with a static index.html resource.
Demonstrates how to create a container image with an embedded Apache Tomcat server using Eclipse JKube.
---
# Eclipse JKube Webapp
This quick start showcases how to use Eclipse JKube with a war project to build a container image.
The webapp generator tries to detect WAR builds and selects a base servlet container image based on the configuration found in the `build.gradle`. A Tomcat base image is selected by default.
Expand Down

0 comments on commit b778ede

Please sign in to comment.