Chapter 4. Managing Fuse Online on OCP

Procedure

1. Log in to OpenShift with an account that gives you permission to edit the Fuse Online custom resource. For example:

   oc login -u admin -p admin-password

2. Switch to the project that is running the Fuse Online environment. For example:

   oc project my-fuse-online-project

3. Edit the syndesis custom resource:

   1. Invoke the following command, which typically opens the resource in an editor:

      oc edit syndesis

   2. Ensure that the following lines are in the resource. Edit as needed:

      components:
        server:
          features:
            auditing: true

4. Save the resource.

   When you enable the auditing feature in the syndesis custom resource, the running syndesis-server configuration reloads and Fuse Online starts logging relevant changes to Fuse Online components.

5. To view the Fuse Online audit log messages, type the following command:

Procedure

1. In the Fuse Online namespace, set the monitoring-key=middleware label by using the following command:

   oc label namespace <fuse-online-namespace> monitoring-key=middleware

2. Verify that your Fuse Online installation added the application monitoring configuration resources to the OpenShift cluster:

   1. In the OpenShift web console, go to the application-monitoring project and then open the prometheus-route URL.

   2. In the Prometheus console, go to the Status Targets page.

      If a Syndesis target is listed, then Fuse Online is configured for monitoring and you can skip to Step 4.

      If a Syndesis target is not listed, continue to Step 3.

3. To expose Fuse Online for monitoring by a Prometheus instance that is installed in a separate OpenShift project, enable the ops add-on in the syndesis custom resource:

   1. Go to the Fuse Online namespace:

      OpenShift 4.x	OpenShift 3.11
      In the OpenShift web console, go to the Fuse Online (syndesis) project. Select Catalog > Installed Operators and then click Fuse Online Operator. Click Syndesis CRD and then click app. Click Yaml to open the yaml file in the editor.	Select Resources > Other Resources. From the dropdown menu, select the Syndesis resources type. For the app resource, click Actions and then select Edit YAML to open the yaml file in the editor.

   2. Edit the yaml file to set the Syndesis.Spec.Addons.Ops.Enable value to true by adding the follow lines:

      spec:
        addons:
          ops:
            enabled: true

   3. Save the file.

   4. Wait for the pod to restart.

      Note

      Fuse Online infrastructure resources are not available immediately after you run the install commands. You might need to wait before you can see the Fuse Online (Syndesis) targets in the Prometheus Targets page.

4. To access Prometheus:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.
   2. Next to the prometheus-route entry, click the hostname URL to open the Prometheus console.
   3. To view a list of the alert rules configured for Fuse Online infrastructure components, click the Alerts menu item.

5. To access Grafana dashboards:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.
   2. Next to the grafana-route entry, click the hostname URL to open the Grafana console.

   3. At the top of the Grafana console, click the dashboard selector.

      • For Fuse Online integrations, select Integration - Camel. This dashboard displays the standard metrics exposed by Apache Camel integration applications.

      • For Fuse Online infrastructure components, select one of the following infrastructure dashboards:

        Infrastructure - DB

        Displays metrics related to the Fuse Online Postgres instance.

        Infrastructure - JVM

        Displays metrics about the running JVM for the syndesis-meta or syndesis-server applications. Chose the application that you want to monitor from the Application drop down list at the top of the dashboard.

        Infrastructure - REST APIs

        Displays metrics relating to the Fuse Online infrastructure API endpoints, such as request throughput and latency. Choose the application that you want to monitor from the Application drop down list at the top of the dashboard.

6. To access Prometheus Alertmanager:

   1. In the OpenShift console for the project where the application monitoring operator is installed, open the list of routes.

   2. Next to the alertmanager-route entry, click the hostname URL to open the Alertmanager console.

      If the Fuse Online infrastructure is healthy, the default view is empty.

      If any of the infrastructure components are unhealthy, any active alerts that have been fired are listed, along with the option to silence them.

Procedure

1. Log in to OpenShift with an account that has permission to install Fuse Online. For example:

   oc login -u developer -p developer

2. Switch to the OpenShift project that is or will be running the Fuse Online environment for which you want to configure backups. For example:

   oc project my-fuse-online-project

3. Create an OpenShift secret. In the command line:

   • Specify syndesis-backup-s3 as shown in the following command format.

   • Replace the AWS variables with your AWS access key, AWS secret key, AWS region in which the bucket resides, and the name of the bucket.

     Use the following command format to create the secret:

     oc create secret generic syndesis-backup-s3 \
     --from-literal=secret-key-id="my-aws-access-key" \
     --from-literal=secret-access-key="my-aws-secret-key" \
     --from-literal=region="aws-region" \
     --from-literal=bucket-name="aws-bucket-name"

     This secret must be present when the backup job is running.

4. If Fuse Online is not yet installed, you must edit the default-cr.yml file to enable backups. See Editing the syndesis custom resource before installing Fuse Online. After Fuse Online is installed, there will be backup jobs according to the schedule that you specified in the custom resource.

   If Fuse Online is running, you must edit the syndesis custom resource:

   1. Invoke the following command, which opens the syndesis custom resource in an editor:

      oc edit syndesis

   2. Add the following under spec::

      backup:
        schedule: my-backup-interval

      Replace my-backup-interval with the desired duration between backups. To determine how to specify the interval between backups, consult the following resources:

      • cron pre-defined schedules

      • cron intervals

        Do not specify the @ sign in front of the interval. For example, to configure daily backups, the custom resource would contain something like this:

        apiVersion: syndesis.io/v1beta1
        kind: Syndesis
        metadata:
          name: app
        spec:
          backup:
            schedule: daily

5. Save the file.

   This adds a backup job to syndesis-operator.

Procedure

1. Download the desired backup file from Amazon S3. Details for doing this are in the AWS documentation for How Do I Download an Object from an S3 Bucket?

2. Extract the content of the zip file. For example, the following command line unzips the 7.6-2020-03-15-23:30:00.zip file and copies the content into the /tmp/fuse-online-backup folder:

   unzip 7.6-2020-03-15-23:30:00.zip -d /tmp/fuse-online-backup

3. Decode the Fuse Online database, for example:

   base64 -d /tmp/fuse-online-backup/syndesis-db.dump > /tmp/fuse-online-backup/syndesis-db

4. Switch to the OpenShift project that is running the new Fuse Online environment. For example, if the new Fuse Online environment is in the my-fuse-online-project, then you would invoke the following command:

   oc project my-fuse-online-project

   The remainder of this procedure assumes that you have switched to the project that contains the new Fuse Online environment.

5. Obtain the name of the database pod.

   If the restored Fuse Online environment uses the provided, internal, PostgreSQL database, invoke the following command to obtain the name of the database pod:

   oc get pods -l deploymentconfig=syndesis-db -o jsonpath='{.items[*].metadata.name}'

   If the restored Fuse Online environment uses an external database, it is assumed that you know how to obtain the name of the pod for that database.

   In the remaining commands, where you see DATABASE_POD_NAME, insert the name of the database pod for the restored Fuse Online environment.

6. Scale down the components that are accessing the database in any way.

   1. Scale down syndesis-operator so that other components can be scaled down:

      oc scale deployment syndesis-operator --replicas 0

   2. Scale down the syndesis-server and syndesis-meta components:

      oc scale dc syndesis-server --replicas 0
oc scale dc syndesis-meta --replicas 0

7. Send the database backup file to the Fuse Online database pod:

   oc cp /tmp/fuse-online-backup/syndesis-db DATABASE_POD_NAME:/tmp/syndesis-db

8. Open a remote shell session in the Fuse Online database pod:

   oc rsh DATABASE_POD_NAME

9. Invoke the following commands to restore the Fuse Online database.

   If a psql command prompts for the database password, and the restored Fuse Online environment uses the provided, internal PostgreSQL database, you can find the password in the POSTGRESQL_PASSWORD environment variable in the syndesis-db deployment configuration. If the restored Fuse Online environment uses an external database, then it is assumed that you know the password.

   cd /tmp
   psql -c 'DROP database if exists syndesis_restore'
   psql -c 'CREATE database syndesis_restore'
   pg_restore -v -d syndesis_restore /tmp/syndesis-db
   psql -c "SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE datname = 'syndesis'"
   psql -c 'DROP database if exists syndesis'
   psql -c 'ALTER database syndesis_restore rename to syndesis'

   Fuse Online should now be restored. You can end the RSH session:

   exit

10. Scale up the Fuse Online components:

    oc scale deployment syndesis-operator --replicas 1

    Scaling syndesis-operator to 1 should bring up the other pods that were scaled down. However, if that does not happen, you can scale them up manually:

    oc scale dc syndesis-server --replicas 1
oc scale dc syndesis-meta --replicas 1

11. The server tries to start each restored integration but you need to update connections first. Consequently, ensure that the restored integrations are not running:

    1. Obtain the Fuse Online console route:

       echo "https://$(oc get route/syndesis -o jsonpath='{.spec.host}' )"

    2. Log in into the Fuse Online console with an OpenShift user account that has permission to install Fuse Online.
    3. Display the list of integrations and ensure that all integrations are stopped. If an integration is running, stop it.

12. For each connection that has a password, you need to update the connection to have the correct password for this Fuse Online environment. The following steps show how to do this for the provided PostgresDB connection.

    1. In the OpenShift console for the project in which this restored Fuse Online environment is running, retrieve the password for the PostgresDB connection. In the syndesis-db deployment, the password is available in the environment variables.
    2. In the Fuse Online console, display the connections.
    3. Edit the PostgresDB connection.
    4. In the connection details for the PostgresDB connection, paste the retrieved password in the Password field.

13. For each integration, confirm that there are no Configuration Required indicators. If there are, edit the integration to resolve the issues. When all steps in the integration are correct, publish the integration.

    If Fuse Online keeps rolling an integration back to a Stopped state right after the Build step, delete the deployment, ensure that no configuration is required, and try publishing the integration again.

    You can safely ignore the following message if you see it in the log:

    Error performing GET request to https://syndesis-my-fuse-online-project.my-cluster-url/api/v1/metrics/integrations

Procedure

1. Log in to OpenShift with an account that has permission to install Fuse Online. For example:

   oc login -u developer -p developer

2. Switch to the OpenShift project that is running the Fuse Online environment that you want to uninstall. For example:

   oc project my-fuse-online-project

3. Delete Fuse Online infrastructure:

   oc delete syndesis app

4. Delete syndesis-operator DeploymentConfig and ImageStream resources:

   oc delete deployment/syndesis-operator
oc delete is/syndesis-operator