Skip to content

Red Hat Process Automation Manager OpenShift container images

License

Notifications You must be signed in to change notification settings

jboss-container-images/rhpam-7-openshift-image

Repository files navigation

Red Hat Process Automation Manager 7 OpenShift images

This repository contains all the image descriptors and files necessary to build the RHPAM images. It also includes the application templates, however they are deprecated in 7.14. Using the Red Hat Business Automation Operator is recommended.

Repo structure:

  • rhpam-7-openshift-image
    • businesscentral: Business Central Container Image descriptor files.
    • businesscentral-monitoring: Business Central Monitoring Container Image descriptor files.
    • controller: RHPAM Controller Container Image descriptor files.
    • dashbuilder: RHPAM Dashbuilder Container Image descriptor files.
    • kieserver: KIE Execution Server Container Image descriptor files.
    • process-migration: Process Instance Migration Container Image descriptor files.
    • quickstarts: Quickstarts used as example on RHPAM images.
    • scripts: Holds scripts to help this repository maintenance.
    • smartrouter: RHPAM Smart Router image descriptor files.
    • templates: Application templates for Processes and Decisions, used to instantiate a new RHPAM environment on OpenShift. (Deprecated)
      • contrib
        • jdbc: Examples about how to add third party jdbc driver on RHPAM images.
      • decision - Decision (RHDM) Application Templates. (Deprecated)
      • docs: Application templates docs generated by the gen_template_docs.py script.
      • process - Process (RHPAM) Application Templates. (Deprecated)

Inside each image directory you will find the following files:

  • container.yaml: used by OSBS builds.
  • content_sets.yaml: define the yum repositories needed to install dependencies for the image.
  • branch-overrides.yaml: overrides file which uses the latest stable version for external dependencies.
  • tag-overrides.yaml: Used to override the branchs to use the final tags to rebuild released images, for CVE respins.
  • image.yaml: the main image descriptor file, here are all the pieces and configuration needed to build an image.

On the root directory you can also find the two files:

  • example-app-secret-template.yaml: Contains a https certificate to be used as example where https is required.
  • rhpam-image-streams.yaml: imagestreams definitions, file used to install the product image streams on OpenShift, this files contains the image stream name and the registry the image will be pulled of.

This repo depends directly on 5 repositories, which are:

  • cct_module: contains some core modules, like s2i and maven.
  • jboss-eap-modules: contains modules responsible to configure JBoss EAP, like datasources and the base configuration files.
  • jboss-eap-image: provides the EAP modules, which is used to install the EAP on the target image.]
  • wildfly-cekit-modules: provides the EAP configuration modules, used to configure the EAP during startup.
  • rhpam-7-image: provides the RHPAM binaries modules.
  • jboss-kie-modules: contains all the resources used to configure the RHPAM images.

Building Images

Notice that, CEKit 3.8 or higher is required to build RHPAM images.

To build the images for local testing there is a Makefile which will do all the hard work for you. With this Makefile you can:

  • Build and test all images with only one command:

    make

    If there's no need to run the tests just set the ignore_test env to true, e.g.:

    make ignore_test=true
  • Test all images with only one command, no build triggered, set the ignore_build env to true, e.g.:

    make ignore_build=true
  • Build images individually, by default it will build and test each image

    make image image_name=businesscentral
    make image image_name=businesscentral-monitoring
    make image image_name=controller
    make image image_name=dashbuilder
    make image image_name=kieserver
    make image image_name=process-migration
    make image image_name=smartrouter

    We can ignore the build or the tests while interacting with a specific image as well, to build only:

    make ignore_test=true image_name={image_name}

    Or to test only:

    make ignore_build=true image_name={image_name}
  • List all available Images: To list all available images in the repository do:

    make list-images
  • Building the images with a different overrides file: This can be done by simpling provide the overrides file name that should reside on the same directory than the target image.

    make OVERRIDES=my-overrides-file-name.yaml

Generate Application Templates docs

The scripts needed to generate the adocs can be found here. To generate the adocs using the current branch use:

make generate_adocs

It will use the main branch from jboss-kie-modules using the current branch from RHPAM git repository.

To generate the adocs for, example, 7.14.x branch, first, switch the git branch from RHPAM repository then execute the following command:

make generate_adocs branch=7.14.x

It will use the 7.14.x branch from jboss-kie-modules using the checked out branch on RHPAM repository based from 7.14.x.

Found an issue?

Please submit an issue here with the Cloud tag or send us a email: [email protected].