Skip to content

Commit 85e0eb7

Browse files
TomerNewmank8s-ci-robot
authored andcommitted
documenting KMM configuration persistent during upgrade feature
Adjusting the docs following the new feature in KMM which configuration can be persistent during upgrade
1 parent 2fe57a3 commit 85e0eb7

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed
Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,64 @@
11
# Configuring
22

3-
KMM should be configured out of the box with sensible defaults.
4-
The operator configuration is set in the `kmm-operator-manager-config` `ConfigMap` in the operator namespace.
5-
To modify any setting, edit the `ConfigMap` data and restart the controller with the following command:
3+
KMM is configured out of the box with sensible defaults.
4+
To modify any setting, create a `ConfigMap` with name of `kmm-operator-manager-config` in the operator namespace with
5+
the relevant data and restart the controller with the following command:
66

77
```shell
88
kubectl delete pod -n "$namespace" -l app.kubernetes.io/component=kmm
99
```
1010

1111
The value of `$namespace` depends on your [installation method](install.md).
1212

13+
## Example
14+
```yaml
15+
apiVersion: v1
16+
data:
17+
controller_config.yaml: |
18+
worker:
19+
firmwareHostPath: /example/different/firmware/path
20+
kind: ConfigMap
21+
metadata:
22+
name: kmm-operator-manager-config
23+
namespace: kmm-operator-system
24+
```
25+
26+
### Note
27+
If you want to configure `KMM Hub`, then create the `ConfigMap` with the name `kmm-operator-hub-manager-config` instead
28+
in the KMM-hub controller's namespace.
29+
30+
1331
## Reference
1432

1533
#### `healthProbeBindAddress`
1634

1735
Defines the address on which the operator should listen for kubelet health probes.
18-
Recommended value: `:8081`.
36+
Default value: `:8081`.
1937

2038
#### `job.gcDelay`
2139

2240
Defines the duration for which successful build pods should be preserved before they are deleted.
2341
Refer to the Go [`ParseDuration`](https://pkg.go.dev/time#ParseDuration) function documentation to understand valid
2442
values for this setting.
25-
There is no recommended value for this setting.
43+
Default value: `0`.
2644

2745
#### `leaderElection.enabled`
2846

2947
Determines whether [leader election](https://kubernetes.io/docs/concepts/architecture/leases/) is used to ensure that
3048
only one replica of the KMM operator is running at any time.
31-
Recommended value: `true`.
49+
Default value: `true`.
3250

3351
#### `leaderElection.resourceID`
3452

3553
Determines the name of the resource that leader election will use for holding the leader lock.
36-
Recommended value: `kmm.sigs.x-k8s.io`.
54+
Default value: `kmm.sigs.x-k8s.io` for KMM and `kmm-hub.sigs.x-k8s.io` for KMM-hub.
3755

3856
#### `metrics.bindAddress`
3957

4058
Determines the bind address for the metrics server.
4159
It will be defaulted to `:8080` if unspecified.
4260
Set this to "0" to disable the metrics server.
43-
Recommended value: `0.0.0.0:8443`.
61+
Default value: `0.0.0.0:8443`.
4462

4563
#### `metrics.enableAuthnAuthz`
4664

@@ -55,33 +73,33 @@ To scrape metrics e.g. via Prometheus the client needs a `ClusterRole` with the
5573

5674
- `nonResourceURLs: "/metrics", verbs: get`
5775

58-
Recommended value: `true`.
76+
Default value: `true`.
5977

6078
#### `metrics.secureServing`
6179

6280
Determines whether the metrics should be served over HTTPS instead of HTTP.
63-
Recommended value: `true`.
81+
Default value: `true`.
6482

6583
#### `webhookPort`
6684

6785
Defines the port on which the operator should be listening for webhook requests.
68-
Recommended value: `9443`.
86+
Default value: `9443`.
6987

7088
#### `worker.runAsUser`
7189

7290
Determines the value of the `runAsUser` field of the worker container's
7391
[SecurityContext](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/).
74-
Recommended value: `9443`.
92+
Default value: `0`.
7593

7694
#### `worker.seLinuxType`
7795

7896
Determines the value of the `seLinuxOptions.type` field of the worker container's
7997
[SecurityContext](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/).
80-
Recommended value: `spc_t`.
98+
Default value: `spc_t`.
8199

82100
#### `worker.firmwareHostPath`
83101

84102
If set, the value of this field will be written by the worker into the `/sys/module/firmware_class/parameters/path` file
85103
on the node.
86104
This sets the [kernel's firmware search path](firmwares.md#setting-the-kernels-firmware-search-path).
87-
Recommended value: `/lib/firmware` if you need to set that value through the worker app; otherwise, unset.
105+
Default value: `/lib/firmware`.

0 commit comments

Comments
 (0)