Coder Social home page Coder Social logo

Parsing Chart.yaml ? about chart-doc-gen HOT 1 OPEN

sparqueur avatar sparqueur commented on August 23, 2024 2
Parsing Chart.yaml ?

from chart-doc-gen.

Comments (1)

chgl avatar chgl commented on August 23, 2024

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?

from chart-doc-gen.

Related Issues (12)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.