OBSDOCS-1530: Support section was removed from Logging documentation in 4.17 #87864
Conversation
openshift-ci-robot
added
the
jira/valid-reference
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
@theashiot: This pull request references OBSDOCS-1530 which is a valid jira issue. In 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. |
|
Skipping CI for Draft Pull Request. |
openshift-ci
bot
added
the
size/S
|
/test all |
theashiot
force-pushed
the
OBSDOCS-1530
branch
from
d5c3ff8 to
4b5bbea
Compare
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
There was a problem hiding this comment.
Thanks @JoaoBraveCoding for the review! I've added a question inline.
theashiot
force-pushed
the
OBSDOCS-1530
branch
from
4b5bbea to
3ecc352
Compare
openshift-ci
bot
added
size/M
|
|
||
| |ClusterLogForwarder | ||
| |clusterlogforwarder.observability.openshift.io/v1 | ||
| |Supported from 5.8 |
There was a problem hiding this comment.
This I believe this is also not correct as this API is older than 5.8, @jcantrill might know the exact number
theashiot
force-pushed
the
OBSDOCS-1530
branch
from
3ecc352 to
09aa985
Compare
openshift-merge-robot
added
the
needs-rebase
|
@theashiot: This pull request references OBSDOCS-1530 which is a valid jira issue. In 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
size/XXL
|
Thanks, @jcantrill for the review! The original idea was to have this section common for 5.8 and 6. But from your comments I see that this might lead to confusion, so it might be better to have it per-release. WDYT? I've also added some questions inline. |
openshift-merge-robot
removed
the
needs-rebase
Before you came onboard, and we may be moving in that direction, my recommendation to docs has been that all documentation should be versioned with no commonality. Just like in code, we "fork" on release and update it as necessary which may mean "multiple" updates per release or cherry-picks. This leads to drift between versions but that isn't necessarily bad IMO. Based upon my experience with documentation over the last 8 years of this project, there has been too much information that is either stale or incorrect because of changes overtime with versioning; subject is relevant in one version but not another. |
theashiot
force-pushed
the
OBSDOCS-1530
branch
from
09aa985 to
8ba3653
Compare
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
| [id="log60-cluster-logging-support"] | |||
| include::_attributes/common-attributes.adoc[] | |||
There was a problem hiding this comment.
The title and the include need to switched. Line 3 should be the title and line 4 should be the attributes.
There was a problem hiding this comment.
There was a problem hiding this comment.
fixed in all three places
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
There was a problem hiding this comment.
This file isn't included in the Topic map so it isn't showing in the preview.
There was a problem hiding this comment.
We had to remove Logging 6.0 from the latest versions of OCP. I'll add it to the topic map when these changes are cherry-picked to the previous OCP releases.
There was a problem hiding this comment.
I recommend in the future that you organize your PRs a little better. If this PR targets versions where this module is not necessary then this module should not be in this PR. It should be in the PR where it is necessary.
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
| [id="log61-cluster-logging-support"] | |||
| include::_attributes/common-attributes.adoc[] | |||
There was a problem hiding this comment.
Title and attributes need to be switched.
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
| [id="log62-cluster-logging-support"] | |||
| include::_attributes/common-attributes.adoc[] | |||
There was a problem hiding this comment.
title and attributes need to be switched.
| [id="support-exception-for-coo-logging-ui-plugin_{context}"] | ||
| == Support exception for the Logging UI Plugin | ||
|
|
||
| Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. |
There was a problem hiding this comment.
I recommend getting cx approval for this support statement. It also sounds like Red{nbsp}Hat provides support to customers might need the word limited added because it sounds like it isn't full support.
There was a problem hiding this comment.
This content will be removed as soon as this PR is merged as COO is GA, Here's the Jira for the removal: https://issues.redhat.com/browse/OBSDOCS-1703
There was a problem hiding this comment.
When you place content in the queue to be reviewed and you don't indicate that it is being removed in another PR, peer-reviewers will spend time reviewing this content. This is wasted time. Please be more thoughtful with how you are organizing your work and PRs.
| [id="support-exception-for-coo-logging-ui-plugin_{context}"] | ||
| == Support exception for the Logging UI Plugin | ||
|
|
||
| Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. |
There was a problem hiding this comment.
My other concern with this paragraph is the promise of future plans, approaching General Availability https://redhat-documentation.github.io/supplementary-style-guide/#statements-about-the-future:~:text=When%20possible%2C%20avoid%20making%20statements%20that%20predict%20future%20releases%20or%20plans.
Maybe With the anticipated?
| @@ -62,14 +71,8 @@ Until the approaching General Availability (GA) release of the Cluster Observabi | |||
|
|
|||
| When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support. | |||
|
|
|||
| You can use the xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. | |||
|
|
|||
| You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. | |||
There was a problem hiding this comment.
| You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. | |
| You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[must-gather tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. |
| * Historical or long term log retention or storage | ||
| * A guaranteed log sink | ||
| * Secure storage - audit logs are not stored by default | ||
|
|
||
| [id="cluster-logging-support-CRDs_{context}"] | ||
| == Supported API custom resource definitions | ||
|
|
||
| LokiStack development is ongoing. Not all APIs are currently supported. | ||
| The following table describes the supported Logging APIs. |
There was a problem hiding this comment.
| The following table describes the supported Logging APIs. | |
| The following table describes the supported {logging-uc} APIs. |
| :_mod-docs-content-type: ASSEMBLY | ||
| [id="log61-cluster-logging-support"] | ||
| include::_attributes/common-attributes.adoc[] | ||
| = Support |
There was a problem hiding this comment.
My comments on the logging-6.0 file apply to both the logging-6.1 and logging-6.2
| :_mod-docs-content-type: ASSEMBLY | ||
| [id="log62-cluster-logging-support"] | ||
| include::_attributes/common-attributes.adoc[] | ||
| = Support |
There was a problem hiding this comment.
My comments on the logging-6.0 file apply to both the logging-6.1 and logging-6.2
JoeAldinger
added
peer-review-done
There was a problem hiding this comment.
Thanks, @JoeAldinger for the wonderful review! I've made the required changes and added some comments. Mind having another look?
best,
ashwin
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
There was a problem hiding this comment.
We had to remove Logging 6.0 from the latest versions of OCP. I'll add it to the topic map when these changes are cherry-picked to the previous OCP releases.
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
| [id="log60-cluster-logging-support"] | |||
| include::_attributes/common-attributes.adoc[] | |||
There was a problem hiding this comment.
fixed in all three places
| Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. | ||
|
|
||
| [id="cluster-logging-support-must-gather_{context}"] | ||
| == Collecting logging data for Red Hat Support |
|
|
||
| When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support. | ||
|
|
||
| You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. |
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
| [id="log61-cluster-logging-support"] | |||
| include::_attributes/common-attributes.adoc[] | |||
| * Historical or long term log retention or storage | ||
| * A guaranteed log sink | ||
| * Secure storage - audit logs are not stored by default | ||
|
|
||
| [id="cluster-logging-support-CRDs_{context}"] | ||
| == Supported API custom resource definitions | ||
|
|
||
| LokiStack development is ongoing. Not all APIs are currently supported. | ||
| The following table describes the supported Logging APIs. |
| @@ -62,14 +71,8 @@ Until the approaching General Availability (GA) release of the Cluster Observabi | |||
|
|
|||
| When opening a support case, it is helpful to provide debugging information about your cluster to Red{nbsp}Hat Support. | |||
|
|
|||
| You can use the xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. | |||
|
|
|||
| You can use the xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool] to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components. | |||
| [id="support-exception-for-coo-logging-ui-plugin_{context}"] | ||
| == Support exception for the Logging UI Plugin | ||
|
|
||
| Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. |
There was a problem hiding this comment.
This content will be removed as soon as this PR is merged as COO is GA, Here's the Jira for the removal: https://issues.redhat.com/browse/OBSDOCS-1703
| [id="support-exception-for-coo-logging-ui-plugin_{context}"] | ||
| == Support exception for the Logging UI Plugin | ||
|
|
||
| Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. |
There was a problem hiding this comment.
As this content is slated to be removed, let's not update it.
| [id="support-exception-for-coo-logging-ui-plugin_{context}"] | ||
| == Support exception for the Logging UI Plugin | ||
|
|
||
| Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. |
|
@theashiot: all tests passed! Full PR test history. Your PR dashboard. 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 kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
@theashiot: This pull request references OBSDOCS-1530 which is a valid jira issue. In 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. |
There was a problem hiding this comment.
I can't tell if this PR targets live branches or not and given its organization and support statement exceptions some merge-reviewers might not be comfortable merging. If this is not targeting live branches which I suspect is the case then I'm less stressed about merging it.
| @@ -0,0 +1,48 @@ | |||
| :_mod-docs-content-type: ASSEMBLY | |||
There was a problem hiding this comment.
I recommend in the future that you organize your PRs a little better. If this PR targets versions where this module is not necessary then this module should not be in this PR. It should be in the PR where it is necessary.
| [id="support-exception-for-coo-logging-ui-plugin_{context}"] | ||
| == Support exception for the Logging UI Plugin | ||
|
|
||
| Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA. |
There was a problem hiding this comment.
When you place content in the queue to be reviewed and you don't indicate that it is being removed in another PR, peer-reviewers will spend time reviewing this content. This is wasted time. Please be more thoughtful with how you are organizing your work and PRs.
There was a problem hiding this comment.
I can't tell if this PR targets live branches or not and given its organization and support statement exceptions some merge-reviewers might not be comfortable merging. If this is not targeting live branches which I suspect is the case then I'm less stressed about merging it.
There was a problem hiding this comment.
I can't tell if this PR targets live branches or not and given its organization and support statement exceptions some merge-reviewers might not be comfortable merging. If this is not targeting live branches which I suspect is the case then I'm less stressed about merging it.
|
Thanks, @JoeAldinger for the feedback! i'll definitely take care of this going forward. This is not a live branch, but still if you feel more comfortable with the content removed, i can remove the content and link this PR in https://issues.redhat.com/browse/OBSDOCS-1703. Let me know which you'd prefer. best, |
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
JoeAldinger
added
merge-review-in-progress
|
Spoke with author on slack fine to merge since these aren't live branches. |
|
/cherrypick logging-docs-6.2-4.18 |
|
/cherrypick logging-docs-6.2-4.17 |
|
/cherrypick logging-docs-6.2-4.16 |
|
@JoeAldinger: new pull request created: #89692 In 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 kubernetes-sigs/prow repository. |
|
@JoeAldinger: new pull request created: #89693 In 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 kubernetes-sigs/prow repository. |
|
@JoeAldinger: new pull request created: #89694 In 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 kubernetes-sigs/prow repository. |
Version(s): Version(s): 4.19, 4.18, 4.17,4.16. Note that this needs to be cherry-picked to logging-docs-6.2-4.18, logging-docs-6.2-4.17, logging-docs-6.2-4.16 release branches and not enterprise-4.18, enterprise-4.17 branches.
Issue: https://issues.redhat.com/browse/OBSDOCS-1530
Link to docs preview:
https://87864--ocpdocs-pr.netlify.app/
https://87864--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.1/log61-cluster-logging-support.html
https://87864--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/log62-cluster-logging-support.html
https://87864--ocpdocs-pr.netlify.app/openshift-enterprise/latest/support/index.html
QE review:
Additional information: