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

operator: Document how to connect to distributor component #5551

Merged
merged 12 commits into from
Mar 17, 2022

Conversation

sasagarw
Copy link

@sasagarw sasagarw commented Mar 7, 2022

What this PR does / why we need it:

  • Adds documentation to connect to distributor component using ClusterLogForwarder.
  • Links forwarding doc to index.md file.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Documentation added
  • Tests updated
  • Add an entry in the CHANGELOG.md about the changes.

@sasagarw sasagarw requested a review from a team as a code owner March 7, 2022 03:17
@xperimental xperimental changed the title [operator] Add documentation to connect to distributor component operator: Document how to connect to distributor component Mar 8, 2022
Copy link
Contributor

@Red-GV Red-GV left a comment

Choose a reason for hiding this comment

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

Looking good! Just a few comments:

operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@xperimental xperimental left a comment

Choose a reason for hiding this comment

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

Finally did a first read-through, sorry for the long wait.

operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/index.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@xperimental xperimental left a comment

Choose a reason for hiding this comment

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

Sorry, missed the YAML style the last time. Personally I like the non-quoted style better for YAML, because there's less distracting characters, but at least we should apply one style consistently.

operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
operator/index.md Outdated Show resolved Hide resolved
operator/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@xperimental xperimental left a comment

Choose a reason for hiding this comment

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

During a discussion with @periklis about connecting Grafana to LokiStack we came to the conclusion that this document needs to be better marked as "only for testing". See my (hopefully final) suggestion.

operator/docs/forwarding_logs_without_gateway.md Outdated Show resolved Hide resolved
@periklis periklis removed the request for review from a team March 17, 2022 08:02
@xperimental xperimental merged commit 5e5067e into grafana:main Mar 17, 2022
@sasagarw sasagarw deleted the add-doc-clfToLoki branch March 23, 2022 09:17
@MasslessParticle MasslessParticle added the backport release-2.5.x Tag a PR with this label to create a PR which cherry pics it into the release-2.5.x branch label Apr 7, 2022
grafanabot pushed a commit that referenced this pull request Apr 7, 2022
MasslessParticle pushed a commit that referenced this pull request Apr 7, 2022
…5811)

(cherry picked from commit 5e5067e)

Co-authored-by: Sashank Agarwal <sasagarw@redhat.com>
splitice pushed a commit to X4BNet/loki that referenced this pull request May 21, 2022
) (grafana#5811)

(cherry picked from commit 5e5067e)

Co-authored-by: Sashank Agarwal <sasagarw@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.5.x Tag a PR with this label to create a PR which cherry pics it into the release-2.5.x branch sig/operator size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants