JarCasting
JarCasting JarCasting

com.melahn:helm-chartmap-generator

A tool that generates a set of helm dependency reports in various formats for a given helm chart repository

License

License
GroupId

GroupId

com.melahn
ArtifactId

ArtifactId

helm-chartmap-generator
Last Version

Last Version

1.0.2
Release Date

Release Date
Type

Type

jar
Description

Description

com.melahn:helm-chartmap-generator
A tool that generates a set of helm dependency reports in various formats for a given helm chart repository
Project URL

Project URL

https://github.com/melahn/helm-chartmap-generator
Source Code Management

Source Code Management

https://github.com/melahn/helm-chartmap-generator/tree/master

Download helm-chartmap-generator

Filename Size
helm-chartmap-generator-1.0.2.pom
helm-chartmap-generator-1.0.2.jar 10 MB
helm-chartmap-generator-1.0.2-sources.jar 6 KB
helm-chartmap-generator-1.0.2-javadoc.jar 393 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.melahn/helm-chartmap-generator/ -->
<dependency>
    <groupId>com.melahn</groupId>
    <artifactId>helm-chartmap-generator</artifactId>
    <version>1.0.2</version>
</dependency>
// https://jarcasting.com/artifacts/com.melahn/helm-chartmap-generator/
implementation 'com.melahn:helm-chartmap-generator:1.0.2'
// https://jarcasting.com/artifacts/com.melahn/helm-chartmap-generator/
implementation ("com.melahn:helm-chartmap-generator:1.0.2")
'com.melahn:helm-chartmap-generator:jar:1.0.2'
<dependency org="com.melahn" name="helm-chartmap-generator" rev="1.0.2">
  <artifact name="helm-chartmap-generator" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.melahn', module='helm-chartmap-generator', version='1.0.2')
)
libraryDependencies += "com.melahn" % "helm-chartmap-generator" % "1.0.2"
[com.melahn/helm-chartmap-generator "1.0.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

helm-chartmap-generator

version License

Overview

This project generates a set of helm dependency reports in various formats for a given helm chart repository. It uses the ChartMap project to generate the reports.

The generated reports can be in various formats including

  • JSON which can be viewed using helm-inspector
  • PlantUML which are then turned into images using PlantUML
  • Text which can of course be viewed using any text editor

In addition to producing the dependency report files, an 'index.html' file is produced that lists the files and provided links to view them.

You can see lots of examples here -> https://melahn.github.io/helm-chartmap-generator/

Maven Central

The jar file, along with source and javadoc, is available from Maven Central.

<dependency>
  <groupId>com.melahn</groupId>
  <artifactId>helm-chartmap-generator</artifactId>
  <version>1.0.2</version>
</dependency>

Prerequisites

  • Java 8 or later.

Usage

  1. Download the executable jar from the resource directory, or download it from Maven Central or build it yourself from source (see below).

  2. Run the command line. See Syntax and Examples below.

Command Line Syntax

java -jar helm-chartmap-generator-1.0.2.jar

Flags:
	-r	<repo name>		the name of the local helm repo to use (required)
	-o	<directory name>	the output directory to use (default <pwd>) (optional)
	-f	<file format mask>	a string containing any combination of 'j','p' and 't' (default 't') (optional)
	-n	<integer>		the maximum number of chart versions to print (default 1) (optional)
	-e	<file name>		environment file (optional)
	-v	verbose			print verbose output (optional)
	-h	help			provide help (optional)

Flags

  • Required
    • -r <repo name>
      • The name of the local helm repo to use. Run 'helm repo list' to see the names of the local helm repos and use any one of them here. A set of one or more reports will be generated for all the charts in that repo.
  • Optional
    • -o <directory name>
      • The name of directory to which the files will be written. The default is the current working directory.
    • -f <file format mask>
      • A string that is formed from the characters 'j','p' and 't' in any order or frequency. If the mask contains the character 'j' a JSON file will be generated. If the mask contains the character 'p' a PlantUML file will be generated. If the mask contains the character 't' a text file will be generated. For example. if the file format mask contains 'jt', then a JSON file report and a text file report will be generated for each chart found in the repo. The default is 't'.
    • -n <integer>
      • The maximum number of versions of a chart to print. For example if there are 8 versions of a given chart in the chart repo and you specify a value of 2, then reports for only the 2 most recent versions will be printed. The default is 1.
    • -e <filename>
      • The location of an Environment Specification which is a yaml file containing a list of environment variables to set before rendering helm templates. See the example environment specification provided in resource/example-env-spec.yaml to understand the format. The default is that no environment specification will be used.
    • -v
      • Verbose. If specified, some extra command line output is shown.
    • -h
      • Help. Whenever specified, any other parameters are ignored. When no parameters are specified, -h is assumed.

Example Commands

Generating reports from the incubator repo using all the detaults
    java -helm-chartmap-generator-1.0.2.jar -r incubator
Generating JSON and PlantUML reports from the stable repo, with up to 3 versions printed with verbose output
    java -helm-chartmap-generator-1.0.2.jar -r stable -f pt -n 3 -v

Notes

When using PlantUML files, the images that are then produced from those files will look best when the following system environment variable variable is set

PLANTUML_LIMIT_SIZE 8192

Issues

If you find any problems please open an issue.

License

MIT

Versions

Version
1.0.2