Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 2.73 KB

README.md

File metadata and controls

88 lines (66 loc) · 2.73 KB
Raw

kaos

The kaos core is contained within a cloud-agnostic backend, allowing users to leverage flexible language agnostic data pipelines.

Build

The most effective way to build the backend for development is with kaos CLI.

  1. Deploy a local cluster (Docker Desktop)
kaos build deploy -c DOCKER -vf
  1. Alternatively, backend infrastructure on a cloud platform can also be deployed (AWS shown below)
kaos build deploy -c AWS -vf
  1. A list of active backend builds already deployed on kaos can be obtained using
kaos build list
  1. The current or active backend build can be determined using
kaos build active
  1. Among the available backends, one can select and set a desired backend environment using
kaos build set -c context_name

OR

kaos build set -i index_number

  1. Make desired changes to the backend (i.e. development)

  2. Re-deploy the local cluster but only the changes will be "built" (i.e. the new backend image)

kaos build deploy -c DOCKER -vf
  1. Kill the existing backend pod in kubernetes to force the pull policy on a new pod
kubectl get pod -l app=kaos-backend -o jsonpath="{.items[0].metadata.name}" | xargs -I {} kubectl delete pod {}

Usage

The backend exposes a JSON-based API. For instance, you can create a workspace with the following call.

curl -X POST http://localhost:80/workspace/local
{
  "build_notebook": null,
  "build_serve": null,
  "build_train": null
}

See the full API documentation for more information.

Structure

The application is divided into four layers.

  • Module routes
    • The outermost layer that specifies the REST API of the backend and leaves all the processing tocontrollers. It handles everything HTTP-specific, marshals exceptions into responses.
  • Module controllers
    • It contains all the high-level business logic of the application.
  • Module services
    • It encapsulates all low-level mechanics and exposes an abstracted interface, so that the controllers manipulate with kaos-specific concepts without any low-level logic.
  • Module clients
    • A thin wrapper over Pachyderm internal storage and pipeline clients. It organizes access to Pachyderms' subsystems, decodes the responses and provides error handling.

Testing

Standardized testing of the CLI consists of pytest and tox. All significant functionality must come with test coverage. Please run tox within an isolated Docker environment using the supplied make file.

make test-unit-docker