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.

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

outputRefs value is missing in Forwarding logs over HTTP documentation #86670

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

prithvipatil97
Copy link
Contributor

@prithvipatil97 prithvipatil97 commented Jan 3, 2025

apiVersion: logging.openshift.io/v1
kind: ClusterLogForwarder
metadata:
  name: <log_forwarder_name> 
  namespace: <log_forwarder_namespace> 
spec:
  serviceAccountName: <service_account_name> 
  outputs:
    - name: httpout-app
      type: http
      url: 
      http:
        headers: 
          h1: v1
          h2: v2
        method: POST
      secret:
        name: 
      tls:
        insecureSkipVerify: 
  pipelines:
    - name:
      inputRefs:
        - application
      outputRefs:
        -                          <<=== Value is missing 
  • Hence we need to add the outputRefs value here.
  • Here is the correct configuration:
apiVersion: logging.openshift.io/v1
kind: ClusterLogForwarder
metadata:
  name: <log_forwarder_name> 
  namespace: <log_forwarder_namespace> 
spec:
  serviceAccountName: <service_account_name> 
  outputs:
    - name: httpout-app
      type: http
      url: 
      http:
        headers: 
          h1: v1
          h2: v2
        method: POST
      secret:
        name: 
      tls:
        insecureSkipVerify: 
  pipelines:
    - name:
      inputRefs:
        - application
      outputRefs:
        - httpout-app              <<=== Need to add this value here

Version(s):

RHOCP 4.16, RHOCP 4.15, RHOCP 4.14, RHOCP 4.13, RHOCP 4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-1590

Link to docs preview:

https://86670--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/logging/log_collection_forwarding/configuring-log-forwarding.html

https://86670--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/log_collection_forwarding/configuring-log-forwarding.html

https://86670--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/logging/log_collection_forwarding/configuring-log-forwarding.html

QE review:

  • QE has approved this change.

Additional information:

- `outputRefs` value is missing in Forwarding logs over HTTP documentation.
- Here is the documentation link: https://docs.openshift.com/container-platform/4.16/observability/logging/log_collection_forwarding/configuring-log-forwarding.html#logging-http-forward_configuring-log-forwarding
- This `outputRefs` value should be the same as the output name.
- It is missing here.
- Here is the current configuration:
~~~
apiVersion: logging.openshift.io/v1
kind: ClusterLogForwarder
metadata:
  name: <log_forwarder_name> 
  namespace: <log_forwarder_namespace> 
spec:
  serviceAccountName: <service_account_name> 
  outputs:
    - name: httpout-app
      type: http
      url: 
      http:
        headers: 
          h1: v1
          h2: v2
        method: POST
      secret:
        name: 
      tls:
        insecureSkipVerify: 
  pipelines:
    - name:
      inputRefs:
        - application
      outputRefs:
        - 
~~~
- Hence we need to add the `outputRefs` value here.
- Here is the correct configuration:
~~~

~~~
@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 3, 2025
Copy link

openshift-ci bot commented Jan 3, 2025

@prithvipatil97: 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.

@prithvipatil97
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jan 3, 2025
@xenolinux xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jan 3, 2025
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

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

LGTM

@xenolinux xenolinux added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jan 3, 2025
@prithvipatil97
Copy link
Contributor Author

Hello @xenolinux ,
Thank you very much for reviewing this PR and providing approval.

Regards,
Prithviraj Patil

@prithvipatil97
Copy link
Contributor Author

Hello Team,
I need QE approval for this change.

All tests have passed and Peer review is also done.

@anpingli , @kabirbhartiRH , @QiaolingTang , It would be really helpful if someone could please take a look and provide QE approval for this change.

Thanks in advance.

Regards,
Prithviraj Patil

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer-review-done Signifies that the peer review team has reviewed this PR size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants