Dev Workspace operator repository that contains the controller for the DevWorkspace Custom Resource. The Kubernetes API of the DevWorkspace is defined in the https://github.com/devfile/api repository.
The DevWorkspace Operator installs the DevWorkspaceOperatorConfig custom resource (short name: dwoc). To configure global behavior of the DevWorkspace Operator, create a DevWorkspaceOperatorConfig named devworkspace-operator-config in the same namespace where the operator is deployed:
apiVersion: controller.devfile.io/v1alpha1
kind: DevWorkspaceOperatorConfig
metadata:
name: devworkspace-operator-config
namespace: $OPERATOR_INSTALL_NAMESPACE
config:
# Configuration fieldsTo apply a configuration to specific workspaces instead of globally, an existing DevWorkspaceOperatorConfig can be referenced in a DevWorkspace's attributes:
apiVersion: workspace.devfile.io/v1alpha2
kind: DevWorkspace
metadata:
name: my-devworkspace
spec:
template:
attributes:
controller.devfile.io/devworkspace-config:
name: <name of DevWorkspaceOperatorConfig CR>
namespace: <namespace of DevWorkspaceOperatorConfig CR>Configuration specified as above will be merged into the default global configuration, overriding any values present.
To see all all configuration options, see kubectl explain dwoc.config, kubectl explain dwoc.config.workspace, etc.
DevWorkspaces can be further configured through DevWorkspace attributes and Kubernetes labels/annotations. For a list of all options available, see additional documentation.
The controller.devfile.io/restricted-access annotation specifies that a DevWorkspace needs additional access control (in addition to RBAC). When a DevWorkspace is created with the controller.devfile.io/restricted-access annotation set to true, the webhook server will guarantee
- Only the DevWorkspace Operator ServiceAccount or DevWorkspace creator can modify important fields in the DevWorkspace
- Only the DevWorkspace creator can create
pods/execinto devworkspace-related containers.
This annotation should be used when a DevWorkspace is expected to contain sensitive information that should be protect above the protection provided by standard RBAC rules (e.g. if the DevWorkspace will store the user's OpenShift token in-memory).
Example:
metadata:
annotations:
controller.devfile.io/restricted-access: true- go 1.16 or later
- git
- sed
- jq
- yq (python-yq from https://github.com/kislyuk/yq#installation, other distributions may not work)
- skopeo (if building the OLM catalogsource)
- podman or docker
Note: kustomize v4.0.5 is required for most tasks. It is downloaded automatically to the .kustomize folder in this repo when required. This downloaded version is used regardless of whether or not kustomize is already installed on the system.
When installing on Kubernetes clusters, the DevWorkspace Operator requires the cert-manager operator in order to properly serve webhooks. To install the latest version of cert-manager in a cluster, the Makefile rule install_cert_manager can be used. The minimum version of cert-manager is v1.0.4.
The controller can be deployed to a cluster provided you are logged in with cluster-admin credentials:
export DWO_IMG=quay.io/devfile/devworkspace-controller:next
make installBy default, the controller will expose workspace servers without any authentication; this is not advisable for public clusters, as any user could access the created workspace via URL.
See below for all environment variables used in the makefile.
Note: The operator requires internet access from containers to work. By default,
crc setupmay not provision this, so it's necessary to configure DNS for Docker:# /etc/docker/daemon.json { "dns": ["192.168.0.1"] }
DevWorkspace Operator has bundle and index images which enable installation via OLM. To enable installing the DevWorkspace Operator through OLM, it may be necessary to create a CatalogSource in the cluster for this index:
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
name: devworkspace-operator-catalog
namespace: openshift-marketplace # Namespace for catalogsource, not operator itself
spec:
sourceType: grpc
image: quay.io/devfile/devworkspace-operator-index:next
publisher: Red Hat
displayName: DevWorkspace Operator Catalog
updateStrategy:
registryPoll:
interval: 5mTwo index images are available for installing the DevWorkspace Operator:
quay.io/devfile/devworkspace-operator-index:release- multi-version catalog with all DevWorkspace Operator releasesquay.io/devfile/devworkspace-operator-index:next- single-version catalog that will deploy the latest commit in themainbranch
Both index images allow automatic updates (to either the latest release or latest commit in main).
After OLM finishes processing the created CatalogSource, DWO should appear on the Operators page in the OpenShift Console.
In order to build a custom bundle, the following environment variables should be set:
| variable | purpose | default value |
|---|---|---|
DWO_BUNDLE_IMG |
Image used for Operator bundle image | quay.io/devfile/devworkspace-operator-bundle:next |
DWO_INDEX_IMG |
Image used for Operator index image | quay.io/devfile/devworkspace-operator-index:next |
DEFAULT_DWO_IMG |
Image used for controller when generating defaults | quay.io/devfile/devworkspace-controller:next |
To build the index image and register its catalogsource to the cluster, run
make generate_olm_bundle_yaml build_bundle_and_index register_catalogsource
Note that setting DEFAULT_DWO_IMG while generating sources will result in local changes to the repo which should be git restored before committing. This can also be done by unsetting the DEFAULT_DWO_IMG env var and re-running make generate_olm_bundle_yaml
The repository contains a Makefile; building and deploying can be configured via the environment variables
| variable | purpose | default value |
|---|---|---|
DWO_IMG |
Image used for controller | quay.io/devfile/devworkspace-controller:next |
DEFAULT_DWO_IMG |
Image used for controller when generating default deployment templates. Can be used to override the controller image in the OLM bundle | quay.io/devfile/devworkspace-controller:next |
NAMESPACE |
Namespace to use for deploying controller | devworkspace-controller |
ROUTING_SUFFIX |
Cluster routing suffix (e.g. $(minikube ip).nip.io, apps-crc.testing). Required for Kubernetes |
192.168.99.100.nip.io |
PULL_POLICY |
Image pull policy for controller | Always |
DEVWORKSPACE_API_VERSION |
Branch or tag of the github.com/devfile/api to depend on | v1alpha1 |
Some of the rules supported by the makefile:
| rule | purpose |
|---|---|
| docker | build and push docker image |
| install | install controller to cluster |
| restart | restart cluster controller deployment |
| install_cert_manager | installs the cert-manager to the cluster (only required for Kubernetes) |
| uninstall | delete controller namespace devworkspace-controller and remove CRDs from cluster |
| help | print all rules and variables |
To see all rules supported by the makefile, run make help
- Take a look samples devworkspace configuration in
./samplesfolder. - Apply any of them by executing
kubectl apply -f ./samples/code-latest.yaml -n <namespace> - As soon as devworkspace is started you're able to get IDE url by executing
kubectl get devworkspace -n <namespace>
export NAMESPACE="devworkspace-controller"
make install
# Wait for webhook server to start
kubectl rollout status deployment devworkspace-controller-manager -n $NAMESPACE --timeout 90s
kubectl rollout status deployment devworkspace-webhook-server -n $NAMESPACE --timeout 90s
# Scale on-cluster deployment to zero to avoid conflict with locally-running instance
oc patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"replicas\":0}}" -n $NAMESPACE
make runDebugging the controller depends on delve being installed (go install github.com/go-delve/delve/cmd/dlv@latest). Note that $GOPATH/bin or $GOBIN must be added to $PATH in order for make debug to run correctly.
make install
# Wait for webhook server to start
kubectl rollout status deployment devworkspace-controller-manager -n $NAMESPACE --timeout 90s
kubectl rollout status deployment devworkspace-webhook-server -n $NAMESPACE --timeout 90s
oc patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"replicas\":0}}"
# Scale on-cluster deployment to zero to avoid conflict with locally-running instance
make debugDebugging the webhook server depends on telepresence being installed (https://www.telepresence.io/docs/latest/install/). Teleprescence works by redirecting traffic going from the webhook-server in the cluster to the local webhook-server you will be running on your computer.
make debug-webhook-serverwhen you are done debugging you have to manually uninstall the telepresence agent
make disconnect-debug-webhook-serverdevfile API is the Kube-native API for cloud development workspaces specification and the core dependency of the devworkspace-operator that should be regularly updated to the latest version. In order to do the update:
- update
DEVWORKSPACE_API_VERSIONvariable in theMakefileandbuild/scripts/generate_deployment.sh. The variable should correspond to the commit SHA from the devfile API repository - run the following scripts and the open pull request
make update_devworkspace_api update_devworkspace_crds # first commit
make generate_all # second commitExample of the devfile API update PR
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).
Configuration settings in the DevWorkspaceOperatorConfig override default values found in pkg/config. The only required configuration setting is .routing.clusterHostSuffix, which is required when running on Kubernetes.
To see documentation on configuration settings, including default values, use kubectl explain or oc explain -- e.g. kubectl explain dwoc.config.routing.clusterHostSuffix
To uninstall the controller and associated CRDs, use the Makefile uninstall rule:
make uninstallThis will delete all custom resource definitions created for the controller, as well as the devworkspace-controller namespace.
-
Next Dockerimage action builds main branch and pushes it to quay.io/devfile/devworkspace-controller:next
-
Code Coverage Report action creates a code coverage report using codecov.io.
For information on contributing to this project please see CONTRIBUTING.md.