{"id":15233395,"url":"https://github.com/karuppiah7890/helm-schema-gen","last_synced_at":"2025-10-04T18:31:38.387Z","repository":{"id":53818548,"uuid":"221866986","full_name":"karuppiah7890/helm-schema-gen","owner":"karuppiah7890","description":"So that you don't have to write values.schema.json by hand from scratch for your Helm 3 charts. [CURRENTLY NOT MAINTAINED]","archived":true,"fork":false,"pushed_at":"2021-07-08T05:52:10.000Z","size":64,"stargazers_count":129,"open_issues_count":9,"forks_count":60,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-16T16:07:07.960Z","etag":null,"topics":["go","golang","hacktoberfest","helm","helm-plugin","helm-schema-gen","json-schema","k8s","plugin"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/karuppiah7890.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-15T07:19:53.000Z","updated_at":"2024-08-09T10:31:20.000Z","dependencies_parsed_at":"2022-08-21T10:10:22.863Z","dependency_job_id":null,"html_url":"https://github.com/karuppiah7890/helm-schema-gen","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karuppiah7890%2Fhelm-schema-gen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karuppiah7890%2Fhelm-schema-gen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karuppiah7890%2Fhelm-schema-gen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karuppiah7890%2Fhelm-schema-gen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karuppiah7890","download_url":"https://codeload.github.com/karuppiah7890/helm-schema-gen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235289302,"owners_count":18965918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","golang","hacktoberfest","helm","helm-plugin","helm-schema-gen","json-schema","k8s","plugin"],"created_at":"2024-09-29T05:08:13.449Z","updated_at":"2025-10-04T18:31:33.105Z","avatar_url":"https://github.com/karuppiah7890.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# helm schema gen plugin [ CURRENTLY NOT MAINTAINED ]\n\n![](https://github.com/karuppiah7890/helm-schema-gen/workflows/goreleaser/badge.svg)\n\nSo that you don't have to write values.schema.json by hand from scratch for your Helm 3 charts\n\n[Helm](https://helm.sh) plugin to generate [JSON Schema for values yaml](https://helm.sh/docs/topics/charts/#schema-files)\n\n## Note about maintenance\n\nI currently don't have the bandwidth to reply to issues, write code and review PRs. For now I recommend forking the repo and making changes and using the fork 😅\n\n## Code stuff\n\nNothing fancy about the code, all the heavy lifting is done by:\n\n- [go-jsonschema-generator](https://github.com/karuppiah7890/go-jsonschema-generator) - for generating JSON schema. It's a fork of [this](https://github.com/mcuadros/go-jsonschema-generator). Thanks to [@mcuadros](https://github.com/mcuadros)\n- [go-yaml](https://github.com/go-yaml/yaml/) - for YAML parsing\n- [cobra](https://github.com/spf13/cobra) - for CLI stuff\n- [The Go stdlib](https://golang.org/pkg/) - for everything else\n\n\n## Install\n\nThe plugin works with both Helm v2 and v3 versions as it's agnostic to the Helm\nbinary version\n\n```\n$ helm plugin install https://github.com/karuppiah7890/helm-schema-gen.git\nkaruppiah7890/helm-schema-gen info checking GitHub for tag '0.0.4'\nkaruppiah7890/helm-schema-gen info found version: 0.0.4 for 0.0.4/Darwin/x86_64\nkaruppiah7890/helm-schema-gen info installed ./bin/helm-schema-gen\nInstalled plugin: schema-gen\n```\n\nBut note that the schema feature is present only in Helm v3 charts, so Helm\nchart still has to be v3, meaning - based on the Helm chart v3 spec. And the\nschema validation is only done in Helm v3. Read more in the\n[Schema Files](https://helm.sh/docs/topics/charts/#schema-files) section of the\nHelm official docs.\n\n## Usage\n\nThe plugin works with both Helm v2 and v3 versions\n\nLet's take a sample `values.yaml` like the below\n\n```\nreplicaCount: 1\n\nimage:\n  repository: nginx\n  pullPolicy: IfNotPresent\n\nimagePullSecrets: []\nnameOverride: \"\"\nfullnameOverride: \"\"\n\nserviceAccount:\n  # Specifies whether a service account should be created\n  create: true\n  # The name of the service account to use.\n  # If not set and create is true, a name is generated using the fullname template\n  name:\n\npodSecurityContext: {}\n  # fsGroup: 2000\n\nsecurityContext: {}\n  # capabilities:\n  #   drop:\n  #   - ALL\n  # readOnlyRootFilesystem: true\n  # runAsNonRoot: true\n  # runAsUser: 1000\n\nservice:\n  type: ClusterIP\n  port: 80\n\ningress:\n  enabled: false\n  annotations: {}\n    # kubernetes.io/ingress.class: nginx\n    # kubernetes.io/tls-acme: \"true\"\n  hosts:\n    - host: chart-example.local\n      paths: []\n  tls: []\n  #  - secretName: chart-example-tls\n  #    hosts:\n  #      - chart-example.local\n\nresources: {}\n  # We usually recommend not to specify default resources and to leave this as a conscious\n  # choice for the user. This also increases chances charts run on environments with little\n  # resources, such as Minikube. If you do want to specify resources, uncomment the following\n  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.\n  # limits:\n  #   cpu: 100m\n  #   memory: 128Mi\n  # requests:\n  #   cpu: 100m\n  #   memory: 128Mi\n\nnodeSelector: {}\n\ntolerations: []\n\naffinity: {}\n```\n\nNow if you use the plugin and pass the `values.yaml` to it, you will\nget the JSON Schema for the `values.yaml`\n\n```\n$ helm schema-gen values.yaml\n{\n    \"$schema\": \"http://json-schema.org/schema#\",\n    \"type\": \"object\",\n    \"properties\": {\n        \"affinity\": {\n            \"type\": \"object\"\n        },\n        \"fullnameOverride\": {\n            \"type\": \"string\"\n        },\n        \"image\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"pullPolicy\": {\n                    \"type\": \"string\"\n                },\n                \"repository\": {\n                    \"type\": \"string\"\n                }\n            }\n        },\n        \"imagePullSecrets\": {\n            \"type\": \"array\"\n        },\n        \"ingress\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"annotations\": {\n                    \"type\": \"object\"\n                },\n                \"enabled\": {\n                    \"type\": \"boolean\"\n                },\n                \"hosts\": {\n                    \"type\": \"array\",\n                    \"items\": {\n                        \"type\": \"object\",\n                        \"properties\": {\n                            \"host\": {\n                                \"type\": \"string\"\n                            },\n                            \"paths\": {\n                                \"type\": \"array\"\n                            }\n                        }\n                    }\n                },\n                \"tls\": {\n                    \"type\": \"array\"\n                }\n            }\n        },\n        \"nameOverride\": {\n            \"type\": \"string\"\n        },\n        \"nodeSelector\": {\n            \"type\": \"object\"\n        },\n        \"podSecurityContext\": {\n            \"type\": \"object\"\n        },\n        \"replicaCount\": {\n            \"type\": \"integer\"\n        },\n        \"resources\": {\n            \"type\": \"object\"\n        },\n        \"securityContext\": {\n            \"type\": \"object\"\n        },\n        \"service\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"port\": {\n                    \"type\": \"integer\"\n                },\n                \"type\": {\n                    \"type\": \"string\"\n                }\n            }\n        },\n        \"serviceAccount\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"create\": {\n                    \"type\": \"boolean\"\n                },\n                \"name\": {\n                    \"type\": \"null\"\n                }\n            }\n        },\n        \"tolerations\": {\n            \"type\": \"array\"\n        }\n    }\n}\n```\n\nYou can save it to a file like this\n\n```\n$ helm schema-gen values.yaml \u003e values.schema.json\n```\n\n## Issues? Feature Requests? Proposals? Feedback?\n\nNote: I currently don't have the bandwidth to reply to issues, write code and review PRs. For now I recommend forking the repo and making changes and using the fork 😅\n\nPut them all in [GitHub issues](https://github.com/karuppiah7890/helm-schema-gen/issues) 😁\nI value every feedback. I really want to make sure that my tools help people and does not\nannoy people. I want my tools to enable people and not hinder them. I'll do my best to help you\nif you face any hindrance because of using my tools! :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaruppiah7890%2Fhelm-schema-gen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaruppiah7890%2Fhelm-schema-gen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaruppiah7890%2Fhelm-schema-gen/lists"}