Merge pull request #4 from ibm-cloud-architecture/bck-updates

Bck updates - creation of grid cards
ibm-cloud-architecture · Jul 31, 2024 · f395476 · f395476
2 parents 971af53 + 02fefee
commit f395476
Show file tree

Hide file tree

Showing 5 changed files with 248 additions and 28 deletions.
diff --git a/docs/openshift/pods/health-checks/index.md b/docs/openshift/pods/health-checks/index.md
@@ -20,15 +20,47 @@ The kubelet can optionally perform and react to three kinds of probes on running
 
 === "OpenShift"
 
-    [Application Health :fontawesome-solid-heart-pulse:](https://docs.openshift.com/container-platform/4.14/applications/application-health.html){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
 
-    [Virtual Machine Health :fontawesome-solid-heart-pulse:](https://docs.openshift.com/container-platform/4.14/virt/logging_events_monitoring/virt-monitoring-vm-health.html){ .md-button target="_blank"}
+      -   :fontawesome-solid-heart-pulse:{ .lg .middle } __Application Health__
+
+          ---
+
+          A health check periodically performs diagnostics on a running container using any combination of the readiness, liveness, and startup health checks.
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.14/applications/application-health.html){ target="_blank"}
+
+      -   :fontawesome-solid-vr-cardboard:{ .lg .middle } __Virtual Machine Health__
+
+          ---
+
+          Use readiness and liveness probes to detect and handle unhealthy virtual machines (VMs).
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-monitoring-vm-health.html){ target="_blank"}
+
+    </div>
 
 === "Kubernetes"
 
-    [Container Probes :fontawesome-solid-heart-pulse:](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-stethoscope:{ .lg .middle } __Container Probes__
+
+          ---
+
+          To perform a diagnostic, the kubelet either executes code within the container, or makes a network request.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes){ target="_blank"}
 
-    [Configure Probes :fontawesome-solid-heart-pulse:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/){ .md-button target="_blank"}
+      -   :fontawesome-solid-pen-to-square:{ .lg .middle } __Configure Probes__
+
+          ---
+
+          Read about how to configure liveness, readiness and startup probes for containers.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/){ target="_blank"}
+
+    </div>
 
 ### References
 
@@ -80,15 +112,47 @@ Kubernetes provides no native storage solution for log data, but you can integra
 
 === "OpenShift"
 
-    [Logs Command :fontawesome-solid-file-lines:](https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/developer-cli-commands.html){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-terminal:{ .lg .middle } __Logs Command__
+
+          ---
+
+          Read about the descriptions and example commands for OpenShift CLI (`oc`) developer commands.
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/developer-cli-commands.html){ target="_blank"}
+
+      -   :fontawesome-solid-circle-nodes:{ .lg .middle } __Cluster Logging__
+
+          ---
+
+          As a cluster administrator, you can deploy logging on an OpenShift Container Platform cluster, and use it to collect and aggregate node system audit logs, application container logs, and infrastructure logs.
 
-    [Cluster Logging :fontawesome-solid-file-lines:](https://docs.openshift.com/container-platform/4.13/logging/cluster-logging.html){ .md-button target="_blank"}
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/logging/cluster-logging.html){ target="_blank"}
 
-    [Logging Collector :fontawesome-solid-file-lines:](https://docs.openshift.com/container-platform/4.13/logging/config/cluster-logging-collector.html){ .md-button target="_blank"}
+      -   :fontawesome-solid-file-lines:{ .lg .middle } __Logging Collector__
+
+          ---
+
+          The collector collects log data from each node, transforms the data, and forwards it to configured outputs.
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/observability/logging/cluster-logging.html#logging-architecture-overview_cluster-logging){ target="_blank"}
+
+    </div>
 
 === "Kubernetes"
 
-    [Logging :fontawesome-solid-file-lines:](https://kubernetes.io/docs/concepts/cluster-administration/logging/){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-file-lines:{ .lg .middle } __Logging__
+
+          ---
+
+          Application logs can help you understand what is happening inside your application and are particularly useful for debugging problems and monitoring cluster activity.
+
+          [:octicons-arrow-right-24: Getting started](https://kubernetes.io/docs/concepts/cluster-administration/logging/){ target="_blank"}
+
+    </div>
 
 ### References
 
@@ -141,13 +205,39 @@ Prometheus, a CNCF project, can natively monitor Kubernetes, nodes, and Promethe
 
 === "OpenShift"
 
-    [Monitoring Application Health :fontawesome-solid-binoculars:](https://docs.openshift.com/container-platform/4.13/applications/application-health.html){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-binoculars:{ .lg .middle } __Monitoring Application Health__
+
+          ---
+
+          OpenShift Container Platform applications have a number of options to detect and handle unhealthy containers.
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/applications/application-health.html){ target="_blank"}
+
+    </div>
 
 === "Kubernetes"
 
-    [Monitoring Resource Usage :fontawesome-solid-binoculars:](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-magnifying-glass:{ .lg .middle } __Monitoring Resource Usage__
+
+          ---
+
+          You can examine application performance in a Kubernetes cluster by examining the containers, pods, services, and the characteristics of the overall cluster.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/){ target="_blank"}
+
+      -   :fontawesome-brands-sourcetree:{ .lg .middle } __Resource Metrics__
+
+          ---
+
+          For Kubernetes, the Metrics API offers a basic set of metrics to support automatic scaling and similar use cases.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-metrics-pipeline/){ target="_blank"}
 
-    [Resource Metrics :fontawesome-solid-binoculars:](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-metrics-pipeline/){ .md-button target="_blank"}
+    </div>
 
 ### References
 

diff --git a/docs/openshift/pods/index.md b/docs/openshift/pods/index.md
@@ -8,19 +8,63 @@ A Pod encapsulates an application’s container (or, in some cases, multiple con
 
 === "OpenShift"
 
-    [About Pods :fontawesome-solid-globe:](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-using.html){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
 
-    [Cluster Configuration for Pods :fontawesome-solid-globe:](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-configuring.html){ .md-button target="_blank"}
+      -   :fontawesome-solid-book:{ .lg .middle } __About Pods__
 
-    [Pod Autoscaling :fontawesome-solid-globe:](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-autoscaling.html){ .md-button target="_blank"}
+          ---
+
+          Learn more about the basics of _pods_ and how they work.
+
+          [:octicons-arrow-right-24: Getting started](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-using.html){ target="_blank"}
+
+      -   :fontawesome-solid-globe:{ .lg .middle } __Cluster Configuration for Pods__
+
+          ---
+
+          Configure your cluster to work for your specific needs.
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-configuring.html){ target="_blank"}
+
+      -   :fontawesome-solid-up-right-and-down-left-from-center:{ .lg .middle } __Pod Autoscaling__
+
+          ---
+
+          Use a horizontal pod autoscaler (HPA) to specify how OCP should automatically scale up or down your deployment.
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-autoscaling.html){ target="_blank"}
+
+    </div>
 
 === "Kubernetes"
 
-    [Pod Overview :fontawesome-solid-globe:](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/){ .md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-book:{ .lg .middle } __Pod Overview__
+
+          ---
+
+          Learn more about the basics of _pods_ and how they work.
+
+          [:octicons-arrow-right-24: Getting started](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/){ target="_blank"}
+
+      -   :fontawesome-solid-arrows-spin:{ .lg .middle } __Pod Lifecycle__
+
+          ---
+
+          Read about the lifecycle process for pods and what each phase means.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/){ target="_blank"}
+
+      -   :fontawesome-solid-globe:{ .lg .middle } __Pod Usage__
+
+          ---
+
+          How do you use pods? Read about it here.
 
-    [Pod Lifecycle :fontawesome-solid-globe:](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/){ .md-button target="_blank"}
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/workloads/pods/pod/){ target="_blank"}
 
-    [Pod Usage :fontawesome-solid-globe:](https://kubernetes.io/docs/concepts/workloads/pods/pod/){ .md-button target="_blank"}
+    </div>
 
 ## References
 

diff --git a/docs/openshift/pods/multi-container/index.md b/docs/openshift/pods/multi-container/index.md
@@ -6,13 +6,41 @@ Container images solve many real-world problems with existing packaging and depl
 
 === "Kubernetes"
 
-    [Sidecar Logging :fontawesome-solid-boxes-stacked:](https://kubernetes.io/docs/concepts/cluster-administration/logging/#using-a-sidecar-container-with-the-logging-agent){.md-button target="_blank"}
+    <div class="grid cards" markdown>
 
-    [Shared Volume Communication :fontawesome-solid-boxes-stacked:](https://kubernetes.io/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume/){.md-button target="_blank"}
+      -   :fontawesome-solid-file-lines:{ .lg .middle } __Sidecar Logging__
 
-    [Toolkit Patterns :fontawesome-solid-boxes-stacked:](https://kubernetes.io/blog/2015/06/the-distributed-system-toolkit-patterns/){.md-button target="_blank"}
+          ---
 
-    [Brendan Burns Paper :fontawesome-solid-boxes-stacked:](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/45406.pdf){.md-button target="_blank"}
+          Application logs can help you understand what is happening inside your application.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/cluster-administration/logging/#using-a-sidecar-container-with-the-logging-agent){ target="_blank"}
+
+      -   :fontawesome-solid-circle-nodes:{ .lg .middle } __Shared Volume Communication__
+
+          ---
+
+          Read about how to use a Volume to communicate between two Containers running in the same Pod.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume/){ target="_blank"}
+
+      -   :fontawesome-solid-blog:{ .lg .middle } __Toolkit Patterns__
+
+          ---
+
+          Read Brendan Burns' blog post about "The Distributed System ToolKit: Patterns for Composite Containers".
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/blog/2015/06/the-distributed-system-toolkit-patterns/){ target="_blank"}
+
+      -   :fontawesome-solid-user:{ .lg .middle } __Brendan Burns Paper__
+
+          ---
+
+          Read Brendan Burns' paper about design patterns for container-based distributed systems.
+
+          [:octicons-arrow-right-24: Learn more](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/45406.pdf){ target="_blank"}
+
+    </div>
 
 ## References
 

diff --git a/docs/openshift/pods/tagging/index.md b/docs/openshift/pods/tagging/index.md
@@ -10,13 +10,39 @@ You can use either labels or annotations to attach metadata to Kubernetes object
 
 === "OpenShift"
 
-    [CLI Label Commands :fontawesome-solid-tags:](https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/developer-cli-commands.html){.md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-comment-dots:{ .lg .middle } __CLI Label Commands__
+
+          ---
+
+          Read about the descriptions and example commands for OpenShift CLI (`oc`) developer commands.
+
+          [:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/developer-cli-commands.html){ target="_blank"}
+
+    </div>
 
 === "Kubernetes"
 
-    [Labels :fontawesome-solid-tags:](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/){.md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-tags:{ .lg .middle } __Labels__
+
+          ---
+
+          Labels can be used to organize and to select subsets of objects.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/){ target="_blank"}
+
+      -   :fontawesome-solid-note-sticky:{ .lg .middle } __Annotations__
+
+          ---
+
+          You can use Kubernetes annotations to attach arbitrary non-identifying metadata to objects.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/){ target="_blank"}
 
-    [Annotations :fontawesome-solid-tags:](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/){.md-button target="_blank"}
+    </div>
 
 ## References
 

diff --git a/docs/openshift/pods/troubleshooting/index.md b/docs/openshift/pods/troubleshooting/index.md
@@ -8,15 +8,47 @@ Usually is getting familiar with how primitives objects interact with each other
 
 === "OpenShift"
 
-     [Debugging with ODO :fontawesome-solid-bug:](https://odo.dev/docs/user-guides/advanced/debugging-with-openshift-toolkit){.md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-bug:{ .lg .middle } __Debugging ODO__
+
+          ---
+
+          OpenShift Toolkit is an IDE plugin available on VS Code and JetBrains IDEs, that allows you to do all things that [`odo`](https://odo.dev/docs/introduction){ target="_blank"} does, i.e. create, test, debug and deploy cloud-native applications on a cloud-native environment in simple steps.
+
+          [:octicons-arrow-right-24: Getting started](https://odo.dev/docs/user-guides/advanced/debugging-with-openshift-toolkit){ target="_blank"}
+
+    </div>
 
 === "Kubernetes"
 
-     [Debugging Applications :fontawesome-solid-bug:](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application/){.md-button target="_blank"}
+    <div class="grid cards" markdown>
+
+      -   :fontawesome-solid-bug:{ .lg .middle } __Debugging Applications__
+
+          ---
+
+          Read about how to debug applications that are deployed into Kubernetes and not behaving correctly.
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application/){ target="_blank"}
+
+      -   :fontawesome-solid-bug:{ .lg .middle } __Debugging Services__
+
+          ---
+
+          You've run your Pods through a Deployment and created a Service, but you get no response when you try to access it. What do you do?
+
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-service/){ target="_blank"}
+
+      -   :fontawesome-solid-bug:{ .lg .middle } __Debugging Replication Controllers__
+
+          ---
+
+          Read about how to debug replication controllers that are deployed into Kubernetes and not behaving correctly.
 
-     [Debugging Services :fontawesome-solid-bug:](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-service/){.md-button target="_blank"}
+          [:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug/debug-application/debug-pods/#debugging-replication-controllers){ target="_blank"}
 
-     [Debugging Replication Controllers :fontawesome-solid-bug:](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-pod-replication-controller/){.md-button target="_blank"}
+    </div>
 
 ## References