Chapter 1. Monitoring and managing Red Hat Fuse applications on OpenShift

Procedure

1. Login to OpenShift as a user with cluster admin access:

   oc login -u <user_with_cluster_admin_role>

2. Retrieve the service signing certificate authority keys, by executing the following commands:

   • To retrieve the certificate:

     oc get secrets/signing-key -n openshift-service-ca -o "jsonpath={.data['tls\.crt']}" | base64 --decode > ca.crt

   • To retrieve the private key:

     oc get secrets/signing-key -n openshift-service-ca -o "jsonpath={.data['tls\.key']}" | base64 --decode > ca.key

3. Generate the client certificate, as documented in Kubernetes certificates administration, using either easyrsa, openssl, or cfssl.

   Here are the example commands using openssl:

   1. Generate the private key:

      openssl genrsa -out server.key 2048

   2. Write the CSR config file.

      cat <<EOT >> csr.conf
        [ req ]
        default_bits = 2048
        prompt = no
        default_md = sha256
        distinguished_name = dn
      
        [ dn ]
        CN = fuse-console.fuse.svc
      
        [ v3_ext ]
        authorityKeyIdentifier=keyid,issuer:always
        keyUsage=keyEncipherment,dataEncipherment,digitalSignature
        extendedKeyUsage=serverAuth,clientAuth
      EOT

   3. Generate the CSR:

      openssl req -new -key server.key -out server.csr -config csr.conf

   4. Issue the signed certificate:

      openssl x509 -req -in server.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out server.crt -days 10000 -extensions v3_ext -extfile csr.conf

1. Log in to the OpenShift console in your web browser as a user with cluster admin access.
2. Select Home > Projects, and then select the project to which you want to add the Fuse Console.
3. Click Operators and then click OperatorHub.
4. In the search field window, type Fuse Console to filter the list of operators.
5. Click Fuse Console Operator.

6. In the Fuse Console Operator install window, click Install.

   The Create Operator Subscription form opens.

   • For Installation mode, you install the Fuse Console Operator to a specific namespace (the current OpenShift project).

     Note that after you install the operator, you can then choose to deploy the Fuse Console to monitor applications in all namespaces on the cluster or to monitor applications only in the namespace in which the Fuse Console operator is installed.

   • For the Approval Strategy, you can select Automatic or Manual to configure how OpenShift handles updates to the Fuse Console Operator.

     • If you select Automatic updates, when a new version of the Fuse Console Operator is available, the OpenShift Operator Lifecycle Manager (OLM) automatically upgrades the running instance of the Fuse Console 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 Fuse Console Operator updated to the new version.

7. Click Subscribe.

   OpenShift installs the Fuse Console Operator in the current namespace.

8. To verify the installation, click Operators and then click Installed Operators. You can see the Fuse Console in the list of operators.

9. In a Terminal window, use the certificate that you generated in Securing the Fuse Console on OpenShift 4.x to create the secret and mount it in the Fuse Console by using the following command where APP_NAME is the name of the Fuse Console Deployment (for example, fuse-console).

   oc create secret tls APP_NAME-tls-proxying --cert server.crt --key server.key

   For example, if the name of the Fuse Console application is fuse-console, type this command:

   oc create secret tls fuse-console-tls-proxying --cert server.crt --key server.key

   If successful, this command returns a response that confirms the secret was created, for example:

   secret/fuse-console-operator-tls-proxying created

10. To deploy the Fuse Console by using the OpenShift web console:

    1. In the list of Installed Operators, under the Name column, click Fuse Console.

    2. On the Overview page under Provided APIs, click Create Instance. A new Custom Resource Definition (CRD) file opens.

       By default, the Fuse Console is deployed to the current namespace.

    3. If you want to deploy the Fuse Console to discover and manage applications within the current namespace, skip to the next step.

       Optionally, if you want to deploy the Fuse Console to discover and manage applications across all namespaces that are on the cluster (and for which you are an authenticated user), edit the CRD file by changing the value of the spec.type field from namespace to cluster.

    4. Click Create.

       After you deploy the Fuse Console, the Fuse Console CRD page opens showing the new Fuse Console service.

1. For a namespace deployment, in the OpenShift web console, open the project in which you installed the Fuse Console operator, and then select Overview. In the Project Overview page, scroll down to the Launcher section and click the the Fuse Console URL to open it.

   For a cluster deployment, in the OpenShift web console’s title bar, click the grid icon ( ). In the popup menu, under Red Hat applications, click the Fuse Console URL link.

2. Log into the Fuse Console.

   An Authorize Access page opens in the browser listing the required permissions.

3. Click Allow selected permissions.

   The Fuse Console opens in the browser and shows the Fuse application pods that you have authorization to access.

4. Click Connect for the application that you want to view.

   A new browser window opens showing the application in the Fuse Console.

Procedure

1. Verify that the Fuse Console image stream is installed by using the following command to retrieve a list of all templates:

   oc get template -n openshift

2. Optionally, if you want to update the already installed image stream with new release tags, use the following command to import the Fuse Console image to the openshift namespace:

   oc import-image fuse7/fuse7-console:1.7 --from=registry.redhat.io/fuse7/fuse-console:1.7 --confirm -n openshift

3. Obtain the Fuse Console APP_NAME value by running the following command:

   oc process --parameters -f TEMPLATE-FILENAME

   where TEMPLATE-FILENAME is one of the following templates:

   • Cluster template:

     https://github.com/jboss-fuse/application-templates/blob/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002//fuse-console-cluster-os4.json

   • Cluster template with configurable RBAC:

     https://github.com/jboss-fuse/application-templates/blob/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002//fuse-console-cluster-rbac.yml

   • Namespace template:

     https://github.com/jboss-fuse/application-templates/blob/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002//fuse-console-namespace-os4.json

   • Namespace template with configurable RBAC:

     https://github.com/jboss-fuse/application-templates/blob/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002//fuse-console-namespace-rbac.yml

     For example, for the cluster template with configurable RBAC, run this command:

     oc process --parameters -f https://github.com/jboss-fuse/application-templates/blob/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002//fuse-console-cluster-rbac.yml

4. From the certificate that you generated in Securing the Fuse Console on OpenShift 4.x, create the secret and mount it in the Fuse Console by using the following command (where APP_NAME is the name of the Fuse Console application).

   oc create secret tls APP_NAME-tls-proxying --cert server.crt --key server.key

5. Create a new application based on your local copy of the Fuse Console template by running the following command (where myproject is the name of your OpenShift project, mytemp is the path to the local directory that contains the Fuse Console template, and myhost is the hostname to access the Fuse Console:

   • For the cluster template:

     oc new-app -n myproject -f {templates-base-url}/fuse-console-cluster-os4.json  -p ROUTE_HOSTNAME=myhost”

   • For the cluster with RBAC template:

     oc new-app -n myproject -f {templates-base-url}/fuse-console-cluster-rbac.yml -p ROUTE_HOSTNAME=myhost”

   • For the namespace template:

     {templates-base-url}/fuse-console-namespace-os4.json

   • For the namespace with RBAC template:

     oc new-app -n myproject -f {templates-base-url}/fuse-console-namespace-rbac.yml

6. To configure the Fuse Console so that it can open the OpenShift Web console, set the OPENSHIFT_WEB_CONSOLE_URL environment variable by running the following command:

   oc set env dc/${APP_NAME} OPENSHIFT_WEB_CONSOLE_URL=`oc get -n openshift-config-managed cm console-public -o jsonpath={.data.consoleURL}`

7. Obtain the status and the URL of your Fuse Console deployment by running this command:

   oc status

8. To access the Fuse Console from a browser, use the URL that is returned in Step 7 (for example, https://fuse-console.192.168.64.12.nip.io).

1. In a terminal window, use the following command to change the .spec.version field of the application custom resource definition:

   oc patch <project-name> <custom-resource-name> --type='merge' -p '{"spec":{"version":"1.7.1"}}'

   For example:

   oc patch myproject example-fuseconsole --type='merge' -p '{"spec":{"version":"1.7.1"}}'

2. Check that the application’s status has updated:

    oc get myproject

   The response shows information about the application, including the version number:

   NAME                  AGE   URL                                        IMAGE
   example-fuseconsole   1m    https://fuseconsole.192.168.64.38.nip.io   docker.io/fuseconsole/online:1.7.1

   When you change the value of the .spec.version field, OpenShift automatically redeploys the application.

3. To check the status of the redeployment that is triggered by the version change:

   oc rollout status deployment.v1.apps/example-fuseconsole

   A successful deployment shows this response:

   deployment "example-fuseconsole" successfully rolled out

Procedure

1. In the OpenShift console, open an existing project or create a new project.

2. Add the Fuse Console to your OpenShift project:

   1. Select Add to Project → Browse Catalog.

      The Select an item to add to the current project page opens.

   2. In the Search field, type Fuse Console.

      The Red Hat Fuse 7.x Console and Red Hat Fuse 7.x Console (cluster) items should appear as the search result.

1. Click one of the Red Hat Fuse Console items:

   • Red Hat Fuse 7.x Console - This version of the Fuse Console discovers and connects to Fuse applications deployed in the current OpenShift project.
   • Red Hat Fuse 7.x Console (cluster) - This version of the Fuse Console can discover and connect to Fuse applications deployed across multiple projects on the OpenShift cluster.

2. In the Red Hat Fuse Console wizard, click Next. The Configuration page of the wizard opens.

   Optionally, you can change the default values of the configuration parameters.

   1. Click Create.

      The Results page of the wizard indicates that the Red Hat Fuse Console has been created.

   2. Click the Continue to the project overview link to verify that the Fuse Console application is added to the project.

   3. To open the Fuse Console, click the provided URL link and then log in.

      An Authorize Access page opens in the browser listing the required permissions.

   4. Click Allow selected permissions.

      The Fuse Console opens in the browser and shows the Fuse pods running in the project.

   5. Click Connect for the application that you want to view.

      A new browser window opens showing the application in the Fuse Console.

1. From the Applications → Pods view in your OpenShift project, click on the pod name to view the details of the running Fuse pod. On the right-hand side of this page, you see a summary of the container template:

   

2. From this view, click on the Open Java Console link to open the Fuse Console.

   

   Note

   In order to configure OpenShift to display a link to Fuse Console in the pod view, the pod running a Fuse on OpenShift image must declare a TCP port within a name attribute set to jolokia:

   {
     "kind": "Pod",
     [...]
     "spec": {
       "containers": [
         {
           [...]
           "ports": [
             {
               "name": "jolokia",
               "containerPort": 8778,
               "protocol": "TCP"
             }

1. Create a new application based on a Fuse Console template by running one of the following commands (where myproject is the name of your project):

   • For the Fuse Console cluster template, where myhost is the hostname to access the Fuse Console:

     oc new-app -n myproject -f https://github.com/jboss-fuse/application-templates/blob/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002//fis-console-cluster-template.json -p ROUTE_HOSTNAME=myhost

   • For the Fuse Console namespace template:

     oc new-app -n myproject -f https://github.com/jboss-fuse/application-templates/blob/application-templates-2.1.0.fuse-sb2-7_11_1-00016-redhat-00002//fis-console-namespace-template.json

     Note

     You can omit the route_hostname parameter for the namespace template because OpenShift automatically generates one.

2. Obtain the status and the URL of your Fuse Console deployment by running this command:

   oc status

3. To access the Fuse Console from a browser, use the provided URL (for example, https://fuse-console.192.168.64.12.nip.io).

1. In the Camel tab’s tree view, click Camel Contexts.
2. Check the box next to one or more contexts in the list.
3. Click Start or Suspend.

4. To delete a context:

   1. Stop the context.
   2. Click the ellipse icon and then select Delete from the dropdown menu.

1. In the Camel tab’s tree view, click a Camel application.
2. To view a list of application attributes and values, click Attributes.
3. To view a graphical representation of the application attributes, click Chart and then click Edit to select the attributes that you want to see in the chart.
4. To view inflight and blocked exchanges, click Exchanges.
5. To view application endpoints, click Endpoints. You can filter the list by URL, Route ID, and direction.
6. To view, enable, and disable statistics related to the Camel built-in type conversion mechanism that is used to convert message bodies and message headers to different types, click Type Converters.
7. To view and execute JMX operations, such as adding or updating routes from XML or finding all Camel components available in the classpath, click Operations.

1. To view a list of routes:

   1. Click the Camel tab.

   2. In the tree view, click the application’s routes folder:

      

2. To start, stop, or delete one or more routes:

   1. Check the box next to one or more routes in the list.
   2. Click Start or Stop.

   3. To delete a route, you must first stop it. Then click the ellipse icon and select Delete from the dropdown menu.

      

      Note

      • When you delete a route, you remove it from the deployed application.
      • You can also select a specific route in the tree view and then click the upper-right menu to start, stop, or delete it.
3. To view a graphical diagram of the routes, click Route Diagram.
4. To view inflight and blocked exchanges, click Exchanges.
5. To view endpoints, click Endpoints. You can filter the list by URL, Route ID, and direction.
6. Click Type Converters to view, enable, and disable statistics related to the Camel built-in type conversion mechanism, which is used to convert message bodies and message headers to different types.

7. To interact with a specific route:

   1. In the Camel tab’s tree view, select a route.
   2. To view a list of route attributes and values, click Attributes.
   3. To view a graphical representation of the route attributes, click Chart. You can click Edit to select the attributes that you want to see in the chart.
   4. To view inflight and blocked exchanges, click Exchanges.
   5. Click Operations to view and execute JMX operations on the route, such as dumping the route as XML or getting the route’s Camel ID value.

8. To trace messages through a route:

   1. In the Camel tab’s tree view, select a route.
   2. Select Trace, and then click Start tracing.

9. To send messages to a route:

   1. In the Camel tab’s tree view, open the context’s endpoints folder and then select an endpoint.
   2. Click the Send subtab.
   3. Configure the message in JSON or XML format.
   4. Click Send.
   5. Return to the route’s Trace tab to view the flow of messages through the route.

1. In the Camel tab’s tree view, select a route.
2. Select Debug, and then click Start debugging.

3. To add a breakpoint, select a node in the diagram and then click Add breakpoint. A red dot appears in the node:

   

   The node is added to the list of breakpoints:

   

4. Click the down arrow to step to the next node or the Play button to resume running the route.
5. Click the Pause button to suspend all threads for the route.
6. Click Stop debugging when you are done. All breakpoints are cleared.