WebSphereHealth custom resource

The WebSphereHealth custom resource represents an instance of WebSphere Health 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.

WebSphereHealth YAML structure

The WebSphereHealth definition has the following structure:
apiVersion: automation.websphere.ibm.com/v1
kind: WebSphereHealth
metadata:
  name: wsa-health
spec:
  analysisManager: 
    image: ...
    memoryAnalysisRunner: 
      activeDeadlineSeconds: ...
      image: ...
      resources: 
        limits: ...
        requests: ...
    replicas: ...
    resources: 
      limits: ...
      requests: ...
  apis: 
    image: ...
    replicas: ...
    resources: 
      limits: ...
      requests: ...
  fileStore: 
    storage: 
      class: ...
      selector: 
        matchExpressions: ...
        matchLabels: ...
      size: ...
  investigationManager: 
    image: ...
    replicas: ...
    resources: 
      limits: ...
      requests: ...
  license: 
    accept: ...
  pullPolicy: ...
  pullSecret: ...
  replicas: ...
  repository: ...
  webhooksAPIs: 
    image: ...
    replicas: ...
    resources: 
      limits: ...
      requests: ...
status: 
  conditions: ...
  endpoints:
    automationUI: ...
  references: 
    pullSecret: ...
  versions: 
    reconciled: ...

WebSphereHealth details

metadata (required)
Refer to the Kubernetes API documentation for the fields of the metadata External link icon field.
spec
Defines the wanted state of WebSphereHealth.
analysisManager
Configuration of the analysis manager. Optional.
image
The container image for the analysis manager. Defaults to the image from cp.icr.io/cp/ repository.
memoryAnalysisRunner
Configuration of the memory analysis 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 3600.
image
The container image for the memory analysis runner. Defaults to the image from cp.icr.io/cp/ repository.
resources
Describes the computational resource requirements. The CPU defaults to 500m with a limit of 1 core. The memory defaults to 4Gi, with a limit of 4Gi.
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
replicas
The number of wanted pods for the WebSphere Health APIs. 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 Health APIs. Optional.
image
The container image for the WebSphere Health APIs. Defaults to the image from cp.icr.io/cp/ repository.
replicas
Number of wanted pods for the WebSphere Health 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
fileStore
Configuration of the file store for WebSphere Health. Optional.
storage
Configuration of the storage for WebSphere Health. Optional.
class
Name of the StorageClass resource. Defaults to the StorageClass resource of the cluster. The name cannot be specified or updated after WebSphere Health is created.
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 50 Gi.
investigationManager
Configuration of the investigation manager. Optional.
image
The container image for the investigation manager. Defaults to the image from cp.icr.io/cp/ repository.
replicas
Number of wanted pods for the investigation 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
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.
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 wanted pods for each WebSphere Health component. Replicas that are specified at each component-level take precedence over this value. Defaults to 3. Maximum is 10.
repository
Repository that contains the images for the WebSphere Health components. Defaults to cp.icr.io/cp/.
webhooksAPIs
Configuration of the webhooks APIs. Optional.
image
The container image for the webhooks APIs. Defaults to the image from cp.icr.io/cp/ repository.
replicas
Number of wanted pods for the webhooks 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
status
Defines the observed state of the WebSphereHealth kind.
endpoints
Information about various endpoints.
automationUI
Link to the IBM Automation UI.
references
Internal information about processed resources for the WebSphereHealth kind.
versions
Stores information about operator and operand versions.