WebSphereAutomation custom resource

The WebSphereAutomation custom resource represents an instance of WebSphere Automation that is installed into a Kubernetes namespace. The resource is created with the default configuration when the instance is created. The CR can be used later to update the configuration.

WebSphereAutomation YAML structure

The WebSphereAutomation definition has the following structure:
apiVersion: automation.websphere.ibm.com/v1
kind: WebSphereAutomation
metadata:
  name: wsa
spec:
  activityRecordManager:
    image: ...
    replicas: ...
    resources: ...
      limits: ...
      requests: ...
  apis:
    image: ...
    replicas: ...
    resources: ...
      limits: ...
      requests: ...
  commonServices:
    registryNamespace: ...
  dataStore: 
    image: ...
    replicas: ...
    resources: 
      limits: ...
      requests: ...
    storage: 
      class: ...
      fsGroup: ...
      selector: 
        matchExpressions: ...
        matchLabels: ...
      size: ...
      supplementalGroups: ...
  events: 
    kafka:
      partitions: ...
      replicas: ...
      resources:
        limits: ...
        requests: ...
      storage:
        class: ...
        selector: ...
        size: ...
    zookeeper:
      partitions: ...
      replicas: ...
      resources:
        limits: ...
        requests: ...
      storage:
        class: ...
        selector: ...
        size: ...
  license: 
    accept: ...
  platformUI: 
    customRoute:
      routeHost: ...
    fileStorageClass: ...
  pullPolicy: ...
  pullSecret: ...
  replicas: ...
  repository: ...
  runbookManager: 
    image: ...
    replicas: ...
    resources: 
      limits: ...
      requests: ...
    runbookRunner: 
      activeDeadlineSeconds: ...
      hostAliases: ...
      image: ...
      resources: 
        limits: ...
        requests: ...
  scaleToZero: ...
status: 
  conditions: ...
  endpoints: 
    automationUI: ...
  references: 
    pullSecret: ...
    truststoreSecretVersion: ...
  versions: 
    reconciled: ...

WebSphereAutomation details

metadata (required)
Refer to the Kubernetes API documentation for the fields of the metadata External link icon field.
spec
WebSphereAutomationSpec defines the wanted state of WebSphereAutomation.
activityRecordManager
Configuration of the activity record manager. Optional.
image
The container image for the activity record manager. Defaults to the image from cp.icr.io/cp/ repository.
replicas
Number of wanted pods for the activityRecordManager. Defaults to 3. Maximum is 10.
resources

Describes the computational resource requirements. The CPU defaults to 200m, with a limit of 400m. The memory defaults to 256Mi, with a limit of 512Mi.

limits
Describes the maximum amount of compute resources allowed. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
requests
Describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
apis
Configuration of the WebSphere Automation APIs. Optional.
image
The container image for the APIs. Defaults to the image from cp.icr.io/cp/ repository.
replicas
Number of wanted pods for the APIs. Defaults to 3. Maximum is 10.
resources

Describes the computational resource requirements. The CPU defaults to 500m, with a limit of 1 core. The memory defaults to 256Mi, with a limit of 1Gi.

limits
Describes the maximum amount of compute resources allowed. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
requests
Describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
commonServices
Configuration of IBM common services. Optional.
registryNamespace
Name of the common services registry namespace. Defaults to ibm-common-services.
dataStore
Configuration of the data store for WebSphere Automation. Optional.
image
The container image for the data store. Defaults to the image from cp.icr.io/cp/ repository.
replicas
Number of wanted pods for the data store. Defaults to 3. This value can only be scaled up. Scaling down to 0 is only supported for backup and restore. No other scaling down is supported.
resources
Describes the computational resource requirements. The CPU defaults to 100m with a limit of 1000m. The memory defaults to 256Mi, with a limit of 1Gi.
limits
Describes the maximum amount of compute resources allowed. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
requests
Describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
storage
Configuration of the storage for WebSphere Automation. Optional.
class
Name of the StorageClass resource. Defaults to the StorageClass resource of the cluster. The name cannot be specified or updated after WebSphere Automation is created.
fsGroup
The group ID for the file system. This might need to be set for some storage providers such as NFS. Optional.
selector
A label query of persistent volumes (PVs) to match when the volume for the data store is selected.
matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
size
Size of the storage for the data store. Defaults to 10 Gi. Limitation: The size cannot be specified or updated after WebSphere Automation is created.
supplementalGroups
The supplemental groups array provides a list of Linux® Group IDs to be set on a container. Optional.
events
Configuration of the events. Optional.
kafka
Configuration of the body for WebSphere Automation Events. Optional.
partitions
Number of partitions needed for Events (Kafka) within WebSphere Automation. Defaults to 3. The maximum is 13. The partitions can be increased, but cannot be decreased after WebSphere Automation is installed.
replicas
Number of desired pods for the WebSphere Automation Events. Defaults to 3. Minimum is 1. Maximum is 10.
resources
Describes the computational resource requirements. The CPU defaults to 1000m with a limit of 1000m. The memory defaults to 2Gi, with a limit of 2Gi.
limits
Limits describes the maximum amount of compute resources allowed. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ External link icon.
requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ External link icon
storage
Configuration of the storage for a WebSphere Automation Events body. Optional.
class
Name of the StorageClass resource. Defaults to the StorageClass resource of the cluster. The name can not be specified or updated after WebSphere Automation Events is created.
selector
A label query of persistent volumes (PVs) to match when the volume for the data store is selected.
size
Size of the storage for the data store. Defaults to 10 Gi. Limitation: The size cannot be decreased after WebSphere Automation Events is created.
zookeeper
Configuration of the body for WebSphere Automation Events. Optional.
partitions
Number of partitions needed for Events (Zookeeper) within WebSphere Automation. Defaults to 3. The maximum is 13. The partitions can be increased, but cannot be decreased after WebSphere Automation is installed.
replicas
Number of desired pods for the WebSphere Automation Events. Defaults to 3. Minimum is 1. Maximum is 10.
resources
Describes the computational resource requirements. The CPU defaults to 1000m with a limit of 1000m. The memory defaults to 2Gi, with a limit of 2Gi.
limits
Limits describes the maximum amount of compute resources allowed. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
requests
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
storage
Configuration of the storage for a WebSphere Automation Events body. Optional.
class
Name of the StorageClass resource. Defaults to the StorageClass resource of the cluster. The name can not be specified or updated after WebSphere Automation Events is created.
selector
A label query of persistent volumes (PVs) to match when the volume for the data store is selected.
size
Size of the storage for the data store. Defaults to 10 Gi. Limitation: The size cannot be decreased after WebSphere Automation Events is created.
license
The license must be reviewed and accepted before WebSphere Automation can be deployed.
accept
I accept the terms of the license agreement corresponding to the applicable IBM program: IBM WebSphere Automation (WSA) or IBM Cloud Pak for Applications (CP4Apps Advanced). For WSA, read the license: https://ibm.biz/WSALicense. For CP4Apps Advanced, read the license: https://ibm.biz/WSACP4AppsAdvLicense. For more information, see Licensing for WebSphere Automation.
platformUI
Configuration of the platform UI. Optional.
customRoute
Configuration of the platform UI route. Optional.
routeHost
The host for the platform UI route.
fileStorageClass
Name of the StorageClass resource. Defaults to the StorageClass resource of the cluster. The name can not be specified or updated after WebSphere Automation Platform UI is created.
pullPolicy
Policy for pulling container images. Defaults to IfNotPresent.
pullSecret
Name of the Secret to use to pull images from the specified repository. It is not required if the cluster is configured with a global image pull secret.
replicas
Number of desired pods for each WebSphere Automation Core component. Replicas specified at each component-level takes precedence over this value. This value does not control the replicas of Data store (Mongo), Events (Kafka), WebSphere Health or Secure components. Defaults to 3. Maximum is 10.
repository
Repository that contains the images for the WebSphere Automation components. Defaults to cp.icr.io/cp/.
runbookManager
Configuration of the runbook manager. Optional.
image
The container image for the runbook manager. Defaults to the image from cp.icr.io/cp/ repository.
replicas
Number of wanted pods for the runbook manager. Defaults to 3. Maximum is 10.
resources
Describes the computational resource requirements. The CPU defaults to 200m with a limit of 400m. The memory defaults to 256Mi, with a limit of 512Mi.
limits
Describes the maximum amount of compute resources allowed. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
requests
Describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
runbookRunner
Configuration of the runbook runner. Optional.
activeDeadlineSeconds
Specifies the duration in seconds relative to the startTime that the job might be active before the system tries to stop it. Defaults to 3000.
hostAliases
List of hosts and IPs that are injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
image
The container image for the runbook runner. Defaults to the image from cp.icr.io/cp/ repository.
resources
Describes the computational resource requirements. The CPU defaults to 200m with a limit of 400m. The memory defaults to 256Mi, with a limit of 512Mi.
limits
Describes the maximum amount of compute resources allowed. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
requests
Describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. For more information, see https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ External link icon.
scaleToZero
Scale down all pods of WebSphere Automation services to zero. This applies to WebSphere Automation Core, Health, and Secure components but does not apply to Data store (Mongo) or Events (Kafka). This value takes precedence over any other replicas values specified for WebSphere Automation. Defaults to false.
status
Defines the observed state of the WebSphereAutomation kind.
conditions
Describes the status of various conditions.
endpoints
Information about various endpoints.
automationUI
Link to the IBM Automation UI.
references
Internal information about processed resources for the WebSphereAutomation kind.
versions
Stores information about operator and operand versions.
reconciled
Version of the operand that is deployed into the cluster after the reconcile loop completes.