Documentation

Overview of ksonnet

The documentation is split into three groups to address various user needs from beginner to advanced.

  • Reference - Comprehensive list of all possible commands in the ksonnet CLI. These are autogenerated from ksonnet the code base.
  • Tutorials - Tutorials demonstrate how to work on a ksonnet application from beginning to end.
  • Examples - Small snippets to illustrate a command or concept in ksonnet. These also aim to dive deeper into a topic compared to tutorials.

Getting Started

New users of ksonnet should start here. Although Kubernetes knowledge is helpful, it is not required to work through these documentation.

  • Core Concepts - A brief overview of terminology and problems that ksonnet aims to solve with these abstractions.

  • Guestbook Tutorial - See ksonnet in action by deploying a stateless guestbook application to a cluster. Then add Redis to see how it comes together.

  • Tour - An interactive tour to show how a ksonnet application generates a manifest though the CLI.

Application

Below is an overview of some commonly used pages from the documentation.

Registry: Create a registry | Package versions | Helm Charts

Components: Import YAML as a component

Prototypes: Building a Prototype

Components: Import YAML as a component | Build a mixin

Parameters: Template Text Files

Environments: Local overrides

Modules: Reusing components

ksonnet-lib

Developer Tools

Other

  • Design docs - Read previous design documentation to see outcomes of design decisions.

  • Incubator registry - The default registry shipped with ksonnet that contains examples of prototypes and components.

Last updated on: September 20, 2018