Skip to content

Commit c048881

Browse files
author
TrueForge-Bot
committed
Update website with latest charts and docs
1 parent be656b1 commit c048881

File tree

870 files changed

+48875
-25376
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

870 files changed

+48875
-25376
lines changed

src/content/docs/truecharts/charts/library/common/CHANGELOG.md renamed to src/content/docs/truecharts-common/common/CHANGELOG.md

Lines changed: 52 additions & 50 deletions
Large diffs are not rendered by default.

‎src/content/docs/truecharts-common/common/addons.md‎

Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,250 @@
1+
---
2+
title: Addons
3+
---
4+
5+
:::note
6+
7+
- Examples under each key are only to be used as a placement guide
8+
- See the [Full Examples](/truecharts-common/addons#full-examples) section for complete examples.
9+
10+
:::
11+
12+
## Appears in
13+
14+
- `.Values.addons`
15+
16+
:::tip
17+
18+
- Replace references to `$name` with the actual name you want to use.
19+
20+
:::
21+
22+
---
23+
24+
## `addons`
25+
26+
Addons to the workloads
27+
28+
| | |
29+
| ---------- | -------- |
30+
| Key | `addons` |
31+
| Type | `map` |
32+
| Required | ❌ |
33+
| Helm `tpl` | ❌ |
34+
| Default | `{}` |
35+
36+
Example
37+
38+
```yaml
39+
addons: {}
40+
```
41+
42+
---
43+
44+
### `addons.$addon`
45+
46+
COnfigure the addon
47+
48+
:::note
49+
50+
Available addons:
51+
52+
- CodeServer
53+
- Netshoot
54+
- GlueTun
55+
- Tailscale
56+
57+
:::
58+
59+
| | |
60+
| ---------- | --------------- |
61+
| Key | `addons.$addon` |
62+
| Type | `map` |
63+
| Required | ✅ |
64+
| Helm `tpl` | ❌ |
65+
| Default | `{}` |
66+
67+
Example
68+
69+
```yaml
70+
addons:
71+
codeserver: {}
72+
netshoot: {}
73+
gluetun: {}
74+
tailscale: {}
75+
```
76+
77+
---
78+
79+
#### `addons.$addon.enabled`
80+
81+
Enables or Disables the Addon
82+
83+
| | |
84+
| ---------- | ----------------------- |
85+
| Key | `addons.$addon.enabled` |
86+
| Type | `bool` |
87+
| Required | ✅ |
88+
| Helm `tpl` | ❌ |
89+
| Default | `false` |
90+
91+
Example
92+
93+
```yaml
94+
addons:
95+
codeserver:
96+
enabled: true
97+
```
98+
99+
---
100+
101+
#### `addons.$addon.targetSelector`
102+
103+
Define the workloads to add the addon to
104+
105+
| | |
106+
| ---------- | ------------------------------ |
107+
| Key | `addons.$addon.targetSelector` |
108+
| Type | `list` of `string` |
109+
| Required | ❌ |
110+
| Helm `tpl` | ❌ |
111+
| Default | `["main"]` |
112+
113+
Example
114+
115+
```yaml
116+
addons:
117+
codeserver:
118+
targetSelector:
119+
- main
120+
- other-workload
121+
```
122+
123+
---
124+
125+
#### `addons.$addon.container`
126+
127+
Define additional options for the container
128+
129+
:::tip
130+
131+
See container options in the [container](/truecharts-common/container) section.
132+
133+
:::
134+
135+
| | |
136+
| ---------- | ----------------------------------------------- |
137+
| Key | `addons.$addon.container` |
138+
| Type | `map` |
139+
| Required | ❌ |
140+
| Helm `tpl` | ❌ |
141+
| Default | Depends on the addon (See common's values.yaml) |
142+
143+
Example
144+
145+
```yaml
146+
addons:
147+
codeserver:
148+
container: {}
149+
```
150+
151+
---
152+
153+
#### `addons.$addon.service`
154+
155+
Define additional options for the service
156+
157+
:::tip
158+
159+
See service options in the [service](/truecharts-common/service) section.
160+
161+
:::
162+
163+
:::note
164+
165+
Only applies to:
166+
167+
- Codeserver
168+
169+
:::
170+
171+
| | |
172+
| ---------- | ----------------------------------------------- |
173+
| Key | `addons.$addon.service` |
174+
| Type | `map` |
175+
| Required | ❌ |
176+
| Helm `tpl` | ❌ |
177+
| Default | Depends on the addon (See common's values.yaml) |
178+
179+
Example
180+
181+
```yaml
182+
addons:
183+
codeserver:
184+
service: {}
185+
```
186+
187+
---
188+
189+
#### `addons.$addon.ingress`
190+
191+
Define additional options for the ingress
192+
193+
:::tip
194+
195+
See ingress options in the [ingress](/truecharts-common/ingress) section.
196+
197+
:::
198+
199+
:::note
200+
201+
Only applies to:
202+
203+
- Codeserver
204+
205+
:::
206+
207+
| | |
208+
| ---------- | ----------------------------------------------- |
209+
| Key | `addons.$addon.ingress` |
210+
| Type | `map` |
211+
| Required | ❌ |
212+
| Helm `tpl` | ❌ |
213+
| Default | Depends on the addon (See common's values.yaml) |
214+
215+
Example
216+
217+
```yaml
218+
addons:
219+
codeserver:
220+
ingress: {}
221+
```
222+
223+
---
224+
225+
## Full Examples
226+
227+
```yaml
228+
addons:
229+
codeserver:
230+
enabled: true
231+
container:
232+
resources:
233+
limits:
234+
cpu: 3333m
235+
memory: 3333Mi
236+
service:
237+
enabled: true
238+
ports:
239+
codeserver:
240+
enabled: true
241+
port: 12345
242+
targetPort: 12345
243+
ingress:
244+
enabled: true
245+
hosts:
246+
- host: code.chart-example.local
247+
paths:
248+
- path: /
249+
pathType: Prefix
250+
```

0 commit comments

Comments
 (0)