Skip to content

Commit

Permalink
docs: document required options for extraMounts
Browse files Browse the repository at this point in the history
Clarifies that either `bind` or `rbind` are required in the Kubelet's
`extraMounts`.

Signed-off-by: Andrew Rynhard <andrew@rynhard.io>
  • Loading branch information
andrewrynhard authored and smira committed Sep 6, 2021
1 parent af66221 commit 82b130e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
2 changes: 2 additions & 0 deletions pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@ var (
Destination: "/var/lib/example",
Type: "bind",
Options: []string{
"bind",
"rshared",
"rw",
},
Expand Down Expand Up @@ -828,6 +829,7 @@ type KubeletConfig struct {
KubeletExtraArgs map[string]string `yaml:"extraArgs,omitempty"`
// description: |
// The `extraMounts` field is used to add additional mounts to the kubelet container.
// Note that either `bind` or `rbind` are required in the `options`.
// examples:
// - value: kubeletExtraMountsExample
KubeletExtraMounts []ExtraMount `yaml:"extraMounts,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions website/content/docs/v0.13/Reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ kubelet:
# type: bind
# source: /var/lib/example
# options:
# - bind
# - rshared
# - rw
```
Expand Down Expand Up @@ -1336,6 +1337,7 @@ Appears in:
type: bind
source: /var/lib/example
options:
- bind
- rshared
- rw
```
Expand Down Expand Up @@ -1368,6 +1370,7 @@ extraArgs:
# type: bind
# source: /var/lib/example
# options:
# - bind
# - rshared
# - rw
```
Expand Down Expand Up @@ -1451,6 +1454,7 @@ extraArgs:
<div class="dt">

The `extraMounts` field is used to add additional mounts to the kubelet container.
Note that either `bind` or `rbind` are required in the `options`.



Expand All @@ -1463,6 +1467,7 @@ extraMounts:
type: bind
source: /var/lib/example
options:
- bind
- rshared
- rw
```
Expand Down

0 comments on commit 82b130e

Please sign in to comment.