Skip to content

Commit 37e04df

Browse files
IlyesbdlalaWeltraumschaf
Ilyesbdlala
authored and
Weltraumschaf
committed
#2086 Regenerated helm docs to fit with the Docusaurus v3 upgrade changes
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
1 parent eeb55db commit 37e04df

52 files changed

Lines changed: 14230 additions & 1578 deletions

File tree

Some content is hidden

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

‎.templates/new-scanner/README.md‎

Lines changed: 340 additions & 37 deletions
Large diffs are not rendered by default.

‎auto-discovery/cloud-aws/README.md‎

Lines changed: 340 additions & 37 deletions
Large diffs are not rendered by default.

‎auto-discovery/kubernetes/README.md‎

Lines changed: 460 additions & 49 deletions
Large diffs are not rendered by default.

‎demo-targets/bodgeit/README.md‎

Lines changed: 230 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -52,32 +52,236 @@ The bodgeit chart can be deployed via helm:
5252
helm upgrade --install bodgeit secureCodeBox/bodgeit
5353
```
5454

55-
## Values
56-
57-
| Key | Type | Default | Description |
58-
|-----|------|---------|-------------|
59-
| affinity | object | `{}` | |
60-
| annotations | object | `{}` | add annotations to the deployment, service and pods |
61-
| fullnameOverride | string | `""` | |
62-
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
63-
| image.repository | string | `"docker.io/securecodebox/bodgeit"` | Container Image containing the bodgeit |
64-
| image.tag | string | defaults to the "latest" version because the appVersion tag is not available at docker.io | The image tag |
65-
| imagePullSecrets | list | `[]` | Define imagePullSecrets when a private registry is used (see: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) |
66-
| ingress.annotations | object | `{}` | |
67-
| ingress.enabled | bool | `false` | |
68-
| ingress.hosts[0].host | string | `"chart-example.local"` | |
69-
| ingress.hosts[0].paths | list | `[]` | |
70-
| ingress.tls | list | `[]` | |
71-
| labels | object | `{}` | add labels to the deployment, service and pods |
72-
| nameOverride | string | `""` | |
73-
| nodeSelector | object | `{}` | |
74-
| podSecurityContext | object | `{}` | |
75-
| replicaCount | int | `1` | |
76-
| resources | object | `{}` | |
77-
| securityContext | object | `{}` | |
78-
| service.port | int | `8080` | |
79-
| service.type | string | `"ClusterIP"` | |
80-
| tolerations | list | `[]` | |
55+
<table>
56+
<thead>
57+
<th>Key</th>
58+
<th>Type</th>
59+
<th class="default-column">Default</th>
60+
<th>Description</th>
61+
</thead>
62+
<tbody>
63+
<tr>
64+
<td>affinity</td>
65+
<td>object</td>
66+
<td class="default-column">
67+
<pre lang="yaml">
68+
69+
`{}`
70+
</pre></td>
71+
<td></td>
72+
</tr>
73+
<tr>
74+
<td>annotations</td>
75+
<td>object</td>
76+
<td class="default-column">
77+
<pre lang="yaml">
78+
79+
`{}`
80+
</pre></td>
81+
<td>add annotations to the deployment, service and pods</td>
82+
</tr>
83+
<tr>
84+
<td>fullnameOverride</td>
85+
<td>string</td>
86+
<td class="default-column">
87+
<pre lang="yaml">
88+
89+
`""`
90+
</pre></td>
91+
<td></td>
92+
</tr>
93+
<tr>
94+
<td>image.pullPolicy</td>
95+
<td>string</td>
96+
<td class="default-column">
97+
<pre lang="yaml">
98+
99+
`"IfNotPresent"`
100+
</pre></td>
101+
<td>Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images</td>
102+
</tr>
103+
<tr>
104+
<td>image.repository</td>
105+
<td>string</td>
106+
<td class="default-column">
107+
<pre lang="yaml">
108+
109+
`"docker.io/securecodebox/bodgeit"`
110+
</pre></td>
111+
<td>Container Image containing the bodgeit</td>
112+
</tr>
113+
<tr>
114+
<td>image.tag</td>
115+
<td>string</td>
116+
<td class="default-column">
117+
<pre lang="yaml">
118+
119+
defaults to the "latest" version because the appVersion tag is not available at docker.io
120+
</pre></td>
121+
<td>The image tag</td>
122+
</tr>
123+
<tr>
124+
<td>imagePullSecrets</td>
125+
<td>list</td>
126+
<td class="default-column">
127+
<pre lang="yaml">
128+
129+
`[]`
130+
</pre></td>
131+
<td>Define imagePullSecrets when a private registry is used (see: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)</td>
132+
</tr>
133+
<tr>
134+
<td>ingress.annotations</td>
135+
<td>object</td>
136+
<td class="default-column">
137+
<pre lang="yaml">
138+
139+
`{}`
140+
</pre></td>
141+
<td></td>
142+
</tr>
143+
<tr>
144+
<td>ingress.enabled</td>
145+
<td>bool</td>
146+
<td class="default-column">
147+
<pre lang="yaml">
148+
149+
`false`
150+
</pre></td>
151+
<td></td>
152+
</tr>
153+
<tr>
154+
<td>ingress.hosts[0].host</td>
155+
<td>string</td>
156+
<td class="default-column">
157+
<pre lang="yaml">
158+
159+
`"chart-example.local"`
160+
</pre></td>
161+
<td></td>
162+
</tr>
163+
<tr>
164+
<td>ingress.hosts[0].paths</td>
165+
<td>list</td>
166+
<td class="default-column">
167+
<pre lang="yaml">
168+
169+
`[]`
170+
</pre></td>
171+
<td></td>
172+
</tr>
173+
<tr>
174+
<td>ingress.tls</td>
175+
<td>list</td>
176+
<td class="default-column">
177+
<pre lang="yaml">
178+
179+
`[]`
180+
</pre></td>
181+
<td></td>
182+
</tr>
183+
<tr>
184+
<td>labels</td>
185+
<td>object</td>
186+
<td class="default-column">
187+
<pre lang="yaml">
188+
189+
`{}`
190+
</pre></td>
191+
<td>add labels to the deployment, service and pods</td>
192+
</tr>
193+
<tr>
194+
<td>nameOverride</td>
195+
<td>string</td>
196+
<td class="default-column">
197+
<pre lang="yaml">
198+
199+
`""`
200+
</pre></td>
201+
<td></td>
202+
</tr>
203+
<tr>
204+
<td>nodeSelector</td>
205+
<td>object</td>
206+
<td class="default-column">
207+
<pre lang="yaml">
208+
209+
`{}`
210+
</pre></td>
211+
<td></td>
212+
</tr>
213+
<tr>
214+
<td>podSecurityContext</td>
215+
<td>object</td>
216+
<td class="default-column">
217+
<pre lang="yaml">
218+
219+
`{}`
220+
</pre></td>
221+
<td></td>
222+
</tr>
223+
<tr>
224+
<td>replicaCount</td>
225+
<td>int</td>
226+
<td class="default-column">
227+
<pre lang="yaml">
228+
229+
`1`
230+
</pre></td>
231+
<td></td>
232+
</tr>
233+
<tr>
234+
<td>resources</td>
235+
<td>object</td>
236+
<td class="default-column">
237+
<pre lang="yaml">
238+
239+
`{}`
240+
</pre></td>
241+
<td></td>
242+
</tr>
243+
<tr>
244+
<td>securityContext</td>
245+
<td>object</td>
246+
<td class="default-column">
247+
<pre lang="yaml">
248+
249+
`{}`
250+
</pre></td>
251+
<td></td>
252+
</tr>
253+
<tr>
254+
<td>service.port</td>
255+
<td>int</td>
256+
<td class="default-column">
257+
<pre lang="yaml">
258+
259+
`8080`
260+
</pre></td>
261+
<td></td>
262+
</tr>
263+
<tr>
264+
<td>service.type</td>
265+
<td>string</td>
266+
<td class="default-column">
267+
<pre lang="yaml">
268+
269+
`"ClusterIP"`
270+
</pre></td>
271+
<td></td>
272+
</tr>
273+
<tr>
274+
<td>tolerations</td>
275+
<td>list</td>
276+
<td class="default-column">
277+
<pre lang="yaml">
278+
279+
`[]`
280+
</pre></td>
281+
<td></td>
282+
</tr>
283+
</tbody>
284+
</table>
81285

82286
## License
83287
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

0 commit comments

Comments
 (0)