OBSDOCS-3551, OBSDOCS-3552, OBSDOCS-3553: Fix installation documentation issues#114284
Open
johnwilkins wants to merge 2 commits into
Open
OBSDOCS-3551, OBSDOCS-3552, OBSDOCS-3553: Fix installation documentation issues#114284johnwilkins wants to merge 2 commits into
johnwilkins wants to merge 2 commits into
Conversation
…ion issues This commit addresses multiple installation documentation issues: OBSDOCS-3551: Installation guide improvements - Add COO requirement to installation workflow - Make log forwarding destination lists generic instead of closed - Fix incorrect oc CLI reference (changed to logcli) - Scope preinstallation checklist to LokiStack deployments only - Align deployment scenarios with volume-based sizing (compatible with PR openshift#114090) - Add multi-cluster LokiStack limitation warning OBSDOCS-3552: Add namespace creation documentation - Add complete namespace YAML with required monitoring labels/annotations - Include instructions for creating openshift-logging namespace in CLI installation OBSDOCS-3553: Fix inconsistent installation steps - Reorganize CLO installation assembly with clear CLI/Console sections - Move COO installation to prerequisites instead of duplicating - Add LokiStack prerequisite to ClusterLogForwarder creation - Move Loki Operator troubleshooting to Loki Operator installation guide Related: - https://redhat.atlassian.net/browse/OBSDOCS-3551 - https://redhat.atlassian.net/browse/OBSDOCS-3552 - https://redhat.atlassian.net/browse/OBSDOCS-3553 Signed-off-by: John Wilkins <jowilkin@redhat.com>
openshift-ci-robot
added
the
jira/valid-reference
|
@johnwilkins: This pull request references OBSDOCS-3551 which is a valid jira issue. This pull request references OBSDOCS-3552 which is a valid jira issue. This pull request references OBSDOCS-3553 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
The previous xref pointed to ../log_forwarding/log-forwarding.adoc which doesn't exist in the openshift-logging distro. The correct path is ../configuring/configuring-log-forwarding.adoc. This fixes the portal build validation error. Signed-off-by: John Wilkins <jowilkin@redhat.com>
| include::modules/creating-the-clusterlogforwarder.adoc[leveloffset=+2] | ||
|
|
||
| [id="optional-configuration_{context}"] | ||
| == Optional: Additional configuration |
Collaborator
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.NoOptionalTitles: Do not begin a module or assembly title with 'Optional:'.
|
@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
4 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
Fixes three related installation documentation bugs by improving clarity, accuracy, and organization of the installation guides.
Changes
OBSDOCS-3551: Installation guide improvements
oc CLIreference tologclifor LogQL queriesOBSDOCS-3552: Namespace creation documentation
openshift.io/cluster-monitoring: "true"labelOBSDOCS-3553: Installation step consistency
JIRA Tickets
Compatibility
All changes are compatible with pending Loki sizing PR #114090. Issue 6 from OBSDOCS-3551 (incorrect sizing recommendations) is already addressed by that PR.
Files Modified
installing/installing-the-loki-operator.adocinstalling/installing-the-red-hat-openshift-logging-operator.adocmodules/creating-the-clusterlogforwarder.adocmodules/enabling-the-logs-tab.adocmodules/installing-the-clo-cli.adocmodules/logging-deployment-scenarios.adocmodules/logging-installation-workflow.adocmodules/logging-operator-requirements.adocmodules/logging-preinstallation-checklist.adocmodules/troubleshooting-logging-installation.adocFiles Created
modules/troubleshooting-loki-operator-installation.adocSigned-off-by: John Wilkins jowilkin@redhat.com