Api

Kube-native API for cloud development workspaces specification
Alternatives To Api
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Securefs661
a month ago1February 27, 201814otherC++
Filesystem in userspace (FUSE) with transparent authenticated encryption
Ocrsdk.com467
2 years ago30apache-2.0Java
ABBYY Cloud OCR SDK
Api1861124 days ago60March 17, 2022335apache-2.0Go
Kube-native API for cloud development workspaces specification
Markdownpicpicker146
5 years ago5gpl-3.0Python
MarkdownPicPicker is a tool to upload a picture in clipboard to cloud and write a markdown format url of the picture to clipboard
Rs_to_velodyne108
6 months ago9C++
A ros tool for converting Robosense pointcloud to Velodyne pointcloud format.
Z59213 months ago22March 19, 202237mitC++
Lightweight C++ and Python interface for datasets in zarr and N5 format
Ngff92
8 days ago106otherBikeshed
Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.
Cloudconvert42
3 years ago3mitRuby
Ruby wrapper for CloudConvert
Cloud Init Example33
7 years ago
Example of setting user-data for AWS EC2 with multipart data, tests the order in which various user data formats are run
Aspose Words Cloud Dotnet20
3 days ago6mitC#
.NET library for communicating with the Aspose.Words Cloud API
Alternatives To Api
Select To Compare


Alternative Project Comparisons
Readme

Kube-native API for cloud development workspaces specification

Sources for this API are defined in Go code, starting from the devworkspace_types.go source file

From these Go sources, several files are generated:

  • A Kubernetes Custom Resource Definition(CRD) with an embedded OpenApi schema,
  • json schemas (in the 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).

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

The generated documentation of the Devfile 2.0 format, based on its json schema, is available here.

Typescript model is build on each commit of main branch and available as an NPM package.

Release

Release details and process are found in Devfile Release

How to build

In order to build the CRD and the various schemas, you don't need to install any pre-requisite apart from docker. In the root directory, just run the following command:

bash ./docker-run.sh ./build.sh

Typescript model

Typescript model is generated based on JSON Schema with help of kubernetes-client/gen. To generate them locally run:

bash ./build/typescript-model/generate.sh

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:

Contribute

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.

License

Apache License 2.0, see LICENSE for details.

Popular Cloud Computing Projects
Popular Format Projects
Popular Cloud Computing Categories

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Golang
Cloud Computing
Format
Schema