|
1 | | -# Dev Workspace Operator |
| 1 | +<p align="center"><img alt="DevWorkspace operator" src="./img/logo.png" width="150px" /></p> |
| 2 | + |
| 3 | +# DevWorkspace Operator |
2 | 4 |
|
3 | 5 | [](https://codecov.io/gh/devfile/devworkspace-operator) |
4 | 6 | [](https://www.bestpractices.dev/projects/8258) |
5 | 7 | [](https://securityscorecards.dev/viewer/?uri=github.com/devfile/devworkspace-operator) |
6 | 8 |
|
7 | | -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. |
| 9 | +DevWorkspace 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. |
| 10 | + |
| 11 | +## What is the DevWorkspace Operator? |
| 12 | + |
| 13 | +A [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to run **fast**, **repeatable** |
| 14 | +and **scalable** Cloud Development Environments. |
| 15 | + |
| 16 | +[Install it](#deploying-devworkspace-operator) and apply a DevWorkspace to create a Cloud Development Environment:<br/> |
| 17 | + |
| 18 | + |
| 19 | +Get the Cloud Developent Environment URI:<br/> |
| 20 | + |
| 21 | + |
| 22 | +Open the IDE:<br/> |
| 23 | +| Visual Studio Code | JetBrains IntelliJ | |
| 24 | +| ------------- | ------------- | |
| 25 | +|  |  | |
| 26 | + |
| 27 | +## Example |
| 28 | + |
| 29 | +Here is a sample DevWorkspace to provision a Cloud Development Environment for the project |
| 30 | +[github.com/l0rd/outyet](https://github.com/l0rd/outyet) with Visual Studio Code as editor and |
| 31 | +`quay.io/devfile/universal-developer-image:ubi8-latest` as the development tooling container image.<br/> |
| 32 | + |
| 33 | +The **template section of a DevWorkspace** is actually [a Devfile](https://devfile.io/docs/2.3.0/what-is-a-devfile): the |
| 34 | +`spec.template` schema matches the [Devfile schema](https://devfile.io/docs/2.3.0/devfile-schema). |
| 35 | + |
| 36 | +**Contributions** are extra components that are added on top of the template. Contributions are used to inject editors |
| 37 | +such as Visual Studio Code and JetBrains. |
| 38 | + |
| 39 | + |
8 | 40 |
|
9 | 41 | ## Configuration |
10 | 42 |
|
|
0 commit comments