Skip to content

Commit

Permalink
update links in README
Browse files Browse the repository at this point in the history
mostly s/http/https/

this file is almost a copy of docs/overview. Maybe it shouldn’t be duplicated?
  • Loading branch information
minrk committed Aug 19, 2018
1 parent 4ba81d3 commit 5040e75
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# kubespawner (jupyterhub-kubernetes-spawner) #
# kubespawner (jupyterhub-kubespawner) #

The *kubespawner* (also known as JupyterHub Kubernetes Spawner) enables JupyterHub to spawn
single-user notebook servers on a [Kubernetes](https://kubernetes.io/)
cluster.

You can read a list of all the spawner options [available on ReadTheDocs](http://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#module-kubespawner.spawner).
You can read a list of all the spawner options [available on ReadTheDocs](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#module-kubespawner.spawner).

## Features ##

Expand All @@ -23,26 +23,26 @@ simultaneous users), Kubernetes is a wonderful way to do it. Features include:
monitoring and failover for the hub process itself.

* Spawn multiple hubs in the same kubernetes cluster, with support for
[namespaces](http://kubernetes.io/docs/admin/namespaces/). You can limit the
[namespaces](https://kubernetes.io/docs/admin/namespaces/). You can limit the
amount of resources each namespace can use, effectively limiting the amount
of resources a single JupyterHub (and its users) can use. This allows
organizations to easily maintain multiple JupyterHubs with just one
kubernetes cluster, allowing for easy maintenance & high resource
utilization.

* Provide guarantees and limits on the amount of resources (CPU / RAM) that
single-user notebooks can use. Kubernetes has comprehensive [resource control](http://kubernetes.io/docs/user-guide/compute-resources/) that can
single-user notebooks can use. Kubernetes has comprehensive [resource control](https://kubernetes.io/docs/user-guide/compute-resources/) that can
be used from the spawner.

* Mount various types of [persistent volumes](http://kubernetes.io/docs/user-guide/persistent-volumes/)
* Mount various types of [persistent volumes](https://kubernetes.io/docs/user-guide/persistent-volumes/)
onto the single-user notebook's container.

* Control various security parameters (such as userid/groupid, SELinux, etc)
via flexible [Pod Security Policies](http://kubernetes.io/docs/user-guide/pod-security-policy/).
via flexible [Pod Security Policies](https://kubernetes.io/docs/user-guide/pod-security-policy/).

* Run easily in multiple clouds (or on your own machines). Helps avoid vendor
lock-in. You can even spread out your cluster across
[multiple clouds at the same time](http://kubernetes.io/docs/user-guide/federation/).
[multiple clouds at the same time](https://kubernetes.io/docs/user-guide/federation/).

In general, Kubernetes provides a ton of well thought out, useful features -
and you can use all of them along with this spawner.
Expand All @@ -51,11 +51,11 @@ and you can use all of them along with this spawner.

### Kubernetes ###

Everything should work from Kubernetes v1.2+.
Everything should work from Kubernetes v1.6+.

The [Kube DNS addon](http://kubernetes.io/docs/user-guide/connecting-applications/#dns)
The [Kube DNS addon](https://kubernetes.io/docs/user-guide/connecting-applications/#dns)
is not strictly required - the spawner uses
[environment variable](http://kubernetes.io/docs/user-guide/connecting-applications/#environment-variables)
[environment variable](https://kubernetes.io/docs/user-guide/connecting-applications/#environment-variables)
based discovery instead. Your kubernetes cluster will need to be configured to
support the types of volumes you want to use.

Expand Down Expand Up @@ -83,10 +83,10 @@ All code is licensed under the terms of the revised BSD license.
#### JupyterHub and kubespawner

- [Reporting Issues](https://github.com/jupyterhub/kubespawner/issues)
- [Documentation for JupyterHub](http://jupyterhub.readthedocs.io/en/latest/) | [PDF (latest)](https://media.readthedocs.org/pdf/jupyterhub/latest/jupyterhub.pdf) | [PDF (stable)](https://media.readthedocs.org/pdf/jupyterhub/stable/jupyterhub.pdf)
- [Documentation for JupyterHub's REST API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyterhub/master/docs/rest-api.yml#/default)
- [Documentation for JupyterHub](https://jupyterhub.readthedocs.io)
- [Documentation for JupyterHub's REST API](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyterhub/master/docs/rest-api.yml#/default)

#### Jupyter

- [Documentation for Project Jupyter](http://jupyter.readthedocs.io/en/latest/index.html) | [PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) | [PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)
- [Project Jupyter website](https://jupyter.org)

0 comments on commit 5040e75

Please sign in to comment.