Shared parameters

Update the custom YAML file to provide the details that are relevant for your overall FileNet Content Manager and IBM Content Navigator environment.

Table 1. Spec configuration parameters
Parameter Description Default Values Required
appVersion The version of the current release.    
(V5.5.6 and later) ibm_license Must exist to accept the IBM license. The only valid value is "accept". Empty Yes
(V5.5.9 and later) license.accept Must exist to accept the IBM license. The only valid value is "true". Empty Yes
Table 2. Shared configuration parameters
Parameters Description Default Values Required
sc_deployment_context Do not change this default setting. FNCM Yes
image_pull_secrets Shared image pull secrets. admin.registrykey No
sc_image_repository All components must use the same Docker image repository, co.icr.io for entitled register, or a local Docker image repository. cp.icr.io No
root_ca_secret If you provide your own root certificate, enter the value. icp4a-root-ca

(V5.5.8 and later) fncm-root-ca

 No
(V5.5.8 and later) external_tls_certificate_secret Shared custom TLS secret which will be used to sign all external routes if defined. If this is not defined, all external routes will be signed with root_ca_secret   No
sc_deployment_type

(V5.5.7 and earlier) Set the value to "enterprise".

(V5.5.8 and later) Set the value to "production".

 None Yes
(V5.5.8 and later) sc_fncm_license_model
  • Specify the license model for FNCM.

    The expected values are ICF.PVUNonProd, ICF.PVUProd, ICF.UVU, FNCM.PVUNonProd, FNCM.PVUProd, FNCM.UVU, or FNCM.CU.

  • Choose one of these licensing models if you are using a license for IBM Cloud Pak® for Business Automation to deploy the standalone IBM® FileNet® Content Manager containers. Valid values depend on your license terms; select from: CP4BA.NonProd, CP4BA.Prod, CP4BA.User
   Yes
(V5.5.8 and later) sc_deployment_profile_size

For a production deployment type, the default is small. You can change the profile to medium or large, as required. For more information, see Identifying the infrastructure requirements.

 small No
sc_run_as_user Optional and only applicable for non-Open Shift Cloud Platform installations. Specify a RunAs user for the security of the pod. This is usually a numerical ID.   No
sc_deployment_platform Enter your certified Kubernetes platform type OCP
(V5.5.6 and later)
  • Use "OCP" for Red Hat OpenShift Container Platform
  • Use "ROKS" if the platform is Red Hat OpenShift on IBM Cloud®.
  • Use " other" for to deploy on non-OCP Kubernetes based platforms.
 Yes
(V5.5.6 and later) sc_ingress_enable For ROKS, this is used to enable Ingress. The default value is "false". The default creates routes instead of ingress. false No
(V5.5.6 and later) sc_ingress_tls_secret_name Must be set if you enable ingress on ROKS. This secret provides TLS for the ingress controller. Empty Yes
sc_deployment_hostname_suffix Specify the hostname used to create routes. Routes are created automatically if sc_deployment_platform is set to OCP or ROKS. For non-BMC, this parameter is not required. example.com Yes
trusted_certificate_list If you want to use your own certificate, use the certificate file to create a secret and then add the secret for this parameter. [] No
sc_optional_components A component is identified by an acronym of the component or subcomponent name. If you want to install more than one component, separate the acronyms of the components with a comma, for example, css,es,tm. cmis No
sc_content_initialization

Enable/disable content initialization (creation of P8 domain, creation of object stores, creation of CSS servers, and initialization of Navigator (ICN)). If not set, the parameter takes the default value.

If the parameter value is true, you must define the initialize_configuration section in the CR as the operator uses the parameters within the section for configuration.

If the parameter value is false, the operator ignores the initialize_configuration section that is defined in the CR.

 false No
sc_content_verification

Enable/disable the content verification (creation of test folder, creation of test document, execution of CBR search, and creation of Navigator demo repository and desktop). If not set, the parameter takes the default value.

If the parameter value is true, you must define the verify_configuration section in the CR as the operator uses the parameters within the section for configuration.

If the parameter value is false, the operator ignores the verify_configuration section that is defined in the CR.

 false No
(V5.5.5 and later)

storage_configuration.sc_fast_file_storage_classname

storage_configuration.sc_medium_file_storage_classname

storage_configuration.sc_slow_file_storage_classname

Storage for an enterprise deployment needs 3 storage classes. If you do not have 3 storage classes, you can use the same one for "slow", "medium", and "fast".

On OpenShift Container Platform (OCP) 3.x and 4.x, the deployment script sets these parameters based on the user input.

" "

" "

" "

Yes

Yes

Yes
(V5.5.10 and later) sc_ingress_annotations List of ingress annotations for ECM and BAN components. Used to created Single Hostname Ingress object. Empty No
(V5.5.10 and later) sc_service_type Service type to support CNCF ingress creation, possible values are ClusterIP, NodePort ClusterIP No
sc_deployment_hostname_suffix Specify the hostname used to create routes. Routes are created automatically if sc_deployment_platform is set to OCP or ROKS. For CNCF clusters, this parameter is used to create Ingress. example.com No
(V5.5.6 and later) sc_ingress_enable For ROKS and CNCF clusters, this is used to enable Ingress. The default value is "false". false No
(V5.5.6 and later) sc_ingress_tls_secret_name This secret provides TLS for the Ingress controller. Empty No
(V5.5.10 and later) sc_ecm_ltpa_secret_name If creating using a custom ltpa-secret name, specify the name here {{ meta.name }}-ecm-ltpa No