OBSDOCS-3534: Add use case guidance and troubleshooting for logging component scheduling#113865
OBSDOCS-3534: Add use case guidance and troubleshooting for logging component scheduling#113865johnwilkins wants to merge 2 commits into
Conversation
Adds decision guide for choosing scheduling mechanisms, simplifies YAML examples with progressive disclosure, and provides troubleshooting procedure for pods that fail to schedule. New modules: - logging-scheduling-use-cases.adoc (decision table and guidance) - troubleshooting-logging-pod-scheduling.adoc (diagnostic procedure) Modified modules: - log-collector-resources-scheduling.adoc (progressive examples) - logging-loki-pod-placement.adoc (condensed repetitive YAML) - scheduling-logging-resources.adoc (assembly structure) Implements Phase 1 improvements from SCHEDULING_RESOURCES_JTBD_ANALYSIS.md Addresses CONFIG-SCHEDULE-1, CONFIG-SCHEDULE-2, OPS-SCHEDULE-1 jobs JTBD Score: 6/10 → 7/10 Signed-off-by: John Wilkins <jowilkin@redhat.com>
openshift-ci-robot
added
the
jira/valid-reference
|
@johnwilkins: This pull request references OBSDOCS-3534 which is a valid jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
Bot
added
the
size/L
|
🤖 Mon Jun 22 19:39:50 - Prow CI generated the docs preview: https://113865--ocpdocs-pr.netlify.app/ |
Signed-off-by: John Wilkins <jowilkin@redhat.com>
|
@johnwilkins: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
3 participants
Summary
Adds use case decision guide, troubleshooting procedures, and simplified examples for scheduling logging components on infrastructure nodes.
Issue: https://redhat.atlassian.net/browse/OBSDOCS-3534
Changes
New Modules:
modules/logging-scheduling-use-cases.adoc- Decision table and use case guidancemodules/troubleshooting-logging-pod-scheduling.adoc- Troubleshooting pending podsModified Modules:
modules/log-collector-resources-scheduling.adoc- Added progressive examples (simple → comprehensive)modules/logging-loki-pod-placement.adoc- Condensed repetitive YAML in second examplescheduling_resources/scheduling-logging-resources.adoc- Added includes for new modulesValue
Before: Users saw complex YAML with all possible fields, no guidance on which to use for their use case, no troubleshooting help.
After: Users see decision table, choose their use case, see minimal example, have troubleshooting procedure if pods don't schedule.
Time to Success: Hours → Minutes
Based on analysis in
SCHEDULING_RESOURCES_JTBD_ANALYSIS.md.Testing
Signed-off-by: John Wilkins jowilkin@redhat.com