doc(chart): Updated chart readme

[ams0]

Description:

A more descriptive Readme for the Helm chart

Affected area:

• New Functionality [ ]
• Documentation [X]
• Install [ ]
• Control Plane [ ]
• CLI Tool [ ]
• Certificate Management [ ]
• Networking [ ]
• Metrics [ ]
• SMI Policy [ ]
• Security [ ]
• Tests [ ]
• CI System [ ]
• Performance [ ]
• Other [ ]

Please answer the following questions with yes/no.

• Does this change contain code from or inspired by another project? If so, did you notify the maintainers and provide attribution?

No

[ams0]

@nojnhuh I know correctly entered the comments in the values.yaml and let helm-docs generate the readme. I did not actually included the readme as I assume the CI will take care of it?

[codecov-io]

Codecov Report

Merging #2322 (37429ff) into main (db184fc) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2322      +/-   ##
==========================================
- Coverage   57.25%   57.23%   -0.02%     
==========================================
  Files         149      149              
  Lines        6660     6660              
==========================================
- Hits         3813     3812       -1     
- Misses       2842     2843       +1     
  Partials        5        5              

Impacted Files	Coverage Δ
pkg/envoy/route/config.go	95.23% <0.00%> (-0.80%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update db184fc...37429ff. Read the comment docs.

[michelleN]

Thank you @ams0 ! These changes look great. Some of the comments seem like they are duplicates of the line above it. If you could remove the lines above that are duplicates, that would be great. Will merge as soon as that is done.

[ams0]

thanks @michelleN ! Also, to be addressed perhaps later, all values are prefixed with OpenServiceMesh, perhaps rendering it at all superfluous.

[michelleN]

Had a minor question about the README but I'll go ahead and merge this and we can address the install line in a follow up PR.

[michelleN]

Should this be charts/osm?

[ams0]

No, it seems that's how it looks in the chart repo:

~> helm search repo osm
NAME   	CHART VERSION	APP VERSION	DESCRIPTION
osm/osm	0.6.1        	v0.6.1     	A Helm chart to install the OSM control plane o...

[nojnhuh]

@nojnhuh I know correctly entered the comments in the values.yaml and let helm-docs generate the readme. I did not actually included the readme as I assume the CI will take care of it?

We actually don't have this automated in CI currently, but we have it documented as a manual step as part of cutting releases. I'm not too worried about everything being perfectly in sync between releases. Thanks for digging in to figure out the helm-docs details.