Skip to content

Commit 0a2dfe5

Browse files
rohanKanojiarohanKanojia
committed
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 <rohaan@redhat.com>
1 parent 4f6803e commit 0a2dfe5

File tree

62 files changed

+396
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+396
-5
lines changed

‎quickstarts/gradle/docker-file-provided-context-and-assembly/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "Gradle :: Docker File Provided Context and Assembly"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
6+
Also provides example on how to configure Docker Context directory and assembly name.
7+
---

‎quickstarts/gradle/docker-file-provided-context-and-file/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "Gradle :: Docker File Provided Context and File"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
6+
Also provides example on how to configure Docker Context directory and Dockerfile path.
7+
---

‎quickstarts/gradle/docker-file-provided-context-dir/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "Gradle :: Docker File Provided Context Dir"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
6+
Also provides example on how to configure Docker Context directory.
7+
---

‎quickstarts/gradle/docker-file-provided-docker-file/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "Gradle :: Docker File Provided Docker File"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
6+
Also provides example on how to configure Docker Context directory and interpolation filter delimiter.
7+
---

‎quickstarts/gradle/docker-file-simple/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Gradle :: Docker File Simple"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
6+
---
17
# Eclipse JKube sample with simple Dockerfile mode
28

39
You can build your Docker images with just providing one `Dockerfile` in your project root directory and Eclipse JKube

‎quickstarts/gradle/groovy-dsl-config/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
name: "Gradle :: Groovy DSL Config"
3+
description: |
4+
Apache Camel application.
5+
Demonstrates how to configure Eclipse JKube build and resource properties using Groovy DSL elements in the project's build.gradle plugin configuration.
6+
---

‎quickstarts/gradle/micronaut-customized-image/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: "Gradle :: Micronaut Customized Image"
3+
description: |
4+
Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).
5+
Includes configuration to enable health check probes (livenessProbe &amp; readinessProbe) using JKube's
6+
powerful resource fragments and micronaut-management feature.
7+
Groovy DSL based image configuration compatible with OpenShift and Kubernetes.
8+
---

‎quickstarts/gradle/micronaut/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
name: "Gradle :: Micronaut"
3+
description: Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).
4+
---
15
# Eclipse JKube Micronaut quickstart
26

37
Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).

‎quickstarts/gradle/openliberty-with-legacy-plugin-syntax/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Gradle :: Open Liberty with Legacy Plugin syntax"
3+
description: |
4+
JAX-RS application deployed with OpenLiberty and Eclipse JKube using old style Gradle syntax for plugin declaration.
5+
The application contains a single endpoint (/hello) that prints 'Hello, World.'.
6+
---
17
# Eclipse JKube OpenLiberty Gradle Quickstart
28

39
This is a demo gradle application based on OpenLiberty framework which can be deployed to Kubernetes with the help of Kubernetes Gradle Plugin.

‎quickstarts/gradle/openliberty/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Gradle :: Open Liberty"
3+
description: |
4+
JAX-RS application deployed with OpenLiberty and Eclipse JKube.
5+
The application contains a single endpoint (/hello) that prints 'Hello, World.'.
6+
---
17
# Eclipse JKube OpenLiberty Gradle Quickstart
28

39
This is a demo gradle application based on OpenLiberty framework which can be deployed to

‎quickstarts/gradle/quarkus-customized-image/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: "Gradle :: Quarkus Customized Image"
3+
description: |
4+
Quarkus application with a single JAX-RS endpoint.
5+
Demonstrates how to build a Quarkus container image based on a Red Hat container image private registry.
6+
Uses a pull secret from Red Hat Registry Service Accounts to authenticate.
7+
---
18
# Eclipse JKube Quarkus with Customized Image Quickstart
29

310
A simple REST application demonstrating usage of Eclipse JKube with Quarkus

‎quickstarts/gradle/quarkus/README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: "Gradle :: Quarkus"
3+
description: |
4+
Quarkus application with a single JAX-RS endpoint.
5+
Demonstrates how to package the project using JVM mode or Native image mode.
6+
Demonstrates how to build a Quarkus project container with Eclipse JKube's S2I, Docker and JIB build strategies.
7+
---
18
# Eclipse JKube Quarkus Quickstart
29

310
A simple REST application demonstrating usage of Eclipse JKube with Quarkus.
@@ -90,7 +97,15 @@ On invoking this, you can see it in browser:
9097
```shell
9198
$ eval $(minikube -p minikube docker-env)
9299
$ ./gradlew clean build -Pquarkus.package.type=native -Pquarkus.native.remote-container-build=true
93-
$ ./gradlew k8sBuild
94-
$ ./gradlew build k8sResource
95-
$ ./gradlew k8sApply
96-
```
100+
$ ./gradlew k8sBuild k8sResource k8sApply
101+
```
102+
103+
### JIB
104+
105+
```shell
106+
$ eval $(minikube -p minikube docker-env)
107+
$ ./gradlew clean build -Pquarkus.package.type=native -Pquarkus.native.remote-container-build=true
108+
$ ./gradlew k8sBuild -Pjkube.build.strategy=jib
109+
$ docker load -i ./build/docker/gradle/quarkus/1.7.0/tmp/docker-build.tar
110+
$ ./gradlew k8sResource k8sApply
111+
```

‎quickstarts/gradle/spring-boot-camel-complete/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "Gradle :: Spring Boot - Camel"
3+
description: |
4+
Spring Boot application with Camel Spring Boot integration.
5+
Programmatically (RouteBuilder) declares 2 routes to log messages and process orders.
6+
Declares an Apache Camel servlet REST endpoint.
7+
---

‎quickstarts/gradle/spring-boot-crd/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: "Gradle :: Spring Boot - Custom Resources"
3+
description: |
4+
Spring Boot application using K8s Custom Resources.
5+
Declares a "Framework" Custom Resource Definition.
6+
Initializes cluster with sample data.
7+
Declares an endpoint to consume Custom Resource data stored in the cluster.
8+
---

‎quickstarts/gradle/spring-boot-helm/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
name: "Gradle :: Spring Boot - Helm"
3+
description: |
4+
Spring Boot application with a single REST endpoint.
5+
Demonstrates how to generate Helm chart (YAML) files using Eclipse JKube's k8sHelm Gradle task.
6+
---

‎quickstarts/gradle/spring-boot-watch/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: "Gradle :: Spring Boot Watch"
3+
description: |
4+
Spring Boot application with a single REST endpoint.
5+
Demonstrates how to watch for source changes using Eclipse JKube's k8sWatch task.
6+
Application gets live reloaded in the cluster each time the project is recompiled (gradle build).
7+
---

‎quickstarts/gradle/spring-boot-with-jib-assembly/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
name: "Gradle :: Spring Boot JIB"
3+
description: |
4+
Spring Boot application with a single REST endpoint.
5+
Demonstrates how to build a project using Eclipse JKube JIB build strategy.
6+
---

‎quickstarts/gradle/spring-boot/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
name: "Gradle :: Spring Boot Web"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes and OpenShift using Eclipse JKube.
6+
---

‎quickstarts/gradle/thorntail/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: "Gradle :: Thorntail"
3+
description: |
4+
Java web application with a single JAX-RS endpoint packaged with Thorntail.
5+
---

‎quickstarts/gradle/vertx/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: "Gradle :: Vertx Web"
3+
description: |
4+
Eclipse Vert.x example application declaring a Simple AbstractVerticle.
5+
---
16
# Vertx sample for Eclipse JKube gradle plugins
27
This is a sample project to use Eclipse JKube plugins.
38

‎quickstarts/gradle/webapp-custom/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Gradle :: Custom Webapp"
3+
description: |
4+
Java Web Application with a static index.html resource.
5+
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.
6+
---
17
# Eclipse JKube Webapp custom
28
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.
39

‎quickstarts/gradle/webapp-jetty/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: "Gradle :: Webapp :: Jetty"
3+
description: |
4+
Java Web Application with a static index.html resource.
5+
Demonstrates building container image with war project.
6+
It also tries to detect WAR builds and select container image based on configuration specified in build.gradle
7+
---
18
# Eclipse JKube Webapp - Jetty
29
This quick start showcases how to use Eclipse JKube with a war project to build a container image.
310
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.

‎quickstarts/gradle/webapp-wildfly/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
name: "Gradle :: Webapp :: Wildfly"
3+
description: |
4+
Java Web Application with a static index.html resource.
5+
Demonstrates how to create a container image with an embedded WildFly server using Eclipse JKube.
6+
WildFly is used instead of Apache Tomcat because there is a WildFly persistence.xml and -ds.xml configuration.
7+
Eclipse JKube detects this file and chooses a WildFly specific base container image.
8+
---
19
# Eclipse JKube Webapp Wildfly Sample
210
This quick start showcases how to use Eclipse JKube with a Wildfly war project.
311
Demonstrates how to create a container image with an embedded WildFly server using Eclipse JKube.

‎quickstarts/gradle/webapp/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Gradle :: Webapp"
3+
description: |
4+
Java Web Application with a static index.html resource.
5+
Demonstrates how to create a container image with an embedded Apache Tomcat server using Eclipse JKube.
6+
---
17
# Eclipse JKube Webapp
28
This quick start showcases how to use Eclipse JKube with a war project to build a container image.
39
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.

‎quickstarts/kit/custom-foo-generator/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
name: "Kit :: Gradle :: Custom Foo Generator"
3+
description: |
4+
A simple project demonstrating how to write your own custom generators using Eclipse JKube Generator API.
5+
One module is Generator and other is app module consuming the custom generator.
6+
---

‎quickstarts/kit/custom-istio-enricher-gradle/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Kit :: Gradle :: Custom Istio Enricher"
3+
description: |
4+
Eclipse JKube Kit example to build and use a Custom Enricher in a SpringBoot Gradle Application.
5+
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.
6+
---
17
# JKube Kit - Custom Enricher Using Eclipse JKube Enricher API in Gradle
28

39
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.

‎quickstarts/kit/custom-istio-enricher/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Kit :: Custom Istio Enricher Parent"
3+
description: |
4+
Eclipse JKube Kit example to build and use a Custom Enricher in a SpringBoot Application.
5+
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.
6+
---
17
# JKube Kit - Custom Enricher Using Eclipse JKube Enricher API
28

39
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:

‎quickstarts/kit/docker-image/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: "Kit :: Docker Image"
3+
description: |
4+
Eclipse JKube Kit example showing how to generate a Docker image by using Eclipse JKube in standalone mode.
5+
---
16
# JKube Kit - Docker Image Build Example
27

38
This [quickstart](../../../quickstarts) will generate a Docker image using JKube Kit API.

‎quickstarts/kit/dynamic-docker-image-file-multi-layer/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Kit :: Docker Image from Multilayer Dockerfile"
3+
description: |
4+
Eclipse JKube Kit example showing how to Dynamically generate a Docker image.
5+
The generated image contains multiple COPY statements which allows the generation of a multilayered container image.
6+
---
17
# JKube Kit - Docker Image Build from Dynamic multilayered Dockerfile Example
28

39
This [quickstart](../../../quickstarts) will generate a Docker image using JKube Kit API.

‎quickstarts/kit/helm/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: "Kit :: Helm"
3+
description: |
4+
Eclipse JKube Kit example showing how to generate a Helm Charts using Eclipse JKube in standalone mode.
5+
---
16
# JKube Kit - Docker Image Build from Dynamic multilayered Dockerfile Example
27

38
This [quickstart](../../../quickstarts) will generate Helm charts using JKube Kit API.

‎quickstarts/maven/docker-file-provided/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: "Maven :: Docker File Provided"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
6+
Also provides example on how to configure Docker Context directory, assembly name etc. under different profiles.
7+
---
18
# JKube externally provided Dockerfile example
29
This quick start showcases how to use Eclipse JKube with external Docker files.
310

‎quickstarts/maven/docker-file-simple/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Maven :: Docker File Provided Context and Assembly"
3+
description: |
4+
Spring Boot Web application with a single @RestController.
5+
Shows how to deploy Spring Boot applications to Kubernetes using existing Dockerfile with Eclipse JKube.
6+
---
17
# Eclipse JKube sample with simple Dockerfile mode
28

39
You can build your Docker images with just providing one `Dockerfile` in your project root directory and Eclipse JKube

‎quickstarts/maven/external-resources/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: "Maven :: External Resources"
3+
description: |
4+
Simple Spring Boot application which demonstrates how you can use Eclipse JKube's resource fragments.
5+
Fragments in `src/main/jkube` directory are detected and picked up by JKube.
6+
These fragments are then merged with the JKube generated cluster configuration manifests (YAML).
7+
---
18
# Eclipse JKube External Resources Quickstart
29

310
This is a simple SpringBoot application which demonstrates how you can use Eclipse JKube's

‎quickstarts/maven/hello-world/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Maven :: Hello World"
3+
description: |
4+
Demo project for getting started with Eclipse JKube.
5+
It just prints "Hello World" on command line and exits.
6+
---
17
# JKube Hello World Sample
28

39
This is a demo project for getting started with Eclipse JKube. It just prints "Hello World" on command

‎quickstarts/maven/ibm-javaee8-webprofile-liberty/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: "Maven :: JavaEE 8 WebProfile"
3+
description: |
4+
Demo project for Jakarta EE 8 WebProfile, IBM WebSphere Liberty is used as a Jakarta EE implementation.
5+
On Windows or Mac if VirtualBox is used, run the tests using:
6+
$ mvn clean verify -DtestProxyHost=192.168.99.100
7+
---
18
## A WebSphere Liberty Java EE 8 based application prepared for development using Eclipse JKube Kubernetes Maven Plugin
29

310
**WebSphere Liberty** is a fast, dynamic, and easy-to-use Java application server, built on the open source

‎quickstarts/maven/karaf-camel-log/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Maven :: Karaf Camel Log"
3+
description: |
4+
Simple Apache Camel application on top of Apache Karaf that logs a series of messages to the Server log.
5+
The application also generates and processes random orders using Camel routes.
6+
---
17
# Eclipse JKube Karaf Quickstart - Camel Log
28

39
This quickstart shows a simple Apache Camel application that logs a series of messages to the Server log and

‎quickstarts/maven/micronaut-customized-image/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
name: "Maven :: Micronaut customized Image"
3+
description: |
4+
Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).
5+
Includes configuration to enable health check probes (livenessProbe &amp; readinessProbe) using JKube's
6+
powerful resource fragments and micronaut-management feature.
7+
XML based image configuration compatible with OpenShift and Kubernetes.
8+
---
19
# Eclipse JKube Micronaut customized image quickstart
210

311
Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).

‎quickstarts/maven/micronaut/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
name: "Maven :: Micronaut"
3+
description: |
4+
Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).
5+
---
16
# Eclipse JKube Micronaut quickstart
27

38
Micronaut application featuring REST endpoints (micronaut-http) with validation (micronaut-validation).

‎quickstarts/maven/openliberty-microprofile/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
name: "Maven :: Open Liberty &amp; MicroProfile"
3+
description: |
4+
How to integrate Eclipse JKube into an OpenLiberty-MicroProfile project as downloaded from start.microprofile.io.
5+
Includes a JAX-RS endpoint, sample CDI injected configuration, and Liveness and Readiness probes.
6+
---
17
# Eclipse JKube OpenLiberty MicroProfile Quickstart
28

39
This example shows how to integrate Eclipse JKube in an OpenLiberty-MicroProfile application as downloaded from

0 commit comments

Comments
 (0)