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

profiling: add tips for kubernetes self-managed deployment #3932

Merged
merged 4 commits into from
Jun 3, 2024

Conversation

inge4pres
Copy link
Contributor

Reason for this PR

Closes https://github.com/elastic/prodfiler/issues/4586.

Details

Added tips to configure collector and symbolizer in k8s environments.
Specifically we're referencing secrets for output added in https://github.com/elastic/prodfiler/pull/4999

@inge4pres inge4pres self-assigned this May 28, 2024
@inge4pres inge4pres requested a review from a team as a code owner May 28, 2024 13:19
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented May 28, 2024

This pull request does not have a backport label. Could you fix it @inge4pres? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label May 28, 2024
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Thanks, Francesco! I have a few recommendations for you.

docs/en/observability/profiling-self-managed-ops.asciidoc Outdated Show resolved Hide resolved

2. Update the collector and symbolizer Helm values files to enable the use of TLS configuration:
+
[source, yaml, highlight=3..4]
Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately this highlight functionality doesn't work in our implementation of asciidoctor.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bummer... is there anything else we can use to make the diff more evident?

Copy link
Member

Choose a reason for hiding this comment

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

Our docs support code callouts. You could add one of those?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a small text to clarify what needs to be done 👍🏼
Thanks for the hint 🙏🏼

Copy link
Member

Choose a reason for hiding this comment

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

perfect

If you are using an ingress controller, the connection routing to the collector Service should be configured to use the gRPC protocol.

We provide an `Ingress` resource as part of the Helm chart, and because the ingress can be any implementation,
you should provide to the chart values the configuration of the ingress, adding the class name and the
Copy link
Member

Choose a reason for hiding this comment

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

you should provide to the chart values the configuration of the ingress

I'm not sure what you're trying to say 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.

The Ingress is managed by the chart, but its configurations need to be passed through from the users, as they are implementation-specific.
This practically means that all the times an ingress is enabled, it must be configured with some values passed in Helm by users.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks, that's very helpful. I made a small recommendation based off of this comment: https://github.com/elastic/observability-docs/pull/3932/files#r1621192289

@bmorelli25 bmorelli25 requested a review from mdbirnstiehl May 28, 2024 20:32
@inge4pres inge4pres requested a review from bmorelli25 June 3, 2024 13:34
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

thank you!

@bmorelli25 bmorelli25 merged commit cdf59fc into main Jun 3, 2024
4 checks passed
@bmorelli25 bmorelli25 deleted the profiling/issue/4586 branch June 3, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify Request:8.15
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants