Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devfile/api
Kube-native API for cloud development workspaces specification
https://github.com/devfile/api
Last synced: about 1 month ago
JSON representation
Kube-native API for cloud development workspaces specification
- Host: GitHub
- URL: https://github.com/devfile/api
- Owner: devfile
- License: apache-2.0
- Created: 2019-12-05T11:17:21.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T12:34:53.000Z (about 2 months ago)
- Last Synced: 2024-08-07T15:13:39.509Z (about 2 months ago)
- Language: Go
- Homepage:
- Size: 13.8 MB
- Stars: 248
- Watchers: 25
- Forks: 61
- Open Issues: 287
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Governance: GOVERNANCE.md
Awesome Lists containing this project
README
# Kube-native API for cloud development workspaces specification
[](LICENSE)
[](https://workspaces.openshift.com/f?url=https://github.com/devfile/api)
[](https://www.bestpractices.dev/projects/8179)
[](https://securityscorecards.dev/viewer/?uri=github.com/devfile/api)
Sources for this API are defined in Go code, starting from the
[devworkspace_types.go source file](pkg/apis/workspaces/v1alpha2/devworkspace_types.go)
From these Go sources, several files are generated:
- A Kubernetes Custom Resource Definition(CRD) with an embedded OpenApi schema,
- json schemas (in the [schemas](schemas) folder) generated from the above CRD, to specify the syntax of:
- the DevWorkspace CRD itself;
- the DevWorkspaceTemplate CRD (a devworkspace content, without runtime information);
- the Devfile 2.0.0 format, which is generated from the `DevWorkspace` API.
Generated files are created by a build script (see section [How to build](#how-to-build)).
## Devfile 2.0.0 file format
A Subset of this `DevWorkspace` API defines a structure (workspace template content), which is also at the core of the **Devfile 2.0** format specification.
For more information about this, please look into the [Devfile support README](https://github.com/devfile/registry-support/blob/main/README.md)
The generated documentation of the Devfile 2.0 format, based on its json schema, is available [here](https://devfile.github.io).
Typescript model is build on each commit of main branch and available as an [NPM package](https://www.npmjs.com/package/@devfile/api).
## Release
Release details and process are found in [Devfile Release](RELEASE.md)
## How to build
For information about building this project visit [CONTRIBUTING.md](./CONTRIBUTING.md#building).
## Specification status
This work is still in an early stage of specification, and the related API and schemas are still a draft proposal.
## Quickly open and test ?
In order to test existing or new Devfile 2.0 or DevWorkspace sample files in a self-service Che workspace (hosted on che.openshift.io), just click on the button below:
[](https://workspaces.openshift.com/f?url=https://github.com/devfile/api)
As soon as the devworkspace is opened, you should be able to:
- open the `yaml` files in the following folders:
- `samples/`
- `devfile-support/samples`
- have `yaml` language support (completion and documentation) based on the current Json schemas.
## Contributing
Please see our [contributing.md](./CONTRIBUTING.md).
## License
Apache License 2.0, see [LICENSE](./LICENSE) for details.
### Adding License Headers
[`license_header`](./license_header.txt) contains the license header to be contained under all source files. For Go sources, this can be included by running `bash add_licenses.sh`.
Ensure `github.com/google/addlicense` is installed by running `go install github.com/google/addlicense@latest`.