52 lines
366 KiB
HTML
52 lines
366 KiB
HTML
|
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Project Documentation for TrueCharts"><meta name=author content="TrueCharts Team"><link href=https://truecharts.org/manual/development/chart-structure/ rel=canonical><link rel=icon href=../../../_static/img/favicon.png><meta name=generator content="mkdocs-1.3.0, mkdocs-material-8.3.8"><title>TrueNAS SCALE Chart Structure - TrueCharts</title><link rel=stylesheet href=../../../assets/stylesheets/main.1d29e8d0.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.cbb835fc.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../../_static/custom.css><script>__md_scope=new URL("../../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-6G6694723V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&>ag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-6G6694723V",{page_path:e.pathname})})})</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-6G6694723V"></script></head> <body dir=ltr data-md-color-scheme data-md-color-primary=none data-md-color-accent=none> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#truenas-scale-chart-structure class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title=TrueCharts class="md-header__button md-logo" aria-label=TrueCharts data-md-component=logo> <img src=../../../_static/img/logo1024.png alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> TrueCharts </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> TrueNAS SCALE Chart Structure </span> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/truecharts/pub title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.
|
||
|
|
charts/ # Directory containing dependency charts
|
||
|
|
Chart.yaml # Required Helm chart information file
|
||
|
|
README.md # Optional: Helm Readme file (will be rendered in TrueNAS SCALE UI as well)
|
||
|
|
templates/ # A directory of templates that, when combined with values.yml will generate K8s YAML
|
||
|
|
values.yaml # The default configuration values for this chart
|
||
|
|
</code></pre></div> <p>The following files are specific for TrueNAS SCALE:</p> <div class=highlight><pre><span></span><code>charts/<train>/<chart name>/SCALE/
|
||
|
|
app-readme.md # TrueNAS SCALE Specific: Readme file for display in TrueNAS SCALE UI, automatically generated
|
||
|
|
questions.yaml # TrueNAS SCALE Specific: File containing questions for TrueNAS SCALE UI
|
||
|
|
ix_values.yaml # Hidden configuration values when installing using TrueNAS SCALE
|
||
|
|
item.yaml # Contains generic information about the App for the TrueNAS SCALE UI
|
||
|
|
</code></pre></div> <p><em>See the upstream Helm chart <a href=https://helm.sh/docs/chart_template_guide/ >developer reference</a> for a complete walk through of developing charts.</em></p> <p>To convert an upstream chart to take advantage of TrueNAS SCALE enhanced UX, first create an <code>item.yaml</code> file. This file among other catalog item information provides a list of categories that this chart fits into. This helps users navigate and filtering when browsing the catalog UI.</p> <div class=highlight><pre><span></span><code>$ cat charts/<train>/<chart name>/SCALE/item.yaml
|
||
|
|
categories:
|
||
|
|
- generic
|
||
|
|
icon_url: "http://ix_url"
|
||
|
|
</code></pre></div> <p>Then add a <code>questions.yaml</code> file to prompt the user for something.</p> <div class=highlight><pre><span></span><code>groups:
|
||
|
|
- name: "Container Images"
|
||
|
|
description: "Image to be used for container"
|
||
|
|
questions:
|
||
|
|
- variable: image
|
||
|
|
description: "Docker Image Details"
|
||
|
|
group: "Container Images"
|
||
|
|
schema:
|
||
|
|
type: dict
|
||
|
|
required: true
|
||
|
|
attrs:
|
||
|
|
- variable: repository
|
||
|
|
description: "Docker image repository"
|
||
|
|
label: "Image repository"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
required: true
|
||
|
|
- variable: tag
|
||
|
|
description: "Tag to use for specified image"
|
||
|
|
label: "Image Tag"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "latest"
|
||
|
|
- variable: pullPolicy
|
||
|
|
description: "Docker Image Pull Policy"
|
||
|
|
label: "Image Pull Policy"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "IfNotPresent"
|
||
|
|
enum:
|
||
|
|
- value: "IfNotPresent"
|
||
|
|
description: "Only pull image if not present on host"
|
||
|
|
- value: "Always"
|
||
|
|
description: "Always pull image even if present on host"
|
||
|
|
- value: "Never"
|
||
|
|
description: "Never pull image even if it's not present on host"
|
||
|
|
</code></pre></div> <p>The above will prompt the user with 2 text fields and a dropdown in the UI getting details for image configuration in a helm chart. <em>More information about questions.yaml is available <a href=https://wiki.truecharts.org/development/questions-yaml/ >here</a></em></p> </article> </div> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../License-headers/ class="md-footer__link md-footer__link--prev" aria-label="Previous: License Header Format" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Previous </span> License Header Format </div> </div> </a> <a href=../chart-yaml-structure/ class="md-footer__link md-footer__link--next" aria-label="Next: Chart.yaml layout" rel=next> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Next </span> Chart.yaml layout </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright © 2020 - 2022 The TrueCharts Project </div> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["navigation.tabs", "navigation.tracking", "navigation.instant", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.b97dbffb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> <script src=../../../assets/javascripts/bundle.0238f547.min.js></script> </body> </html>
|