Skip to content

Commit feaeece

Browse files
Artus-LHINDArtus-LHIND
committed
feat: add full-template example
1 parent 61d5caf commit feaeece

File tree

4 files changed

+317
-0
lines changed

4 files changed

+317
-0
lines changed

‎example-charts/full-template/Chart.yaml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
apiVersion: v2
2+
name: full-template
3+
deprecated: true
4+
version: "1.0.0"
5+
type: application
6+
appVersion: "13.0.0"
7+
description: A chart for showing every README-element
8+
home: "https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"
9+
maintainers:
10+
- email: [email protected]
11+
name: John Norwood
12+
sources: ["https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template"]
13+
kubeVersion: "<=1.18"
14+
engine: gotpl
15+
16+
dependencies:
17+
- name: nginx-ingress
18+
version: "0.22.1"
19+
repository: "@stable"

‎example-charts/full-template/README.md

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
# full-template
2+
3+
## `chart.deprecationWarning`
4+
5+
> **:exclamation: This Helm Chart is deprecated!**
6+
7+
## `chart.description`
8+
9+
A chart for showing every README-element
10+
11+
## `chart.version`
12+
13+
1.0.0
14+
15+
## `chart.versionLine`
16+
17+
Current chart version is `1.0.0`
18+
19+
## `chart.versionBadge`
20+
21+
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square)
22+
23+
## `chart.type`
24+
25+
application
26+
27+
## `chart.typeLine`
28+
29+
Current chart type is `application`
30+
31+
## `chart.typeBadge`
32+
33+
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
34+
35+
## `chart.appVersion`
36+
37+
13.0.0
38+
39+
## `chart.appVersionLine`
40+
41+
Current chart appVersion is `13.0.0`
42+
43+
## `chart.appVersionBadge`
44+
45+
![AppVersion: 13.0.0](https://img.shields.io/badge/AppVersion-13.0.0-informational?style=flat-square)
46+
47+
## `chart.homepage`
48+
49+
https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template
50+
51+
## `chart.homepageLine`
52+
53+
**Homepage:** <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
54+
55+
## `chart.maintainersHeader`
56+
57+
## Maintainers
58+
59+
## `chart.maintainersTable`
60+
61+
| Name | Email | Url |
62+
| ---- | ------ | --- |
63+
| John Norwood | [email protected] | |
64+
65+
## `chart.maintainersSection`
66+
67+
## Maintainers
68+
69+
| Name | Email | Url |
70+
| ---- | ------ | --- |
71+
| John Norwood | [email protected] | |
72+
73+
## `chart.sourcesHeader`
74+
75+
## Source Code
76+
77+
## `chart.sourcesList`
78+
79+
80+
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
81+
82+
## `chart.sourcesSection`
83+
84+
## Source Code
85+
86+
* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/full-template>
87+
88+
## `chart.kubeVersion`
89+
90+
<=1.18
91+
92+
## `chart.kubeVersionLine`
93+
94+
Kubernetes: `<=1.18`
95+
96+
## `chart.requirementsHeader`
97+
98+
## Requirements
99+
100+
## `chart.requirementsTable`
101+
102+
| Repository | Name | Version |
103+
|------------|------|---------|
104+
| @stable | nginx-ingress | 0.22.1 |
105+
106+
## `chart.requirementsSection`
107+
108+
## Requirements
109+
110+
Kubernetes: `<=1.18`
111+
112+
| Repository | Name | Version |
113+
|------------|------|---------|
114+
| @stable | nginx-ingress | 0.22.1 |
115+
116+
## `chart.valuesHeader`
117+
118+
## Values
119+
120+
## `chart.valuesTable`
121+
122+
| Key | Type | Default | Description |
123+
|-----|------|---------|-------------|
124+
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
125+
| controller.extraVolumes[0].name | string | `"config-volume"` | |
126+
| controller.image.repository | string | `"nginx-ingress-controller"` | |
127+
| controller.image.tag | string | `"18.0831"` | |
128+
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
129+
| controller.name | string | `"controller"` | |
130+
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
131+
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
132+
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
133+
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
134+
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
135+
| controller.service.type | string | `"LoadBalancer"` | |
136+
137+
## `chart.valuesSection`
138+
139+
## Values
140+
141+
| Key | Type | Default | Description |
142+
|-----|------|---------|-------------|
143+
| controller.extraVolumes[0].configMap.name | string | `"nginx-ingress-config"` | Uses the name of the configmap created by this chart |
144+
| controller.extraVolumes[0].name | string | `"config-volume"` | |
145+
| controller.image.repository | string | `"nginx-ingress-controller"` | |
146+
| controller.image.tag | string | `"18.0831"` | |
147+
| controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
148+
| controller.name | string | `"controller"` | |
149+
| controller.persistentVolumeClaims | list | the chart will construct this list internally unless specified | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
150+
| controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
151+
| controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
152+
| controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |
153+
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
154+
| controller.service.type | string | `"LoadBalancer"` | |

‎example-charts/full-template/README.md.gotmpl

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
{{ template "chart.header" . }}
2+
## `chart.deprecationWarning`
3+
4+
{{ template "chart.deprecationWarning" . }}
5+
6+
## `chart.description`
7+
8+
{{ template "chart.description" . }}
9+
10+
## `chart.version`
11+
12+
{{ template "chart.version" . }}
13+
14+
## `chart.versionLine`
15+
16+
{{ template "chart.versionLine" . }}
17+
18+
## `chart.versionBadge`
19+
20+
{{ template "chart.versionBadge" . }}
21+
22+
## `chart.type`
23+
24+
{{ template "chart.type" . }}
25+
26+
## `chart.typeLine`
27+
28+
{{ template "chart.typeLine" . }}
29+
30+
## `chart.typeBadge`
31+
32+
{{ template "chart.typeBadge" . }}
33+
34+
## `chart.appVersion`
35+
36+
{{ template "chart.appVersion" . }}
37+
38+
## `chart.appVersionLine`
39+
40+
{{ template "chart.appVersionLine" . }}
41+
42+
## `chart.appVersionBadge`
43+
44+
{{ template "chart.appVersionBadge" . }}
45+
46+
## `chart.homepage`
47+
48+
{{ template "chart.homepage" . }}
49+
50+
## `chart.homepageLine`
51+
52+
{{ template "chart.homepageLine" . }}
53+
54+
## `chart.maintainersHeader`
55+
56+
{{ template "chart.maintainersHeader" . }}
57+
58+
## `chart.maintainersTable`
59+
60+
{{ template "chart.maintainersTable" . }}
61+
62+
## `chart.maintainersSection`
63+
64+
{{ template "chart.maintainersSection" . }}
65+
66+
## `chart.sourcesHeader`
67+
68+
{{ template "chart.sourcesHeader" . }}
69+
70+
## `chart.sourcesList`
71+
72+
{{ template "chart.sourcesList" . }}
73+
74+
## `chart.sourcesSection`
75+
76+
{{ template "chart.sourcesSection" . }}
77+
78+
## `chart.kubeVersion`
79+
80+
{{ template "chart.kubeVersion" . }}
81+
82+
## `chart.kubeVersionLine`
83+
84+
{{ template "chart.kubeVersionLine" . }}
85+
86+
## `chart.requirementsHeader`
87+
88+
{{ template "chart.requirementsHeader" . }}
89+
90+
## `chart.requirementsTable`
91+
92+
{{ template "chart.requirementsTable" . }}
93+
94+
## `chart.requirementsSection`
95+
96+
{{ template "chart.requirementsSection" . }}
97+
98+
## `chart.valuesHeader`
99+
100+
{{ template "chart.valuesHeader" . }}
101+
102+
## `chart.valuesTable`
103+
104+
{{ template "chart.valuesTable" . }}
105+
106+
## `chart.valuesSection`
107+
108+
{{ template "chart.valuesSection" . }}

‎example-charts/full-template/values.yaml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
controller:
2+
name: controller
3+
image:
4+
repository: nginx-ingress-controller
5+
tag: "18.0831"
6+
7+
# controller.persistentVolumeClaims -- List of persistent volume claims to create.
8+
# For very long comments, break them into multiple lines.
9+
# @default -- the chart will construct this list internally unless specified
10+
persistentVolumeClaims: []
11+
12+
extraVolumes:
13+
- name: config-volume
14+
configMap:
15+
# controller.extraVolumes[0].configMap.name -- Uses the name of the configmap created by this chart
16+
name: nginx-ingress-config
17+
18+
# controller.ingressClass -- Name of the ingress class to route through this controller
19+
ingressClass: nginx
20+
21+
# controller.podLabels -- The labels to be applied to instances of the controller pod
22+
podLabels: {}
23+
24+
publishService:
25+
# controller.publishService.enabled -- Whether to expose the ingress controller to the public world
26+
enabled: false
27+
28+
# controller.replicas -- (int) Number of nginx-ingress pods to load balance between
29+
replicas:
30+
31+
service:
32+
annotations:
33+
# controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" -- Hostname to be assigned to the ELB for the service
34+
external-dns.alpha.kubernetes.io/hostname: stupidchess.jmn23.com
35+
36+
type: LoadBalancer

0 commit comments

Comments
 (0)