Skip to content

Add documentation on getting started with Kubernetes #1693

Open
@choldgraf

Description

@choldgraf

IN jupyterhub/team-compass#296, @consideRatio shared some helpful information to help people get started with K8S. I think it might make more sense to have that information in this repository, either in CONTRIBUTING.md, or
perhaps in a contributing section in the community area.

I'm pasting Erik's text below in case we can re-use it in these docs.

Kubernetes basics

This section is a very brief primer on Kubernetes, along with some links to help
you get started.

What is Kubernetes / Helm

Kubernetes is an open source system allowing you to declare docker containers you want
to have running along with required networking and storage requirements they have. While
doing this, you may end up with many Kubernetes resource files, and this is when Helm
can help you package them into one unit. A Helm package (also called a Helm
chart
), can be customized and installed/upgraded more easily than if you had a
collection of Kubernetes resource files.

Check out the Zero to JupyterHub for Kubernetes
guide for more information about Kubernetes, and how to deploy JupyterHub on it.

Learning resources

Tooling advice

After having installed the common tools (docker,
kubectl, and
helm), also make sure to setup kubectl tab
completion

and helm tab completion as well! If you
would like a GUI working against your Kubernetes cluster,
https://github.com/lensapp/lens seems to be the most promising at the moment.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions