Merge pull request #10886 from adellape/custom_error_apb

Add custom error msg for APB

Author: adellape

apb_devel/writing/reference.adoc

@@ -821,3 +821,45 @@ mounted into a pod as a volume:
             - key: haste-config
               path: config.js
 ----
+
+[[apb-devel-writing-ref-custom-error-msg]]
+== Customizing Error Messages
+
+A default error message is returned in the web console when a provision call
+fails. For example:
+
+----
+Error occurred during provision. Please contact administrator if the issue persists.
+----
+
+To provide more information for troubleshooting purposes should a failure occur,
+you can write custom error messages for your APB that the web console can check
+for and return to the user.
+
+Kubernetes allows pods to log fatal events to a termination log. The log file
+location is set by the `terminationMessagePath` field in a pod's specification
+and defaults to *_/dev/termination-log_*.
+
+Starting in {product-title} 3.10, the broker now checks this termination log for
+any messages that have been written to the file and passes the content to the
+service catalog. The web console then displays any such messages found in the
+event of a failure.
+
+[NOTE]
+====
+See
+link:https://kubernetes.io/docs/tasks/debug-application-cluster/determine-reason-pod-failure/[Kubernetes documentation] for more details on pod termination messages.
+====
+
+The following is an example of how this can be done in an APB utilizing a
+CloudFormation template:
+
+----
+- name: Writing Termination Message
+  shell: echo "[CloudFormation Error] - {{ ansible_failed_result.msg }}" > /dev/termination-log
+
+- fail: msg="[APB Failed Plain - '{{ _apb_plan_id }}'] "
+----
+
+If an error occurs, this example custom message is written to the default
+termination log path before it fails the pod.