https://github.com/vpavlin/vpavlin-pp-test
https://github.com/vpavlin/vpavlin-pp-test
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vpavlin/vpavlin-pp-test
- Owner: vpavlin
- License: apache-2.0
- Created: 2018-01-02T15:45:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-03T15:54:14.000Z (over 7 years ago)
- Last Synced: 2025-01-23T03:44:41.088Z (4 months ago)
- Language: HTML
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= Externalized Configuration - Eclipse Vert.x Booster
IMPORTANT: While you can run and interact with this booster on our local host, you cannot take advantage of using externalized configuration with this booster without using OpenShift. For more details on using this booster with a single-node OpenShift cluster, CI/CD deployments, as well as the rest of the runtime, see the link:http://appdev.openshift.io/docs/vertx-runtime.html[Eclipse Vert.x Runtime Guide].
IMPORTANT: This booster requires Java 8 JDK or greater and Maven 3.3.x or greater.
IMPORTANT: As part of the process of creating this booster, launch.openshift.io set up a project with a CI/CD deployment of this booster. You can see the status of this deployment in your Single-node OpenShift Cluster or OpenShift Online Web Console.
== Running the Booster Locally
To run this booster on your local host:
[source,bash,options="nowrap",subs="attributes+"]
----
$ git clone [email protected]:${loggedUser}/vpavlin-pp-test
$ cd vpavlin-pp-test
$ mvn compile vertx:run
----
== Interacting with the Booster Locally
To interact with your booster while its running, use the form at `http://localhost:8080` or the `curl` command:
[source,bash,options="nowrap",subs="attributes+"]
----
$ curl http://localhost:8080/api/greeting
{"content":"Hello, World!"}
$ curl http://localhost:8080/api/greeting?name=Sarah
{"content":"Hello, Sarah!"}
----
== Running the Booster on a Single-node OpenShift Cluster
If you have a single-node OpenShift cluster, such as Minishift or the Red Hat Container Development Kit, link:http://appdev.openshift.io/docs/minishift-installation.html[installed and running], you can also deploy your booster there. A single-node OpenShift cluster provides you with access to a cloud environment that is similar to a production environment.
To deploy your booster to a running single-node OpenShift cluster:
. Log in and create your project.
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ oc login -u developer -p developer
$ oc new-project MY_PROJECT_NAME
----
. Be sure that view access rights for the service account are added before deploying your booster.
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ oc policy add-role-to-user view -n $(oc project -q) -z default
----
. Navigate to the root directory of your booster.
. Deploy your ConfigMap configuration using `app-config.yml`.
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ oc create configmap app-config --from-file=app-config.yml
----
. Deploy your booster.
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ mvn clean fabric8:deploy -Popenshift
----
== Interacting with the Booster on a Single-node OpenShift Cluster
To interact with your booster while it's running on a Single-node OpenShift Cluster, you first need to obtain it's URL:
[source,bash,options="nowrap",subs="attributes+"]
----
$ oc get route booster-configmap-vertx -o jsonpath={$.spec.host}
booster-configmap-vertx-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME
----
You can use the form at your application's url or you can use the `curl` command:
[source,bash,options="nowrap",subs="attributes+"]
----
$ curl http://booster-configmap-vertx-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/api/greeting
{"content":"Hello World from a ConfigMap!"}
$ curl http://booster-configmap-vertx-MY_PROJECT_NAME.LOCAL_OPENSHIFT_HOSTNAME/api/greeting?name=Sarah
{"content":"Hello Sarah from a ConfigMap!"}
----
== More Information
You can learn more about this booster and the Eclipse Vert.x runtime in the link:http://appdev.openshift.io/docs/vertx-runtime.html[Eclipse Vert.x Runtime Guide].