Hello OpenTelemetry Maintainers,

Problem/Motivation

Currently, I don’t know if the opentelemetry-demo Helm chart supports readinessProbe configuration in its templates. And this option is not documented in the values.schema.json file.

This lack of discoverability can lead to user confusion. For instance, a colleague of mine believed the feature was unsupported and had to download and manually modify the chart templates to add readiness probes.

In many enterprise environments, security policies require that all Kubernetes workloads have a readinessProbe configured. The current difficulty in finding and using this feature can be a barrier for new users in such organizations who are trying to adopt the demo.

Similar issue

I saw that collector chart had a similar topic in 2023 : #697

Proposed Solution

To improve the user experience and align the documentation with the chart's capabilities, I propose making the following changes:

1. Update values.schema.json: Add a definition for the readinessProbe object to the properties of each relevant component. This definition would mirror the existing structure of the livenessProbe for consistency.
2. Add Examples to values.yaml: Update the main values.yaml file to include commented-out examples of a readinessProbe for each component. This would serve as clear, in-place documentation without changing the default behavior of the chart.

Benefits

• Improves Discoverability: Users can easily see that readinessProbe is a supported and configurable option.
• Enhances User Experience: Prevents confusion and the need for users to inspect template source code to understand chart features.

If the maintainers agree with this approach, I would be happy to open a Pull Request to implement these changes. This would be my first contribution to the project.

Thank you for your time and consideration. Looking forward to your feedback!