Skip to content

Commit 8d863c7

Browse files
authored
Add missing privateAddress/privateInterface fields to host documentation (#323)
Document `privateInterface` and `privateAddress` fields.
1 parent f42c3da commit 8d863c7

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,28 @@ Override OS distribution auto-detection. By default `k0sctl` detects the OS by r
362362
address: 10.0.0.2
363363
```
364364

365+
##### `spec.hosts[*].privateInterface` <string> (optional) (default: ``)
366+
367+
Override private network interface selected by host fact gathering.
368+
Useful in case fact gathering picks the wrong private network interface.
369+
370+
```yaml
371+
- role: worker
372+
os: debian
373+
privateInterface: eth1
374+
```
375+
376+
##### `spec.hosts[*].privateAddress` <string> (optional) (default: ``)
377+
378+
Override private IP address selected by host fact gathering.
379+
Useful in case fact gathering picks the wrong IPAddress.
380+
381+
```yaml
382+
- role: worker
383+
os: debian
384+
privateAddress: 10.0.0.2
385+
```
386+
365387
##### `spec.hosts[*].ssh` <mapping> (optional)
366388

367389
SSH connection options.

0 commit comments

Comments
 (0)