From 2fe0001bf4ec470ab13b61ebe5e1ad6f8e2b28bd Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Mon, 16 May 2022 16:05:15 +0530 Subject: [PATCH] doc (quickstarts/) : Add quickstart metadata in README for processing in website (#1050) Add quickstart metadata in all README.md files of all quickstarts. Signed-off-by: Rohan Kumar --- .../README.md | 7 ++++++ .../README.md | 7 ++++++ .../README.md | 7 ++++++ .../README.md | 7 ++++++ .../gradle/docker-file-simple/README.md | 6 +++++ .../gradle/groovy-dsl-config/README.md | 6 +++++ .../micronaut-customized-image/README.md | 8 +++++++ quickstarts/gradle/micronaut/README.md | 4 ++++ .../README.md | 6 +++++ quickstarts/gradle/openliberty/README.md | 6 +++++ .../gradle/quarkus-customized-image/README.md | 7 ++++++ quickstarts/gradle/quarkus/README.md | 23 +++++++++++++++---- .../spring-boot-camel-complete/README.md | 7 ++++++ quickstarts/gradle/spring-boot-crd/README.md | 8 +++++++ quickstarts/gradle/spring-boot-helm/README.md | 6 +++++ .../gradle/spring-boot-watch/README.md | 7 ++++++ .../spring-boot-with-jib-assembly/README.md | 6 +++++ quickstarts/gradle/spring-boot/README.md | 6 +++++ quickstarts/gradle/spring-boot/build.gradle | 4 ++++ quickstarts/gradle/thorntail/README.md | 5 ++++ quickstarts/gradle/vertx/README.md | 5 ++++ quickstarts/gradle/webapp-custom/README.md | 6 +++++ quickstarts/gradle/webapp-jetty/README.md | 7 ++++++ quickstarts/gradle/webapp-wildfly/README.md | 8 +++++++ quickstarts/gradle/webapp/README.md | 6 +++++ .../kit/custom-foo-generator/README.md | 6 +++++ .../custom-istio-enricher-gradle/README.md | 6 +++++ .../kit/custom-istio-enricher/README.md | 6 +++++ quickstarts/kit/docker-image/README.md | 5 ++++ .../README.md | 6 +++++ quickstarts/kit/helm/README.md | 5 ++++ .../maven/docker-file-provided/README.md | 7 ++++++ .../maven/docker-file-simple/README.md | 6 +++++ .../maven/external-resources/README.md | 7 ++++++ quickstarts/maven/hello-world/README.md | 6 +++++ .../ibm-javaee8-webprofile-liberty/README.md | 7 ++++++ quickstarts/maven/karaf-camel-log/README.md | 6 +++++ .../micronaut-customized-image/README.md | 8 +++++++ quickstarts/maven/micronaut/README.md | 5 ++++ .../maven/openliberty-microprofile/README.md | 6 +++++ quickstarts/maven/openliberty/README.md | 7 ++++++ .../maven/quarkus-customized-image/README.md | 7 ++++++ quickstarts/maven/quarkus/README.md | 7 ++++++ .../spring-boot-camel-complete/README.md | 7 ++++++ quickstarts/maven/spring-boot-crd/README.md | 8 +++++++ .../maven/spring-boot-dekorate/README.md | 6 +++++ quickstarts/maven/spring-boot-helm/README.md | 6 +++++ quickstarts/maven/spring-boot-watch/README.md | 7 ++++++ .../maven/spring-boot-with-jib/README.md | 6 +++++ quickstarts/maven/spring-boot/README.md | 6 +++++ quickstarts/maven/thorntail/README.md | 4 ++++ quickstarts/maven/vertx/README.md | 4 ++++ quickstarts/maven/vertx4/README.md | 4 ++++ quickstarts/maven/webapp-jetty/README.md | 8 +++++++ .../maven/webapp-wildfly-datasource/README.md | 8 +++++++ .../maven/webapp-wildfly-datasource/pom.xml | 2 +- quickstarts/maven/webapp-wildfly/README.md | 8 +++++++ quickstarts/maven/webapp/README.md | 6 +++++ quickstarts/maven/wildfly-jar-slim/README.md | 4 ++++ quickstarts/maven/wildfly-jar/README.md | 4 ++++ quickstarts/maven/xml-config/README.md | 6 +++++ quickstarts/maven/yaml-only/README.md | 6 +++++ quickstarts/maven/zero-config/README.md | 7 ++++++ 63 files changed, 400 insertions(+), 5 deletions(-) create mode 100644 quickstarts/gradle/docker-file-provided-context-and-assembly/README.md create mode 100644 quickstarts/gradle/docker-file-provided-context-and-file/README.md create mode 100644 quickstarts/gradle/docker-file-provided-context-dir/README.md create mode 100644 quickstarts/gradle/docker-file-provided-docker-file/README.md create mode 100644 quickstarts/gradle/groovy-dsl-config/README.md create mode 100644 quickstarts/gradle/micronaut-customized-image/README.md create mode 100644 quickstarts/gradle/spring-boot-camel-complete/README.md create mode 100644 quickstarts/gradle/spring-boot-crd/README.md create mode 100644 quickstarts/gradle/spring-boot-helm/README.md create mode 100644 quickstarts/gradle/spring-boot-watch/README.md create mode 100644 quickstarts/gradle/spring-boot-with-jib-assembly/README.md create mode 100644 quickstarts/gradle/spring-boot/README.md create mode 100644 quickstarts/gradle/thorntail/README.md create mode 100644 quickstarts/kit/custom-foo-generator/README.md create mode 100644 quickstarts/maven/openliberty/README.md create mode 100644 quickstarts/maven/webapp-jetty/README.md create mode 100644 quickstarts/maven/webapp/README.md create mode 100644 quickstarts/maven/xml-config/README.md create mode 100644 quickstarts/maven/yaml-only/README.md 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. diff --git a/quickstarts/kit/custom-foo-generator/README.md b/quickstarts/kit/custom-foo-generator/README.md new file mode 100644 index 0000000000..8f9b81fa74 --- /dev/null +++ b/quickstarts/kit/custom-foo-generator/README.md @@ -0,0 +1,6 @@ +--- +name: "Kit :: Gradle :: Custom Foo Generator" +description: | + A simple project demonstrating how to write your own custom generators using Eclipse JKube Generator API. + One module is Generator and other is app module consuming the custom generator. +--- \ No newline at end of file diff --git a/quickstarts/kit/custom-istio-enricher-gradle/README.md b/quickstarts/kit/custom-istio-enricher-gradle/README.md index 0198a49a76..1629a3e67a 100644 --- a/quickstarts/kit/custom-istio-enricher-gradle/README.md +++ b/quickstarts/kit/custom-istio-enricher-gradle/README.md @@ -1,3 +1,9 @@ +--- +name: "Kit :: Gradle :: Custom Istio Enricher" +description: | + Eclipse JKube Kit example to build and use a Custom Enricher in a SpringBoot Gradle Application. + It will demonstrate how you can extend Eclipse JKube Kit's Enricher API to make your own enricher and use it to enrich or generate manifests as per your requirements. +--- # JKube Kit - Custom Enricher Using Eclipse JKube Enricher API in Gradle This example demonstrates how you can extend Eclipse JKube Kit's Enricher API to make your own enricher and use it to enrich or generate manifests as per your requirements. diff --git a/quickstarts/kit/custom-istio-enricher/README.md b/quickstarts/kit/custom-istio-enricher/README.md index 1a534e073f..b33c4afad3 100644 --- a/quickstarts/kit/custom-istio-enricher/README.md +++ b/quickstarts/kit/custom-istio-enricher/README.md @@ -1,3 +1,9 @@ +--- +name: "Kit :: Custom Istio Enricher Parent" +description: | + Eclipse JKube Kit example to build and use a Custom Enricher in a SpringBoot Application. + It will demonstrate how you can extend Eclipse JKube Kit's Enricher API to make your own enricher and use it to enrich or generate manifests as per your requirements. +--- # JKube Kit - Custom Enricher Using Eclipse JKube Enricher API This example demonstrates how you can extend Eclipse JKube Kit's Enricher API to make your own enricher and use it to enrich or generate manifests as per your requirements. This is a multi module project which contains these modules: diff --git a/quickstarts/kit/docker-image/README.md b/quickstarts/kit/docker-image/README.md index 65c611c163..4736aa0b6c 100644 --- a/quickstarts/kit/docker-image/README.md +++ b/quickstarts/kit/docker-image/README.md @@ -1,3 +1,8 @@ +--- +name: "Kit :: Docker Image" +description: | + Eclipse JKube Kit example showing how to generate a Docker image by using Eclipse JKube in standalone mode. +--- # JKube Kit - Docker Image Build Example This [quickstart](../../../quickstarts) will generate a Docker image using JKube Kit API. diff --git a/quickstarts/kit/dynamic-docker-image-file-multi-layer/README.md b/quickstarts/kit/dynamic-docker-image-file-multi-layer/README.md index 991dbba14b..9db612a4b6 100644 --- a/quickstarts/kit/dynamic-docker-image-file-multi-layer/README.md +++ b/quickstarts/kit/dynamic-docker-image-file-multi-layer/README.md @@ -1,3 +1,9 @@ +--- +name: "Kit :: Docker Image from Multilayer Dockerfile" +description: | + Eclipse JKube Kit example showing how to Dynamically generate a Docker image. + The generated image contains multiple COPY statements which allows the generation of a multilayered container image. +--- # JKube Kit - Docker Image Build from Dynamic multilayered Dockerfile Example This [quickstart](../../../quickstarts) will generate a Docker image using JKube Kit API. diff --git a/quickstarts/kit/helm/README.md b/quickstarts/kit/helm/README.md index 09dbf4437b..66fa031a37 100644 --- a/quickstarts/kit/helm/README.md +++ b/quickstarts/kit/helm/README.md @@ -1,3 +1,8 @@ +--- +name: "Kit :: Helm" +description: | + Eclipse JKube Kit example showing how to generate a Helm Charts using Eclipse JKube in standalone mode. +--- # JKube Kit - Docker Image Build from Dynamic multilayered Dockerfile Example This [quickstart](../../../quickstarts) will generate Helm charts using JKube Kit API. diff --git a/quickstarts/maven/docker-file-provided/README.md b/quickstarts/maven/docker-file-provided/README.md index 32f8469714..9095701753 100644 --- a/quickstarts/maven/docker-file-provided/README.md +++ b/quickstarts/maven/docker-file-provided/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: Docker File Provided" +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, assembly name etc. under different profiles. +--- # JKube externally provided Dockerfile example This quick start showcases how to use Eclipse JKube with external Docker files. diff --git a/quickstarts/maven/docker-file-simple/README.md b/quickstarts/maven/docker-file-simple/README.md index c6728cbd2f..5ef2218060 100644 --- a/quickstarts/maven/docker-file-simple/README.md +++ b/quickstarts/maven/docker-file-simple/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: 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. +--- # 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/maven/external-resources/README.md b/quickstarts/maven/external-resources/README.md index 6360585285..03cabad27b 100644 --- a/quickstarts/maven/external-resources/README.md +++ b/quickstarts/maven/external-resources/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: External Resources" +description: | + Simple Spring Boot application which demonstrates how you can use Eclipse JKube's resource fragments. + Fragments in `src/main/jkube` directory are detected and picked up by JKube. + These fragments are then merged with the JKube generated cluster configuration manifests (YAML). +--- # Eclipse JKube External Resources Quickstart This is a simple SpringBoot application which demonstrates how you can use Eclipse JKube's diff --git a/quickstarts/maven/hello-world/README.md b/quickstarts/maven/hello-world/README.md index 13071f4973..a560bd52bd 100644 --- a/quickstarts/maven/hello-world/README.md +++ b/quickstarts/maven/hello-world/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: Hello World" +description: | + Demo project for getting started with Eclipse JKube. + It just prints "Hello World" on command line and exits. +--- # JKube Hello World Sample This is a demo project for getting started with Eclipse JKube. It just prints "Hello World" on command diff --git a/quickstarts/maven/ibm-javaee8-webprofile-liberty/README.md b/quickstarts/maven/ibm-javaee8-webprofile-liberty/README.md index a06fc8cafa..e39bc42a39 100644 --- a/quickstarts/maven/ibm-javaee8-webprofile-liberty/README.md +++ b/quickstarts/maven/ibm-javaee8-webprofile-liberty/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: JavaEE 8 WebProfile" +description: | + Demo project for Jakarta EE 8 WebProfile, IBM WebSphere Liberty is used as a Jakarta EE implementation. + On Windows or Mac if VirtualBox is used, run the tests using: + $ mvn clean verify -DtestProxyHost=192.168.99.100 +--- ## A WebSphere Liberty Java EE 8 based application prepared for development using Eclipse JKube Kubernetes Maven Plugin **WebSphere Liberty** is a fast, dynamic, and easy-to-use Java application server, built on the open source diff --git a/quickstarts/maven/karaf-camel-log/README.md b/quickstarts/maven/karaf-camel-log/README.md index d30e4c680e..07d561c2c2 100644 --- a/quickstarts/maven/karaf-camel-log/README.md +++ b/quickstarts/maven/karaf-camel-log/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: Karaf Camel Log" +description: | + Simple Apache Camel application on top of Apache Karaf that logs a series of messages to the Server log. + The application also generates and processes random orders using Camel routes. +--- # Eclipse JKube Karaf Quickstart - Camel Log This quickstart shows a simple Apache Camel application that logs a series of messages to the Server log and diff --git a/quickstarts/maven/micronaut-customized-image/README.md b/quickstarts/maven/micronaut-customized-image/README.md index 99510d0ad6..4446ed7ae0 100644 --- a/quickstarts/maven/micronaut-customized-image/README.md +++ b/quickstarts/maven/micronaut-customized-image/README.md @@ -1,3 +1,11 @@ +--- +name: "Maven :: 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. + XML based image configuration compatible with OpenShift and Kubernetes. +--- # Eclipse JKube Micronaut customized image quickstart Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation). diff --git a/quickstarts/maven/micronaut/README.md b/quickstarts/maven/micronaut/README.md index 24c7c4e203..a5303ca1d9 100644 --- a/quickstarts/maven/micronaut/README.md +++ b/quickstarts/maven/micronaut/README.md @@ -1,3 +1,8 @@ +--- +name: "Maven :: 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/maven/openliberty-microprofile/README.md b/quickstarts/maven/openliberty-microprofile/README.md index 961d6cb9ec..d535c7b6d8 100644 --- a/quickstarts/maven/openliberty-microprofile/README.md +++ b/quickstarts/maven/openliberty-microprofile/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: Open Liberty & MicroProfile" +description: | + How to integrate Eclipse JKube into an OpenLiberty-MicroProfile project as downloaded from start.microprofile.io. + Includes a JAX-RS endpoint, sample CDI injected configuration, and Liveness and Readiness probes. +--- # Eclipse JKube OpenLiberty MicroProfile Quickstart This example shows how to integrate Eclipse JKube in an OpenLiberty-MicroProfile application as downloaded from diff --git a/quickstarts/maven/openliberty/README.md b/quickstarts/maven/openliberty/README.md new file mode 100644 index 0000000000..5e4294f0b5 --- /dev/null +++ b/quickstarts/maven/openliberty/README.md @@ -0,0 +1,7 @@ +--- +name: "Maven :: Open Liberty" +description: | + JAX-RS application deployed with OpenLiberty and Eclipse JKube. + The application contains a single endpoint (/hello) that prints 'Hello, World.'. + An Arquillian based Integration Test is also included. +--- \ No newline at end of file diff --git a/quickstarts/maven/quarkus-customized-image/README.md b/quickstarts/maven/quarkus-customized-image/README.md index 69101434e2..c3233adc16 100644 --- a/quickstarts/maven/quarkus-customized-image/README.md +++ b/quickstarts/maven/quarkus-customized-image/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: 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/maven/quarkus/README.md b/quickstarts/maven/quarkus/README.md index a000d8306f..82e3386194 100644 --- a/quickstarts/maven/quarkus/README.md +++ b/quickstarts/maven/quarkus/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: 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. diff --git a/quickstarts/maven/spring-boot-camel-complete/README.md b/quickstarts/maven/spring-boot-camel-complete/README.md index f9ab5ef5da..9c3358f88c 100644 --- a/quickstarts/maven/spring-boot-camel-complete/README.md +++ b/quickstarts/maven/spring-boot-camel-complete/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: 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. +--- # Eclipse JKube Spring Boot with Camel integration Quick start This is a quickstart project to use Eclipse JKube plugin with [Apache Camel](https://camel.apache.org/). diff --git a/quickstarts/maven/spring-boot-crd/README.md b/quickstarts/maven/spring-boot-crd/README.md index 4d4ce2cee6..98b75ec55a 100644 --- a/quickstarts/maven/spring-boot-crd/README.md +++ b/quickstarts/maven/spring-boot-crd/README.md @@ -1,3 +1,11 @@ +--- +name: "Maven :: 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. +--- # Spring Boot with Custom Resources This example shows how to use Eclipse JKube to deploy a Spring Boot application that uses Custom Resource Definitions. diff --git a/quickstarts/maven/spring-boot-dekorate/README.md b/quickstarts/maven/spring-boot-dekorate/README.md index 8f2ab85e85..cac85806ed 100644 --- a/quickstarts/maven/spring-boot-dekorate/README.md +++ b/quickstarts/maven/spring-boot-dekorate/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: Spring Boot - Dekorate" +description: | + Spring Boot application with Dekorate integration. + Eclipse JKube uses Dekorate generated cluster configuration manifests. +--- # Spring Boot with Dekorate integration Quickstart This examples shows how Eclipse JKube can work together with [Dekorate](https://github.com/dekorateio/dekorate) annotations diff --git a/quickstarts/maven/spring-boot-helm/README.md b/quickstarts/maven/spring-boot-helm/README.md index 92226553cc..52574daf38 100644 --- a/quickstarts/maven/spring-boot-helm/README.md +++ b/quickstarts/maven/spring-boot-helm/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: Spring Boot - Helm" +description: | + Spring Boot application with a single REST endpoint. + Demonstrates how to generate Helm chart (YAML) files using Eclipse JKube's k8s:helm Maven goal. +--- # Eclipse JKube Spring Boot with YAML Quickstart This is a quickstart project to use Eclipse JKube plugin with customized yaml configurations. diff --git a/quickstarts/maven/spring-boot-watch/README.md b/quickstarts/maven/spring-boot-watch/README.md index cc0d0dc956..ec6f10e986 100644 --- a/quickstarts/maven/spring-boot-watch/README.md +++ b/quickstarts/maven/spring-boot-watch/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: Spring Boot Watch" +description: | + Spring Boot application with a single REST endpoint. + Demonstrates how to watch for source changes using Eclipse JKube's k8s:watch goal. + Application gets live reloaded in the cluster each time the project is recompiled (mvn package). +--- # Spring Boot Sample This is a sample project to use Eclipse JKube plugins. diff --git a/quickstarts/maven/spring-boot-with-jib/README.md b/quickstarts/maven/spring-boot-with-jib/README.md index b2a4740eef..37769f9904 100644 --- a/quickstarts/maven/spring-boot-with-jib/README.md +++ b/quickstarts/maven/spring-boot-with-jib/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: Spring Boot JIB" +description: | + Spring Boot application with a single REST endpoint. + Demonstrates how to build a project using Eclipse JKube JIB build strategy. +--- # Spring Boot Sample with JIB Build Mode This is also a Spring Boot application to demonstrate how Eclipse JKube handles Kubernetes/OpenShift workflows by diff --git a/quickstarts/maven/spring-boot/README.md b/quickstarts/maven/spring-boot/README.md index da04515434..f51cfc166f 100644 --- a/quickstarts/maven/spring-boot/README.md +++ b/quickstarts/maven/spring-boot/README.md @@ -1,3 +1,9 @@ +--- +name: "Maven :: Spring Boot Web" +description: | + Spring Boot Web application with a single @RestController. + Shows how to deploy Spring Boot applications to Kubernetes (-Pkubernetes) and OpenShift (-Popenshift) using Eclipse JKube. +--- # Spring Boot Sample This is a sample project to use Eclipse JKube plugins. diff --git a/quickstarts/maven/thorntail/README.md b/quickstarts/maven/thorntail/README.md index 421de57139..f8b0ffafea 100644 --- a/quickstarts/maven/thorntail/README.md +++ b/quickstarts/maven/thorntail/README.md @@ -1,3 +1,7 @@ +--- +name: "Maven :: Thorntail" +description: Java web application with a single JAX-RS endpoint packaged with Thorntail. +--- # Thorntail Sample This is a sample project to use Eclipse JKube plugins. diff --git a/quickstarts/maven/vertx/README.md b/quickstarts/maven/vertx/README.md index d2baf16027..c9266cc0bf 100644 --- a/quickstarts/maven/vertx/README.md +++ b/quickstarts/maven/vertx/README.md @@ -1,3 +1,7 @@ +--- +name: "Maven :: Vertx Web" +description: Eclipse Vert.x example application declaring a Simple AbstractVerticle. +--- # Vertx sample for Eclipse JKube maven plugins This is a sample project to use Eclipse JKube plugins. diff --git a/quickstarts/maven/vertx4/README.md b/quickstarts/maven/vertx4/README.md index 51e548dcb2..1edf736aee 100644 --- a/quickstarts/maven/vertx4/README.md +++ b/quickstarts/maven/vertx4/README.md @@ -1,3 +1,7 @@ +--- +name: "Maven :: Vertx 4 Web" +description: Eclipse Vert.x 4 example application declaring a Simple AbstractVerticle. +--- # Eclipse JKube Vert.x 4 Web Quickstart Eclipse Vert.x 4 Web example application declaring a Simple AbstractVerticle. diff --git a/quickstarts/maven/webapp-jetty/README.md b/quickstarts/maven/webapp-jetty/README.md new file mode 100644 index 0000000000..3e26e76f24 --- /dev/null +++ b/quickstarts/maven/webapp-jetty/README.md @@ -0,0 +1,8 @@ +--- +name: "Maven :: Webapp Jetty" +description: | + Java Web Application with a static index.html resource. + Demonstrates how to create a container image with an embedded Eclipse Jetty server using Eclipse JKube. + Jetty is used instead of Apache Tomcat because there is a Jetty specific configuration file (jetty-logging.properties). + Eclipse JKube detects this file and chooses a Jetty specific base container image. +--- \ No newline at end of file diff --git a/quickstarts/maven/webapp-wildfly-datasource/README.md b/quickstarts/maven/webapp-wildfly-datasource/README.md index 7d702e672c..0bf679839d 100644 --- a/quickstarts/maven/webapp-wildfly-datasource/README.md +++ b/quickstarts/maven/webapp-wildfly-datasource/README.md @@ -1,3 +1,11 @@ +--- +name: "Maven :: Webapp :: Wildfly :: Datasource" +description: | + Java Web Application that uses an embedded h2 database. + 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/maven/webapp-wildfly-datasource/pom.xml b/quickstarts/maven/webapp-wildfly-datasource/pom.xml index 305ece8c52..2f60a0e799 100644 --- a/quickstarts/maven/webapp-wildfly-datasource/pom.xml +++ b/quickstarts/maven/webapp-wildfly-datasource/pom.xml @@ -23,7 +23,7 @@ war - Java Web Application that uses an embeded h2 database. + Java Web Application that uses an embedded h2 database. 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. diff --git a/quickstarts/maven/webapp-wildfly/README.md b/quickstarts/maven/webapp-wildfly/README.md index 3c83c9e30f..c971278a2a 100644 --- a/quickstarts/maven/webapp-wildfly/README.md +++ b/quickstarts/maven/webapp-wildfly/README.md @@ -1,3 +1,11 @@ +--- +name: "Maven :: 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 specific plugin configuration. + Eclipse JKube detects this plugin and chooses a WildFly specific base container image. +--- # Eclipse JKube Webapp Wildfly Sample ## Build Application's Docker Image diff --git a/quickstarts/maven/webapp/README.md b/quickstarts/maven/webapp/README.md new file mode 100644 index 0000000000..8c6c8aa18a --- /dev/null +++ b/quickstarts/maven/webapp/README.md @@ -0,0 +1,6 @@ +--- +name: "Maven :: 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. +--- \ No newline at end of file diff --git a/quickstarts/maven/wildfly-jar-slim/README.md b/quickstarts/maven/wildfly-jar-slim/README.md index 169517e1df..20aa150f5b 100644 --- a/quickstarts/maven/wildfly-jar-slim/README.md +++ b/quickstarts/maven/wildfly-jar-slim/README.md @@ -1,3 +1,7 @@ +--- +name: "Maven :: Wildfly JAR :: Slim" +description: Java web application with a single JAX-RS endpoint packaged with WildFly Jar Maven Plugin. +--- # Wildfly JAR Slim Server Sample This is a sample project to use Eclipse JKube plugins. diff --git a/quickstarts/maven/wildfly-jar/README.md b/quickstarts/maven/wildfly-jar/README.md index 58e1c50f3b..77865d39b4 100644 --- a/quickstarts/maven/wildfly-jar/README.md +++ b/quickstarts/maven/wildfly-jar/README.md @@ -1,3 +1,7 @@ +--- +name: "Maven :: Wildfly JAR" +description: Java web application with a single JAX-RS endpoint packaged with WildFly Jar Maven Plugin. +--- # Wildfly JAR Sample This is a sample project to use Eclipse JKube plugins. diff --git a/quickstarts/maven/xml-config/README.md b/quickstarts/maven/xml-config/README.md new file mode 100644 index 0000000000..41348897e1 --- /dev/null +++ b/quickstarts/maven/xml-config/README.md @@ -0,0 +1,6 @@ +--- +name: "Maven :: Yaml" +description: | + Apache Camel application. + Demonstrates how to configure Eclipse JKube build and resource properties using XML elements in the project's pom.xml plugin configuration. +--- \ No newline at end of file diff --git a/quickstarts/maven/yaml-only/README.md b/quickstarts/maven/yaml-only/README.md new file mode 100644 index 0000000000..06f4007f56 --- /dev/null +++ b/quickstarts/maven/yaml-only/README.md @@ -0,0 +1,6 @@ +--- +name: "Maven :: Docker File Provided Context and Assembly" +description: | + Example showing how to use Eclipse JKube Maven Plugins to deploy cluster configuration YAML files. + Example with Yaml only resources +--- \ No newline at end of file diff --git a/quickstarts/maven/zero-config/README.md b/quickstarts/maven/zero-config/README.md index a8b09d6d78..ab76f4b2e6 100644 --- a/quickstarts/maven/zero-config/README.md +++ b/quickstarts/maven/zero-config/README.md @@ -1,3 +1,10 @@ +--- +name: "Maven :: Zero-Config" +description: | + Spring Boot application with a single REST endpoint. + Demonstrates Eclipse JKube Zero Configuration capabilities. + All configurations to create the container image and resource manifests are inferred from the project and its dependencies. +--- # Spring Boot Sample With Zero Config This is a sample project to use Eclipse JKube plugins.