values-metadata.yaml

## Metadata for IBM App Connect Enterprise Server configuration
## This metadata is used to augment the value.yaml to drive IPC UI for configuration of the Helm chart installation

# License configuration metadata
license:
  __metadata:
    label: "License"
    description: "Set whether the license should be accepted"
    type: "string"
    required: true
    options:
    - label: "Accepted"
      value: "accept"
    - label: "Not accepted"
      value: "not accepted"

# Content Server metadata
contentServerURL:
  __metadata:
    label: "Content Server URL"
    description: "Specify the URL to pull content from. This value should be available from the App Connect Enterprise dashboard when adding a server."
    type: "string"
    immutable: false
    required: true

# Base image selection metadata
imageType:
  __metadata:
    label: "Which type of image to run"
    description: "Run a standalone integration server a standalone server, an integration server with MQ client or an integration server with MQ server"
    options:
    - label: 'App Connect Enterprise only'
      value: 'ace'
    - label: 'App Connect Enterprise with MQ client'
      value: 'acemqclient'
    - label: 'App Connect Enterprise with MQ server'
      value: 'acemqserver'

# Grafana Dashboard deployment
dashboardEnabled:
    __metadata:
      label: "Deploy the dashboard to grafana"
      description: "Automatically deploy the dashboard into grafana"
      type: "boolean"
      hidden: true

# DesignerFlows enablement metadata
designerFlowsEnabled:
  __metadata:
    label: "Enable IBM App Connect Designer flows"
    description: "Run an Integration Server with an associated sidecar container for running flows authored in IBM App Connect Designer"
    type: "boolean"

# Image configuration metadata
image:
  __metadata:
    label: "Images"
    description: "Define images to be used"
  aceonly:
    __metadata:
      label: "Docker image for App Connect Enterprise"
      description: "The repository and name for the Docker image with App Connect Enterprise"
      type: "string"
      required: true
  acemqclient:
    __metadata:
      label: "Docker image for App Connect Enterprise with MQ client"
      description: "The repository and name for the Docker image with App Connect Enterprise with MQ client"
      type: "string"
      required: true
  acemq:
    __metadata:
      label: "Docker image for App Connect Enterprise with MQ server"
      description: "The repository and name for the Docker image with App Connect Enterprise with MQ server"
      type: "string"
      required: true
  configurator:
    __metadata:
      label: "Configurator Docker image"
      description: "Docker registry image to pull for the IBM Cloud Private configurator"
      type: "string"
      required: true
  designerflows:
    __metadata:
      label: "Designer flows Docker image"
      description: "Docker registry image to pull for the App Connect Designer flows"
      type: "string"
      required: true
  pullPolicy:
    __metadata:
      label: "Image pull policy"
      description: "The default pull policy is IfNotPresent which causes the Kubelet to skip pulling an image if it already exists"
      options:
      - label: 'Always'
        value: 'Always'
      - label: 'Never'
        value: 'Never'
      - label: 'IfNotPresent'
        value: 'IfNotPresent'
  pullSecret:
    __metadata:
      label: "Image pull secret"
      description: "Secret to use when pulling the image.  Set this when using an image from a private registry."
      type: "string"
      required: false

arch:
  __metadata:
    label: "Architecture scheduling preference"
    description: "Architecture scheduling preference for worker node (only amd64 supported)"
    type: "string"
    immutable: true
    required: true

# Integration Server metadata
integrationServer:
  __metadata:
    label: "Integration Server"
    description: "Define configuration for the Integration Server"
  name:
    __metadata:
      label: "Integration server name"
      description: "App Connect Enterprise integration server name, which defaults to the Helm release name"
      type: "string"
      required: false
  keystoreKeyNames:
    __metadata:
      label: "List of key aliases for the keystore"
      description: "Comma-separated list of key alias names to mount from the pre-installed secret"
      type: "string"
      required: false
  truststoreCertNames:
    __metadata:
      label: "List of certificate aliases for the truststore"
      description: "Comma-separated list of certificate alias names to mount from the pre-installed secret"
      type: "string"
      required: false
  defaultAppName:
    __metadata:
      label: "Name of the default application"
      description: "defaultAppName allows you to specifiy a name for the default application for the deployment of independent resources"
      type: "string"
      required: false
  configurationSecret:
    __metadata:
      label: "The name of the secret to create or to use that contains the server configuration"
      description: "The secret containing the server configuration or the name of the secret to generate"
      type: "string"
      immutable: false
      required: false
  fsGroupGid:
    __metadata:
      label: "File system group ID"
      description: "The file system group ID to use for volumes that support ownership management (such as NFS)"
      type: "string"
      required: false
      immutable: false

# Service configuration metadata
service:
  __metadata:
    label: "Service"
    description: "Service settings"
  type:
    __metadata:
      label: "Service type"
      description: "Type of service"
      type: "string"
      required: true
      options:
      - label: "ClusterIP"
        value: "ClusterIP"
      - label: "NodePort"
        value: "NodePort"
  webuiPort:
    __metadata:
      label: "Web UI Port"
      description: "Web UI port number"
      type: "number"
      immutable: true
      required: true
  serverlistenerPort:
    __metadata:
      label: "HTTP port"
      description: "HTTP server listener port number"
      type: "number"
      immutable: true
      required: true
  serverlistenerTLSPort:
    __metadata:
      label: "HTTPS port"
      description: "HTTPS server listener port number"
      type: "number"
      immutable: true
      required: true
  iP:
    __metadata:
      label: "Proxy Node IP or FQDN"
      description: "An IP address or DNS name that the nodeport is connected to, that is, the proxy node's IP or fully qualified domain name (FQDN)"
      type: "string"
      required: true

# Settings specific to deployments of ACE without MQ
aceonly:
  __metadata:
    label: "Configuration for App Connect Enterprise (without MQ) deployments"
    description: "Configuration settings for specifying required resources when running App Connect Enterprise without MQ"
  # Resource requests and limits configuration metadata
  resources:
    requests:
      cpu:
        __metadata:
          label: "CPU request"
          description: "Minimum number of CPU cores. Specify integer, fractional (e.g., 0.5), or millicore values (e.g., 100m, where 100m is equivalent to 0.1 core)."
          type: "string"
          required: true
      memory:
        __metadata:
          label: "Memory request"
          description: "The minimum memory in bytes. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki."
          type: "string"
          required: true
    limits:
      cpu:
        __metadata:
          label: "CPU limit"
          description: "Upper limit of CPU cores. Specify integer, fractional (e.g., 0.5), or millicore values (e.g., 100m, where 100m is equivalent to 0.1 core)."
          type: "string"
          required: true
      memory:
        __metadata:
          label: "Memory limit"
          description: "The memory upper limit in bytes. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki."
          type: "string"
          required: true
  # Replica count metadata. This only applies when running without MQ.
  replicaCount:
    __metadata:
      label: "Replica count"
      description: "The number of replica pods to run. This only applies when running without a queue manager."
      type: "number"
      required: false

# Settings specific to deployments of ACE with MQ
acemq:
  __metadata:
    label: "Configuration for App Connect Enterprise with MQ stateful sets"
    description: "Configuration settings for specifying required resources when running App Connect Enterprise with MQ"
  # Resource requests and limits configuration metadata
  resources:
    requests:
      cpu:
        __metadata:
          label: "CPU request"
          description: "Minimum number of CPU cores. Specify integer, fractional (e.g., 0.5), or millicore values (e.g., 100m, where 100m is equivalent to 0.1 core)."
          type: "string"
          required: true
      memory:
        __metadata:
          label: "Memory request"
          description: "The minimum memory in bytes. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki."
          type: "string"
          required: true
    limits:
      cpu:
        __metadata:
          label: "CPU limit"
          description: "Upper limit of CPU cores. Specify integer, fractional (e.g., 0.5), or millicore values (e.g., 100m, where 100m is equivalent to 0.1 core)."
          type: "string"
          required: true
      memory:
        __metadata:
          label: "Memory limit"
          description: "The memory upper limit in bytes. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki."
          type: "string"
          required: true
  pki:
    keys:
      __metadata:
        label: "Keys"
        description: "Certificates containing private keys to add. See Readme/values.yaml for format."
        type: "string"
        multiline: true
    trust:
      __metadata:
        label: "Certificates"
        description: "Certificates to add. See Readme/values.yaml for format."
        type: "string"
        multiline: true
  qmname:
    __metadata:
      label: "Queue manager name"
      description: "MQ queue manager name, which defaults to the Helm release name"
      type: "string"
      required: false
  initVolumeAsRoot:
    __metadata:
      label: "Initialize MQ volume using root"
      description: "Whether or not the storage class (such as NFS) requires root permissions to initialize"
      type: "boolean"
      required: true

# Settings specific to deployments of ACE with a sidecar for running flows authored in IBM App Connect Designer
designerflows:
  __metadata:
    label: "Resources for running IBM App Connect Designer flows"
    description: "Resource settings for sidecar containers to run flows authored in IBM App Connect Designer"
  # Resource requests and limits configuration metadata
  resources:
    requests:
      cpu:
        __metadata:
          label: "CPU request"
          description:  "Minimum number of CPU cores. Specify integer, fractional (e.g., 0.5), or millicore values (e.g., 100m, where 100m is equivalent to 0.1 core)."
          type: "string"
          required: true
      memory:
        __metadata:
          label: "Memory request"
          description: "The minimum memory in bytes. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki."
          type: "string"
          required: true
    limits:
      cpu:
        __metadata:
          label: "CPU limit"
          description: "Upper limit of CPU cores. Specify integer, fractional (e.g., 0.5), or millicore values (e.g., 100m, where 100m is equivalent to 0.1 core)."
          type: "string"
          required: true
      memory:
        __metadata:
          label: "Memory limit"
          description: "The memory upper limit in bytes. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki."
          type: "string"
          required: true

# global persistence parameters
persistence:
  __metadata:
    label: "Persistence settings"
    description: "Settings for the persistent volumes (applicable only when running with a queue manager)"
  enabled:
    __metadata:
      label: "Enable persistence"
      description: "Whether or not to store MQ messages and configuration on a Persistent Volume"
      type: "boolean"
  useDynamicProvisioning:
    __metadata:
      label: "Use dynamic provisioning"
      description: "Specify whether to use storage classes to provision a persistent volume automatically"
      type: "boolean"

dataPVC:
  __metadata:
    label: "Data persistent volume claims (PVCs)"
    description: "Settings for the PVCs (applicable only when running with a queue manager)"
  name:
    __metadata:
      label: "Name"
      description: "Name of PVC that is used for MQ objects and messages"
      type: "string"
      required: true
  storageClassName:
    __metadata:
      label: "Storage class name"
      description: "Storage class of PVC that is used for MQ objects and messages"
      type: "string"
      required: false
  size:
    __metadata:
      label: "Size"
      description: "Size of PVC that is used for MQ objects and messages"
      type: "string"
      required: true

# log metadata section specifies settings for MQ and ACE logs
log:
  __metadata:
    label: "Log"
    description: "Log format"
  format:
    __metadata:
      label: "Log settings"
      description: "The format of container logs output to the container's console"
      type: "string"
      required: false
      options:
      - label: "JSON"
        value: "json"
      - label: "Basic"
        value: "basic"

# Metrics metadata
metrics:
  __metadata:
    label: "Metrics"
    description: "Metrics settings"
  enabled:
    __metadata:
      label: "Enable metrics"
      description: "Specify whether to generate Prometheus metrics for the Integration Server and queue manager"
      type: "boolean"

# livenessProbe section specifies setting for the ACE and MQ liveness probe, which checks for a running Integration Server and Queue Manager
livenessProbe:
  __metadata:
    label: "Liveness probe"
    description: "Settings for the liveness probe that checks that the integration server is still running"
  # initialDelaySeconds should be raised if your system cannot start the Queue Manager and Integration Server in 120 seconds
  initialDelaySeconds:
    __metadata:
      label: "Initial delay (seconds)"
      description: "How long to wait before starting the probe. Increase this value if your system cannot start the integration server in the default time period."
      type: "number"
      required: false
  periodSeconds:
    __metadata:
      label: "Period (seconds)"
      description: "How often to perform the probe"
      type: "number"
      required: false
      hidden: true
  timeoutSeconds:
    __metadata:
      label: "Timeout (seconds)"
      description: "How long before a probe times out"
      type: "number"
      required: false
      hidden: true
  failureThreshold:
    __metadata:
      label: "Failure threshold"
      description: "Number of times the probe can fail before taking action"
      type: "number"
      required: false
      hidden: true

# readinessProbe section specifies setting for the ACE and MQ readiness probe, which checks when the ACE admin port is open and the MQ listener is running
readinessProbe:
  __metadata:
    label: "Readiness probe"
    description: "Settings for the readiness probe that checks if the integration server is ready"
  initialDelaySeconds:
    __metadata:
      label: "Initial delay (seconds)"
      description: "How long to wait before starting the probe"
      type: "number"
      required: false
  periodSeconds:
    __metadata:
      label: "Period (seconds)"
      description: "How often to perform the probe"
      type: "number"
      required: false
      hidden: true
  timeoutSeconds:
    __metadata:
      label: "Timeout (seconds)"
      description: "How long before a probe times out"
      type: "number"
      required: false
      hidden: true
  failureThreshold:
    __metadata:
      label: "Failure threshold"
      description: "Number of times the probe can fail before taking action"
      type: "number"
      required: false
      hidden: true

# Operations dashboard configuration
odTracingConfig:
  __metadata:
    label: "Operations Dashboard configuration"
    description: "Settings for the IBM Cloud Pak For Integration Operations Dashboard"
  enabled:
    __metadata:
      label: "Enable Operations Dashboard"
      description: "Whether or not to enable the OD for this release"
      type: "boolean"
      required: true

  odAgentImageRepository:
    __metadata:
      label: "OD agent image repository"
      description: "Repository where the OD agent image is located"
      type: "string"
      required: false
  odAgentImageTag:
    __metadata:
      label: "OD agent image tag"
      description: "The tag for the Docker image for the OD agent"
      type: "string"
      required: false
  odAgentLivenessProbe:
    initialDelaySeconds:
      __metadata:
        label: "OD agent liveness probe initial delay (seconds)"
        description: "How long to wait before starting the probe. Raise this delay if your system cannot start the collector in the default time period"
        type: "number"
        required: false
    periodSeconds:
      __metadata:
        label: "Period (seconds)"
        description: "How often to perform the probe"
        type: "number"
        required: false
        hidden: true
    timeoutSeconds:
      __metadata:
        label: "Timeout (seconds)"
        description: "How long before a probe times out"
        type: "number"
        required: false
        hidden: true
    failureThreshold:
      __metadata:
        label: "Failure threshold"
        description: "Number of times the probe can fail before taking action"
        type: "number"
        required: false
        hidden: true
  odAgentReadinessProbe:
    initialDelaySeconds:
      __metadata:
        label: "OD agent readiness probe initial delay (seconds)"
        description: "How long to wait before starting the probe. Raise this delay if your system cannot allow the collector to be ready in the default time period"
        type: "number"
        required: false
    periodSeconds:
      __metadata:
        label: "Period (seconds)"
        description: "How often to perform the probe"
        type: "number"
        required: false
        hidden: true
    timeoutSeconds:
      __metadata:
        label: "Timeout (seconds)"
        description: "How long before a probe times out"
        type: "number"
        required: false
        hidden: true
    failureThreshold:
      __metadata:
        label: "Failure threshold"
        description: "Number of times the probe can fail before taking action"
        type: "number"
        required: false
        hidden: true

  odCollectorImageRepository:
    __metadata:
      label: "OD collector image repository"
      description: "Repository where the OD collector image is located"
      required: false
  odCollectorImageTag:
    __metadata:
      label: "OD collector image tag"
      description: "The tag for the Docker image for the OD collector"
      type: "string"
      required: false
  odCollectorLivenessProbe:
    initialDelaySeconds:
      __metadata:
        label: "OD collector liveness probe initial delay (seconds)"
        description: "How long to wait before starting the probe. Raise this delay if your system cannot start the collector in the default time period"
        type: "number"
        required: false
    periodSeconds:
      __metadata:
        label: "Period (seconds)"
        description: "How often to perform the probe"
        type: "number"
        required: false
        hidden: true
    timeoutSeconds:
      __metadata:
        label: "Timeout (seconds)"
        description: "How long before a probe times out"
        type: "number"
        required: false
        hidden: true
    failureThreshold:
      __metadata:
        label: "Failure threshold"
        description: "Number of times the probe can fail before taking action"
        type: "number"
        required: false
        hidden: true
  odCollectorReadinessProbe:
    initialDelaySeconds:
      __metadata:
        label: "OD collector readiness probe initial delay (seconds)"
        description: "How long to wait before starting the probe. Raise this delay if your system cannot allow the collector to be ready in the default time period"
        type: "number"
        required: false
    periodSeconds:
      __metadata:
        label: "Period (seconds)"
        description: "How often to perform the probe"
        type: "number"
        required: false
        hidden: true
    timeoutSeconds:
      __metadata:
        label: "Timeout (seconds)"
        description: "How long before a probe times out"
        type: "number"
        required: false
        hidden: true
    failureThreshold:
      __metadata:
        label: "Failure threshold"
        description: "Number of times the probe can fail before taking action"
        type: "number"
        required: false
        hidden: true

  odTracingNamespace:
    __metadata:
      label: "OD tracing instance namespace"
      description: "Namespace where the Operation Dashboard was released"
      type: "string"
      required: false