Skip to main content

Tool for vendoring Helm charts into a Git repository

Project description

chart-vendor

Overview

This is a simple tool which allows you to vendor Helm charts from external sources into your repository, with the ability to apply patches to the vendored charts.

Installation

pip install chart-vendor

Usage

Basic Command

chart-vendor [CHART_NAME]
  • CHART_NAME (optional): The name of the specific chart to fetch. If omitted, all charts specified in the configuration will be fetched.

Options

  • --charts-root: Root path where charts are generated. Default is charts.
  • --check: Check if all chart manifests are applied or not. If there are uncommitted changes or untracked files, the check will fail.

Examples

Fetch All Charts

chart-vendor

Fetch a Specific Chart

chart-vendor my-chart

Check for Uncommitted Changes

chart-vendor --check

Configuration

The CLI expects a configuration file named .charts.yml in the current working directory. This file should define the charts to be managed. The format of the configuration file is based on Pydantic models.

Example Configuration

charts:
  - name: my-chart
    repository:
      url: https://example.com/charts
    version: 1.0.0
    dependencies:
      - name: dependency-chart
        repository:
          url: https://example.com/dependency-charts
        version: 1.2.3
    patches:
      gerrit:
        example.gerrit.com:
          - 12345
          - 67890

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chart-vendor-0.2.0.tar.gz (8.5 kB view hashes)

Uploaded Source

Built Distribution

chart_vendor-0.2.0-py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page