jonny
/
fuse-rest-http-booster-bad
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

doc review and update 2 

https://issues.jboss.org/browse/FUSEDOC-2619
pull/20/head
MelissaFlinn 8 years ago committed by Andrea Tarocchi
parent
847cf25068
commit
50de568718
1 changed files with 42 additions and 25 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 67
      README.adoc

67
README.adoc
Unescape View File

@ -12,46 +12,33 @@ This booster introduces the mechanics of interacting with a remote (exposed by A
Use this booster to: Use this booster to:
* Execute an HTTP GET request on the `camel/greetings/{name}` endpoint by using the URL parameter `{name}` * Execute an HTTP GET request on the `camel/greetings/{name}` endpoint by using the URL parameter `{name}`
* Produce a response in JSON format with a payload of Hello, $name! (where $name is replaced by the value of the URL parameter from the HTTP GET request).
* Produce a response in JSON format with a payload of `Hello, $name!` (where `$name` is replaced by the value of the URL parameter from the HTTP GET request).
* Browse the API's Swagger page. * Browse the API's Swagger page.
== Deployment options == Deployment options
You can run this booster in the following modes: You can run this booster in the following modes:
* Standalone on your machine
* Single-node OpenShift cluster * Single-node OpenShift cluster
* OpenShift Online at link:{launchURL}[] * OpenShift Online at link:{launchURL}[]
* Standalone on your machine
The most effective way to use this booster is to deploy and run the project on OpenShift. The most effective way to use this booster is to deploy and run the project on OpenShift.
For more details about running this booster on a single-node OpenShift cluster, CI/CD deployments, as well as the rest of the runtime, see the link:http://appdev.openshift.io/docs/spring-boot-runtime.html[Spring Boot Runtime Guide]. For more details about running this booster on a single-node OpenShift cluster, CI/CD deployments, as well as the rest of the runtime, see the link:http://appdev.openshift.io/docs/spring-boot-runtime.html[Spring Boot Runtime Guide].
IMPORTANT: This booster requires Java 8 JDK or later and Maven 3.3.x or later. IMPORTANT: This booster requires Java 8 JDK or later and Maven 3.3.x or later.
== Running the booster standalone on your machine
To run this booster as a standalone project on your local machine:
. Download the project and extract the archive on your local filesystem.
. Build the project:
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ cd PROJECT_DIR
$ mvn clean package
----
. Run the services:
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ mvn spring-boot:run
----
. Go to link:http://localhost:8080[] and then follow the instructions on that page.
== Running the booster on a single-node OpenShift cluster == 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 deploy your booster there.
A single-node OpenShift cluster provides you with access to a cloud environment that is similar to a production environment. 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: 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 deploy your booster there.
To deploy this booster to a running single-node OpenShift cluster:
. Download the project and extract the archive on your local filesystem. . Download the project and extract the archive on your local filesystem.
@ -69,6 +56,13 @@ $ oc login -u developer -p developer
$ oc new-project MY_PROJECT_NAME $ oc new-project MY_PROJECT_NAME
---- ----
. Change the directory to the folder that contains the extracted booster application (for example, `my_openshift/fuse-rest-http-booster-master`) :
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ cd my_openshift/fuse-rest-http-booster-master
----
. Build and deploy the project to the OpenShift cluster: . Build and deploy the project to the OpenShift cluster:
+ +
[source,bash,options="nowrap",subs="attributes+"] [source,bash,options="nowrap",subs="attributes+"]
@ -79,15 +73,38 @@ $ mvn clean -DskipTests fabric8:deploy -Popenshift
. In your browser, navigate to the `MY_PROJECT_NAME` project in the OpenShift console. . In your browser, navigate to the `MY_PROJECT_NAME` project in the OpenShift console.
Wait until you can see that the pod for the `fuse-rest-http-booster` application has started up. Wait until you can see that the pod for the `fuse-rest-http-booster` application has started up.
. Just above the entry for the `fuse-rest-http-booster` application on the `Overview` page, find the URL of the form `http://fuse-rest-http-booster-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io`. . On the project's `Overview` page, locate the URL for the `fuse-rest-http-booster` application. The URL uses this form:
`http://fuse-rest-http-booster-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io`.
. Click on the URL to access the greetings service application and then follow the instructions on that page. . Click the URL to access the greetings service application and then follow the instructions on that page.
== Running the booster on OpenShift Online == Running the booster on OpenShift Online
You can deploy the circuit breaker booster directly to OpenShift Online when you create the project at link:{launchURL}[].
To deploy this booster directly to OpenShift Online when you create the project at link:{launchURL}[].
. Go to link:{launchURL}[]. . Go to link:{launchURL}[].
. At the *Deployment step*, select *Use OpenShift Online*. . At the *Deployment step*, select *Use OpenShift Online*.
. Follow the on-screen instructions to create a new *REST API Level 0* project by using the *Fuse* runtime. . Follow the on-screen instructions to create a new *REST API Level 0* project by using the *Fuse* runtime.
NOTE: As part of the process of creating this booster, link:{launchURL}[] sets 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. NOTE: As part of the process of creating this booster, link:{launchURL}[] sets 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 standalone on your machine
To run this booster as a standalone project on your local machine:
. Download the project and extract the archive on your local filesystem.
. Build the project:
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ cd PROJECT_DIR
$ mvn clean package
----
. Run the services:
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ mvn spring-boot:run
----
. Go to link:http://localhost:8080[] and then follow the instructions on that page.

Write Preview
Loading…
Cancel
Save