Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

Commit

Permalink
mention about installatiion with Helm v2 and v3 in a more clear manner
Browse files Browse the repository at this point in the history
  • Loading branch information
karuppiah7890 committed Dec 24, 2020
1 parent 75934be commit 2ebc39a
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Nothing fancy about the code, all the heavy lifting is done by:

## Install

The plugin works with both helm v2 and v3 versions
The plugin works with both Helm v2 and v3 versions as it's agnostic to the Helm
binary version

```
$ helm plugin install https://github.com/karuppiah7890/helm-schema-gen.git
Expand All @@ -25,9 +26,15 @@ karuppiah7890/helm-schema-gen info installed ./bin/helm-schema-gen
Installed plugin: schema-gen
```

But note that the schema feature is present only in Helm v3 charts, so Helm
chart still has to be v3, meaning - based on the Helm chart v3 spec. And the
schema validation is only done in Helm v3. Read more in the
[Schema Files](https://helm.sh/docs/topics/charts/#schema-files) section of the
Helm official docs.

## Usage

The plugin works with both helm v2 and v3 versions
The plugin works with both Helm v2 and v3 versions

Let's take a sample `values.yaml` like the below

Expand Down

0 comments on commit 2ebc39a

Please sign in to comment.