Enabling feedback from Runtime environment

When you configure the feedback loop in distributed mode, the training results from the Runtime environment are pushed to the Authoring environment.

About this task

If you are working exclusively in an Authoring environment and your projects are not published to the Runtime environment yet, set up the runtime feedback function. For more information about the ADP parameters that are involved, see IBM Automation Document Processing parameters.

Procedure

To enable the runtime feedback function, set the runtime_feedback.enabled parameter to true in the CR yaml file.

Set runtime_feedback.runtime_type to sandbox.

This example is a subset of the CR yaml configuration in the Authoring environment.

spec:
  shared_configuration:
    sc_deployment_patterns: document_processing
    sc_optional_components: document_processing_designer
  ca_configuration:
    global:
      runtime_feedback:
        enabled: true
        runtime_type: "sandbox"

The feedback capability introduces the ability for a remote Runtime environment to provide feedback to the Authoring environment. The feedback feature is essentially working in distributed mode. When the Runtime environment deploys successfully, enable the feedback loop in distributed mode. When the configuration completes, the training result from the Runtime environment is pushed to the Authoring environment. Currently the mapping between the Authoring and the Runtime environment is 1:1.

The next steps require that you configure the feedback look in distributed mode.

Make sure that the secret that contains the TLS certificate for the Authoring environment is created on the Runtime environment. Also, check that the value for repo_service_url is correct in the CR yaml file. For more information, see Importing the Zen route certificate to the runtime environment.
In your Authoring environment, log in to the IBM Foundational Service Platform UI as the user in the captureadmins or projectadmins group. Create an API key. For more details about how to create the API key, see Generating API keys for authentication.
In your Runtime environment, create the secret with the information from Step 4.
```
oc create secret generic aca-design-api-key --from-literal=ZenApiKey=<username:APIkey>
```
Where username is the Document Processing username, and APIKey is the API key that is created in Step 4.
Note: You can update the secret with a new API key if necessary. The pods are restarted to pick up the new credential.

Update the CR yaml file in the Runtime environment with the following parameters.

spec:
  shared_configuration:
    sc_deployment_patterns: document_processing
    sc_optional_components: document_processing_runtime
  ca_configuration:
    global:
      runtime_feedback:
        enabled: true
        runtime_type: "distributed"
        design_api_secret: "aca-design-api-key" # Secret created in step 5 above
        design_tls_secret: "cdra-tls-secret" # Design TLS secret created in step 3 above.