Helm Chart Checks

[jasperchui]

Note rough sizings in person days are included

Required High (GA 5/10 mandatory)

• (Martin) (2 pd) Deployed container images scanned and verified by Red Hat Verify that images used in chart are Red Hat certified #38 (https://issues.redhat.com/browse/HELM-53)

• (Igor) (10 pd) Run test and include OCP version used for performing the checks Capture OCP version #43

  • enable value overrides

• (Martin) (5 pd) Add annotations to report Add annotations to the report #67

  • Tool generated annotations
    • OCP version Capture OCP version #43
    • timestamp, digest Generate a digest of Helm Chart  #42
  • Annotations from chart Create schema and check for Partner annotations #71

• (Martin) (2pd) Report output to console for collection by partner Provide report to std out instead of a file  #65

  • Create Report schema Provide a schema for the report #64

• (Martin) (5 pd) Ability to define which checks are mandatory, optional, experimental (need to categorize current checks)

Required manual checks

• Chart README.md includes pull secret instructions for private registries if required - will be a manual review of the PR at least for GA.

Required Medium (GA 5/10 nice to have)

• (5 pd) Check to make sure app is not using deprecated APIs (https://issues.redhat.com/browse/HELM-64)
• (10 pd) Chart.yaml includes keywords mapped to OpenShift Categories Chart.yaml includes keywords mapped to OpenShift categories #39 (https://issues.redhat.com/browse/HELM-107)
• (5 pd) Chart includes appropriate license file

Required not prioritized (pots GA 5/10)

• (10 pd) Integrate with other Helm Chart Check providers Enable integration with other chart verification system #36 (ie. Stackrox, IBM cv)
• Chart does not install infra plugins and drivers (network, storage, hardware etc) Verify chart does not install infra plugins and/or drivers #37 ((https://issues.redhat.com/browse/HELM-61)
• Compare minKubeVersion against specific OpenShift release Compare kubeVersion against specific OpenShift Release #40 (https://issues.redhat.com/browse/HELM-108)
• Chart README.md includes prerequisites for installing the chart if it exists

Recommended

• (Recommended) Chart can be installed without manual prerequisites Verify chart can be installed without manual prerequisites #41 (https://issues.redhat.com/browse/HELM-62)
• (Recommended) Chart can be installed without admin privileges (https://issues.redhat.com/browse/HELM-63)

[mmulholla]

https://docs.google.com/spreadsheets/d/1RSYpc7oo3bdQ5DyyWr_ExCmLtQ7IFif3KR-xHfMRXMY/edit#gid=0

[sbose78]

Check to make sure app is not using deprecated APIs

Mid-term/long-term, this is something an external API like kubelinter should help us with?