Skip to content

Commit 3a00719

Browse files
committed
docs: add documentation for generateName option
1 parent a0ceba9 commit 3a00719

3 files changed

Lines changed: 34 additions & 0 deletions

File tree

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
#### `generateName` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#images-kaniko-generateName}
6+
7+
GenerateName will be used as the generateName field of the build pod
8+
9+
</summary>
10+
11+
12+
13+
</details>

docs/pages/configuration/_partials/v2beta1/images/kaniko_reference.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import PartialSkipPullSecretMount from "./kaniko/skipPullSecretMount.mdx"
1212
import PartialNodeSelector from "./kaniko/nodeSelector.mdx"
1313
import PartialTolerationsreference from "./kaniko/tolerations_reference.mdx"
1414
import PartialServiceAccount from "./kaniko/serviceAccount.mdx"
15+
import PartialGenerateName from "./kaniko/generateName.mdx"
1516
import PartialAnnotations from "./kaniko/annotations.mdx"
1617
import PartialLabels from "./kaniko/labels.mdx"
1718
import PartialInitEnv from "./kaniko/initEnv.mdx"
@@ -72,6 +73,9 @@ Tolerations is a tolerations list to use for the kaniko pod
7273
<PartialServiceAccount />
7374

7475

76+
<PartialGenerateName />
77+
78+
7579
<PartialAnnotations />
7680

7781

docs/pages/configuration/images/build-engines/kaniko.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,23 @@ images:
151151

152152
## Build Pod Configuration
153153

154+
### `generateName`
155+
The `generateName` option expects a string that will be used as the generateName field of the build pod
156+
157+
#### Default value for `generateName`
158+
```yaml
159+
generateName: devspace-build-kaniko-
160+
```
161+
162+
#### Example: Add generateName to kaniko build pods
163+
```yaml
164+
images:
165+
backend:
166+
image: 123.456.789.0:5000/john/appbackend
167+
kaniko:
168+
generateName: devspace-build-kaniko-backend-
169+
```
170+
154171
### `annotations`
155172
The `annotations` option expects a key/value map of extra annotations that will be added to the build pod
156173

0 commit comments

Comments
 (0)