Skip to content

Commit b2e9140

Browse files
adityadtu5wilfred-s
authored andcommitted
[YUNIKORN-3132] New security context settings for placeholder pods (#546)
Documentation for the settings: - service.placeholderRunAsUser - service.placeholderRunAsGroup - service.placeholderFsGroup Closes: #546 Signed-off-by: Wilfred Spiegelenburg <wilfreds@apache.org>
1 parent 4c5cbb5 commit b2e9140

1 file changed

Lines changed: 36 additions & 6 deletions

File tree

docs/user_guide/service_config.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ Sets the tolerations for the YuniKorn scheduler pod.
247247

248248
Default: `[]`
249249

250-
Example:
250+
Example:
251251
```yaml
252252
tolerations:
253253
- key: node-role.kubernetes.io/control-plane
@@ -262,7 +262,7 @@ Sets the tolerations for the YuniKorn admission controller pod.
262262

263263
Default: `[]`
264264

265-
Example:
265+
Example:
266266
```yaml
267267
admissionController:
268268
tolerations:
@@ -540,6 +540,9 @@ data:
540540
service.disableGangScheduling: "false"
541541
service.enableConfigHotRefresh: "true"
542542
service.placeholderImage: "registry.k8s.io/pause:3.7"
543+
service.placeholderRunAsUser: 65535
544+
service.placeholderRunAsGroup: 65535
545+
service.placeholderFsGroup: 65535
543546
service.instanceTypeNodeLabelKey: "node.kubernetes.io/instance-type"
544547
health.checkInterval: "30s"
545548
log.level: "INFO"
@@ -692,6 +695,33 @@ Example:
692695
```yaml
693696
service.placeholderImage: "registry.k8s.io/pause:3.6"
694697
```
698+
#### service.placeholderRunAsUser
699+
**Optional** setting which sets the runtime user ID of the entrypoint process of the placeholder container.
700+
701+
Default: If value not provided, it will default to the user of the image you set in `service.placeholderImage`. For the default placeholder image (`registry.k8s.io/pause`) it is `65535`.
702+
703+
Example:
704+
```yaml
705+
service.placeholderRunAsUser: 65535
706+
```
707+
#### service.placeholderRunAsGroup
708+
**Optional** setting which sets the runtime group ID of the entrypoint process of the placeholder container.
709+
710+
Default: If value not provided, it will default to the group of the image you set in `service.placeholderImage`. For the default placeholder image (`registry.k8s.io/pause`) it is `65535`.
711+
712+
Example:
713+
```yaml
714+
service.placeholderRunAsGroup: 65535
715+
```
716+
#### service.placeholderFsGroup
717+
**Optional** setting which sets the runtime fsGroup ID of the entrypoint process of the placeholder container.
718+
719+
Default: If value not provided, it will *NOT* be set.
720+
721+
Example:
722+
```yaml
723+
service.placeholderFsGroup: 65535
724+
```
695725
#### service.instanceTypeNodeLabelKey
696726
Sets the node label that will be used to determine the instance type of node.
697727

@@ -810,9 +840,9 @@ log.level: "DEBUG"
810840
#### log.\{subsystem\}.level
811841
Sets the verbosity that YuniKorn subsystem will log at.
812842

813-
Yunikorn allows fine-grained logging configuration in a hierarchical manner. For example,
814-
setting an entry for `log.core.level` will configure all loggers that start with `core.`
815-
(including `core.scheduler`, etc.) unless a more specific configuration is present.
843+
Yunikorn allows fine-grained logging configuration in a hierarchical manner. For example,
844+
setting an entry for `log.core.level` will configure all loggers that start with `core.`
845+
(including `core.scheduler`, etc.) unless a more specific configuration is present.
816846
Each subsystem[^1] has its log level.
817847

818848
A change to this setting will be picked up without a restart of YuniKorn. The available
@@ -935,7 +965,7 @@ Example:
935965
admissionController.filtering.bypassNamespaces: "^kube-system$,^fluentd-"
936966
```
937967

938-
> **_NOTE :_**
968+
> **_NOTE :_**
939969
> To simplify management, you can directly set the `yunikorn.apache.org/namespace.enableYunikorn` annotation on the namespace itself, regardless of whether it is specified in a regular expression. This annotation enables you to determine if the namespace should be managed by Yunikorn.
940970

941971
#### admissionController.filtering.labelNamespaces

0 commit comments

Comments
 (0)