quickstarts

Author: jschuler

examples/test.didact.yaml

@@ -0,0 +1,64 @@
+metadata:
+  name: add-healthchecks
+spec:
+  displayName: Adding health checks to your sample application
+  durationMinutes: 10
+  icon: ''
+  description: You just created a sample application. Now, let’s add health checks
+    to it.
+  prerequisites: [You completed the "Getting started with a sample" quick start.]
+  introduction: |-
+    ### This quick start shows you how to add health checks to your sample application.
+    You should have previously created the **sample-app** application and **nodejs-sample** deployment using the **Get started with a sample** quick start. If you haven't, you may be able to follow these tasks with any existing deployment without configured health checks.
+  tasks:
+    - title: Viewing the details of your sample application
+      description: |-
+        ### To view the details of your sample application:
+        1. Go to the project your sample application was created in.
+        2. In the **</> Developer** perspective, go to **Topology**.
+        3. Click on the **nodejs-sample** deployment to view its details.
+
+        A side panel is displayed containing the details of your sample application.
+      review:
+        instructions: |-
+          #### To verify you are viewing the details of your sample application:
+          Is the side panel titled **nodejs-sample**?
+        failedTaskHelp: This task isn’t verified yet. Try the task again.
+      summary:
+        success: You have viewed the details of your sample app!
+        failed: Try the steps again.
+    - title: Verifying that there are no health checks
+      description: |-
+        ### To verify that there your sample application has no health checks configured:
+        1. View the information in the **Resources** tab in the side panel.
+      review:
+        instructions: |-
+          #### To verify there are no health checks configured:
+          Do you see an inline alert stating that **nodejs-sample** does not have health checks?
+        failedTaskHelp: This task isn’t verified yet. Try the task again.
+      summary:
+        success: You have verified that there are no existing health checks!
+        failed: Try the steps again.
+    - title: Adding health checks to your sample
+      description: |-
+        ### To add health checks to your sample:
+        1. Add health checks to your **nodejs-sample** deployment in one of the following ways: (a) On the side panel, click on the **Actions** menu, where you will see an **Add Health Checks** menu item or (b) Click on the **Add Health Checks** link on the inline notification in the side panel.
+        2. In the Add Health Checks form, click on the **Add Readiness Probe** link.  Leave the default values, and click on the check to add the Readiness Probe.
+        3. Click on the **Add Liveness Probe** link.  Leave the default values, and click on the check to add the Liveness Probe.
+        4. Click on the **Add Startup Probe** link.  Leave the default values, and click on the check to add the Startup Probe.
+        5. Click **Add** when you’re done.
+
+        You will be brought back to the Topology View.
+      review:
+        instructions: |-
+          #### Verify that health checks are now configured:
+          Is the inline notification gone?
+        failedTaskHelp:
+          This task isn’t verified yet. Try the task again, or [read more](https://docs.openshift.com/container-platform/4.6/applications/application-health.html#odc-adding-health-checks)
+          about this topic.
+      summary:
+        success: You have added health checks to your sample app!
+        failed: Try the steps again.
+  conclusion: Your sample application now has health checks. To ensure that your application
+    is running correctly, take the **Monitor your sample application** quick start.
+  nextQuickStart: [template-id]