diff --git a/quickstarts/gradle/docker-file-provided-context-and-assembly/README.md b/quickstarts/gradle/docker-file-provided-context-and-assembly/README.md new file mode 100644 index 0000000000..4ef0fa5af5 --- /dev/null +++ b/quickstarts/gradle/docker-file-provided-context-and-assembly/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/docker-file-provided-context-and-file/README.md b/quickstarts/gradle/docker-file-provided-context-and-file/README.md new file mode 100644 index 0000000000..ba36dacf66 --- /dev/null +++ b/quickstarts/gradle/docker-file-provided-context-and-file/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/docker-file-provided-context-dir/README.md b/quickstarts/gradle/docker-file-provided-context-dir/README.md new file mode 100644 index 0000000000..0834f6168e --- /dev/null +++ b/quickstarts/gradle/docker-file-provided-context-dir/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/docker-file-provided-docker-file/README.md b/quickstarts/gradle/docker-file-provided-docker-file/README.md new file mode 100644 index 0000000000..eef9f4f887 --- /dev/null +++ b/quickstarts/gradle/docker-file-provided-docker-file/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/docker-file-simple/README.md b/quickstarts/gradle/docker-file-simple/README.md index 92aad1a69b..519854d53a 100644 --- a/quickstarts/gradle/docker-file-simple/README.md +++ b/quickstarts/gradle/docker-file-simple/README.md @@ -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 diff --git a/quickstarts/gradle/groovy-dsl-config/README.md b/quickstarts/gradle/groovy-dsl-config/README.md new file mode 100644 index 0000000000..5be8f82dee --- /dev/null +++ b/quickstarts/gradle/groovy-dsl-config/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/micronaut-customized-image/README.md b/quickstarts/gradle/micronaut-customized-image/README.md new file mode 100644 index 0000000000..1adda2f3cc --- /dev/null +++ b/quickstarts/gradle/micronaut-customized-image/README.md @@ -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 & readinessProbe) using JKube's + powerful resource fragments and micronaut-management feature. + Groovy DSL based image configuration compatible with OpenShift and Kubernetes. +--- \ No newline at end of file diff --git a/quickstarts/gradle/micronaut/README.md b/quickstarts/gradle/micronaut/README.md index 768fd0a62f..82abf6f737 100644 --- a/quickstarts/gradle/micronaut/README.md +++ b/quickstarts/gradle/micronaut/README.md @@ -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). diff --git a/quickstarts/gradle/openliberty-with-legacy-plugin-syntax/README.md b/quickstarts/gradle/openliberty-with-legacy-plugin-syntax/README.md index ec003818fc..fb402dd2d9 100644 --- a/quickstarts/gradle/openliberty-with-legacy-plugin-syntax/README.md +++ b/quickstarts/gradle/openliberty-with-legacy-plugin-syntax/README.md @@ -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. diff --git a/quickstarts/gradle/openliberty/README.md b/quickstarts/gradle/openliberty/README.md index 6811420215..040411ab69 100644 --- a/quickstarts/gradle/openliberty/README.md +++ b/quickstarts/gradle/openliberty/README.md @@ -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 diff --git a/quickstarts/gradle/quarkus-customized-image/README.md b/quickstarts/gradle/quarkus-customized-image/README.md index 453107d1b2..78964158fb 100644 --- a/quickstarts/gradle/quarkus-customized-image/README.md +++ b/quickstarts/gradle/quarkus-customized-image/README.md @@ -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 diff --git a/quickstarts/gradle/quarkus/README.md b/quickstarts/gradle/quarkus/README.md index 14c8d6e6f2..cfd4b0359f 100644 --- a/quickstarts/gradle/quarkus/README.md +++ b/quickstarts/gradle/quarkus/README.md @@ -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. @@ -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 -``` \ No newline at end of file +$ ./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 +``` diff --git a/quickstarts/gradle/spring-boot-camel-complete/README.md b/quickstarts/gradle/spring-boot-camel-complete/README.md new file mode 100644 index 0000000000..2751af90f4 --- /dev/null +++ b/quickstarts/gradle/spring-boot-camel-complete/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/spring-boot-crd/README.md b/quickstarts/gradle/spring-boot-crd/README.md new file mode 100644 index 0000000000..91dcbc5aaa --- /dev/null +++ b/quickstarts/gradle/spring-boot-crd/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/spring-boot-helm/README.md b/quickstarts/gradle/spring-boot-helm/README.md new file mode 100644 index 0000000000..83036ca141 --- /dev/null +++ b/quickstarts/gradle/spring-boot-helm/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/spring-boot-watch/README.md b/quickstarts/gradle/spring-boot-watch/README.md new file mode 100644 index 0000000000..1bad110361 --- /dev/null +++ b/quickstarts/gradle/spring-boot-watch/README.md @@ -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). +--- \ No newline at end of file diff --git a/quickstarts/gradle/spring-boot-with-jib-assembly/README.md b/quickstarts/gradle/spring-boot-with-jib-assembly/README.md new file mode 100644 index 0000000000..de5e24e762 --- /dev/null +++ b/quickstarts/gradle/spring-boot-with-jib-assembly/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/spring-boot/README.md b/quickstarts/gradle/spring-boot/README.md new file mode 100644 index 0000000000..78b4abd05d --- /dev/null +++ b/quickstarts/gradle/spring-boot/README.md @@ -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. +--- \ No newline at end of file diff --git a/quickstarts/gradle/spring-boot/build.gradle b/quickstarts/gradle/spring-boot/build.gradle index 74e9bd8bb9..4d872b42bf 100644 --- a/quickstarts/gradle/spring-boot/build.gradle +++ b/quickstarts/gradle/spring-boot/build.gradle @@ -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() diff --git a/quickstarts/gradle/thorntail/README.md b/quickstarts/gradle/thorntail/README.md new file mode 100644 index 0000000000..51e79100b0 --- /dev/null +++ b/quickstarts/gradle/thorntail/README.md @@ -0,0 +1,5 @@ +--- +name: "Gradle :: Thorntail" +description: | + Java web application with a single JAX-RS endpoint packaged with Thorntail. +--- \ No newline at end of file diff --git a/quickstarts/gradle/vertx/README.md b/quickstarts/gradle/vertx/README.md index 68011f7168..b6a544161f 100644 --- a/quickstarts/gradle/vertx/README.md +++ b/quickstarts/gradle/vertx/README.md @@ -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. diff --git a/quickstarts/gradle/webapp-custom/README.md b/quickstarts/gradle/webapp-custom/README.md index f79a115733..0b884bf336 100644 --- a/quickstarts/gradle/webapp-custom/README.md +++ b/quickstarts/gradle/webapp-custom/README.md @@ -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. diff --git a/quickstarts/gradle/webapp-jetty/README.md b/quickstarts/gradle/webapp-jetty/README.md index b2fbab1f27..cdb23af24e 100644 --- a/quickstarts/gradle/webapp-jetty/README.md +++ b/quickstarts/gradle/webapp-jetty/README.md @@ -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. diff --git a/quickstarts/gradle/webapp-wildfly/README.md b/quickstarts/gradle/webapp-wildfly/README.md index fddda2fd38..c67657abbc 100644 --- a/quickstarts/gradle/webapp-wildfly/README.md +++ b/quickstarts/gradle/webapp-wildfly/README.md @@ -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. diff --git a/quickstarts/gradle/webapp/README.md b/quickstarts/gradle/webapp/README.md index 5b52df7e53..2e3c26ae85 100644 --- a/quickstarts/gradle/webapp/README.md +++ b/quickstarts/gradle/webapp/README.md @@ -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.