Skip to content

Latest commit

 

History

History
110 lines (71 loc) · 3.36 KB

README.md

File metadata and controls

110 lines (71 loc) · 3.36 KB
Raw

kube-workspace-operator

Kubernetes operator that allows managing user-specific, persistent "workspace" pods that can be accessed via SSH.

A command line interface is proved that allows starting and stopping a workspace.

The primary use case is providing a standardized and easily accesible development environment for machine learning practitioners.

Features

  • Start and stop workspaces via the CLI
  • Easy authentication via SSH keys
  • Persistent /home/username storage via PersistentVolumeClaims
  • Kubernetes Pod templates for customizing the workspace
  • Helm chart

Work in progress:

  • Scheduled (automatic) and manual backup of the persistent storage
  • Logging of SSH sessions

Authentication

For ease of use authentication is handled via SSH public keys. The server configuration must specify a whitelist of user/public key pairs.

The public key is used as an API token. Access to workspaces is only possible via SSH with the private key.

Usage - CLI

The CLI provides a convenient shell interface for starting and stopping workspaces.

NOTE: An administrator has to add your SSH public key to the authorized keys before you can use the CLI.

(See [Deploy] below for how to configure and deploy the project to a Kubernetes cluster.)

Installation:

  • Pip: python3 -m pip install -e 'git+https://github.com/refaktory/kube-workspace.git#egg=kworkspace&subdirectory=cli'

  • Nix/NixOS: Flakes must be enabled Run once: nix run github:refaktory/kube-workspace.cli Shell: nix shell -p github:refaktory/kube-workspace.cli

Commands:

  • kworkspace connect - Ensure your workspace is running, then connect with SSH
  • kworkspace start - Start your workspace if it is not already running
  • kworkspace stop- Stop your workspace

Port Forwarding

If you want to acces a port either on the workspace container, or from a service running in the cluster, you can use SSH port forwarding.

The CLI makes this easy:

  • Forward container port 8000 to your machine
    • kworkspace connect -f 8000:
    • curl localhost:8000 => works!
  • Forward container port 80 to 8080 on your machine
    • kworkspace connect -f 8080:80:
    • curl localhost:8080 => works!
  • Forward a remote host on port 80 to your machine on port 8888
    • kworkspace connect -f 8888:some-service.namespace.svc.cluster.local:80:
    • curl localhost:8888 => works!

Note: the port forward only remains active for the livetime of the SSH session. So don't close the terminal!

Deploy

TODO

Development

This project uses the xtask pattern to provide a development CLI.

Commands:

  • cargo xtask fmt - Format all code (cargo fmt for Rust, black for CLI)
  • cargo xtask lint - Lint all code (Rust + Python CLI)
  • cargo xtask test - Run all tests (Rust + Python CLI)
  • cargo xtask ci - Run all lints and tests as executed by the CI
  • cargo xtask docker-build - Build Docker image
  • cargo xtask docker-publish - Build Docker image and publish to image registry

Pull Request Validation

Before submitting a pull request, run cargo xtask ci to execute all all checks as they are run by the CI.

This includes lints and tests for both the CLI and the operator and will surface any issues that would fail the CI.

Nix

If you use nix with Flakes, you can run nix develop to get a development shell with all required dependencies.