Keda: Improve Helm Chart

Created on 16 May 2019  路  9Comments  路  Source: kedacore/keda

Improve Helm Chart in order to make it easier to onboard:

  • Provide a README with more info: _(see CHART LICENSE, README AND NOTES)_

    • A description of the application or service the chart provides

    • Any prerequisites or requirements to run the chart

    • Descriptions of options in values.yaml and default values

    • Any other information that may be relevant to the installation or configuration of the chart

  • License

That said, I would do copy the repo license into the chart folder during the build & package stage of the release.

enhancement good first issue help wanted

All 9 comments

I'm happy to pick this up if you want.

Related: #102

The chart configuration is documented via #265

I can pick up the notes as well - My suggestion would be to drop a small note that ScaledObjects need to be installed or do you have other suggestions?

The license is just a file in the folder structure which I would copy during the release process rather than duplicating it. Thoughts?

+1 to the note idea. The notes should cover anything required for KEDA to function that doesn't happen in the helm install command

Well, it was your good idea as part of #102 :D

From my initial POC with it there wasn't much more to do than deploy app & scaled object so will just do that then maybe?

I think what's left open is the license. Feel free to assign this to me

Notes.txt could include:

  • A link to the scaled objects ref doc or quickstart
  • How to view any scaled objects
  • How to view any HPA that gets created
  • Info on the dashboard

Closed in #315

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ppatierno picture ppatierno  路  4Comments

alexakr picture alexakr  路  4Comments

aman-bansal picture aman-bansal  路  4Comments

audunsol picture audunsol  路  4Comments

gordonbondon picture gordonbondon  路  4Comments