Automation assets deployment by using the CLI

Use the CLI to deploy IBM Automation foundation assets (Automation assets), an instance type in IBM Cloud Pak® for Integration that lets you store, manage, and retrieve integration assets.

Before you begin

Complete these prerequisites before you create an Automation assets instance. An OpenShift cluster administrator should carry out the following tasks (for more information, see OpenShift roles and permissions):

Deploying the Automation assets instance by using a block storage class

Important: For high availability and disaster recovery with RWO volumes, the failover characteristics depend on your storage provider. For example, if you’re using EBS in AWS (to avoid using a replicated storage provider, such as ODF), then using EBS restricts you to a single availability zone (AZ). This architecture prevents Automation assets from starting up in a different AZ in the event of a failure. You could lose your Automation assets instance, unless you’ve backed it up separately and can restore a new instance from the backup.
  1. To create an Automation assets instance by using block storage class in single replica mode, create a file called aa-instance.yaml:

    apiVersion: integration.ibm.com/v1beta1
    kind: AssetRepository
    metadata:
      name: production
      namespace: cp4i
      labels:
        backup.integration.ibm.com/component: assetrepository
    spec:
      designerAIFeatures:
        enabled: true
      license:
        accept: true
        license: L-QYVA-B365MB
      replicas: 1
      singleReplicaOnly: true
      storage:
        assetDataVolume:
          class: <RWO_STORAGE_CLASS>
        couchVolume:
          class: <RWO_STORAGE_CLASS>
      version: 4.1
  2. In the aa-instance.yaml file, update these fields as indicated:

    • metadata.name - enter a name for the new instance, or use the default.

    • metadata.namespace - enter the namespace in which to deploy the instance.

    • spec.license.license - keep the default value, unless you change the value for spec.version. For more information about specific license versions, see "Table of license versions" in Licensing.

    • spec.designerAIFeatures.enabled - if you do not wish to have AI features enabled, set to false.

    • spec.storage.assetDataVolume and spec.storage.couchVolume - configure the storage class for each. Replace <RWO_STORAGE_CLASS> with a block storage class that supports ReadWriteOnce (RWO) volumes. For more information, see Storage considerations.

    For additional configuration options, see Configuring Automation assets.

  3. After you edit the Kubernetes resource, apply it to the OpenShift cluster:

    oc apply -f aa-instance.yaml

Deploying the Automation assets instance with a file storage class

  1. To create an Automation assets instance using file storage class in scalable mode, create a file called aa-instance.yaml:

    apiVersion: integration.ibm.com/v1beta1
    kind: AssetRepository
    metadata:
      name: production
      namespace: cp4i
      labels:
        backup.integration.ibm.com/component: assetrepository     
    spec:
      designerAIFeatures:
        enabled: true
      license:
        accept: true
        license: L-QYVA-B365MB
      replicas: 1
      storage:
        assetDataVolume:
          class: <RWX_STORAGE_CLASS>
        couchVolume:
          class: <RWO_STORAGE_CLASS>
      version: 4.1
  2. In the aa-instance.yaml file, update these fields as indicated:

    • metadata.name - enter a name for the new instance, or use the default.

    • metadata.namespace - enter the namespace in which to deploy the instance.

    • spec.license.license - keep the default value, unless you change the value for spec.version. For more information about specific license versions, see "Table of license versions" in Licensing.

    • spec.designerAIFeatures.enabled - if you do not wish to have AI features enabled, set to false.

    • spec.storage.assetDataVolume - configure the storage class. Replace <RWX_STORAGE_CLASS> with a file storage class that supports ReadWriteMany (RWX) volumes. For more information, see Storage considerations.

    • spec.storage.couchVolume - configure the storage class. Replace <RWO_STORAGE_CLASS> with a block storage class that supports ReadWriteOnce (RWO) volumes. For more information, see Storage considerations.

    For additional configuration options, see Using Automation assets.

  3. After you edit the Kubernetes resource, apply it to the OpenShift cluster:

    oc apply -f aa-instance.yaml

Troubleshooting

For information about known issues, workarounds, and troubleshooting information, see Known Limitations.