Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.11 KB

README.md

File metadata and controls

67 lines (48 loc) · 2.11 KB
Raw

Quarkus OpenAPI and Red Hat OpenShift API Management

This sample application can be used to demonstrate deploying a Quarkus, application on OpenShift, and the Service Discovery capability of 3scale.

Specifically, it has been designed and tested on OpenShift Dedicated and Red Hat OpenShift API Management.

This application is a modified version of the Quarkus quickstart/guide for OpenAPI and Swagger UI*. Notable differences:

  • Set quarkus.smallrye-openapi.store-schema-directory in application.properties
  • Updated .gitignore with openapi.json and openapi.yaml
  • Added the quarkus-openshift extension

Prerequisites

Verify that your system meets the following requirements:

  • JDK 11+
  • Gradle or Apache Maven 3.8.5+

Usage

Dev Mode

Exposes the application on http://localhost:8080 and enables live reload.

mvn quarkus:dev

Deploy to OpenShift

NOTE: This requires the OpenShift (oc) Command-Line tool to be installed on your system, and that you have a valid cluster login.

mvn clean package -Dquarkus.kubernetes.deploy=true -Dquarkus.openshift.expose=true

Import to 3scale API Management

Add the following annotations and label to the Service associated with the Quarkus application you deployed in the previous section:

oc annotate svc/rhoam-openapi "discovery.3scale.net/description-path=/openapi?format=json"
oc annotate svc/rhoam-openapi discovery.3scale.net/port="8080"
oc annotate svc/rhoam-openapi discovery.3scale.net/scheme=http
oc label svc/rhoam-openapi discovery.3scale.net="true"

Now you can import the Service using 3scale Service Discovery.

Building Docker Image

(Re)Create the JAR file for the project to convert it into a distributable format

mvn package

Build the image (make sure to change quay.io ORG as needed)

docker build -f src/main/docker/Dockerfile.jvm -t quay.io/${ORG}/rhoam-quarkus-openapi:latest .

The image can be pushed to quay.io or run locally if needed using docker run

docker run -i --rm -p 8080:8080 quay.io/${ORG}/rhoam-quarkus-openapi:latest