CR configuration settings

The CR configuration settings specify the properties when you are installing and updating the deployment.

Note: It is imperative for customers to utilize the metadata.name field in the Custom Resource (CR) file as stepzen. Failure to adhere to this naming convention may result in the admin-script functioning unexpectedly. Please ensure compliance to maintain seamless functionality.
Specification Property Description Required
imagePullPolicy   Image pull policy for the operator. One of Always, Never or IfNotPresent. Optional
imagePullSecrets   List of image pull secrets (Docker credentials used for accessing a registry) for retrieving the Graph Service image. Set this to your IBM entitlement key as described in Installing API Connect Essentials Required
controlDatabaseSecret   Name of Kubernetes secret storing the Graph Server PostgreSQL metadata database credentials. This setting should contain the property DSN containing a string of the form postgresql://user:password@host:port/database. Required
license   Set to true to accept the API Connect Essentials License agreement. You cannot install API Connect Essentials without accepting the license agreement. Required
graphServer/graphServerSubscription/jdbcService annotations Specify custom annotations to add to the pods. Optional
labels Specify custom labels to add to the pods. Optional
tolerations Specify custom tolerations to add to the pods. The value must be an array of objects with the following properties:
  • effect: string
  • key: string
  • operator: string
  • tolerationSeconds: integer
  • value: string. Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

See Taints and Tolerations in the Kubernetes documentation for descriptions.

Optional
nodeSelector NodeSelector allows scheduling pods on nodes by matching labels. Optional
affinity Allows to override the default node affinity settings. Must be an object with one or more of the following properties:
  • nodeAffinity: object
  • podAffinity: object
  • podAntiAffinity: object

See Assigning Pods to Nodes in the Kubernetes documentation for a description of these properties.

Optional
resources Specify a CPU request and a CPU limit for the API Connect for GraphQL Graph Service container. The value must be an object with the following properties:
  • limits
    • CPU:integer
    • memory:integer
  • requests
    • CPU: integer
    • memory:integer
Optional
hpa Specify horizontal pod autoscaling parameters. The value must be an object with the following properties:
  • minReplicas: integer. Minimum pods that can be scaled down to by HPA. Must be 1 or greater.
  • maxReplicas: integer. Maximum pods that can be scaled up to by HPA. Must be greater than or equal to minReplicas.
  • targetCPUUtilizationPercentage: integer. CPU utilization threshold percentage for triggering scaling.
  • targetMemoryUtilizationPercentage: integer. Memory utilization threshold percentage for triggering scaling.
Required
persistentVolumeClaim (applicable only to the JDBCservice) The name of the PersistentVolumeClaim used to access storage resources where the database drivers are located. Required
enableLocalhost   set to false to additionally block access to localhost and private networks when enableProtectNetworkIp is true (default: false). Optional
enableProtectNetworkIp   block access to multicast IPs but allow private IP ranges except localhost (default: true). Optional