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

Improve Jaeger tracing documentation #59

Open
W3D3 opened this issue Sep 27, 2023 · 0 comments
Open

Improve Jaeger tracing documentation #59

W3D3 opened this issue Sep 27, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@W3D3
Copy link
Contributor

W3D3 commented Sep 27, 2023

The docs in docs/TRACING.md refer to hardcoded versions of the jaeger-operator helm chart that is incompatible with more recent K8s versions.

We should cut everything from that documentation page that is not Unguard related (like the name of the jaeger-agent that has to match) and simply link to an up-to-date documentation page that explains how to install Jaeger on K8s like https://www.jaegertracing.io/docs/1.49/operator/ or similar.

We could also recommend not to use the operator, as it requires cert-manager in recent versions (which makes it more work to setup for something that will be used for local dev only anways) and just install the Jaeger helm chart using:

helm install jaeger jaegertracing/jaeger

I would also suggest getting rid of /k8s-templates/jaeger in the process.

@W3D3 W3D3 added bug Something isn't working enhancement New feature or request good first issue Good for newcomers and removed bug Something isn't working labels Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant