qniblib

Documentation

Index

• Constants
• type Content
  • func NewContent(m map[string]interface{}) Content
  • func (c *Content) String() string
• type Database
• type DockerImage
  • func (d *DockerImage) String() string
• type DockerImages
  • func (di *DockerImages) GetImages() []DockerImage
  • func (di *DockerImages) String() string
• type DockerSpawner
  • func NewDockerSpaner() DockerSpawner
  • func (ds *DockerSpawner) Init() (err error)
  • func (ds *DockerSpawner) ListNotebooks(user string) (nbs map[string]Notebook, err error)
  • func (ds *DockerSpawner) SpawnNotebook(user string, r *http.Request, token string) (nb Notebook, err error)
• type KubernetesSpawner
  • func NewKubernetesSpawner() KubernetesSpawner
  • func (s *KubernetesSpawner) Init() (err error)
  • func (s *KubernetesSpawner) ListNotebooks(user string) (map[string]Notebook, error)
  • func (s *KubernetesSpawner) SpawnNotebook(user string, r *http.Request, token string) (nb Notebook, err error)
• type LocalDB
  • func NewLocalDB() LocalDB
  • func (db *LocalDB) AddNotebook(notebook Notebook) (err error)
  • func (db *LocalDB) Init() (err error)
  • func (db *LocalDB) ListNotebooks(user string) (nbs map[string]Notebook, err error)
  • func (db *LocalDB) RemoveNotebook(notebook Notebook) (err error)
• type Notebook
  • func NewNotebook(id, spwnr, name, user, iurl, eurl, path, token string) Notebook
• type Route
  • func NewRoute(uid, target string) Route
• type Spawner
• type Webserver
  • func NewWebserver(ctx *cli.Context) Webserver
  • func (www *Webserver) AddRoute(uid, cntname, target string) (err error)
  • func (www *Webserver) HandlerHome(w http.ResponseWriter, r *http.Request)
  • func (www *Webserver) HandlerNotebooks(w http.ResponseWriter, r *http.Request)
  • func (www *Webserver) HandlerStartContainer(w http.ResponseWriter, r *http.Request)
  • func (www *Webserver) HandlerUserLogin(w http.ResponseWriter, r *http.Request)
  • func (www *Webserver) Init(spawner Spawner, db Database)
  • func (www *Webserver) ListNotebooks(user string) (nbs map[string]Notebook, err error)
  • func (www *Webserver) LoginFormHandler(w http.ResponseWriter, r *http.Request)
  • func (www *Webserver) LogutHandler(w http.ResponseWriter, r *http.Request)
  • func (www *Webserver) Start()

Constants

const (
	InternalNotebookPort = 8888
)

Types

type Content

type Content struct {
	User           string
	Authenticated  bool
	UCPtoken       string
	Notebooks      map[string]Notebook
	JupyterImages  []DockerImage
	NotebookImages []DockerImage
}

func NewContent

func NewContent(m map[string]interface{}) Content

func (*Content) String

func (c *Content) String() string

type Database

type Database interface {
	// Setup the spawner
	Init() error
	// ListNotebooks returns the notebooks for a given user
	ListNotebooks(user string) (map[string]Notebook, error)
	// AddNotebook inserts a notebook with all its info
	AddNotebook(notebook Notebook) (err error)
	// RemoveNotebook removes a notebook from the DB
	RemoveNotebook(notebook Notebook) (err error)
}

type DockerImage

type DockerImage struct {
	Name string
}

func (*DockerImage) String

func (d *DockerImage) String() string

type DockerImages

type DockerImages struct {
	Images []DockerImage
}

func (*DockerImages) GetImages

func (di *DockerImages) GetImages() []DockerImage

func (*DockerImages) String

func (di *DockerImages) String() string

type DockerSpawner

type DockerSpawner struct {
	Type string
	// contains filtered or unexported fields
}

func NewDockerSpaner

func NewDockerSpaner() DockerSpawner

func (*DockerSpawner) Init

func (ds *DockerSpawner) Init() (err error)

func (*DockerSpawner) ListNotebooks

func (ds *DockerSpawner) ListNotebooks(user string) (nbs map[string]Notebook, err error)

func (*DockerSpawner) SpawnNotebook

func (ds *DockerSpawner) SpawnNotebook(user string, r *http.Request, token string) (nb Notebook, err error)

type KubernetesSpawner

type KubernetesSpawner struct {
	Type string
	// contains filtered or unexported fields
}

func NewKubernetesSpawner

func NewKubernetesSpawner() KubernetesSpawner

func (*KubernetesSpawner) Init

func (s *KubernetesSpawner) Init() (err error)

func (*KubernetesSpawner) ListNotebooks

func (s *KubernetesSpawner) ListNotebooks(user string) (map[string]Notebook, error)

ListNotebooks returns the notebooks for a given user

func (*KubernetesSpawner) SpawnNotebook

func (s *KubernetesSpawner) SpawnNotebook(user string, r *http.Request, token string) (nb Notebook, err error)

SpawnNotebooks create a notebook

type LocalDB

type LocalDB struct {
	// contains filtered or unexported fields
}

func NewLocalDB

func NewLocalDB() LocalDB

func (*LocalDB) AddNotebook

func (db *LocalDB) AddNotebook(notebook Notebook) (err error)

func (*LocalDB) Init

func (db *LocalDB) Init() (err error)

func (*LocalDB) ListNotebooks

func (db *LocalDB) ListNotebooks(user string) (nbs map[string]Notebook, err error)

func (*LocalDB) RemoveNotebook

func (db *LocalDB) RemoveNotebook(notebook Notebook) (err error)

type Notebook

type Notebook struct {
	ID          string
	Spawner     string
	Name        string
	User        string
	InternalUrl string
	ExternalUrl string
	Path        string
	Token       string
}

func NewNotebook

func NewNotebook(id, spwnr, name, user, iurl, eurl, path, token string) Notebook

type Route

type Route struct {
	// contains filtered or unexported fields
}

func NewRoute

func NewRoute(uid, target string) Route

type Spawner

type Spawner interface {
	// Setup the spawner
	Init() error
	// ListNotebooks returns the notebooks for a given user
	ListNotebooks(user string) (map[string]Notebook, error)
	// SpawnNotebooks create a notebook
	SpawnNotebook(user string, r *http.Request, token string) (nb Notebook, err error)
}

type Webserver

type Webserver struct {
	SessionID string
	// contains filtered or unexported fields
}

func NewWebserver

func NewWebserver(ctx *cli.Context) Webserver

func (*Webserver) AddRoute

func (www *Webserver) AddRoute(uid, cntname, target string) (err error)

func (*Webserver) HandlerHome

func (www *Webserver) HandlerHome(w http.ResponseWriter, r *http.Request)

func (*Webserver) HandlerNotebooks

func (www *Webserver) HandlerNotebooks(w http.ResponseWriter, r *http.Request)

func (*Webserver) HandlerStartContainer

func (www *Webserver) HandlerStartContainer(w http.ResponseWriter, r *http.Request)

func (*Webserver) HandlerUserLogin

func (www *Webserver) HandlerUserLogin(w http.ResponseWriter, r *http.Request)

func (*Webserver) Init

func (www *Webserver) Init(spawner Spawner, db Database)

func (*Webserver) ListNotebooks

func (www *Webserver) ListNotebooks(user string) (nbs map[string]Notebook, err error)

func (*Webserver) LoginFormHandler

func (www *Webserver) LoginFormHandler(w http.ResponseWriter, r *http.Request)

func (*Webserver) LogutHandler

func (www *Webserver) LogutHandler(w http.ResponseWriter, r *http.Request)

func (*Webserver) Start

func (www *Webserver) Start()