Skip to content
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.

Sign up for GitHub

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

Jump to bottom

OBSDOCS-1640: Document HTTP output proxy should be configurable #88847

Draft
wants to merge 1 commit into
base: logging-docs-6.2
Choose a base branch
from
Draft

OBSDOCS-1640: Document HTTP output proxy should be configurable #88847

wants to merge 1 commit into from
+2,330 −0

Conversation

theashiot
Copy link
Contributor

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 18, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 18, 2025 •
edited by openshift-ci bot
Loading

@theashiot: This pull request references OBSDOCS-1640 which is a valid jira issue.

In response to this:

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 18, 2025
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Feb 18, 2025

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci openshift-ci bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Feb 18, 2025
@theashiot
Copy link
Contributor Author

/test all

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Feb 18, 2025 •
edited
Loading

🤖 Thu Feb 20 18:42:43 - Prow CI generated the docs preview:

https://88847--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-configuring-log-forwarding-6.0.html
https://88847--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.1/log6x-configuring-log-forwarding-6.1.html
https://88847--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/log6x-configuring-log-forwarding-6.2.html

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Feb 18, 2025
View reviewed changes
modules/log6x/cluster-logging-collector-log-forward-gcp.adoc
----
$ oc -n openshift-logging create secret generic gcp-secret --from-file google-application-credentials.json=_<your_service_account_key_file.json>_
----
. Create a `ClusterLogForwarder` Custom Resource YAML using the template below:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] Vale.Terms: Use 'custom resources?' instead of 'Custom Resource'.

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Feb 18, 2025
View reviewed changes
modules/log6x/cluster-logging-collector-log-forward-syslog.adoc
@@ -0,0 +1,188 @@
:_mod-docs-content-type: PROCEDURE
[id="cluster-logging-collector-log-forward-syslog_{context}"]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] OpenShiftAsciiDoc.IdHasContextVariable: ID is missing the '_{context}' variable at the end of the ID.

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Feb 18, 2025
View reviewed changes
modules/log6x/logging-forward-splunk.adoc
$ oc -n openshift-logging create secret generic vector-splunk-secret --from-literal hecToken=<HEC_Token>
----
+
. Create or edit the `ClusterLogForwarder` Custom Resource (CR) using the template below:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] Vale.Terms: Use 'custom resources?' instead of 'Custom Resource'.

ocpdocs-vale-bot
ocpdocs-vale-bot reviewed Feb 18, 2025
View reviewed changes
modules/log6x/logging-multiline-except.adoc
at testjava.Main.main(Main.java:10)
----

* To enable logging to detect multi-line exceptions and reassemble them into a single log entry, ensure that the `ClusterLogForwarder` Custom Resource (CR) contains a `detectMultilineErrors` field, with a value of `true`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] Vale.Terms: Use 'custom resources?' instead of 'Custom Resource'.

@theashiot
Copy link
Contributor Author

/retest

@theashiot
Copy link
Contributor Author

/retest

alanconway
alanconway approved these changes Feb 19, 2025
View reviewed changes
Copy link

@alanconway alanconway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for the HTTP output section

@theashiot
Copy link
Contributor Author

Thanks, @alanconway!

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 20, 2025
kabirbhartiRH
kabirbhartiRH reviewed Feb 20, 2025
View reviewed changes
modules/log6x/logging-http-forward-6-2.adoc Outdated
outputs:
- name: httpout-app
type: http
url: <4>
Copy link

@kabirbhartiRH kabirbhartiRH Feb 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'url' attribute should be inside the 'http' output type.

spec:
  managementState: Managed
  outputs:
    - http:
        headers:
          h1: v1
          h2: v2
        method: POST
        proxyURL: <proxy_url>
        url: <url>
      name: httpout-app
      type: http
  pipelines:
    - inputRefs:
        - application
      name: app-logs
      outputRefs:
        - httpout-app
  serviceAccount:
    name: <service_account_name>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the example, i've updated this.

kabirbhartiRH
kabirbhartiRH reviewed Feb 20, 2025
View reviewed changes
modules/log6x/logging-http-forward-6-2.adoc Outdated
tls:
insecureSkipVerify: <8>
pipelines:
- name:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please provide a name for the pipeline here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated as per your comment above.

@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 20, 2025
@theashiot
Copy link
Contributor Author

/test all

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Feb 20, 2025

@theashiot: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/validate-portal 8b1adb4 link true /test validate-portal

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kabirbhartiRH kabirbhartiRH kabirbhartiRH left review comments

@ocpdocs-vale-bot ocpdocs-vale-bot ocpdocs-vale-bot left review comments

@alanconway alanconway alanconway approved these changes

Assignees
No one assigned
Labels
do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@theashiot @openshift-ci-robot @ocpdocs-previewbot @alanconway @kabirbhartiRH @ocpdocs-vale-bot @openshift-merge-robot