https://github.com/squat/jupyter-operator

A Kubernetes operator for Jupyter Notebooks
https://github.com/squat/jupyter-operator

jupyter jupyter-notebook kubernetes operator

Last synced: about 2 months ago
JSON representation

A Kubernetes operator for Jupyter Notebooks

• Host: GitHub
• URL: https://github.com/squat/jupyter-operator
• Owner: squat
• License: apache-2.0
• Created: 2017-11-10T17:23:48.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-21T16:20:22.000Z (almost 6 years ago)
• Last Synced: 2024-06-20T08:03:52.276Z (6 months ago)
• Topics: jupyter, jupyter-notebook, kubernetes, operator
• Language: Go
• Size: 21.6 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Jupyter-Operator

This is a Kubernetes operator for [Jupyter Notebooks](https://jupyter.org/).

[![Build Status](https://travis-ci.org/squat/jupyter-operator.svg?branch=master)](https://travis-ci.org/squat/jupyter-operator)

[![Go Report Card](https://goreportcard.com/badge/github.com/squat/jupyter-operator)](https://goreportcard.com/report/github.com/squat/jupyter-operator)

## Overview

The Jupyter Operator automates the deployment of Jupyter Notebooks to a Kubernetes Cluster.

It configures TLS certificates for the Notebook server and exposes the application via ingress and service resources.

## Requirements

* Kubernetes v1.7+

## Usage

### Create the RBAC resources for the operator

```sh

kubectl create -f example/rbac

```

### Deploy the Jupyter Operator

```sh

kubectl create -f examples/deployment.yaml

```

### Create a notebook

```sh

kubectl create -f examples/notebook.yaml

```

### Access the notebook

Resolve DNS for `example-notebook.example.com` as the Kubernetes cluster, e.g. edit `/etc/hosts`:

```sh

 example-notebook.example.com

```

Navigate a browser to `example-notebook.example.com` and login with the password `mypassword`.