Skip to content

Commit f395476

Browse files
authored
Merge pull request #4 from ibm-cloud-architecture/bck-updates
Bck updates - creation of grid cards
2 parents 971af53 + 02fefee commit f395476

File tree

5 files changed

+248
-28
lines changed

5 files changed

+248
-28
lines changed

docs/openshift/pods/health-checks/index.md

Lines changed: 101 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,47 @@ The kubelet can optionally perform and react to three kinds of probes on running
2020

2121
=== "OpenShift"
2222

23-
[Application Health :fontawesome-solid-heart-pulse:](https://docs.openshift.com/container-platform/4.14/applications/application-health.html){ .md-button target="_blank"}
23+
<div class="grid cards" markdown>
2424

25-
[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"}
25+
- :fontawesome-solid-heart-pulse:{ .lg .middle } __Application Health__
26+
27+
---
28+
29+
A health check periodically performs diagnostics on a running container using any combination of the readiness, liveness, and startup health checks.
30+
31+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.14/applications/application-health.html){ target="_blank"}
32+
33+
- :fontawesome-solid-vr-cardboard:{ .lg .middle } __Virtual Machine Health__
34+
35+
---
36+
37+
Use readiness and liveness probes to detect and handle unhealthy virtual machines (VMs).
38+
39+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-monitoring-vm-health.html){ target="_blank"}
40+
41+
</div>
2642

2743
=== "Kubernetes"
2844

29-
[Container Probes :fontawesome-solid-heart-pulse:](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes){ .md-button target="_blank"}
45+
<div class="grid cards" markdown>
46+
47+
- :fontawesome-solid-stethoscope:{ .lg .middle } __Container Probes__
48+
49+
---
50+
51+
To perform a diagnostic, the kubelet either executes code within the container, or makes a network request.
52+
53+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes){ target="_blank"}
3054

31-
[Configure Probes :fontawesome-solid-heart-pulse:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/){ .md-button target="_blank"}
55+
- :fontawesome-solid-pen-to-square:{ .lg .middle } __Configure Probes__
56+
57+
---
58+
59+
Read about how to configure liveness, readiness and startup probes for containers.
60+
61+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/){ target="_blank"}
62+
63+
</div>
3264

3365
### References
3466

@@ -80,15 +112,47 @@ Kubernetes provides no native storage solution for log data, but you can integra
80112
81113
=== "OpenShift"
82114
83-
[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"}
115+
<div class="grid cards" markdown>
116+
117+
- :fontawesome-solid-terminal:{ .lg .middle } __Logs Command__
118+
119+
---
120+
121+
Read about the descriptions and example commands for OpenShift CLI (`oc`) developer commands.
122+
123+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/developer-cli-commands.html){ target="_blank"}
124+
125+
- :fontawesome-solid-circle-nodes:{ .lg .middle } __Cluster Logging__
126+
127+
---
128+
129+
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.
84130

85-
[Cluster Logging :fontawesome-solid-file-lines:](https://docs.openshift.com/container-platform/4.13/logging/cluster-logging.html){ .md-button target="_blank"}
131+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/logging/cluster-logging.html){ target="_blank"}
86132

87-
[Logging Collector :fontawesome-solid-file-lines:](https://docs.openshift.com/container-platform/4.13/logging/config/cluster-logging-collector.html){ .md-button target="_blank"}
133+
- :fontawesome-solid-file-lines:{ .lg .middle } __Logging Collector__
134+
135+
---
136+
137+
The collector collects log data from each node, transforms the data, and forwards it to configured outputs.
138+
139+
[: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"}
140+
141+
</div>
88142

89143
=== "Kubernetes"
90144

91-
[Logging :fontawesome-solid-file-lines:](https://kubernetes.io/docs/concepts/cluster-administration/logging/){ .md-button target="_blank"}
145+
<div class="grid cards" markdown>
146+
147+
- :fontawesome-solid-file-lines:{ .lg .middle } __Logging__
148+
149+
---
150+
151+
Application logs can help you understand what is happening inside your application and are particularly useful for debugging problems and monitoring cluster activity.
152+
153+
[:octicons-arrow-right-24: Getting started](https://kubernetes.io/docs/concepts/cluster-administration/logging/){ target="_blank"}
154+
155+
</div>
92156

93157
### References
94158

@@ -141,13 +205,39 @@ Prometheus, a CNCF project, can natively monitor Kubernetes, nodes, and Promethe
141205

142206
=== "OpenShift"
143207

144-
[Monitoring Application Health :fontawesome-solid-binoculars:](https://docs.openshift.com/container-platform/4.13/applications/application-health.html){ .md-button target="_blank"}
208+
<div class="grid cards" markdown>
209+
210+
- :fontawesome-solid-binoculars:{ .lg .middle } __Monitoring Application Health__
211+
212+
---
213+
214+
OpenShift Container Platform applications have a number of options to detect and handle unhealthy containers.
215+
216+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/applications/application-health.html){ target="_blank"}
217+
218+
</div>
145219

146220
=== "Kubernetes"
147221

148-
[Monitoring Resource Usage :fontawesome-solid-binoculars:](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/){ .md-button target="_blank"}
222+
<div class="grid cards" markdown>
223+
224+
- :fontawesome-solid-magnifying-glass:{ .lg .middle } __Monitoring Resource Usage__
225+
226+
---
227+
228+
You can examine application performance in a Kubernetes cluster by examining the containers, pods, services, and the characteristics of the overall cluster.
229+
230+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/){ target="_blank"}
231+
232+
- :fontawesome-brands-sourcetree:{ .lg .middle } __Resource Metrics__
233+
234+
---
235+
236+
For Kubernetes, the Metrics API offers a basic set of metrics to support automatic scaling and similar use cases.
237+
238+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-metrics-pipeline/){ target="_blank"}
149239

150-
[Resource Metrics :fontawesome-solid-binoculars:](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-metrics-pipeline/){ .md-button target="_blank"}
240+
</div>
151241

152242
### References
153243

docs/openshift/pods/index.md

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,63 @@ A Pod encapsulates an application’s container (or, in some cases, multiple con
88

99
=== "OpenShift"
1010

11-
[About Pods :fontawesome-solid-globe:](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-using.html){ .md-button target="_blank"}
11+
<div class="grid cards" markdown>
1212

13-
[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"}
13+
- :fontawesome-solid-book:{ .lg .middle } __About Pods__
1414

15-
[Pod Autoscaling :fontawesome-solid-globe:](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-autoscaling.html){ .md-button target="_blank"}
15+
---
16+
17+
Learn more about the basics of _pods_ and how they work.
18+
19+
[:octicons-arrow-right-24: Getting started](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-using.html){ target="_blank"}
20+
21+
- :fontawesome-solid-globe:{ .lg .middle } __Cluster Configuration for Pods__
22+
23+
---
24+
25+
Configure your cluster to work for your specific needs.
26+
27+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-configuring.html){ target="_blank"}
28+
29+
- :fontawesome-solid-up-right-and-down-left-from-center:{ .lg .middle } __Pod Autoscaling__
30+
31+
---
32+
33+
Use a horizontal pod autoscaler (HPA) to specify how OCP should automatically scale up or down your deployment.
34+
35+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.3/nodes/pods/nodes-pods-autoscaling.html){ target="_blank"}
36+
37+
</div>
1638

1739
=== "Kubernetes"
1840

19-
[Pod Overview :fontawesome-solid-globe:](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/){ .md-button target="_blank"}
41+
<div class="grid cards" markdown>
42+
43+
- :fontawesome-solid-book:{ .lg .middle } __Pod Overview__
44+
45+
---
46+
47+
Learn more about the basics of _pods_ and how they work.
48+
49+
[:octicons-arrow-right-24: Getting started](https://kubernetes.io/docs/concepts/workloads/pods/pod-overview/){ target="_blank"}
50+
51+
- :fontawesome-solid-arrows-spin:{ .lg .middle } __Pod Lifecycle__
52+
53+
---
54+
55+
Read about the lifecycle process for pods and what each phase means.
56+
57+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/){ target="_blank"}
58+
59+
- :fontawesome-solid-globe:{ .lg .middle } __Pod Usage__
60+
61+
---
62+
63+
How do you use pods? Read about it here.
2064

21-
[Pod Lifecycle :fontawesome-solid-globe:](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/){ .md-button target="_blank"}
65+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/workloads/pods/pod/){ target="_blank"}
2266

23-
[Pod Usage :fontawesome-solid-globe:](https://kubernetes.io/docs/concepts/workloads/pods/pod/){ .md-button target="_blank"}
67+
</div>
2468

2569
## References
2670

docs/openshift/pods/multi-container/index.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,41 @@ Container images solve many real-world problems with existing packaging and depl
66

77
=== "Kubernetes"
88

9-
[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"}
9+
<div class="grid cards" markdown>
1010

11-
[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"}
11+
- :fontawesome-solid-file-lines:{ .lg .middle } __Sidecar Logging__
1212

13-
[Toolkit Patterns :fontawesome-solid-boxes-stacked:](https://kubernetes.io/blog/2015/06/the-distributed-system-toolkit-patterns/){.md-button target="_blank"}
13+
---
1414

15-
[Brendan Burns Paper :fontawesome-solid-boxes-stacked:](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/45406.pdf){.md-button target="_blank"}
15+
Application logs can help you understand what is happening inside your application.
16+
17+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/cluster-administration/logging/#using-a-sidecar-container-with-the-logging-agent){ target="_blank"}
18+
19+
- :fontawesome-solid-circle-nodes:{ .lg .middle } __Shared Volume Communication__
20+
21+
---
22+
23+
Read about how to use a Volume to communicate between two Containers running in the same Pod.
24+
25+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume/){ target="_blank"}
26+
27+
- :fontawesome-solid-blog:{ .lg .middle } __Toolkit Patterns__
28+
29+
---
30+
31+
Read Brendan Burns' blog post about "The Distributed System ToolKit: Patterns for Composite Containers".
32+
33+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/blog/2015/06/the-distributed-system-toolkit-patterns/){ target="_blank"}
34+
35+
- :fontawesome-solid-user:{ .lg .middle } __Brendan Burns Paper__
36+
37+
---
38+
39+
Read Brendan Burns' paper about design patterns for container-based distributed systems.
40+
41+
[:octicons-arrow-right-24: Learn more](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/45406.pdf){ target="_blank"}
42+
43+
</div>
1644

1745
## References
1846

docs/openshift/pods/tagging/index.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,39 @@ You can use either labels or annotations to attach metadata to Kubernetes object
1010

1111
=== "OpenShift"
1212

13-
[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"}
13+
<div class="grid cards" markdown>
14+
15+
- :fontawesome-solid-comment-dots:{ .lg .middle } __CLI Label Commands__
16+
17+
---
18+
19+
Read about the descriptions and example commands for OpenShift CLI (`oc`) developer commands.
20+
21+
[:octicons-arrow-right-24: Learn more](https://docs.openshift.com/container-platform/4.13/cli_reference/openshift_cli/developer-cli-commands.html){ target="_blank"}
22+
23+
</div>
1424

1525
=== "Kubernetes"
1626

17-
[Labels :fontawesome-solid-tags:](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/){.md-button target="_blank"}
27+
<div class="grid cards" markdown>
28+
29+
- :fontawesome-solid-tags:{ .lg .middle } __Labels__
30+
31+
---
32+
33+
Labels can be used to organize and to select subsets of objects.
34+
35+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/){ target="_blank"}
36+
37+
- :fontawesome-solid-note-sticky:{ .lg .middle } __Annotations__
38+
39+
---
40+
41+
You can use Kubernetes annotations to attach arbitrary non-identifying metadata to objects.
42+
43+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/){ target="_blank"}
1844

19-
[Annotations :fontawesome-solid-tags:](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/){.md-button target="_blank"}
45+
</div>
2046

2147
## References
2248

docs/openshift/pods/troubleshooting/index.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,47 @@ Usually is getting familiar with how primitives objects interact with each other
88

99
=== "OpenShift"
1010

11-
[Debugging with ODO :fontawesome-solid-bug:](https://odo.dev/docs/user-guides/advanced/debugging-with-openshift-toolkit){.md-button target="_blank"}
11+
<div class="grid cards" markdown>
12+
13+
- :fontawesome-solid-bug:{ .lg .middle } __Debugging ODO__
14+
15+
---
16+
17+
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.
18+
19+
[:octicons-arrow-right-24: Getting started](https://odo.dev/docs/user-guides/advanced/debugging-with-openshift-toolkit){ target="_blank"}
20+
21+
</div>
1222

1323
=== "Kubernetes"
1424

15-
[Debugging Applications :fontawesome-solid-bug:](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application/){.md-button target="_blank"}
25+
<div class="grid cards" markdown>
26+
27+
- :fontawesome-solid-bug:{ .lg .middle } __Debugging Applications__
28+
29+
---
30+
31+
Read about how to debug applications that are deployed into Kubernetes and not behaving correctly.
32+
33+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application/){ target="_blank"}
34+
35+
- :fontawesome-solid-bug:{ .lg .middle } __Debugging Services__
36+
37+
---
38+
39+
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?
40+
41+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-service/){ target="_blank"}
42+
43+
- :fontawesome-solid-bug:{ .lg .middle } __Debugging Replication Controllers__
44+
45+
---
46+
47+
Read about how to debug replication controllers that are deployed into Kubernetes and not behaving correctly.
1648

17-
[Debugging Services :fontawesome-solid-bug:](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-service/){.md-button target="_blank"}
49+
[:octicons-arrow-right-24: Learn more](https://kubernetes.io/docs/tasks/debug/debug-application/debug-pods/#debugging-replication-controllers){ target="_blank"}
1850

19-
[Debugging Replication Controllers :fontawesome-solid-bug:](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-pod-replication-controller/){.md-button target="_blank"}
51+
</div>
2052

2153
## References
2254

0 commit comments

Comments
 (0)