Skip to content

Commit 05aca76

Browse files
committed
Update README.md to document configuration via the new CRD.
Signed-off-by: Angel Misevski <[email protected]>
1 parent cde6bc2 commit 05aca76

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,11 @@ make disconnect-debug-webhook-server
139139

140140
### Controller configuration
141141

142-
Controller behavior can be configured with data from the `devworkspace-controller` config map in the same namespace where controller lives.
142+
Controller behavior can be configured using the `DevWorkspaceOperatorConfig` custom resource (`dwoc` for short). To configure the controller, create a `DevWorkspaceOperatorConfig` named `devworkspace-operator-config` in the same namespace as the controller. If using the Makefile to deploy the DevWorkspaceOperator, a pre-filled config is created automatically (see `deploy/default-config.yaml`).
143143

144-
For all available configuration properties and their default values, see [pkg/config](https://github.com/devfile/devworkspace-operator/tree/main/pkg/config)
144+
Configuration settings in the `DevWorkspaceOperatorConfig` override default values found in [pkg/config](https://github.com/devfile/devworkspace-operator/tree/main/pkg/config). The only required configuration setting is `.routing.clusterHostSuffix`, which is required when running on Kubernetes.
145+
146+
To see documentation on configuration settings, including default values, use `kubectl explain` or `oc explain` -- e.g. `kubectl explain dwoc.config.routing.clusterHostSuffix`
145147

146148
### Remove controller from your K8s/OS Cluster
147149
To uninstall the controller and associated CRDs, use the Makefile uninstall rule:

0 commit comments

Comments
 (0)