App Connect Designer Authoring reference

Use this reference to create and delete App Connect Designer instances by using the IBM® Cloud Pak for Integration Platform Navigator, or the Red Hat® OpenShift® web console or CLI.

Introduction

The App Connect Designer Authoring API enables you to create an App Connect Designer instance for developing, testing, and sharing integration flows. An App Connect Designer instance provides an authoring environment for hosting non-production workloads.


Usage guidelines:

Multiple instances of App Connect Designer can be created in a namespace (project) for individual or team use. Users in this namespace can then use their allocated instance to develop and manage flows.

Prerequisites

  • Red Hat OpenShift Container Platform 4.6 is required for EUS compliance. Red Hat OpenShift Container Platform 4.10 is also supported for migration from EUS to a Continuous Delivery (CD) or Long Term Support (LTS) release.
  • For any production licensed instances, you must create a secret called ibm-entitlement-key in the namespace where you want to create IBM App Connect resources. For more information, see IBM Entitled Registry entitlement keys.
  • When you create an App Connect Designer instance, you can enable the use of local connectors only, or enable the use of both local and cloud-managed connectors. These connectors will be used to connect to the target applications that are referenced in any flows that are created, and to run the defined events, actions, or operations. To use cloud-managed connectors, the following prerequisites must be met:
    1. An instance of IBM App Connect on IBM Cloud is required, which hosts the cloud-managed connectors.
    2. Launch the instance and make a note of the instance identifier.
      Locating the instance identifier of an App Connect instance
    3. Make a note of the region in which the instance is provisioned.
    4. Create an IBM Cloud API key while logged in to the same IBM Cloud account as the App Connect on IBM Cloud instance. You can create this key from the IBM Cloud API Keys page at: https://cloud.ibm.com/iam/apikeys. Download the key to your browser’s default location for later use. The file is named apiKey.json.
      Tip: To keep the value of the key secure, it needs to be stored in a Kubernetes secret. Depending on how you choose to create your App Connect Designer instance (Form or YAML view), you can either let the IBM App Connect Operator generate a secret for you, or you can manually create a secret by using the Red Hat OpenShift web console or CLI.
    5. Optional. To create your own secret for the IBM Cloud API key, complete either of the following steps:
      • Red Hat OpenShift web console:
        1. From the navigation, click Workloads > Secrets.
        2. If necessary, select the namespace (project) in which you installed the IBM App Connect Operator.
        3. Click Create > Key/Value Secret and then specify a name for the secret in the Secret Name field.
        4. Specify apikey in the Key field, and then specify the IBM Cloud API key in the Value field.
        5. Click Create.
        6. Make a note of the secret name so that you can specify it while creating your App Connect Designer instance.
      • Red Hat OpenShift CLI:
        1. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.
        2. Run the following command:
          oc create secret generic secretName --from-literal=apikey=IBMCloudAPIkey --namespace=namespaceName
          Where:
          • secretName is the name of the secret for storing the IBM Cloud API key.
          • IBMCloudAPIkey is the key within the downloaded apiKey.json file.
          • namespaceName is the namespace in which the App Connect Designer instance will be created. You can omit the --namespace flag if you are already logged in to this namespace.
        3. Make a note of the secret name so that you can specify it while creating the App Connect Designer instance.
    Access considerations for cloud-managed connectors:

    The number of App Connect Designer instances that you create should depend on your team requirements, but take note of the following consideration for access.

    If you create one App Connect Designer instance for a team of users under a namespace, each user will require access to the (single) App Connect on IBM Cloud instance that hosts the connectors. (An App Connect Designer instance can be coupled with only one App Connect on IBM Cloud instance.)

    Each user will require Developer access to the Cloud Foundry organization and space that the App Connect on IBM Cloud instance belongs to. For more information about allocating Developer access to the App Connect on IBM Cloud instance, see Inviting users to an account in the IBM Cloud Managing identity and access documentation.

Red Hat OpenShift SecurityContextConstraints requirements

IBM App Connect runs under the default restricted SecurityContextConstraints.

Resources required

Minimum recommended requirements:

  • CPU: 4 Cores
  • Memory: 5.05 GB
  • Storage: 10 GB
With Mapping Assist:
  • CPU: 5 Cores
  • Memory: 6.05 GB

For information about how to configure these values, see Custom resource values.

Creating an instance

You can create an App Connect Designer instance from the IBM Cloud Pak for Integration Platform Navigator, or by using the Red Hat OpenShift web console or CLI.

Before you begin

  • The IBM App Connect Operator must be installed in your cluster either through a standalone deployment or an installation of IBM Cloud Pak for Integration. For further details, see the following information:
  • Ensure that you have cluster administrator authority or have been granted the appropriate role-based access control (RBAC).
  • Decide how to control upgrades to the instance when a new version becomes available. The spec.version value that you specify while creating the instance will determine how that instance is upgraded after installation, and whether you will need to specify a different license or version number for the upgrade. To help you decide whether to specify a spec.version value that either lets you subscribe to a channel for updates, or that uses a specific version for the instance, review the Upgrade considerations for channels, versions, and licenses before you start this task.
    Namespace restriction for an instance, server, or configuration:

    The namespace in which you install must be no more than 40 characters in length.

    Restriction: If you are using IBM App Connect Operator 1.1.4 or later, which installs Operator for Apache CouchDB 2.0.x or later by default, only a spec.version value that resolves to 11.0.0.14-r1-eus or later is supported for App Connect Designer.
Create options:

Creating an instance from the IBM Cloud Pak for Integration Platform Navigator

To create an App Connect Designer instance from the IBM Cloud Pak for Integration Platform Navigator, complete the following steps:

  1. From a browser window, log in to the IBM Cloud Pak for Integration Platform Navigator.
  2. From the Capabilities tab, click Create capability.
  3. Click the App Connect Designer tile and click Next.
  4. Click a tile to select which type of instance you want to create:
    • Quick start: Deploy an App Connect Designer instance with one replica pod.

      Consider choosing this option if you are the sole user and want to quickly get started for evaluative purposes.

    • Development: Deploy an App Connect Designer instance with multiple replica pods for high availability.

      Consider choosing this option for a multi-user environment with larger workloads than the Quick start deployment, with the capability to switch between replica pods to support failover.

    • Development with mapping assist: Deploy an App Connect Designer instance with multiple replica pods for high availability, and with Mapping Assist enabled for smart mapping.

      Consider choosing this option to create a Development deployment that additionally provides the technology to auto-populate the fields within a flow with the best possible matches from previous nodes.

  5. Click Next. A UI form view opens with the minimum configuration required to create the instance.
  6. Complete either of the following steps:
    • To quickly get going, complete the configuration fields. You can display advanced settings in the UI form view by setting Advanced settings to On. Note that some fields might not be represented in the form.
      Tip:

      If you set the Connectors to use field to all (to enable both local and cloud-managed connectors), you must specify an IBM Cloud API key that provides access to the App Connect on IBM Cloud instance that hosts the cloud-managed connectors.

      You can either specify the IBM Cloud API key in the IBM Cloud API key field, or specify the name of a manually created secret, which stores the IBM Cloud API key, in the IBM Cloud API key secret field. For information about creating an IBM Cloud API key or secret, see Prerequisites. You can specify the key or secret in either of the following ways:

      • Specify the IBM Cloud API key to automatically generate a secret:
        1. Switch to the YAML view.
        2. Update the YAML settings to include the spec.ibmCloudAPIKeyValue parameter and set its value to the IBM Cloud API key. For example:
          spec:
   ibmCloudAPIKeyValue: abc_123
      • Specify the name of a manually created secret that stores the IBM Cloud API key:
        1. From the IBM Cloud API key drop-down list, select ProvideAsASecretInIBMCloudAPIKeySecret.
        2. In the IBM Cloud API key secret field, specify the name of the manually created secret that stores the IBM Cloud API key. For information about creating this secret, see Prerequisites.

      For information about the spec.ibmCloudAPIKeyValue and spec.ibmCloudAPIKeySecret parameters (which represent the IBM Cloud API key and IBM Cloud API key secret fields), see Custom resource values.

      When the Connectors to use field is set to all, you must also specify the instance identifier (spec.appConnectInstanceID) and endpoint (spec.appConnectURL) of the App Connect on IBM Cloud instance.

    • For a more advanced configuration, click YAML to switch to the YAML view and then update the editor with your required parameters.
      • For information about the available parameters and their values, see Custom resource values.
        In the default parameters that are presented, be aware that a value is required for spec.couchdb.storage.class (and for spec.couchdb.storage.size) when spec.couchdb.storage.type is set to persistent-claim. The spec.couchdb.storage.class value must match a supported storage class for your cluster. (The UI form view presents these classes in a drop-down list.) 
        spec:
  couchdb:
    storage:
      class: 'storageClassValue'
      size: 10Gi
      type: persistent-claim
      • For licensing information, see Licensing reference for IBM App Connect Operator.
  7. Click Create. You are redirected to the Platform Navigator. An entry for the instance is shown in the capabilities table with an initial status of Pending, which you can click to check the progress of the deployment. When the deployment completes, the status changes to Ready.

Users with the required permission can access this Designer instance and use it to author flows.

Creating an instance from the Red Hat OpenShift web console

To create an App Connect Designer instance by using the Red Hat OpenShift web console, complete the following steps:

  1. Applicable to IBM Cloud Pak for Integration only:
    1. If not already logged in, log in to the Platform Navigator for your cluster.
    2. From the IBM Cloud Pak menu IBM Cloud Pak menu, click OpenShift Console and log in if prompted.
  2. Applicable to an IBM App Connect Operator deployment only: From a browser window, log in to the Red Hat OpenShift Container Platform web console.
  3. From the navigation, click Operators > Installed Operators.
  4. If required, select the namespace (project) in which you installed the IBM App Connect Operator.
  5. From the Installed Operators page, click IBM App Connect.
  6. From the Operator Details page for the App Connect Operator, click the App Connect Designer Authoring tab. Any previously created Designer instances are displayed in a table.
  7. Click Create DesignerAuthoring. Switch to the YAML view if necessary for a finer level of control over your installation settings. The minimum custom resource (CR) definition that is required to create a Designer instance is displayed.

    From the Details tab on the Operator Details page, you can also locate the App Connect Designer Authoring tile and click Create Instance to specify installation settings for the instance.

  8. Update the content of the YAML editor with the parameters and values that you require for this Designer instance.
    • To view the full set of parameters and values available, see Custom resource values.
      In the default parameters that are presented, be aware that a value is required for spec.couchdb.storage.class (and for spec.couchdb.storage.size) when spec.couchdb.storage.type is set to persistent-claim. The spec.couchdb.storage.class value must match a supported storage class for your cluster. (The Form view presents these classes in the Storage Class drop-down list.) 
      spec:
  couchdb:
    storage:
      class: 'storageClassValue'
      size: 10Gi
      type: persistent-claim
      Note: If you want to create and run callable flows in the Designer instance, you must configure the instance to use a switch server that you created earlier. For information about how to create a switch server, see App Connect Switch Server reference. Update the YAML to include the spec.switchServer.name parameter and set its value to the name of the switch server. For example:
      spec:
  switchServer:
    name: default
    • For licensing information, see Licensing reference for IBM App Connect Operator.
  9. Optional: If you prefer to use the Form view, click Form View and then complete the fields. Note that some fields might not be represented in the form.
    Tip:

    If you set the Connectors to use field to all (to enable both local and cloud-managed connectors), you must specify an IBM Cloud API key that provides access to the App Connect on IBM Cloud instance that hosts the cloud-managed connectors.

    You can either specify the IBM Cloud API key in the IBM Cloud API key field, or specify the name of a manually created secret, which stores the IBM Cloud API key, in the IBM Cloud API key secret field. For information about creating an IBM Cloud API key or secret, see Prerequisites. You can specify the key or secret in either of the following ways:

    • Specify the IBM Cloud API key to automatically generate a secret:
      1. Switch to the YAML view.
      2. Update the YAML settings to include the spec.ibmCloudAPIKeyValue parameter and set its value to the IBM Cloud API key. For example:
        spec:
   ibmCloudAPIKeyValue: abc_123
    • Specify the name of a manually created secret that stores the IBM Cloud API key:
      1. From the IBM Cloud API key drop-down list, select ProvideAsASecretInIBMCloudAPIKeySecret.
      2. In the IBM Cloud API key secret field, specify the name of the manually created secret that stores the IBM Cloud API key. For information about creating this secret, see Prerequisites.

    For information about the spec.ibmCloudAPIKeyValue and spec.ibmCloudAPIKeySecret parameters (which represent the IBM Cloud API key and IBM Cloud API key secret fields), see Custom resource values.

    When the Connectors to use field is set to all, you must also specify the instance identifier (spec.appConnectInstanceID) and endpoint (spec.appConnectURL) of the App Connect on IBM Cloud instance.

  10. Click Create to start the deployment. An entry for the Designer instance is shown in the DesignerAuthorings table, initially with a Pending status.
  11. Click the Designer instance name to view information about its definition and current status.

    On the Details tab of the page, the Conditions section reveals the progress of the deployment.

    Note: The UI URL field provides the URL for accessing the Designer instance. You can also locate this URL under Networking > Routes in the console navigation.

    Share this URL with users who have access to this namespace, and who will need to use the Designer instance to author flows.

    You can use the breadcrumb trail to return to the (previous) Operator Details page for the App Connect Operator. When the deployment is complete, the status is shown as Ready in the DesignerAuthorings table.

Creating an instance from the Red Hat OpenShift CLI

To create an App Connect Designer instance from the Red Hat OpenShift CLI, complete the following steps:

  1. From your local computer, create a YAML file that contains the configuration for the App Connect Designer instance that you want to create. Include the metadata.namespace parameter to identify the namespace in which you want to create the instance; this should be the same namespace where the other App Connect instances or resources are created.

    Example:

    apiVersion: appconnect.ibm.com/v1beta1
kind: DesignerAuthoring
metadata:
  name: des-mapast
  namespace: mynamespace
spec:
  couchdb:
    replicas: 1
    storage:
      class: ibmc-block-gold
      size: 10Gi
      type: persistent-claim
  designerFlowsOperationMode: all
  designerMappingAssist:
    enabled: true
  license:
    accept: true
    license: L-APEH-CEKET7
    use: AppConnectEnterpriseProduction
  useCommonServices: true
  version: 11.0.0-eus
  appConnectInstanceID: abcde123
  appConnectURL: 'https://firefly-api-prod.appconnect.ibmcloud.com'
  ibmCloudAPIKeyValue: 123456asdfg789hjklluiop
  replicas: 3
    • To view the full set of parameters and values that you can specify, see Custom resource values.
      In the default parameters that are presented, be aware that a value is required for spec.couchdb.storage.class (and for spec.couchdb.storage.size) when spec.couchdb.storage.type is set to persistent-claim. The spec.couchdb.storage.class value must match a supported storage class for your cluster. 
      spec:
  couchdb:
    storage:
      class: 'storageClassValue'
      size: 10Gi
      type: persistent-claim
      Note: If you want to create and run callable flows in the Designer instance, you must configure the instance to use a switch server that you created earlier. For information about how to create a switch server, see App Connect Switch Server reference. Update the YAML to include the spec.switchServer.name parameter and set its value to the name of the switch server. For example:
      spec:
  switchServer:
    name: default
    • For licensing information, see Licensing reference for IBM App Connect Operator
  2. Save this file with a .yaml extension; for example, designer_cr.yaml.
  3. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.
  4. Run the following command to create the App Connect Designer instance. (Use the name of the .yaml file that you created.)
    oc apply -f designer_cr.yaml
  5. Run the following command to check the status of the App Connect Designer instance and verify that it is ready:
    oc get designerauthorings -n namespace

    The output will also provide the URL of the Designer instance; for example:

    NAME         RESOLVEDVERSION   REPLICAS   CUSTOMIMAGES   STATUS    URL                                                                         AGE
des-mapast   11.0.0.18-r1-eus  3          false          Ready     https://des-mapast-designer-https-mynamespace.apps.acecc-abcde.icp4i.com   50m12s

    Share the URL value in the output with users who have access to this namespace, and who will need to use the Designer instance to author flows.

Deleting an instance

If no longer required, you can uninstall an App Connect Designer instance by deleting it. You can delete an instance from the IBM Cloud Pak for Integration Platform Navigator, or by using the Red Hat OpenShift web console or CLI.

Ensure that you have cluster administrator authority or have been granted the appropriate role-based access control (RBAC).

Delete options:

Deleting an instance from the IBM Cloud Pak for Integration Platform Navigator

To delete an App Connect Designer instance from the IBM Cloud Pak for Integration Platform Navigator, complete the following steps:

  1. From a browser window, log in to the IBM Cloud Pak for Integration Platform Navigator.
  2. On the Capabilities tab, search in the table to locate the App Connect Designer instance that you want to delete.
  3. Click the options icon (Options menu) for that row to open the options menu, and then click Delete.
  4. Confirm the deletion.

Deleting an instance from the Red Hat OpenShift web console

To delete an App Connect Designer instance by using the Red Hat OpenShift web console, complete the following steps:

  1. Applicable to IBM Cloud Pak for Integration only:
    1. If not already logged in, log in to the Platform Navigator for your cluster.
    2. From the IBM Cloud Pak menu IBM Cloud Pak menu, click OpenShift Console and log in if prompted.
  2. Applicable to an IBM App Connect Operator deployment only: From a browser window, log in to the Red Hat OpenShift Container Platform web console.
  3. From the navigation, click Operators > Installed Operators.
  4. If required, select the namespace (project) in which you installed the IBM App Connect Operator.
  5. From the Installed Operators page, click IBM App Connect.
  6. From the Operator Details page for the App Connect Operator, click the App Connect Designer Authoring tab.
  7. Locate the DesignerAuthoring instance that you want to delete.
  8. Click the options icon (Options menu) for that row to open the options menu, and then click the Delete option.
  9. Confirm the deletion.

Deleting an instance from the Red Hat OpenShift CLI

To delete an App Connect Designer instance from the Red Hat OpenShift CLI, complete the following steps:

  1. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.
  2. Run the following command to delete the App Connect Designer instance, where instanceName is the value of the metadata.name parameter.
    oc delete designerauthoring instanceName

Validation for custom resource values

  • IBM Common Services must be enabled for IBM Cloud Pak for Integration. (If using an IBM Cloud Pak licence, set useCommonServices: true.)
  • If using cloud-managed connectors (specified by using spec.designerFlowsOperationMode: all), the following parameters must all be set:
    • spec.appConnectInstanceID
    • spec.appConnectURL
    • spec.ibmCloudAPIKeyValue or spec.ibmCloudAPIKeySecret
  • Limits on length of name and namespace when creating resources: To allow for valid routes and child objects with names that are derived from the CR name, limit the length of the CR name:
    • If the namespace name is too long, routes will not work. The name value that you specify should be less than maxNameLength always.
    • DesignerAuthoring has a smaller maxNameLength than the other custom resources because it creates an integration server.
    • Allow 12 characters for suffixes that are added to child resources.
    • If a namespace name is 40 characters in length, then 10 characters are available for the CR name for DesignerAuthoring.
  • A storage class must be provided when using persistent storage.
  • The size, storage type, storage class, or storage size of the CouchDB cluster cannot be modified after creation.

Custom resource values

The following table lists the configurable parameters and default values for the custom resource.

Parameter Description Default

apiVersion

The API version that identifies which schema is used for this instance.

appconnect.ibm.com/v1beta1

kind

The resource type.

DesignerAuthoring

metadata.name

A unique short name by which the Designer instance can be identified.

metadata.namespace

The namespace (project) in which the Designer instance is installed.

The namespace in which you install must be no more than 40 characters in length.

spec.appConnectInstanceID

The instance identifier of the App Connect on IBM Cloud instance that hosts the cloud-managed connectors that will be used when running flows. For information about locating this value, see Prerequisites.

Required if spec.designerFlowsOperationMode is set to all.

spec.appConnectURL

The base URL that is associated with the region where the App Connect on IBM Cloud instance (which hosts the cloud-managed connectors) is provisioned. Specify the value that matches the region:

  • For the us-south or sydney region, specify https://firefly-api-prod.appconnect.ibmcloud.com.
  • For the eu-gb region, specify https://firefly-api-produk.eu-gb.appconnect.ibm.com.

Required if spec.designerFlowsOperationMode is set to all.

spec.couchdb.replicas

The number of replica pods to run between 1-10. (Optional)

3

spec.couchdb.resources.requests.cpu

The minimum required CPU core. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

100m

spec.couchdb.resources.requests.memory

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. (Optional)

128Mi

spec.couchdb.storage.class

CouchDB requires a persistent volume with ReadWriteOnce access mode. Specify a supported storage class for your cluster. If using IBM Cloud, set the storage class to ibmc-block-gold.

(Required if spec.couchdb.storage.type is set to persistent-claim.)

spec.couchdb.storage.size

Size of persistent volume for CouchDB. (Required if spec.couchdb.storage.type is set to persistent-claim.)

spec.couchdb.storage.type

Valid values are:

  • persistent-claim: Persistent claim storage is recommended for extra resilience. Retains the existing configuration, logs, and persistent messages when pods restart.
  • ephemeral: When using ephemeral storage, there is a risk that data might be lost when pods restart. Might typically be used when environments are created for demonstration.

spec.designerFlowsOperationMode

The set of connectors to use in the App Connect Designer instance:

  • local: Enable the use of locally deployed connectors only.
  • all: Enable the use of both cloud-managed and locally deployed connectors. To enable access to the cloud-managed connectors, you must also set the following parameters: spec.appConnectInstanceID, spec.appConnectURL, and either spec.ibmCloudAPIKeyValue or spec.ibmCloudAPIKeySecret.

local

spec.designerMappingAssist.enabled

Controls deployment of Mapping Assist components. (Optional)

Valid values are true and false.

spec.ibmCloudAPIKey

Deprecated: (Only applicable if spec.version resolves to 11.0.0.9-r3 or earlier)

Superseded by spec.ibmCloudAPIKeyValue.

The spec.ibmCloudAPIKey parameter is retained for backward compatibility only.

spec.ibmCloudAPIKeySecret

(Only applicable if spec.version resolves to 11.0.0.10-r1 or later)

The name of an auto-generated or manually created secret that stores the IBM Cloud API key, which provides access to your App Connect on IBM Cloud instance.

Required when spec.designerFlowsOperationMode is set to all, and spec.ibmCloudAPIKeyValue is either not specified or is set to ProvideAsASecretInIBMCloudAPIKeySecret.

The IBM Cloud API key needs to be stored in a secret to keep its value secure. You can either create your own secret, or have the IBM App Connect Operator create one for you:

  • If you specify an IBM Cloud API key in spec.ibmCloudAPIKeyValue (without manually creating a secret), when the Designer instance is created, a secret is automatically created to store the IBM Cloud API key and the secret name is assigned to spec.ibmCloudAPIKeySecret. The secret name is generated as instanceName-apikey-generatedCharacters, where instanceName is the metadata.name value. Also, spec.ibmCloudAPIKeyValue is then automatically updated to ProvideAsASecretInIBMCloudAPIKeySecret.
  • If spec.ibmCloudAPIKeyValue is unspecified or set to ProvideAsASecretInIBMCloudAPIKeySecret, you must create a secret to store the IBM Cloud API key, as described in Prerequisites. Assign this secret name to spec.ibmCloudAPIKeySecret.

spec.ibmCloudAPIKeyValue

(Only applicable if spec.version resolves to 11.0.0.10-r1 or later)

An IBM Cloud API key that is generated under the same IBM Cloud account as your App Connect on IBM Cloud instance. This key will be used to authenticate to that cloud instance. For information about generating an IBM Cloud API key, see Prerequisites.

Required when spec.designerFlowsOperationMode is set to all, and spec.ibmCloudAPIKeySecret is not specified.

If you specify an IBM Cloud API key in spec.ibmCloudAPIKeyValue (without manually creating a secret), when the Designer instance is created, a secret is automatically created to store the IBM Cloud API key and the secret name is assigned to spec.ibmCloudAPIKeySecret. The secret name is generated as instanceName-apikey-generatedCharacters, where instanceName is the metadata.name value. Also, spec.ibmCloudAPIKeyValue is then automatically updated to ProvideAsASecretInIBMCloudAPIKeySecret.

spec.imagePullSecrets.name

An optional list of references to secrets in the same namespace to use for pulling any of the images used. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of Docker, only DockerConfig type secrets are honored. For more information, see https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod.

spec.integrationServer.containers.connectors.image

(Only applicable if spec.version resolves to 11.0.0.10-r2 or earlier)

The path to the Docker image. (Optional)

spec.integrationServer.containers.connectors.imagePullPolicy

(Only applicable if spec.version resolves to 11.0.0.10-r2 or earlier)

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.integrationServer.containers.connectors.resources.limits.cpu

(Only applicable if spec.version resolves to 11.0.0.10-r2 or earlier)

The upper limit of CPU core. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.integrationServer.containers.connectors.resources.limits.memory

(Only applicable if spec.version resolves to 11.0.0.10-r2 or earlier)

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. (Optional)

512Mi

spec.integrationServer.containers.connectors.resources.requests.cpu

(Only applicable if spec.version resolves to 11.0.0.10-r2 or earlier)

The minimum required CPU core. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

250m

spec.integrationServer.containers.connectors.resources.requests.memory

(Only applicable if spec.version resolves to 11.0.0.10-r2 or earlier)

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. (Optional)

256Mi

spec.integrationServer.containers.designereventflows.image

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

The path to the Docker image. (Optional)

spec.integrationServer.containers.designereventflows.imagePullPolicy

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.integrationServer.containers.designereventflows.resources.limits.cpu

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

The upper limit of CPU core. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.integrationServer.containers.designereventflows.resources.limits.memory

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

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. (Optional)

512Mi

spec.integrationServer.containers.designereventflows.resources.requests.cpu

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

The minimum required CPU core. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

250m

spec.integrationServer.containers.designereventflows.resources.requests.memory

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

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. (Optional)

256Mi

spec.integrationServer.containers.designerflows.image

The path to the Docker image. (Optional)

spec.integrationServer.containers.designerflows.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.integrationServer.containers.designerflows.resources.limits.cpu

The upper limit of CPU core. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.integrationServer.containers.designerflows.resources.limits.memory

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. (Optional)

512Mi

spec.integrationServer.containers.designerflows.resources.requests.cpu

The minimum required CPU core. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

250m

spec.integrationServer.containers.designerflows.resources.requests.memory

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. (Optional)

256Mi

spec.integrationServer.containers.proxy.image

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

The path to the Docker image. (Optional)

spec.integrationServer.containers.proxy.imagePullPolicy

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.integrationServer.containers.proxy.resources.limits.cpu

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

The upper limit of CPU core. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.integrationServer.containers.proxy.resources.limits.memory

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

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.  (Optional)

1024Mi

spec.integrationServer.containers.proxy.resources.requests.cpu

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

The minimum required CPU core. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

100m

spec.integrationServer.containers.proxy.resources.requests.memory

(Only applicable if spec.version resolves to 11.0.0.10-r3-eus, 11.0.0.11-r1, or later)

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. (Optional)

256Mi

spec.integrationServer.containers.runtime.image

The path to the Docker image. (Optional)

spec.integrationServer.containers.runtime.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.integrationServer.containers.runtime.resources.limits.cpu

The upper limit of CPU core. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.integrationServer.containers.runtime.resources.limits.memory

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. (Optional)

1Gi

spec.integrationServer.containers.runtime.resources.requests.cpu

The minimum required CPU core. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

200m

spec.integrationServer.containers.runtime.resources.requests.memory

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. (Optional)

256Mi

spec.license.accept

An indication of whether the license should be accepted.

Valid values are true and false. To install, this value must be set to true.

false

spec.license.license

See Licensing reference for IBM App Connect Operator for the valid values.

spec.license.use

See Licensing reference for IBM App Connect Operator for the valid values.

If using an IBM Cloud Pak for Integration license, spec.useCommonServices must be set to true.

spec.pod.containers.connectorAuthService.image

The path to the Docker image. (Optional)

spec.pod.containers.connectorAuthService.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.pod.containers.connectorAuthService.livenessProbe.failureThreshold

The number of times the liveness probe (which checks whether the container is still running) can fail before taking action.

1

spec.pod.containers.connectorAuthService.livenessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the liveness probe, which checks whether the container is still running. Increase this value if your system cannot start the container in the default time period.

30

spec.pod.containers.connectorAuthService.livenessProbe.periodSeconds

How often (in seconds) to perform the liveness probe that checks whether the container is still running.

5

spec.pod.containers.connectorAuthService.livenessProbe.timeoutSeconds

How long (in seconds) before the liveness probe (which checks whether the container is still running) times out.

3

spec.pod.containers.connectorAuthService.readinessProbe.failureThreshold

The number of times the readiness probe (which checks whether the container is ready) can fail before taking action.

1

spec.pod.containers.connectorAuthService.readinessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the readiness probe, which checks whether the container is ready.

30

spec.pod.containers.connectorAuthService.readinessProbe.periodSeconds

How often (in seconds) to perform the readiness probe that checks whether the container is ready.

5

spec.pod.containers.connectorAuthService.readinessProbe.timeoutSeconds

How long (in seconds) before the readiness probe (which checks whether the container is ready) times out.

3

spec.pod.containers.connectorAuthService.resources.limits.cpu

The upper limit of CPU core that is allocated for running the connector auth service container. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.pod.containers.connectorAuthService.resources.limits.memory

The memory upper limit in bytes that is allocated for running the connector auth service container. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

1024Mi

spec.pod.containers.connectorAuthService.resources.requests.cpu

The minimum required CPU core that is allocated for running the connector auth service container. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

100m

spec.pod.containers.connectorAuthService.resources.requests.memory

The minimum memory in bytes that is allocated for running the connector auth service container. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

256Mi

spec.pod.containers.flowdocAuthoring.image

The path to the Docker image. (Optional)

spec.pod.containers.flowdocAuthoring.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.pod.containers.flowdocAuthoring.livenessProbe.failureThreshold

The number of times the liveness probe (which checks whether the container is still running) can fail before taking action.

1

spec.pod.containers.flowdocAuthoring.livenessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the liveness probe, which checks whether the container is still running. Increase this value if your system cannot start the container in the default time period.

30

spec.pod.containers.flowdocAuthoring.livenessProbe.periodSeconds

How often (in seconds) to perform the liveness probe that checks whether the container is still running.

5

spec.pod.containers.flowdocAuthoring.livenessProbe.timeoutSeconds

How long (in seconds) before the liveness probe (which checks whether the container is still running) times out.

3

spec.pod.containers.flowdocAuthoring.readinessProbe.failureThreshold

The number of times the readiness probe (which checks whether the container is ready) can fail before taking action.

1

spec.pod.containers.flowdocAuthoring.readinessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the readiness probe, which checks whether the container is ready.

30

spec.pod.containers.flowdocAuthoring.readinessProbe.periodSeconds

How often (in seconds) to perform the readiness probe that checks whether the container is ready.

5

spec.pod.containers.flowdocAuthoring.readinessProbe.timeoutSeconds

How long (in seconds) before the readiness probe (which checks whether the container is ready) times out.

3

spec.pod.containers.flowdocAuthoring.resources.limits.cpu

The upper limit of CPU core that is allocated for running the flow doc authoring container. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.pod.containers.flowdocAuthoring.resources.limits.memory

The memory upper limit in bytes that is allocated for running the flow doc authoring container. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

1024Mi

spec.pod.containers.flowdocAuthoring.resources.requests.cpu

The minimum required CPU core. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

100m

spec.pod.containers.flowdocAuthoring.resources.requests.memory

The minimum memory in bytes that is allocated for running the flow doc authoring container. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

256Mi

spec.pod.containers.flowTestManager.image

The path to the Docker image. (Optional)

spec.pod.containers.flowTestManager.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.pod.containers.flowTestManager.livenessProbe.failureThreshold

The number of times the liveness probe (which checks whether the container is still running) can fail before taking action.

1

spec.pod.containers.flowTestManager.livenessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the liveness probe, which checks whether the container is still running. Increase this value if your system cannot start the container in the default time period.

30

spec.pod.containers.flowTestManager.livenessProbe.periodSeconds

How often (in seconds) to perform the liveness probe that checks whether the container is still running.

5

spec.pod.containers.flowTestManager.livenessProbe.timeoutSeconds

How long (in seconds) before the liveness probe (which checks whether the container is still running) times out.

3

spec.pod.containers.flowTestManager.readinessProbe.failureThreshold

The number of times the readiness probe (which checks whether the container is ready) can fail before taking action.

1

spec.pod.containers.flowTestManager.readinessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the readiness probe, which checks whether the container is ready.

30

spec.pod.containers.flowTestManager.readinessProbe.periodSeconds

How often (in seconds) to perform the readiness probe that checks whether the container is ready.

5

spec.pod.containers.flowTestManager.readinessProbe.timeoutSeconds

How long (in seconds) before the readiness probe (which checks whether the container is ready) times out.

3

spec.pod.containers.flowTestManager.resources.limits.cpu

The upper limit of CPU core that is allocated for running the flow test manager container. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.pod.containers.flowTestManager.resources.limits.memory

The memory upper limit in bytes that is allocated for running the flow test manager container. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

1024Mi

spec.pod.containers.flowTestManager.resources.requests.cpu

The minimum required CPU core that is allocated for running the flow test manager container. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

100m

spec.pod.containers.flowTestManager.resources.requests.memory

The minimum memory in bytes that is allocated for running the flow test manager container. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

256Mi

spec.pod.containers.mappingAssist.image

The path to the Docker image. (Optional)

spec.pod.containers.mappingAssist.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.pod.containers.mappingAssist.livenessProbe.failureThreshold

The number of times the liveness probe (which checks whether the container is still running) can fail before taking action.

1

spec.pod.containers.mappingAssist.livenessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the liveness probe, which checks whether the container is still running. Increase this value if your system cannot start the container in the default time period.

30

spec.pod.containers.mappingAssist.livenessProbe.periodSeconds

How often (in seconds) to perform the liveness probe that checks whether the container is still running.

5

spec.pod.containers.mappingAssist.livenessProbe.timeoutSeconds

How long (in seconds) before the liveness probe (which checks whether the container is still running) times out.

3

spec.pod.containers.mappingAssist.readinessProbe.failureThreshold

The number of times the readiness probe (which checks whether the container is ready) can fail before taking action.

1

spec.pod.containers.mappingAssist.readinessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the readiness probe, which checks whether the container is ready.

30

spec.pod.containers.mappingAssist.readinessProbe.periodSeconds

How often (in seconds) to perform the readiness probe that checks whether the container is ready.

5

spec.pod.containers.mappingAssist.readinessProbe.timeoutSeconds

How long (in seconds) before the readiness probe (which checks whether the container is ready) times out.

3

spec.pod.containers.mappingAssist.resources.limits.cpu

The upper limit of CPU core that is allocated for running the Mapping Assist container. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

2300m

spec.pod.containers.mappingAssist.resources.limits.memory

The memory upper limit in bytes that is allocated for running the Mapping Assist container. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

2765Mi

spec.pod.containers.mappingAssist.resources.requests.cpu

The minimum required CPU core that is allocated for running the Mapping Assist container. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

800m

spec.pod.containers.mappingAssist.resources.requests.memory

The minimum memory in bytes that is allocated for running the Mapping Assist container. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

900Mi

spec.pod.containers.proxy.image

The path to the Docker image. (Optional)

spec.pod.containers.proxy.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.pod.containers.proxy.livenessProbe.failureThreshold

The number of times the liveness probe (which checks whether the container is still running) can fail before taking action.

1

spec.pod.containers.proxy.livenessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the liveness probe, which checks whether the container is still running. Increase this value if your system cannot start the container in the default time period.

60

spec.pod.containers.proxy.livenessProbe.periodSeconds

How often (in seconds) to perform the liveness probe that checks whether the container is still running.

5

spec.pod.containers.proxy.livenessProbe.timeoutSeconds

How long (in seconds) before the liveness probe (which checks whether the container is still running) times out.

3

spec.pod.containers.proxy.readinessProbe.failureThreshold

The number of times the readiness probe (which checks whether the container is ready) can fail before taking action.

1

spec.pod.containers.proxy.readinessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the readiness probe, which checks whether the container is ready.

5

spec.pod.containers.proxy.readinessProbe.periodSeconds

How often (in seconds) to perform the readiness probe that checks whether the container is ready.

5

spec.pod.containers.proxy.readinessProbe.timeoutSeconds

How long (in seconds) before the readiness probe (which checks whether the container is ready) times out.

3

spec.pod.containers.proxy.resources.limits.cpu

The upper limit of CPU core that is allocated for running the Designer proxy container. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.pod.containers.proxy.resources.limits.memory

The memory upper limit in bytes that is allocated for running the Designer proxy container. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

1024Mi

spec.pod.containers.proxy.resources.requests.cpu

The minimum required CPU core that is allocated for running the Designer proxy container. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

200m

spec.pod.containers.proxy.resources.requests.memory

The minimum memory in bytes that is allocated for running the Designer proxy container. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

256Mi

spec.pod.containers.runtime.image

The path to the Docker image. (Optional)

spec.pod.containers.runtime.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.pod.containers.runtime.livenessProbe.failureThreshold

The number of times the liveness probe (which checks whether the container is still running) can fail before taking action.

1

spec.pod.containers.runtime.livenessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the liveness probe, which checks whether the container is still running. Increase this value if your system cannot start the container in the default time period.

30

spec.pod.containers.runtime.livenessProbe.periodSeconds

How often (in seconds) to perform the liveness probe that checks whether the container is still running.

5

spec.pod.containers.runtime.livenessProbe.timeoutSeconds

How long (in seconds) before the liveness probe (which checks whether the container is still running) times out.

3

spec.pod.containers.runtime.readinessProbe.failureThreshold

The number of times the readiness probe (which checks whether the container is ready) can fail before taking action.

1

spec.pod.containers.runtime.readinessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the readiness probe, which checks whether the container is ready.

30

spec.pod.containers.runtime.readinessProbe.periodSeconds

How often (in seconds) to perform the readiness probe that checks whether the container is ready.

5

spec.pod.containers.runtime.readinessProbe.timeoutSeconds

How long (in seconds) before the readiness probe (which checks whether the container is ready) times out.

3

spec.pod.containers.runtime.resources.limits.cpu

The upper limit of CPU core that is allocated for running the Designer runtime container. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.pod.containers.runtime.resources.limits.memory

The memory upper limit in bytes that is allocated for running the Designer runtime container. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

1024Mi

spec.pod.containers.runtime.resources.requests.cpu

The minimum required CPU core that is allocated for running the Designer runtime container. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

100m

spec.pod.containers.runtime.resources.requests.memory

The minimum memory in bytes that is allocated for running the Designer runtime container. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

256Mi

spec.pod.containers.ui.image

The path to the Docker image. (Optional)

spec.pod.containers.ui.imagePullPolicy

corev1.PullPolicy

Valid values are Always, Never, and IfNotPresent. (Optional)

IfNotPresent

spec.pod.containers.ui.livenessProbe.failureThreshold

The number of times the liveness probe (which checks whether the container is still running) can fail before taking action.

1

spec.pod.containers.ui.livenessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the liveness probe, which checks whether the container is still running. Increase this value if your system cannot start the container in the default time period.

60

spec.pod.containers.ui.livenessProbe.periodSeconds

How often (in seconds) to perform the liveness probe that checks whether the container is still running.

30

spec.pod.containers.ui.livenessProbe.timeoutSeconds

How long (in seconds) before the liveness probe (which checks whether the container is still running) times out.

10

spec.pod.containers.ui.readinessProbe.failureThreshold

The number of times the readiness probe (which checks whether the container is ready) can fail before taking action.

1

spec.pod.containers.ui.readinessProbe.initialDelaySeconds

How long to wait (in seconds) before starting the readiness probe, which checks whether the container is ready.

60

spec.pod.containers.ui.readinessProbe.periodSeconds

How often (in seconds) to perform the readiness probe that checks whether the container is ready.

2

spec.pod.containers.ui.readinessProbe.timeoutSeconds

How long (in seconds) before the readiness probe (which checks whether the container is ready) times out.

10

spec.pod.containers.ui.resources.limits.cpu

The upper limit of CPU core that is allocated for running the Designer UI container. Specify integers, fractions (for example, 0.5), or millicores values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

1

spec.pod.containers.ui.resources.limits.memory

The memory upper limit in bytes that is allocated for running the Designer UI container. Specify integers with suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

1024Mi

spec.pod.containers.ui.resources.requests.cpu

The minimum required CPU core that is allocated for running the Designer UI container. Specify integers, fractions (for example, 0.5), or millicore values (for example, 100m, where 100m is equivalent to .1 core). (Optional)

100m

spec.pod.containers.ui.resources.requests.memory

The minimum memory in bytes that is allocated for running the Designer UI container. Specify integers with one of these suffixes: E, P, T, G, M, K, or power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki. (Optional)

256Mi

spec.replicas

The number of replica pods to run for each deployment. A number between 1-10. (Optional)

3

spec.switchServer.name

The name of an existing switch server that was created to configure secure connectivity when running callable flows in the Designer instance. For information about how to create a switch server, see App Connect Switch Server reference.

 

spec.useCommonServices

An indication of whether to enable use of IBM Cloud Pak foundational services (previously IBM Cloud Platform Common Services). (Optional)

Valid values are true and false.

Must be set to true if using an IBM Cloud Pak for Integration license (specified via spec.license.use).

true

spec.version

The product version that the Designer instance is based on. Can be specified by using a channel or as a fully qualified version. If you specify a channel, you must ensure that the license aligns with the latest available version of the IBM App Connect Operator. (Optional)

To view the available values that you can choose from, see spec.version values.

Restriction: If you are using IBM App Connect Operator 1.1.4 or later, which installs Operator for Apache CouchDB 2.0.x or later by default, only a spec.version value that resolves to 11.0.0.14-r1-eus or later is supported for App Connect Designer.

11.0.0

Storage

When creating a Designer Authoring instance (kind=DesignerAuthoring), the custom resource settings must include details of the storage type that should be used (either persistent-claim or ephemeral). Persistent claim storage is recommended for extra resilience. When using ephemeral storage, there is a risk that data might be lost when pods restart.

Persistent storage

Persistent storage can be attached by specifying the spec.couchdb.storage.class parameter. To work with the CouchDB Operator, storage classes must support the following modes:

  • Dynamic volume provisioning
  • ReadWriteOnce (RWO) access modes
  • volumeBindingMode: WaitForFirstConsumer (zone-local storage)
  • POSIX filesystem compatibility (for example, not NFS)
This maps to the following preferred options for common public cloud environments:
Provider Type Storage class Documentation
IBM Cloud IBM Block Storage ibm-block-* Documentation
AWS Elastic Block Storage aws-ebs Documentation
Azure Azure Disk default or managed-premium Documentation

For Google Compute Engine (GCE), Persistent Disk can be used, but a storage class must be manually created to support dynamic provisioning.

For more information about persistent volumes, see http://kubernetes.io/docs/user-guide/persistent-volumes/.

Limitations

Supports only the amd64 CPU architecture. For more information, see Supported platforms.