helm-chart

This repository stores in its gh-pagesbranch packaged Helmcharts for BinderHub and Zero to JupyterHub K8s. These packaged Helmcharts are made available as a valid Helm chartrepository on an automatically updatedwebsite thanks to GitHub Pages.We use chartpress to add package and add Helm charts to this Helm chartrepository.

Usage

This Helm chart repository enables you to install a JupyterHub and BinderHubHelm chart directly from it into your Kubernetes cluster. Please refer to theJupyterHub Helm chart documentation or theBinderHub Helm chart documentation for allthe additional details required.

# Let helm the command line tool know about a Helm chart repository
# that we decide to name jupyterhub.
helm repo add jupyterhub https://jupyterhub.github.io/helm-chart/
helm repo update

# Simplified example on how to install a Helm chart from a Helm chart repository
# named jupyterhub. See the Helm chart's documentation for additional details
# required.
helm install jupyterhub/<helm chart name> --version <helm chart version>

Release notes

The JupyterHub Helm chart

For an extensive list of the released versions, click the badge above!

Each JupyterHub Helm chart release utilizes a specific version of JupyterHuband KubeSpawner and requires a minimum Kubernetes version as well as aminimum Helm version to function properly.

For detailed information about what Python libraries and other packages areavailable alongside JupyterHub, inspect files such as Dockerfile andrequirements.txt within the imagesfolder.

The BinderHub Helm chart

For an extensive list of the released versions, click the badge above!

BinderHub's Helm chart use JupyterHub's Helm chart as a dependency. That meansthat each BinderHub use a specific version of JupyterHub's Helm chart, alongwith BinderHub specific components like the BinderHub Pythonpackage itselfand repo2docker.

For detailed information about what Python libraries and other packages areavailable alongside BinderHub, inspect files such as Dockerfile andrequirements.txt within the imagesfolder.

Currently, the BinderHub Helm chart does not tag releases though, so making asimilar comparison to the one above is hard.

Local development of GitHub page

Background knowledge

To locally development the GitHub page for this repostiory, some backgroundunderstanding can be useful. A good start is to read Helm's documentation aboutHelm chart repositories. After that,keep this in mind.

• GitHub Pages relies on Jekyll that in turn use the Liquid templatinglanguage (with some additions) togenerate and host static web pages.
• Everything that is to be used to generate the GitHubPage is required to reside at thegh-pages branch.
• Templates get data from a Jekyll DataFolder that you caninspect here.This folder only contains a symlink file that in turn points toindex.yamlwhich is a important file for a Helm chartrepository.
• index.mdfile will be converted to index.html by Jekyll and act as a Human readablepage.
• _config.ymlis a Jekyll configuration file.
• Gemfile actslike a doc-requirements.txt but for Ruby, allowing us to work with Jekylllocally a bit easier.
• info.jsonis a way for us to provide easy access to information from the templatesunderlying data source, theindex.yamlfile. We are for example using the rendered info.json to create the badges youfind in this readme about the latest stable/pre/dev release.

Setting up for local development

There are probably different ways to go about this, but sometimes what mattersis to have one at all. Doing the following was tested by @consideRatio2019-10-19 on Ubuntu 19.04.

1. Install Ruby, Gem, and Bundler.

   1. Install rbenv.
   2. Install the rbenv-build plugin to allows you to use rbenv install.
   3. Run rbenv install <version> with the latest stable version.
   4. Run rbenv global <version>.
   5. Verify you can run ruby -v and gem -v.
   6. Run gem install bundler to work with Gemfiles etc.

2. Install Jekyll.

   1. Checkout the gh-pages branch with git checkout gh-pages.
   2. Run bundle install

3. Start a local webserver.

   1. Run bundle exec jekyll serve.
   2. Visit http://localhost:4000.