my-chart-verifier

README

my-chart-verifier: Rules based tool to certify Helm charts

The my-chart-verifier CLI tool allows you to validate the Helm chart against a configurable list of checks. The tool ensures that the Helm charts include the associated metadata and formatting, and are distribution ready.

The tool allows users to validate a Helm chart URL and provides a report where each check has a positive or negative result. A negative result from a check indicates a problem with the chart, which needs correction. It ensures that the Helm chart works seamlessly on Red Hat OpenShift and can be submitted as a certified Helm chart in the OpenShift Helm Repository.

The input is provided through the command-line interface, with the only required input parameter being the uri option. The output is represented through a YAML format with descriptions added in a human-readable format. The report should be submitted with a full set of checks thus validating the Helm chart.

The tool provides the following features:

• Helm chart verification: Verifies if a Helm chart is compliant with a certain set of independent checks with no particular execution order.
• Red Hat OpenShift Certified chart validation: Verifies the Helm chart's readiness for being certified and submitted in the OpenShift Helm Repository.
• Report generation: Generates a verification report in a YAML format.
• Customizable checks: Defines the checks you wish to execute during the verification process.

For more information see:

• The command line interface and checks performed
  • Key features
  • Types of Helm chart checks
  • Default set of checks for a Helm chart
  • Run Helm chart checks
  • Profiles
  • Chart Testing
• Certification Annotations
  • Verifier added annotations
  • Annotations by profile
  • Provider annotations
• Introduction to the submission process
  • Submission options
  • Provider controlled delivery
• Troubleshooting
  • Check failures
  • Report related submission failures
• Chart Verifier API
  • Overview
  • Verifier
  • Report
  • Report Summary
  • Checks
  • Example

For developer specific information, see:

• Additional information for developers.
• Creating a my-chart-verifier release.

Documentation

Overview

* Copyright 2021 Red Hat * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.