Fuse on OpenShift Guide

Procedure

1. Log into your OpenShift cluster as administrator:

   oc login --user system:admin --token=my-token --server=https://my-cluster.example.com:6443

2. Open the project in which you want to deploy Fuse:

   oc project myproject

3. Create a docker-registry secret using your Red Hat Customer Portal account, replacing PULL_SECRET_NAME with psi-internal-registry to create:

   oc create secret docker-registry psi-internal-registry \
     --docker-server=docker-registry.redhat.io \
     --docker-username=CUSTOMER_PORTAL_USERNAME \
     --docker-password=CUSTOMER_PORTAL_PASSWORD \
     --docker-email=EMAIL_ADDRESS

   You should see the following output:

   secret/psi-internal-registry created

   Important

   You must create this docker-registry secret in every OpenShift project namespace that will authenticate to registry.redhat.io.

4. Link the secret to your service account to use the secret for pulling images. The following example uses the default service account, builder service account, and deployer service account:

   oc secrets link default psi-internal-registry
   oc secrets link default psi-internal-registry --for=pull
   oc secrets link builder psi-internal-registry
   oc secrets link builder psi-internal-registry --for=pull
   oc secrets link deployer psi-internal-registry
   oc secrets link deployer psi-internal-registry --for=pull

   The service account name must match the name that the OpenShift pod uses.

   Note

   If you do not want to use your Red Hat username and password to create the pull secret, you can create an authentication token using a registry service account.

Procedure

1. Start the OpenShift 4 Server.

2. Log in to the OpenShift Server as an administrator.

   oc login --user system:admin --token=my-token --server=https://my-cluster.example.com:6443

3. Verify that you are using the project for which you created a docker-registry secret.

   oc project openshift

4. View the current configuration of Samples operator.

   oc get configs.samples.operator.openshift.io -n openshift-cluster-samples-operator -o yaml

5. Configure Samples operator to ignore the fuse templates and image streams that are added.

   oc edit configs.samples.operator.openshift.io -n openshift-cluster-samples-operator

6. Add the Fuse imagestreams Skipped Imagestreams section and add Fuse and Spring Boot 2 templates to Skipped Templates section.

   [...]
   spec:
     architectures:
     - x86_64
     managementState: Managed
     skippedImagestreams:
     - fuse-console-rhel8
     - fuse-eap-openshift-jdk8-rhel7
     - fuse-eap-openshift-jdk11-rhel8
     - fuse-java-openshift-rhel8
     - fuse-java-openshift-jdk11-rhel8
     - fuse-karaf-openshift-rhel8
     - fuse-karaf-openshift-jdk11-rhel8
     - fuse-apicurito-generator-rhel8
     - fuse-apicurito-rhel8
     skippedTemplates:
     - s2i-fuse711-eap-camel-amq
     - s2i-fuse711-eap-camel-cdi
     - s2i-fuse711-eap-camel-cxf-jaxrs
     - s2i-fuse711-eap-camel-cxf-jaxws
     - s2i-fuse711-karaf-camel-amq
     - s2i-fuse711-karaf-camel-log
     - s2i-fuse711-karaf-camel-rest-sql
     - s2i-fuse711-karaf-cxf-rest
     - s2i-fuse711-spring-boot-2-camel-amq
     - s2i-fuse711-spring-boot-2-camel-config
     - s2i-fuse711-spring-boot-2-camel-drools
     - s2i-fuse711-spring-boot-2-camel-infinispan
     - s2i-fuse711-spring-boot-2-camel-rest-3scale
     - s2i-fuse711-spring-boot-2-camel-rest-sql
     - s2i-fuse711-spring-boot-2-camel
     - s2i-fuse711-spring-boot-2-camel-xa
     - s2i-fuse711-spring-boot-2-camel-xml
     - s2i-fuse711-spring-boot-2-cxf-jaxrs
     - s2i-fuse711-spring-boot-2-cxf-jaxws
     - s2i-fuse711-spring-boot-2-cxf-jaxrs-xml
     - s2i-fuse711-spring-boot-2-cxf-jaxws-xml

7. Install Fuse on OpenShift image streams.

   BASEURL=https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002
   
   oc create -n openshift -f ${BASEURL}/fis-image-streams.json

8. Install Fuse on OpenShift quickstart templates:

   for template in eap-camel-amq-template.json \
    eap-camel-cdi-template.json \
    eap-camel-cxf-jaxrs-template.json \
    eap-camel-cxf-jaxws-template.json \
    karaf-camel-amq-template.json \
    karaf-camel-log-template.json \
    karaf-camel-rest-sql-template.json \
    karaf-cxf-rest-template.json ;
    do oc create -n openshift -f \
    ${BASEURL}/quickstarts/${template}
    done

9. Install Spring Boot 2 quickstart templates:

   for template in spring-boot-2-camel-amq-template.json \
    spring-boot-2-camel-config-template.json \
    spring-boot-2-camel-drools-template.json \
    spring-boot-2-camel-infinispan-template.json \
    spring-boot-2-camel-rest-3scale-template.json \
    spring-boot-2-camel-rest-sql-template.json \
    spring-boot-2-camel-template.json \
    spring-boot-2-camel-xa-template.json \
    spring-boot-2-camel-xml-template.json \
    spring-boot-2-cxf-jaxrs-template.json \
    spring-boot-2-cxf-jaxws-template.json \
    spring-boot-2-cxf-jaxrs-xml-template.json \
    spring-boot-2-cxf-jaxws-xml-template.json ;
    do oc create -n openshift -f \
    ${BASEURL}/quickstarts/${template}
    done

10. (Optional) View the installed Fuse on OpenShift templates:

    oc get template -n openshift

Procedure

1. Start the OpenShift 4.x Server.
2. In a web browser, navigate to the OpenShift console in your browser. Log in to the console with your credentials.
3. Click Operators and then click OperatorHub.
4. In the search field, type API Designer.
5. Click the Red Hat Integration - API Designer card. The Red Hat Integration - API Designer Operator install page opens.

6. Click Install. The Install Operator page opens.

   1. For Update Channel, select fuse-console-7.11.x.
   2. For Installation mode, select a namespace (project) from the list of namespaces on the cluster.

   3. For the Approval Strategy, select Automatic or Manual to configure how OpenShift handles updates to the API Designer Operator.

      • If you select Automatic updates, when a new version of the API Designer Operator is available, the OpenShift Operator Lifecycle Manager (OLM) automatically upgrades the running instance of the API Designer without human intervention.
      • If you select Manual updates, when a newer version of an Operator is available, the OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the API Designer Operator updated to the new version.
7. Click Install to make the API Designer Operator available to the specified namespace (project).
8. To verify that the API Designer is installed in the project, click Operators and then click Installed Operators to see the Red Hat Integration - API Designer in the list.

Procedure

1. Start the OpenShift Server.

2. Log in to the OpenShift Server as an administrator.

   oc login -u system:admin

3. Verify that you are using the project for which you created a docker-registry secret.

   oc project openshift

4. Install the Fuse on OpenShift image streams.

   BASEURL=https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002
   
   oc create -n openshift -f ${BASEURL}/fis-image-streams.json

5. Install the quickstart templates:

   for template in eap-camel-amq-template.json \
    eap-camel-cdi-template.json \
    eap-camel-cxf-jaxrs-template.json \
    eap-camel-cxf-jaxws-template.json \
    karaf-camel-amq-template.json \
    karaf-camel-log-template.json \
    karaf-camel-rest-sql-template.json \
    karaf-cxf-rest-template.json ;
    do
    oc create -n openshift -f \
    ${BASEURL}/quickstarts/${template}
    done

6. Install Spring Boot 2 quickstart templates:

   for template in spring-boot-2-camel-amq-template.json \
    spring-boot-2-camel-config-template.json \
    spring-boot-2-camel-drools-template.json \
    spring-boot-2-camel-infinispan-template.json \
    spring-boot-2-camel-rest-3scale-template.json \
    spring-boot-2-camel-rest-sql-template.json \
    spring-boot-2-camel-template.json \
    spring-boot-2-camel-xa-template.json \
    spring-boot-2-camel-xml-template.json \
    spring-boot-2-cxf-jaxrs-template.json \
    spring-boot-2-cxf-jaxws-template.json \
    spring-boot-2-cxf-jaxrs-xml-template.json \
    spring-boot-2-cxf-jaxws-xml-template.json ;
    do oc create -n openshift -f \
    ${BASEURL}/quickstarts/${template}
    done

7. Install the templates for the Fuse Console.

   oc create -n openshift -f ${BASEURL}/fis-console-cluster-template.json
   oc create -n openshift -f ${BASEURL}/fis-console-namespace-template.json

   Note

   For information on deploying the Fuse Console, see Set up Fuse Console on OpenShift.

8. Install the Apicurito template:

   oc create -n openshift -f ${BASEURL}/fuse-apicurito.yml

9. (Optional) View the installed Fuse on OpenShift images and templates:

   oc get template -n openshift

Procedure

1. Install internal ROOT CA.

   cd /etc/pki/ca-trust/source/anchors
   sudo curl -O https://password.corp.redhat.com/RH-IT-Root-CA.crt
   sudo update-ca-trust extract
   sudo update-ca-trust update

   This certificate allows the system to authenticate itself to the registry.

2. Login to registry.redhat.io.

   docker login -u USERNAME -p PASSWORD registry.redhat.io

3. Pull the Fuse on OpenShift images from registry.redhat.io.

   docker pull registry.redhat.io/fuse7/fuse-java-openshift-rhel8:1.11
   docker pull registry.redhat.io/fuse7/fuse-java-openshift-jdk11-rhel8:1.11
   docker pull registry.redhat.io/fuse7/fuse-karaf-openshift-rhel8:1.11
   docker pull registry.redhat.io/fuse7/fuse-console-rhel8:1.11
   docker pull registry.redhat.io/fuse7/fuse-apicurito-rhel8:1.11
   docker pull registry.redhat.io/fuse7/fuse-apicurito-generator-rhel8:1.11

4. Tag the pulled imagestreams.

   docker tag registry.redhat.io/fuse7/fuse-java-openshift-rhel8:1.11 docker-registry.upshift.redhat.com/fuse7/fuse-java-openshift-rhel8:1.11
   docker tag registry.redhat.io/fuse7/fuse-java-openshift-jdk11-rhel8:1.11 docker-registry.upshift.redhat.com/fuse7/fuse-java-openshift-jdk11-rhel8:1.11
   docker tag registry.redhat.io/fuse7/fuse-karaf-openshift-rhel8:1.11 docker-registry.upshift.redhat.com/fuse-karaf-openshift-rhel8:1.11
   docker tag registry.redhat.io/fuse7/fuse-console-rhel8:1.11 docker-registry.upshift.redhat.com/fuse7-fuse-console-rhel8:1.11
   docker tag registry.redhat.io/fuse7/fuse-apicurito-rhel8:1.11 docker-registry.upshift.redhat.com/fuse7-fuse-apicurito-rhel8:1.11
   docker tag registry.redhat.io/fuse7/fuse-apicurito-generator-rhel8:1.11 docker-registry.upshift.redhat.com/fuse7-fuse-apicurito-generator-rhel8:1.11

5. Push the tagged imagestreams to the internal docker registry.

   docker push docker-registry.upshift.redhat.com/fuse7/fuse-java-openshift-rhel8:1.11
   docker push docker-registry.upshift.redhat.com/fuse7/fuse-java-openshift-jdk11-rhel8:1.11
   docker push docker-registry.upshift.redhat.com/fuse-karaf-openshift-rhel8:1.11
   docker push docker-registry.upshift.redhat.com/fuse7-fuse-console-rhel8:1.11
   docker push docker-registry.upshift.redhat.com/fuse7-fuse-apicurito-rhel8:1.11
   docker push docker-registry.upshift.redhat.com/fuse7-fuse-apicurito-generator-rhel8:1.11

Procedure

1. Log into your OpenShift cluster as administrator:

   oc login --user system:admin --token=my-token --server=https://my-cluster.example.com:6443

2. Open the project in which you want to deploy Fuse:

   oc project myproject

3. Create a docker-registry secret using your Red Hat Customer Portal account, replacing PULL_SECRET_NAME with psi-internal-registry to create:

   oc create secret docker-registry psi-internal-registry \
     --docker-server=docker-registry.redhat.io \
     --docker-username=CUSTOMER_PORTAL_USERNAME \
     --docker-password=CUSTOMER_PORTAL_PASSWORD \
     --docker-email=EMAIL_ADDRESS

   You should see the following output:

   secret/psi-internal-registry created

   Important

   You must create this docker-registry secret in every OpenShift project namespace that will authenticate to registry.redhat.io.

4. Link the secret to your service account to use the secret for pulling images. The following example uses the default service account, builder service account, and deployer service account:

   oc secrets link default psi-internal-registry
   oc secrets link default psi-internal-registry --for=pull
   oc secrets link builder psi-internal-registry
   oc secrets link builder psi-internal-registry --for=pull
   oc secrets link deployer psi-internal-registry
   oc secrets link deployer psi-internal-registry --for=pull

   The service account name must match the name that the OpenShift pod uses.

   Note

   If you do not want to use your Red Hat username and password to create the pull secret, you can create an authentication token using a registry service account.

Procedure

1. Download Red Hat Fuse on OpenShift imagestream json file.

   curl -o fis-image-streams.json https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002/fis-image-streams.json

2. Open the fis-image-streams.json file and locate all the references to registry.redhat.io. For example:

   {
   "name": "1.9",
   "annotations": {
   "description": "Red Hat Fuse 7.11 Karaf S2I images.",
   "openshift.io/display-name": "Red Hat Fuse 7.11 Karaf",
   "iconClass": "icon-rh-integration",
   "tags": "builder,jboss-fuse,java,karaf,xpaas,hidden",
   "supports":"jboss-fuse:7.11.0,java:8,xpaas:1.2",
   "version": "1.9"
   },
   "referencePolicy": {
   "type": "Local"
   },
   "from": {
   "kind": "DockerImage",
   "name": "registry.redhat.io/fuse7/fuse-karaf-openshift-rhel8:1.11"
   }
   },

3. Replace all the registry.redhat.io references in the file with psi-internal-registry name. For example:

   {
   "name": "1.9",
   "annotations": {
   "description": "Red Hat Fuse 7.11 Karaf S2I images.",
   "openshift.io/display-name": "Red Hat Fuse 7.11 Karaf",
   "iconClass": "icon-rh-integration",
   "tags": "builder,jboss-fuse,java,karaf,xpaas,hidden",
   "supports":"jboss-fuse:7.11.0,java:8,xpaas:1.2",
   "version": "1.9"
   },
   "referencePolicy": {
   "type": "Local"
   },
   "from": {
   "kind": "DockerImage",
   "name": "docker-registry.upshift.redhat.com/fuse7/fuse-karaf-openshift-rhel8:1.11"
   }
   },

4. After all the references are replaced, run the following command to install Fuse on OpenShift imagestreams:

   oc create -f fis-image-streams.json -n {namespace}

Procedure

1. In preparation for building and deploying the Fuse on OpenShift project, log in to the OpenShift Server as follows.

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

   Where, OPENSHIFT_IP_ADDR is a placeholder for the OpenShift server’s IP address as this IP address is not always the same.

   Note

   The developer user (with developer password) is a standard account that is automatically created on the virtual OpenShift Server by CDK. If you are accessing a remote server, use the URL and credentials provided by your OpenShift administrator.

2. Create a new project namespace called test (assuming it does not already exist).

   oc new-project test

   If the test project namespace already exists, switch to it.

   oc project test

3. Install the Fuse on OpenShift image streams:

   BASEURL=https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002
   
   oc create -n test -f ${BASEURL}/fis-image-streams.json

   The command output displays the Fuse image streams that are now available in your Fuse on OpenShift project.

4. Install the quickstart templates.

   BASEURL=https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002
   
   for template in eap-camel-amq-template.json \
    eap-camel-cdi-template.json \
    eap-camel-cxf-jaxrs-template.json \
    eap-camel-cxf-jaxws-template.json \
    karaf-camel-amq-template.json \
    karaf-camel-log-template.json \
    karaf-camel-rest-sql-template.json \
    karaf-cxf-rest-template.json ;
    do
    oc create -n test -f \
    ${BASEURL}/quickstarts/${template}
    done

5. Install Spring Boot 2 quickstart templates:

   BASEURL=https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002
   
   for template in spring-boot-2-camel-amq-template.json \
    spring-boot-2-camel-config-template.json \
    spring-boot-2-camel-drools-template.json \
    spring-boot-2-camel-infinispan-template.json \
    spring-boot-2-camel-rest-3scale-template.json \
    spring-boot-2-camel-rest-sql-template.json \
    spring-boot-2-camel-template.json \
    spring-boot-2-camel-xa-template.json \
    spring-boot-2-camel-xml-template.json \
    spring-boot-2-cxf-jaxrs-template.json \
    spring-boot-2-cxf-jaxws-template.json \
    spring-boot-2-cxf-jaxrs-xml-template.json \
    spring-boot-2-cxf-jaxws-xml-template.json ;
    do oc create -n openshift -f \
    ${BASEURL}/quickstarts/${template}
    done

6. Install the templates for the Fuse Console.

   oc create -n test -f ${BASEURL}/fis-console-cluster-template.json
   oc create -n test -f ${BASEURL}/fis-console-namespace-template.json

   Note

   For information on deploying the Fuse Console, see Set up Fuse Console on OpenShift.

7. (Optional) View the installed Fuse on OpenShift images and templates.

   oc get template -n test

8. In your browser, navigate to the OpenShift console:

   1. Use https://OPENSHIFT_IP_ADDR:8443 and replace OPENSHIFT_IP_ADDR with your OpenShift server’s IP address.
   2. Log in to the OpenShift console with your credentials (for example, with username developer and password developer).

Procedure

1. Go to the appropriate directory on your system.

2. In a shell prompt, enter the following the mvn command to create a Spring Boot 2 project.

   mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
     -DarchetypeCatalog=https://maven.repository.redhat.com/ga/io/fabric8/archetypes/archetypes-catalog/2.2.0.fuse-sb2-7_11_1-00018-redhat-00002/archetypes-catalog-2.2.0.fuse-sb2-7_11_1-00018-redhat-00002-archetype-catalog.xml \
     -DarchetypeGroupId=org.jboss.fuse.fis.archetypes \
     -DarchetypeArtifactId=spring-boot-camel-xml-archetype \
     -DarchetypeVersion=2.2.0.fuse-sb2-7_11_1-00018-redhat-00002

   The archetype plug-in switches to interactive mode to prompt you for the remaining fields.

   Define value for property 'groupId': : org.example.fis
   Define value for property 'artifactId': : fuse711-spring-boot
   Define value for property 'version':  1.0-SNAPSHOT: :
   Define value for property 'package':  org.example.fis: :
   Confirm properties configuration:
   groupId: org.example.fis
   artifactId: fuse711-spring-boot
   version: 1.0-SNAPSHOT
   package: org.example.fis
    Y: : Y

   When prompted, enter org.example.fis for the groupId value and fuse711-spring-boot for the artifactId value. Accept the defaults for the remaining fields.

3. If the above command exited with the BUILD SUCCESS status, you should now have a new Fuse on OpenShift project under the fuse711-spring-boot subdirectory.

4. You are now ready to build and deploy the fuse711-spring-boot project. Assuming you are still logged into OpenShift, change to the directory of the fuse711-spring-boot project, and then build and deploy the project, as follows.

   cd fuse711-spring-boot
   mvn oc:deploy -Popenshift

Procedure

1. Add the following dependency to your Spring Boot pom.xml file:

   <dependency>
       <groupId>org.apache.camel</groupId>
       <artifactId>camel-spring-boot-starter</artifactId>
   </dependency>

2. Add the classes with your Camel routes as shown in the snippet below. Once these routes are added to the class path the routes are started automatically.

   package com.example;
   
   import org.apache.camel.builder.RouteBuilder;
   import org.springframework.stereotype.Component;
   
   @Component
   public class MyRoute extends RouteBuilder {
   
       @Override
       public void configure() throws Exception {
           from("timer:foo")
             .to("log:bar");
       }
   }

3. Optional. To keep the main thread blocked so that Camel stays up, do one of the following.

   1. Include the spring-boot-starter-web dependency,

   2. Or add camel.springboot.main-run-controller=true to your application.properties or application.yml file.

      You can customize the Camel application in the application.properties or application.yml file with camel.springboot.* properties.

4. Optional. To refer to a custom bean by using the bean’s ID name, configure the options in the src/main/resources/application.properties (or the application.yml) file. The following example shows how the xslt component refers to a custom bean by using the bean ID.

   1. Refer to a custom bean by the id myExtensionFactory.

      camel.component.xslt.saxon-extension-functions=myExtensionFactory

   2. Then create the custom bean using Spring Boot @Bean annotation.

      @Bean(name = "myExtensionFactory")
      public ExtensionFunctionDefinition myExtensionFactory() {
          }

      Or, for a Jackson ObjectMapper, in the camel-jackson data-format:

      camel.dataformat.json-jackson.object-mapper=myJacksonMapper

Procedure

1. Define the properties either in the application.properties file:  

   route.from = jms:invoices

   Or set the Camel properies as the system properties, for example:

   java -Droute.to=jms:processed.invoices -jar mySpringApp.jar

2. Use the configured properties as placeholders in Camel route as follows.

   @Component
   public class MyRouter extends RouteBuilder {
   
     @Override
     public void configure() throws Exception {
       from("{{route.from}}").to("{{route.to}}");
     }
   
   }

Procedure

1. Specify the include or exclude patterns in your unit test classes as properties to @SpringBootTest annotation, as shown below:

   @RunWith(CamelSpringBootRunner.class)
   @SpringBootTest(classes = {MyApplication.class);
      properties = {"camel.springboot.java-routes-include-pattern=**/Foo*"})
   public class FooTest {

   In the FooTest class, the include pattern is **/Foo*, which represents an Ant style pattern. Here, the pattern starts with a double asterisk, which matches with any leading package name. /Foo* means the class name must start with Foo, for example, FooRoute.

2. Run the test using the following maven command:

   mvn test -Dtest=FooTest

Procedure

1. This is a sample application.properties file. Replace the following options in the Kubernetes yaml descriptor.

   # Cluster
   cluster.nodename=1
   cluster.base-dir=./target/tx
   
   # Transaction Data
   spring.jta.transaction-manager-id=${cluster.nodename}
   spring.jta.log-dir=${cluster.base-dir}/store/${cluster.nodename}
   
   # Narayana recovery settings
   snowdrop.narayana.openshift.recovery.enabled=true
   snowdrop.narayana.openshift.recovery.current-pod-name=${cluster.nodename}
   # You must enable resource filtering in order to inject the Maven artifactId
   snowdrop.narayana.openshift.recovery.statefulset=${project.artifactId}
   snowdrop.narayana.openshift.recovery.status-dir=${cluster.base-dir}/status

2. You need a shared volume to store both transactions and information related to termination. It can be mounted in the StatefulSet yaml descriptor as follows.

   apiVersion: apps/v1
   kind: StatefulSet
   #...
   spec:
   #...
     template:
   #...
       spec:
         containers:
         - env:
           - name: CLUSTER_BASE_DIR
             value: /var/transaction/data
             # Override CLUSTER_NODENAME with Kubernetes Downward API (to use `pod-0`, `pod-1` etc. as tx manager id)
           - name: CLUSTER_NODENAME
             valueFrom:
               fieldRef:
                 apiVersion: v1
                 fieldPath: metadata.name
   #...
           volumeMounts:
           - mountPath: /var/transaction/data
             name: the-name-of-the-shared-volume
   #...

Procedure

1. Download Camel Spring Boot XA project.

   git clone --branch spring-boot-camel-xa-7.11.1.fuse-sb2-7_11_1-00022-redhat-00002 https://github.com/jboss-fuse/spring-boot-camel-xa

2. Navigate to spring-boot-camel-xa directory and run following command.

   mvn clean install

3. Log in to the OpenShift Server.

   oc login -u developer -p developer

4. Create a new project namespace called test (assuming it does not already exist).

   oc new-project test

   If the test project namespace already exists, switch to it.

   oc project test

5. Install dependencies.

   • Install postgresql using username as theuser and password as Thepassword1!.

     oc new-app --param=POSTGRESQL_USER=theuser --param=POSTGRESQL_PASSWORD='Thepassword1!' --env=POSTGRESQL_MAX_PREPARED_TRANSACTIONS=100 --template=postgresql-persistent

   • Install the A-MQ broker using username as theuser and password as Thepassword1!.

     oc new-app --param=MQ_USERNAME=theuser --param=MQ_PASSWORD='Thepassword1!' --template=amq63-persistent

6. Create a persistent volume claim for the transaction log.

   oc create -f persistent-volume-claim.yml

7. Build and deploy your quickstart.

   mvn oc:deploy -Popenshift

8. Scale it up to the desired number of replicas.

   oc scale statefulset spring-boot-camel-xa --replicas 3

   Note: The pod name is used as transaction manager id (spring.jta.transaction-manager-id property). The current implementation also limits the length of transaction manager ids. So please note that:

   • The name of the StatefulSet is an identifier for the transaction system, so it must not be changed.
   • You should name the StatefulSet so that all of its pod names have length lower than or equal to 23 characters. Pod names are created by OpenShift using the convention: <statefulset-name>-0, <statefulset-name>-1 and so on. Narayana does its best to avoid having multiple recovery managers with the same id, so when the pod name is longer than the limit, the last 23 bytes are taken as transaction manager id (after stripping some characters like -).

9. Once the quickstart is running, get the base service URL using the following command.

   NARAYANA_HOST=$(oc get route spring-boot-camel-xa -o jsonpath={.spec.host})

Procedure

1. Get the list of messages in the audit_log table.

   curl -w "\n" http://$NARAYANA_HOST/api/

2. The list is empty at the beginning. Now you can put the first element.

   curl -w "\n" -X POST http://$NARAYANA_HOST/api/?entry=hello

   After waiting for some time get the new list.

   curl -w "\n" http://$NARAYANA_HOST/api/

3. The new list contains two messages, hello and hello-ok. The hello-ok confirms that the message has been sent to a outgoing queue and then logged. You can add multiple messages and see the logs.

Procedure

1. Send a message named fail.

   curl -w "\n" -X POST http://$NARAYANA_HOST/api/?entry=fail

2. After waiting for some time get the new list.

   curl -w "\n" http://$NARAYANA_HOST/api/

3. This message produces an exception at the end of the route, so that the transaction is always rolled back. You should not find any trace of the message in the audit_log table.

Procedure

1. Log in to the OpenShift server as a developer.

   oc login -u developer -p developer

2. Create a new project for quickstart, for example:.

   oc new-project quickstart

3. Retrieve the quickstart project by using the Maven archetype:

   mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeCatalog=https://maven.repository.redhat.com/ga/io/fabric8/archetypes/archetypes-catalog/2.2.0.fuse-sb2-790047-redhat-00004/archetypes-catalog-2.2.0.fuse-sb2-790047-redhat-00004-archetype-catalog.xml -DarchetypeGroupId=org.jboss.fuse.fis.archetypes -DarchetypeArtifactId=spring-boot-camel-amq-archetype -DarchetypeVersion=2.2.0.fuse-sb2-790047-redhat-00004

4. Navigate to the quickstart directory fuse711-spring-boot-camel-amq.

   cd fuse711-spring-boot-camel-amq

5. Run the following commands to apply configuration files to AMQ Broker. These configuration files create the AMQ Broker user and the queue, both with the admin privileges.

   oc login -u admin -p admin
   
   oc apply -f src/main/resources/k8s

6. Create the ConfigMap for the application, for example:

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: spring-boot-camel-amq-config
     namespace: quickstarts
   data:
     service.host: 'fuse-broker-amqps-0-svc'
     service.port.amqp: '5672'
     service.port.amqps: '5671'

7. Run the mvn command to deploy the quickstart to the OpenShift server, by using the ImageStream from Step 3:

   mvn oc:deploy -Popenshift -Djkube.generator.fromMode=istag -Djkube.generator.from=openshift/fuse-java-openshift:1.9

8. To verify that the quickstart is running successfully:

   1. Navigate to the OpenShift web console in your browser (https://OPENSHIFT_IP_ADDR, replace OPENSHIFT_IP_ADDR with the IP address of the cluster) and log in to the console with your credentials (for example, with username developer and password, developer).
   2. In the left hand side panel, expand Home and then click Status to view the Project Status page for openshift project.
   3. Click fuse711-spring-boot-camel-amq to view the Overview information page for the quickstart.
   4. In the left hand side panel, expand Workloads.
   5. Click Pods and then click fuse711-spring-boot-camel-amq-xxxxx. The pod details for the quickstart are displayed.

   6. Click Logs to view the logs for the application.

      The output shows the messages are sent successfully.

      10:17:59.825 [Camel (camel) thread #10 - timer://order] INFO  generate-order-route - Generating order order1379.xml
      10:17:59.829 [Camel (camel) thread #8 - JmsConsumer[incomingOrders]] INFO  jms-cbr-route - Sending order order1379.xml to the UK
      10:17:59.829 [Camel (camel) thread #8 - JmsConsumer[incomingOrders]] INFO  jms-cbr-route - Done processing order1379.xml
      10:18:02.825 [Camel (camel) thread #10 - timer://order] INFO  generate-order-route - Generating order order1380.xml
      10:18:02.829 [Camel (camel) thread #7 - JmsConsumer[incomingOrders]] INFO  jms-cbr-route - Sending order order1380.xml to another country
      10:18:02.829 [Camel (camel) thread #7 - JmsConsumer[incomingOrders]] INFO jms-cbr-route - Done processing order1380.xml

9. To view the routes on the web interface, click Open Java Console and check the messages in the AMQ queue.

1. Reading recursively from secrets mounts
2. Named after the application (see spring.application.name)
3. Matching some labels

Procedure

1. Go to the appropriate directory on your system.

2. Launch the Maven command to create a Karaf project

   mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
     -DarchetypeCatalog=https://maven.repository.redhat.com/ga/io/fabric8/archetypes/archetypes-catalog/2.2.0.fuse-sb2-7_11_1-00018-redhat-00002/archetypes-catalog-2.2.0.fuse-sb2-7_11_1-00018-redhat-00002-archetype-catalog.xml \
     -DarchetypeGroupId=org.jboss.fuse.fis.archetypes \
     -DarchetypeArtifactId=karaf-camel-log-archetype \
     -DarchetypeVersion=2.2.0.fuse-sb2-7_11_1-00018-redhat-00002

3. The archetype plug-in switches to interactive mode to prompt you for the remaining fields

   Define value for property 'groupId': : org.example.fis
   Define value for property 'artifactId': : fuse711-karaf-camel-log
   Define value for property 'version':  1.0-SNAPSHOT: :
   Define value for property 'package':  org.example.fis: :
   Confirm properties configuration:
   groupId: org.example.fis
   artifactId: fuse711-karaf-camel-log
   version: 1.0-SNAPSHOT
   package: org.example.fis
    Y: : Y

   When prompted, enter org.example.fis for the groupId value and fuse711-karaf-camel-log for the artifactId value. Accept the defaults for the remaining fields.

4. If the above command exited with the BUILD SUCCESS status, you should now have a new Fuse on OpenShift project under the fuse711-karaf-camel-log subdirectory.

5. You are now ready to build and deploy the fuse711-karaf-camel-log project. Assuming you are still logged into OpenShift, change to the directory of the fuse711-karaf-camel-log project, and then build and deploy the project, as follows.

   cd fuse711-karaf-camel-log
   mvn oc:deploy -Popenshift

Procedure

1. Open you project’s pom.xml and add fabric8-karaf-checks feature in the startupFeatures section.

   pom.xml

   <startupFeatures>
     ...
     <feature>fabric8-karaf-checks</feature>
     ...
   </startupFeatures>

   The oc:resources goal will detect if your using the fabric8-karaf-checks feature and automatically add the Kubernetes for readiness and liveness probes to your container’s configuration.

Procedure

1. Add the view role to the default service account to enable clustering. This grants the user the view access to the default service account. Service accounts are required in each project to run builds, deployments, and other pods. Enter the following oc client commands in a shell prompt:

   oc login -u developer -p developer
   oc policy add-role-to-user view -z default

2. View the installed Fuse on OpenShift templates.

   oc get template -n openshift

3. Enter the following command to create the resources required for running the Red Hat Fuse 7.11 Camel CDI with EAP quickstart. It creates a deployment config and build config for the quickstart. The information about the quickstart and the resources created is displayed on the terminal.

   oc new-app s2i-fuse7-eap-camel-cdi
   
   --> Creating resources ...
       service "s2i-fuse7-eap-camel-cdi" created
       service "s2i-fuse7-eap-camel-cdi-ping" created
       route.route.openshift.io "s2i-fuse7-eap-camel-cdi" created
       imagestream.image.openshift.io "s2i-fuse7-eap-camel-cdi" created
       buildconfig.build.openshift.io "s2i-fuse7-eap-camel-cdi" created
       deploymentconfig.apps.openshift.io "s2i-fuse7-eap-camel-cdi" created
   --> Success
       Access your application via route 's2i-fuse7-eap-camel-cdi-OPENSHIFT_IP_ADDR'
       Build scheduled, use 'oc logs -f bc/s2i-fuse7-eap-camel-cdi' to track its progress.
       Run 'oc status' to view your app.

4. Navigate to the OpenShift web console in your browser (https://OPENSHIFT_IP_ADDR, replace OPENSHIFT_IP_ADDR with the IP address of the cluster) and log in to the console with your credentials (for example, with username developer and password, developer).
5. In the left hand side panel, expand Home. Click Status to view the Project Status page. All the existing applications in the selected namespace (for example, openshift) are displayed.

6. Click s2i-fuse7-eap-camel-cdi to view the Overview information page for the quickstart.

   

7. Click the Resources tab and then click the link displayed in the Routes section to access the application.

   

   The link has the form http://s2i-fuse7-eap-camel-cdi-OPENSHIFT_IP_ADDR. This shows a message like the following in your browser:

   Hello world from 172.17.0.3

8. You can also specify a name using the name parameter in the URL. For example, if you enter the URL, http://s2i-fuse7-eap-camel-cdi-openshift.apps.cluster-name.openshift.com/?name=jdoe, in your browser you see the response:

   Hello jdoe from 172.17.0.3

9. Click View Logs to view the logs for the application.

10. To shut down the running pod,

    1. Click the Overview tab to return to the overview information page of the application.
    2. Click the icon next to Desired Count. The Edit Count window is displayed.
    3. Use the down arrow to scale down to zero to stop the pod.

Procedure

1. Create a configuration file named pv.yaml using the sample configuration below. This provisions a path on the host machine as a PersistentVolume named pv001.

   apiVersion: v1
   kind: PersistentVolume
   metadata:
     name: pv0001
   spec:
     accessModes:
       - ReadWriteOnce
     capacity:
       storage: 2Mi
     hostPath:
       path: /data/pv0001/

   Here the host path is /data/pv0001 and storage capacity is limited to 2MB. For example, when using OpenShift CDK it will provision the directory /data/pv0001 from the virtual machine hosting the OpenShift Cluster.

2. Create the PersistentVolume.

   oc create -f pv.yaml

3. Verify the creation of PersistentVolume. This will list all the PersistentVolumes configured in your OpenShift cluster:

   oc get pv

Procedure

1. Create a sample container configuration as shown below which mounts PersistentVolumeClaim pvc0001 at /usr/share/data in its filesystem.

   spec:
     template:
       spec:
         containers:
           - volumeMounts:
             - name: vol0001
               mountPath: /usr/share/data
         volumes:
           - name: vol0001
             persistentVolumeClaim:
               claimName: pvc0001

   Any data written by the application to the directory /usr/share/data is now persisted across container restarts.

2. Add this configuration in the file src/main/jkube/deployment.yml in a Fuse on OpenShift application and create OpenShift resources using command:

   mvn oc:resource-apply

3. Verify that the created DeploymentConfiguration has the volume mount and the volume.

   oc describe deploymentconfig <application-dc-name>

   For Fuse on OpenShift quickstarts, replace the <application-dc-name> with the Maven project name, for example spring-boot-camel.

Procedure

1. Fuse on OpenShift image streams are normally installed on the openshift project on the OpenShift server. To check the status of the Fuse on OpenShift images on OpenShift, login to OpenShift as an administrator and enter the following command:

   $ oc get is -n openshift
   NAME                           DOCKER REPO                                          TAGS                                    	UPDATED
   fuse-console-rhel8               172.30.1.1:5000/openshift/fuse7/fuse-console-rhel8              1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago
   fuse7-eap-openshift-jdk8-rhel7   172.30.1.1:5000/openshift/fuse7/fuse-eap-openshift-jdk8-rhel7        1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago
   fuse7-eap-openshift-jdk11-rhel8  172.30.1.1:5000/openshift/fuse7/fuse-eap-openshift-jdk11-rhel8        1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago
   fuse7-java-openshift-rhel8       172.30.1.1:5000/openshift/fuse7/fuse-java-openshift-rhel8       1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago
   fuse7-java-openshift-jdk11-rhel8 172.30.1.1:5000/openshift/fuse7/fuse-java-openshift-jdk11-rhel8       1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago
   fuse7-karaf-openshift-rhel8      172.30.1.1:5000/openshift/fuse7/fuse-karaf-openshift-rhel8      1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago
   fuse-apicurito-generator-rhel8   172.30.1.1:5000/openshift/fuse7/fuse-apicurito-generator-rhel8   1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago
   apicurito-ui-rhel8               172.30.1.1:5000/openshift/fuse7/apicurito-ui-rhel8               1.5,1.6,1.7,1.8,1.9,1.10,1.11    About an hour ago

2. You can now update each image stream one at a time:

   oc import-image -n openshift fuse7/fuse7-java-openshift-rhel8:1.11
   oc import-image -n openshift fuse7/fuse7-java-openshift-jdk11-rhel8:1.11
   oc import-image -n openshift fuse7/fuse7-karaf-openshift-rhel8:1.11
   oc import-image -n openshift fuse7/fuse7-eap-openshift-jdk8-rhel7:1.11
   oc import-image -n openshift fuse7/fuse7-eap-openshift--jdk11-rhel8:1.11
   oc import-image -n openshift fuse7/fuse7-console-rhel8:1.11
   oc import-image -n openshift fuse7/apicurito-ui-rhel8:1.11
   oc import-image -n openshift fuse7/fuse-apicurito-generator-rhel8:1.11

Procedure

1. You need administrator privileges to update the Fuse on OpenShift templates. Log in to the OpenShift Server as an administrator, as follows:

   oc login URL -u ADMIN_USER -p ADMIN_PASS

   Where URL is the URL of the OpenShift server and ADMIN_USER, ADMIN_PASS are the credentials of an administrator account on the OpenShift server.

2. Install the patched Fuse on OpenShift templates. Enter the following commands at a command prompt:

   BASEURL=https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002
   
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/eap-camel-amq-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/eap-camel-cdi-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/eap-camel-cxf-jaxrs-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/eap-camel-cxf-jaxws-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/karaf-camel-amq-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/karaf-camel-log-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/karaf-camel-rest-sql-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/karaf-cxf-rest-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-camel-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-camel-amq-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-camel-config-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-camel-drools-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-camel-infinispan-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-camel-xml-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-cxf-jaxrs-template.json
   oc replace --force -n openshift -f ${BASEURL}/quickstarts/spring-boot-cxf-jaxws-template.json

   Note

   The BASEURL points at the GA branch of the Git repository that stores the quickstart templates. It will always have the latest templates at HEAD. Therfore, any time you run the preceding commands, you will get the latest version of the templates.

1. Delete the Spring Boot 2 quickstart templates.

   for template in spring-boot-2-camel-amq-template.json \
    spring-boot-2-camel-config-template.json \
    spring-boot-2-camel-drools-template.json \
    spring-boot-2-camel-infinispan-template.json \
    spring-boot-2-camel-rest-3scale-template.json \
    spring-boot-2-camel-rest-sql-template.json \
    spring-boot-2-camel-template.json \
    spring-boot-2-camel-xa-template.json \
    spring-boot-2-camel-xml-template.json \
    spring-boot-2-cxf-jaxrs-template.json \
    spring-boot-2-cxf-jaxws-template.json \
    spring-boot-2-cxf-jaxrs-xml-template.json \
    spring-boot-2-cxf-jaxws-xml-template.json ;
    do oc delete -n openshift -f \
    ${BASEURL}/quickstarts/${template}
    done

2. Delete Fuse on OpenShift quickstart templates.

   for template in eap-camel-amq-template.json \
    eap-camel-cdi-template.json \
    eap-camel-cxf-jaxrs-template.json \
    eap-camel-cxf-jaxws-template.json \
    karaf-camel-amq-template.json \
    karaf-camel-log-template.json \
    karaf-camel-rest-sql-template.json \
    karaf-cxf-rest-template.json ;
    do
    oc delete -n openshift -f \
    ${BASEURL}/quickstarts/${template}
    done

3. Delete the imagestreams.

   oc delete -n openshift -f ${BASEURL}/fis-image-streams.json

4. Remove items in the Samples Operator.

   Edit the configuration of Samples Operator:

   oc edit configs.samples.operator.openshift.io -n openshift-cluster-samples-operator

5. Remove the Fuse and Spring Boot 2 templates from the skippedImagestreams and skippedTemplates section.