OBSDOCS-3671: Activate Troubleshoot category with JTBD-aligned assemblies - #116772
Open
johnwilkins wants to merge 1 commit into
Open
OBSDOCS-3671: Activate Troubleshoot category with JTBD-aligned assemblies#116772johnwilkins wants to merge 1 commit into
johnwilkins wants to merge 1 commit into
Conversation
- Activate Troubleshoot category in topic map (renamed from "Troubleshooting logging" to "Troubleshoot") - Create 3 focused assemblies: - Troubleshoot the installation (symptom-based with prerequisites integration) - Troubleshoot log forwarding (Loki rate limit errors) - Troubleshoot logging alerts (LokiStack alert diagnostic procedures) New content: - modules/troubleshoot-installation-symptoms.adoc: Comprehensive symptom reference (definition lists) - Preserves all 5 symptoms from embedded table - Adds 3 new symptoms based on prerequisites (StorageClass, object storage, CA bundle) - modules/troubleshoot-lokistack-alerts.adoc: LokiStack alert troubleshooting procedures - Addresses all review feedback from PR openshift#116470 - Uses environment variable pattern for CR names - PromQL query for discarded samples analysis - Links to loki-operator.dev runbook - modules/troubleshoot-loki-rate-limit-errors.adoc: Renamed from loki-rate-limit-errors.adoc Deprecated content removed: - troubleshooting/cluster-logging-cluster-status.adoc (Elasticsearch/Kibana/Fluentd only) - Fluentd redeployment module reference Consistency updates: - All filenames use imperative "troubleshoot-" prefix (aligned with titles for DITA migration) - All IDs updated to "troubleshoot-*" pattern with legacy IDs as anchors - Topic map names use imperative form without gerunds - Plain text references in procedure steps, xrefs in Additional resources per modular docs standards - Removed embedded troubleshooting from installing/installing-the-red-hat-openshift-logging-operator.adoc - Updated configuring/configuring-the-log-store.adoc and configuring/tuning-the-log-store.adoc to reference renamed module Testing: - Build: All Successful (bash scripts/prow-smoke-test.sh --validate openshift-logging) - Vale: 0 errors, 0 warnings on new troubleshooting content Closes PR openshift#116470 (content ported with review feedback addressed) Addresses: https://redhat.atlassian.net/browse/OBSDOCS-3671 Signed-off-by: John Wilkins <jowilkin@redhat.com>
|
@johnwilkins: This pull request references OBSDOCS-3671 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-robot
added
the
jira/valid-reference
openshift-ci
Bot
added
the
size/L
|
@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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Activates the Troubleshoot category in OpenShift Logging documentation with three focused assemblies aligned with the JTBD (Jobs-to-be-Done) framework.
Changes
Topic Map Updates
New Content
1. Troubleshoot the installation
troubleshooting/troubleshoot-installation.adocmodules/troubleshoot-installation-symptoms.adoc(definition list structure)installing/installing-the-red-hat-openshift-logging-operator.adoc2. Troubleshoot log forwarding
troubleshooting/troubleshoot-log-forwarding.adocmodules/troubleshoot-loki-rate-limit-errors.adoc(renamed fromloki-rate-limit-errors.adoc)3. Troubleshoot logging alerts
troubleshooting/troubleshoot-logging-alerts.adocmodules/troubleshoot-lokistack-alerts.adocsum by (tenant, reason) (irate(loki_discarded_samples_total[2m]))Deprecated Content Removed
troubleshooting/cluster-logging-cluster-status.adoc(Elasticsearch/Kibana/Fluentd only)cluster-logging-log-store-status.adocredeploying-fluentd-pods.adocmodule include (deprecated Fluentd content)Consistency Updates for DITA Migration
Related File Updates
configuring/configuring-the-log-store.adoc: Updated module reference totroubleshoot-loki-rate-limit-errors.adocconfiguring/tuning-the-log-store.adoc: Updated module reference totroubleshoot-loki-rate-limit-errors.adocTODO - Follow-up Work
Related to PR #116570 (Configure category restructure):
Loki rate limit troubleshooting duplication:
troubleshoot-loki-rate-limit-errors.adocappears in both:configuring/configuring-the-log-store.adoc(embedded)troubleshooting/troubleshoot-log-forwarding.adoc(centralized)Other embedded troubleshooting in Configure:
configuring/configuring-log-forwarding.adoc:troubleshooting-log-collection.adoc(TLS cert, 429 rate limit, collector not running, debug logging)cross-account-log-forwarding-troubleshooting.adoc(AWS cross-account issues)configuring/cluster-logging-collector.adoc:troubleshooting-collector-metrics-cardinality.adoc(advanced cardinality diagnostic)configuring/loki-query-performance-troubleshooting.adoc:Recommendation: Address Configure embedded troubleshooting consolidation after PR #116570 merges to avoid conflicts.
Testing
bash scripts/prow-smoke-test.sh --validate openshift-logging- All SuccessfulRelated PRs
JIRA
Ticket: OBSDOCS-3671
Version: 6.6
Activates Troubleshoot category per ideal hierarchy guidance.
Signed-off-by: John Wilkins jowilkin@redhat.com