-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Logging 6x - Docs Outline / Planning #76623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
|
||
// Module included in the following assemblies: | ||
// | ||
:_mod-docs-content-type: CONCEPT | ||
[id="log6x-oc-explain_{context}"] | ||
|
||
= Using the `oc explain` command | ||
|
||
The `oc explain` command is an essential tool in the OpenShift Command-Line Interface (CLI) that provides detailed descriptions of the fields within Kubernetes resources, including Custom Resources (CRs) introduced by Operators. This command is invaluable for administrators and developers who are configuring or troubleshooting resources in an OpenShift cluster. | ||
|
||
. *Resource Descriptions*: It offers in-depth explanations of all fields associated with a specific Kubernetes or Custom Resource. This includes standard resources like pods and services, as well as more complex entities like statefulsets. | ||
|
||
. *Hierarchical Structure*: The command displays the structure of resource fields in a hierarchical format, clarifying the relationships between different configuration options. This hierarchical view is crucial for proper configuration. | ||
|
||
. *Type Information*: `oc explain` also indicates the type of each field (such as string, integer, or boolean), which is critical for ensuring that resource definitions are provided with correct data types. | ||
|
||
. *Default Values*: When applicable, the command shows the default values for fields, providing insights into what values will be used if none are explicitly specified. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
// Module included in the following assemblies: | ||
// | ||
|
||
|
||
:_mod-docs-content-type: CONCEPT | ||
[id="logging-6x-v-5x_{context}"] | ||
= OpenShift Logging 6.0: Key Differences from Previous Versions | ||
|
||
OpenShift Logging 6.0 is the culmination of efforts to modernize the underlying components of the logging solution. Over the past few releases, Loki and Vector were gradually introduced with a focus on improving performance and enhancing features while maintaining the stability required for business continuity. | ||
|
||
|
||
* **Horizontal Scalability:** Loki's architecture allows for seamless horizontal scaling, ensuring that the logging system can handle the growing demands of large-scale OpenShift deployments. | ||
|
||
* **Improved Query Performance:** Loki's indexing and query mechanisms are optimized for speed, enabling faster log retrieval and analysis. | ||
|
||
* **Improved Integration:** Loki and Vector offer tighter integration with OpenShift, providing a more seamless and native logging experience. | ||
|
||
* **Increased Flexibility** More configuration options to fine tune your logging deployment. | ||
|
||
* **Enhanced Log Processing:** Vector's processing capabilities have been expanded, enabling you to perform more complex filtering. | ||
|
||
* **OpenShift Web Console:** The integrated Logs page offers a user-friendly interface for searching, filtering, and viewing logs directly within the OpenShift console. | ||
|
||
|
||
== Functional changes | ||
|
||
https://issues.redhat.com/browse/OBSDOCS-1168 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
// Module included in the following assemblies: | ||
// | ||
// * observability/logging/performance_reliability/logging-content-filtering.adoc | ||
// * observability/logging/logging-6.0/log6x-clf.adoc | ||
|
||
:_mod-docs-content-type: PROCEDURE | ||
[id="logging-content-filter-drop-records_{context}"] | ||
|
@@ -10,7 +11,6 @@ When the `drop` filter is configured, the log collector evaluates log streams ac | |
|
||
.Prerequisites | ||
|
||
* You have installed the {clo}. | ||
* You have administrator permissions. | ||
* You have created a `ClusterLogForwarder` custom resource (CR). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not correct. You can create a clusterLogForwarder as the first time with all the needed and not needed to have it previously created. What it's a requirement is to have create a serviceAccount to be used in the clusterLogForwarder linked to the correct clusterRoles depending on the log types allowed to this serviceAccount to collect. All the details are already mentioned in the PR https://github.com/openshift/openshift-docs/pull/80384/files exactly here https://github.com/openshift/openshift-docs/pull/80384/files#diff-7312d97cd1d4f7bf7f053f75108d26c4898afe1c9442033332be3b09358f75b5 and here https://github.com/openshift/openshift-docs/pull/80384/files#diff-8a01457b83c79be59c3ecdcc18d761f057790cab1de118070de9608994e11bf2 |
||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be useful an example in this section, for example, how to review the outputs and options supported for an specific output. This should be so much helpful as the most of the people doesn't know how to run it or what they need to write
oc explain <API>.spec....
@libander
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oc explain lokistacks.loki.grafana.com
oc explain recordingrules.loki.grafana.com
oc explain rulerconfigs.loki.grafana.com
oc explain alertingrules.loki.grafana.com
oc explain lokistacks.loki.grafana.com.spec
oc explain lokistacks.loki.grafana.com.spec.storage
oc explain lokistacks.loki.grafana.com.spec.storage.schemas.FIELDS
oc explain lokistacks.loki.grafana.com.spec.size