Reference: Fields in the Analytics CR

Use the table of analytics-specific fields to configure the top-level or analytics CR for installing your API Connect analytics subsystem.

If using a top-level CR, make changes there. If you make changes directly to the analytics CR, they will be overwritten by the contents of the top-level CR the next time the API Connect operator reconciliation loop runs.

The two fields that must be in Analytics CR are ingestion.endpoint and ingestion.clientSubjectDN. The other fields are optional depending on the analytics features you want to configure.

Table 1. Configurable settings in the Analytics subsystem CR.
Field Type Default value Description Comments 
allowUpgrade
 Boolean no Set to true to allow analytics upgrade to v10.0 5. See Additional considerations upgrading to analytics v10.0.5 - Kubernetes, Additional considerations upgrading to analytics v10.0.5 - OpenShift. 
databaseBackup:
  host
 String   The URL to your S3 storage. See Configuring backup settings for Analytics, Configuring backup settings for Analytics on OpenShift and Cloud Pak for Integration. 
databaseBackup:
  path
 String   The path to your S3 storage at the URL specified by databaseBackup.host. See Configuring backup settings for Analytics, Configuring backup settings for Analytics on OpenShift and Cloud Pak for Integration. 
databaseBackup:
  schedule
 String   Specifies the frequency of automatic backups. Use any valid cron string. See Configuring backup settings for Analytics, Configuring backup settings for Analytics on OpenShift and Cloud Pak for Integration. 
databaseBackup:
  enableCompression
 Boolean true Specifies whether to compress the backups. See Configuring backup settings for Analytics, Configuring backup settings for Analytics on OpenShift and Cloud Pak for Integration. 
databaseBackup:
  credentials
 String   The name of your S3 storage authentication secret. See Configuring backup settings for Analytics, Configuring backup settings for Analytics on OpenShift and Cloud Pak for Integration. 
databaseBackup:
  chunkSize
 String 1Gi   See Configuring backup settings for Analytics, Configuring backup settings for Analytics on OpenShift and Cloud Pak for Integration. 
databaseBackup:
  enableServerSideEncryption
 Boolean     See Configuring backup settings for Analytics, Configuring backup settings for Analytics on OpenShift and Cloud Pak for Integration. 
external:
  offload:
    filter
 String   Filter configuration for external offload. See Offloading data to a third-party system - Kubernetes, Offloading data to a third-party system - OpenShift. 
external:
  offload:
    enabled
 Boolean false Enables analytics offload feature. See Offloading data to a third-party system - Kubernetes, Offloading data to a third-party system - OpenShift. 
external:
  offload:
    output
 String   Output configuration for external offload. See Offloading data to a third-party system - Kubernetes, Offloading data to a third-party system - OpenShift. 
external:
  offload:
    passwordSecretName
 String   The name of the secret that has the password to access the certificate keystore. For where you are using a password protected key/truststore. See Offloading data to a third-party system - Kubernetes, Offloading data to a third-party system - OpenShift. 
external:
  offload:
    secretName
 String   The name of the secret that contains the certificates used for connecting to the offload target. See Offloading data to a third-party system - Kubernetes, Offloading data to a third-party system - OpenShift. 
ingestion:
  endpoint
 Object   FQDN and TLS Secrets for client endpoint. Identifies the endpoint that enables the Gateway to push your analytics data. 
ingestion:
  clientSubjectDN
 String   Subject DN (distinguished name) for authenticating with ingestion endpoint (RFC 2253).   
ingestion:
  filter
 String   Filter to modify API event data that is stored internally (not offloaded). See Configuring ingestion filters on Kubernetes Configuring ingestion filters on OpenShift. 
ingestion:
  queue
 Object   Persistent queue settings. Must be set to persisted if present. See Configuring persistent queue on Kubernetes, Configuring persistent queue on OpenShift. 
ingestion:
  queue:
    type
 String   Defines the storage type for the persistent storage feature. Options are 'persisted' or 'memory' See Configuring persistent queue on Kubernetes, Configuring persistent queue on OpenShift. 
ingestion:
  queue:
    volumeClaimTemplate:
      volumeSize
 String   Storage size for your persistent queue. See Configuring persistent queue on Kubernetes, Configuring persistent queue on OpenShift. 
ingestion:
  queue:
    volumeClaimTemplate:
      storageClassName
 String   Storage class name for your persistent storage. See Configuring persistent queue on Kubernetes, Configuring persistent queue on OpenShift. 
ingestion:
  pipelineWorkers
 4 <= integer <= 128 24 Number of pipeline workers. More workers mean more CPU and memory requirements, but gives you the benefit of extra threads to pull data off the ingestion http interface and process it for storage. This has diminishing returns as the size increases, and should usually be multiple of the number of cores on your hardware. Adjust with caution. 
ingestion:
  pipelineBatchSize
 10 <= integer <= 10000 250 Batch size of a pipeline worker. Pulling more or less data off the http interface per worker can have benefits. Recommended values are 125, 250, and 500. Increasing the value requires more memory. 
ingestion:
  pipelineBatchDelay
 10 <= integer <= 5000 50 Batch delay of a pipeline worker. How long to wait for the batch size to fill before leaving the http interface to process for storage. Having threads wait too long causes idle threads in your system; however, setting this value too low decreases performance. Adjust with caution. 
ingestion:
  configReloadAutomatic
 Boolean true Whether to automatically reload the pipeline on configuration changes. Typically, when the underlying files for the pipeline are modified, the pipeline process automatically reloads and picks up the changes. However, in Kubernetes environments where the pipeline is mapped to configmaps, this is unreliable. Ingestion microservice restarts are usually required. 
ingestion:
  pipelineUnsafeShutdown
 Boolean false Whether to allow unsafe shutdown of the pipeline. Typically, the pipeline attempts to empty all workers' batches before shutdown to prevent data loss. You might need to enable this setting if the pipeline is badly configured and refuses to respond to shut down requests (uncommon). Adjust with caution. 
standaloneCluster
 Boolean       
storage:
  type
 String shared Type of storage deployment. Shared is the only available option. 
storage:
  shared:
    volumeClaimTemplate:
      storageClassName
 String cluster default Storage class name. Name of the storage class configured to use for creating the microservice persistent volume. 
storage:
  shared:
    volumeClaimTemplate:
      volumeSize
 String 50Gi Volume size. Size of the volume used for data storage. See Estimating internal storage space for more information.