Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parsing Chart.yaml ? #14

Open
sparqueur opened this issue Oct 2, 2020 · 1 comment
Open

Parsing Chart.yaml ? #14

sparqueur opened this issue Oct 2, 2020 · 1 comment

Comments

@sparqueur
Copy link

Hi,

Your project is really geat 👍
However, why do we have to provide a doc.yaml which contains a chart block ?
The Chart.yaml could be used as an input, no ?

@chgl
Copy link

chgl commented Mar 1, 2021

Some fields in doc.yaml don't have a correspondence in Chart.yaml, e.g. doc.yaml's repository.url/name. But I think the Chart.yaml's annotations could be used for this, something like:

apiVersion: v2
name: test
description: A Helm chart for deploying the test app on Kubernetes.
type: application
version: 1.0.0
annotations:
  chart-doc-gen.appscode.com/repository-url: https://charts.appscode.com/stable/
  chart-doc-gen.appscode.com/repository-name: appscode
  # ...
  # or even:
  chart-doc-gen.appscode.com/doc.yaml: |
    project:
      name: Stash by AppsCode
      shortName: Stash
      url: https://github.com/stashed/stash
      description: Backup your Kubernetes Volumes
      app: a Stash operator
    repository:
      url: https://charts.appscode.com/stable/
      name: appscode
    chart:
      name: stash
      version: v0.9.0-rc.0
      values: "-- generate from values file --"
      valuesExample: "-- generate from values file --"
    prerequisites:
    - "Kubernetes v1.14+"
    - "`--allow-privileged` flag must be set to true for both the API server and the kubelet"
    - "(If you use Docker) The Docker daemon of the cluster nodes must allow shared mounts"
    - "Pre-installed HashiCorp Vault server."
    release:
      name: stash-operator
      namespace: kube-system

With some reasonable defaults if the annotations aren't used?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants