Introduction

This project exposes a CRUD HTTP endpoint and a UI to use this service. The CRUD endpoint is implemented using a Vert .x application and JDBC.

The application lets you:

retrieve a list of fruits
create new fruits
edit existing fruits
delete fruits

The CRUD endpoint follow the HTTP recommendations in term of HTTP verb and status.

Prerequisites

To get started with this quickstart you'll need the following prerequisites:

Name	Description	Version
java	Java JDK	8
maven	Apache Maven	3.3.x
oc	OpenShift Client	v1.4.x
git	Git version management	2.x

In order to build and deploy this project on OpenShift, you need either:

a local OpenShift instance such as Minishift,
account on an OpenShift Online (OSO) instance, such as https://console.dev-preview-int.openshift.com/ instance.

Deployment instructions

To build and deploy this quickstart you can:

deploy it to OpenShift using Apache Maven,
deploy it to OpenShift using a pipeline.

If you are using Minishift

oc login https://192.168.64.12:8443 -u developer -p developer

Open your browser to https://192.168.64.12:8443/console/, and log in using developer/developer.
Check that you have a project. If oc project returns an error, create a project with:

oc new-project myproject

If your are using OpenShift Online

Go to OpenShift Online to get the token used by the oc client for authentication and project access.
On the oc client, execute the following command to replace $MYTOKEN with the one from the Web Console:

oc login https://api.dev-preview-int.openshift.com --token=$MYTOKEN

Check that you have a project. If oc project returns an error, create a project with:

oc new-project myproject

Deploy the application to OpenShift using Maven

To deploy the application using Maven, launch:

oc new-app \
 -p POSTGRESQL_USER=luke \
 -p POSTGRESQL_PASSWORD=secret \
 -p POSTGRESQL_DATABASE=my_data \
 -p DATABASE_SERVICE_NAME=my-database \
 --name=my-database \
 --template=postgresql-ephemeral 
mvn fabric8:deploy -Popenshift

The first command creates a PostgreSQL database. It's an ephemeral database, so the data is lost if you stop the database. The second command builds and deploys the application to the OpenShift instance on which you are logged in. The database credentials are store in an OpenShift secret deployed during the application deployment.

Once deployed, you can access the application using the application URL. Retrieve it using:

$ oc get route vertx-crud -o jsonpath={$.spec.host}
vertx-http-myproject.192.168.64.12.nip.io

Then, open your browser to the displayed url: http://vertx-crud-myproject.192.168.64.12.nip.io.

Alternatively, you can invoke the greeting service directly using curl or httpie:

# Get the fruits list
http http://$URL/api/fruits
# Add fruits
http POST http://$URL/api/fruits name=apple
# Edit fruits
http PUT http://$URL/api/fruits/1 name=pineapple
# Delete fruits
http DELETE http://$URL/api/fruits/1

If you get a 503 response, it means that the application is not ready yet.

Deploy the application to OpenShift using a pipeline

When deployed with a pipeline the application is built from the sources (from a git repository) by a continuous integration server (Jenkins) running in OpenShift.

To trigger this built:

Apply the OpenShift template:

oc new-app -f src/openshift/openshift-pipeline-template.yml

Trigger the pipeline build:

oc start-build vertx-crud

With the sequence of command, you have deployed a Jenkins instance in your OpenShift project, define the build pipeline of the application and trigger a first build of the application.

Once the build is complete, you can access the application using the application URL. Retrieve this url using:

oc get route vertx-crud -o jsonpath={$.spec.host}

Then, open your browser to the displayed url. For instance, http://vertx-crud-myproject.192.168.64.12.nip.io.

Alternatively, you can invoke the greeting service directly using curl or httpie:

# Get the fruits list
http http://$URL/api/fruits
# Add fruits
http POST http://$URL/api/fruits name=apple
# Edit fruits
http PUT http://$URL/api/fruits/1 name=pineapple
# Delete fruits
http DELETE http://$URL/api/fruits/1

If you get a 503 response, it means that the application is not ready yet.

Running integration tests

The quickstart also contains a set of integration tests. You need to be connected to an OpenShift instance (Openshift Online or Minishift) to run them. You also need to select an existing project.

Then, run integration tests using: