Preparing capabilities

Each capability that you want to install must be prepared for before you apply your custom resource.

About this task

The following progress bar shows you where you are in the installation process. You can click the completed parts in the diagram to go back and check that you did everything that you needed to do.

Preparing a capability can involve many steps and more often than not involves setting up persistence and taking measures to secure the containers.

Important: You must take note of the capabilities and the optional components that you plan to install. Many capabilities include components from other patterns, so you must search for and use the preparing tasks under these capability headings to make sure that your installation is successful. For more information, see Capabilities for production deployments.

Remember, Business Automation Navigator (BAN) is always installed in every deployment. As a minimum, you must have an LDAP server and a supported database before you can apply a custom resource. By default, the Resource Registry (RR) used by Business Automation Studio uses the dynamic storage class to automatically back up data. You can configure a persistent volume if you want to change the default.

In addition to preparing BAN and RR, the Document Processing capability, for example, includes components from the document_processing pattern, but also includes options from the foundation pattern, and the content pattern. To prepare all of the components that you want to include in a deployment with Document Processing, review the steps in all of the following sections.

The following table summarizes the requirements that are needed for each capability.

Table 1. What to prepare and what each capability needs
Capability	LDAP	Database	Persistent volume
Application Engine (Business Automation Application)	Yes	Yes	Yes
Automation Decision Services	Yes	Yes	No
Business Automation Insights	No	No	Yes
Business Automation Navigator	Yes	Yes	Yes
Business Automation Studio	Yes	Yes	Yes
Business Automation Workflow authoring	Yes	Yes	Yes
Business Automation Workflow Runtime and Workstream services	Yes	Yes	Yes
Document Processing	Yes	Yes	Yes
FileNet Content Manager	Yes	Yes	Yes
Operational Decision Manager	Yes	Yes	No

To set up monitoring for your containers, access to one of the following services is required:

Access to Graphite
Access to Prometheus

To forward logs from your containers, access to a hosted local Elasticsearch is required. Kibana is required in order to view and filter logs from Elasticsearch.

This information helps you to create and collect the settings you need to enable the containers' logging capabilities and monitoring at deployment time.

Procedure

Ensure that you have an installation of Elasticsearch server to receive logs from the containers.
Ensure that you have Kibana configured with Elasticsearch to view and filter logs.
Compile the values for your logging system.
You specify these values in the custom resource YAML file for operator deployment.
Use the following reference information to compile the values: Logging parameters
Ensure that you have an installation of Graphite or Prometheus for the monitoring service.
Compile the values for your monitoring system.
You specify these values in the custom resource YAML file for operator deployment.
Use the following reference information to compile the values: Monitoring parameters

What to do next

After you complete all of the preparation steps for all of the capabilities that you want to install, go ahead and create a production deployment. For more information, see Creating a production deployment.