Custom resource pattern structure
Your custom resource file that you apply to the operator must include the necessary sections. The sections define specific parts of your intended deployment, and are used to compile a custom resource file.
- The metadata section applies to all of the included capabilities.
- The spec section defines the target platform, the deployment type, the license, and security and storage information.
- The LDAP and data source section defines parameters for all of the included capabilities.
- The foundation capabilities section defines parameters that are needed by the other included patterns.
- The component sections define parameters that you want to customize for each included component.
In many places in the documentation,
configuration parameters are referred to by their section.parameter
or
section.component.parameter
location in the custom resource file. The dot separator
is shorthand for the indentation of the YAML in the custom resource. For example,
spec.appVersion
refers to the appVersion parameter in the
specification section (spec) of the custom
resource.
spec:
appVersion: <version>
Components that are recognized by a pattern (for example ecm_configuration in the simplified FileNet® Content Manager pattern) are not listed in the respective custom resource template file. The pattern is aware of these parameters and includes them by default.
###############################################################################
##
##Licensed Materials - Property of IBM
##
##(C) Copyright IBM Corp. 2020. All Rights Reserved.
##
##US Government Users Restricted Rights - Use, duplication or
##disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
##
###############################################################################
apiVersion: icp4a.ibm.com/v1
kind: ICP4ACluster
metadata:
name: icp4adeploy
labels:
app.kubernetes.io/instance: ibm-dba
app.kubernetes.io/managed-by: ibm-dba
app.kubernetes.io/name: ibm-dba
release: <version>
spec:
appVersion: <version>
ibm_license: "accept"
##########################################################################
## This section contains the shared configuration for all the components #
##########################################################################
shared_configuration:
...
ldap_configuration:
...
datasource_configuration:
...
########################################################################
####### FileNet Content Manager configuration #######
########################################################################
ecm_configuration:
...
########################################################################
####### Business Automation Navigator configuration #######
########################################################################
navigator_configuration:
...
########################################################################
####### Operational Decision Manager Configuration #######
########################################################################
odm_configuration:
...
########################################################################
####### App Engine production configuration #######
########################################################################
application_engine_configuration:
...
########################################################################
####### Business Automation Studio configuration #######
########################################################################
bastudio_configuration:
...
########################################################################
######## Business Automation Insights configuration #######
########################################################################
bai_configuration:
...
########################################################################
####### Business Automation Workflow Configuration #######
########################################################################
baw_configuration:
...
########################################################################
####### IBM Process Federation Server Configuration #######
########################################################################
pfs_configuration:
...
########################################################################
####### IBM Business Automation Machine Learning Server Configuration #######
########################################################################
baml_configuration:
...