Install third-party components
Disclaimer
This chapter contains some hints and guidelines on installing required third-party components in an OpenShift 4.14 cluster. It does not provide a production-grade ready setup for IBM Industry Solutions Workbench. It aims to outline an example setup of the required third party components in an easy way and tries to get the start-up quicker. With regard to quickly evolving technologies and products, this can be outdated even one day after publishing. All values given as examples in this guide are not considered safe.
Recommendations for a PoC
For a typical PoC situation we recommend the following setup:
| Component | Tested Version | Note |
|---|---|---|
| Red Hat Integration - AMQ Streams | 2.2 | |
| Red Hat Integration - Service Registry Operator | 2.1 | |
| Red Hat OpenShift GitOps | 1.12 | |
| Red Hat OpenShift Pipelines | 1.13 | |
| Red Hat Single Sign-On Operator | 7.6 | |
| Gitlab Operator | 0.13 | Provided by 'GitLab Inc' |
| MongoDB | 3.6 | Provided by 'Red Hat MongoDB' template |
| Component Repository - Chartmuseum | 3.6.2 | Helm Repository including an index.yaml, e.g. Chartmuseum |
The available versions for components installed by the operators may differ from the tested versions because the operator always installs the latest version of the component.
If possible, use properly signed certificates for the OpenShift cluster. Self-signed certificates increase the effort and complexity of the installation. A wildcard certificate must be available as the default router certificate. Cluster Admin privileges are required for a full installation. A default storage class that is used to provide volumes for persistent volume claims must exist.
Create OpenShift projects
It is recommended and assumed in the following that all third-party components except GitLab will be installed in a separate OpenShift project called foundation.
If you decide to also install GitLab, this should be in another project called foundation-gitlab. This is due to special security context constraint requirements that GitLab needs to properly work. Overall it is preferable to use an existing git repository service.
As a cluster administrator, run the following commands to create the project foundation:
oc new-project foundationRepeat to create project foundation-gitlab for installation of GitLab:
oc new-project foundation-gitlabNecessary components
The following list of components needs to be installed and configured properly to ensure the correct operation of IBM Industry Solutions Workbench:
- Red Hat Integration - AMQ Streams
- Red Hat Integration - Service Registry Operator
- Red Hat OpenShift GitOps
- Red Hat OpenShift Pipelines
- Red Hat Single Sign-On Operator
- MongoDB
- Gitlab Operator
- Component Repository
If you already have some of the mentioned services (like Git Provider or Component Repository) in place an additional installation is not mandatory.
Optional components
The following components can be installed/configured optionally:
Summary
After following the outlined steps in this guideline you have installed and configured the third party components that are necessary for continuing the installation of IBM Industry Solutions Workbench.
Please note for a production-ready setup, these components require additional configuration regarding sizing, high availability and security. Please refer to the official component documentation for details.