Switch to native kramdown in-page TOCs instead of proprietary

pull/43/head
John Mulhausen 2016-02-17 18:32:18 -08:00
parent 15ca4aab1e
commit f249edaed0
68 changed files with 139 additions and 76 deletions

View File

@ -1 +0,0 @@
<div id="pageTOC" style="padding-top:15px; font-weight: bold; width: auto;"></div>

View File

@ -1,7 +1,8 @@
---
title: "Admission Controllers"
---
{% include pagetoc.html %}
* TOC
{:toc}
## What are they?

View File

@ -6,7 +6,8 @@ title: "Using Large Clusters"
At v1.0, Kubernetes supports clusters up to 100 nodes with 30 pods per node and 1-2 containers per pod.
{% include pagetoc.html %}
* TOC
{:toc}
## Setup

View File

@ -1,7 +1,8 @@
---
title: "Daemon Sets"
---
{% include pagetoc.html %}
* TOC
{:toc}
## What is a _Daemon Set_?

View File

@ -12,7 +12,8 @@ or try [Google Container Engine](https://cloud.google.com/container-engine/) for
Also, at this time high availability support for Kubernetes is not continuously tested in our end-to-end (e2e) testing. We will
be working to add this continuous testing, but for now the single-node master installations are more heavily tested.
{% include pagetoc.html %}
* TOC
{:toc}
## Overview

View File

@ -4,7 +4,8 @@ title: "Kubernetes Cluster Admin Guide"
The cluster admin guide is for anyone creating or administering a Kubernetes cluster.
It assumes some familiarity with concepts in the [User Guide](../user-guide/README).
{% include pagetoc.html %}
* TOC
{:toc}
## Planning a cluster

View File

@ -1,7 +1,8 @@
---
title: "Networking in Kubernetes"
---
{% include pagetoc.html %}
* TOC
{:toc}
Kubernetes approaches networking somewhat differently than Docker does by
default. There are 4 distinct networking problems to solve:

View File

@ -1,7 +1,8 @@
---
title: "Node"
---
{% include pagetoc.html %}
* TOC
{:toc}
## What is a node?

View File

@ -7,7 +7,8 @@ Updated: 9/20/2015
API structure, and developers wanting to extend the Kubernetes API. An introduction to
using resources with kubectl can be found in [Working with resources](../user-guide/working-with-resources).*
{% include pagetoc.html %}
* TOC
{:toc}
The conventions of the [Kubernetes API](../api) (and related APIs in the ecosystem) are intended to ease client development and ensure that configuration mechanisms can be implemented that work across a diverse set of use cases consistently.

View File

@ -3,7 +3,8 @@ title: "Kubectl Conventions"
---
Updated: 8/27/2015
{% include pagetoc.html %}
* TOC
{:toc}
## Principles

View File

@ -5,7 +5,8 @@ Kubernetes can run on a range of platforms, from your laptop, to VMs on a cloud
bare metal servers. The effort required to set up a cluster varies from running a single command to
crafting your own customized cluster. We'll guide you in picking a solution that fits for your needs.
{% include pagetoc.html %}
* TOC
{:toc}
## Options

View File

@ -1,7 +1,8 @@
---
title: "Getting started on AWS EC2"
---
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -1,7 +1,8 @@
---
title: "Getting started on CentOS"
---
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -16,7 +16,8 @@ This [Ansible](http://ansibleworks.com) playbook deploys Kubernetes on a CloudSt
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -4,7 +4,8 @@ title: "Getting Started on CoreOS"
{% include pagetoc.html %}
* TOC
{:toc}
There are multiple guides on running Kubernetes with [CoreOS](https://coreos.com/kubernetes/docs/latest/):

View File

@ -3,7 +3,8 @@ title: "Kubernetes on Azure with CoreOS and Weave"
---
In this guide I will demonstrate how to deploy a Kubernetes cluster to Azure cloud. You will be using CoreOS with Weave, which implements simple and secure networking, in a transparent, yet robust way. The purpose of this guide is to provide an out-of-the-box implementation that can ultimately be taken into production with little change. It will demonstrate how to provision a dedicated Kubernetes master and etcd nodes, and show how to scale the cluster with ease.
{% include pagetoc.html %}
* TOC
{:toc}
### Prerequisites

View File

@ -6,7 +6,8 @@ which implements simple and secure networking, in a transparent, yet robust way.
implementation that can ultimately be taken into production with little change. It will demonstrate how to provision a dedicated Kubernetes
master and etcd nodes, and show how to scale the cluster with ease.
{% include pagetoc.html %}
* TOC
{:toc}
### Prerequisites

View File

@ -4,7 +4,8 @@ title: "Bare Metal CoreOS with Kubernetes (OFFLINE)"
Deploy a CoreOS running Kubernetes environment. This particular guild is made to help those in an OFFLINE system,
whether for testing a POC before the real deal, or you are restricted to be totally offline for your applications.
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -3,7 +3,8 @@ title: "Getting started with Kubernetes on DCOS"
---
This guide will walk you through installing [Kubernetes-Mesos](https://github.com/mesosphere/kubernetes-mesos) on [Datacenter Operating System (DCOS)](https://mesosphere.com/product/) with the [DCOS CLI](https://github.com/mesosphere/dcos-cli) and operating Kubernetes with the [DCOS Kubectl plugin](https://github.com/mesosphere/dcos-kubectl).
{% include pagetoc.html %}
* TOC
{:toc}
## About Kubernetes on DCOS

View File

@ -10,7 +10,8 @@ _Note_:
There is a [bug](https://github.com/docker/docker/issues/14106) in Docker 1.7.0 that prevents this from working correctly.
Please install Docker 1.6.2 or Docker 1.7.1.
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -1,13 +1,14 @@
---
title: "Running Kubernetes locally via Docker"
---
The following instructions show you how to set up a simple, single node Kubernetes cluster using Docker.
The following instructions show you how to set up a simple, single node Kubernetes cluster using Docker.
Here's a diagram of what the final result will look like:
![Kubernetes Single Node on Docker](/images/docs/k8s-singlenode-docker.png)
{% include pagetoc.html %}
![Kubernetes Single Node on Docker](/images/docs/k8s-singlenode-docker.png)
* TOC
{:toc}
## Prerequisites

View File

@ -1,7 +1,8 @@
---
title: "Running Kubernetes with Calico Networking on a Digital Ocean Fedora Host"
---
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -3,7 +3,8 @@ title: "Configuring Kubernetes on Fedora via Ansible"
---
Configuring Kubernetes on Fedora via Ansible offers a simple way to quickly create a clustered environment with little effort.
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -1,7 +1,8 @@
---
title: "Getting started on Fedora"
---
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -3,7 +3,8 @@ title: "Kubernetes multiple nodes cluster with flannel on Fedora"
---
This document describes how to deploy Kubernetes on multiple hosts to set up a multi-node cluster and networking with flannel. Follow fedora [getting started guide](fedora_manual_config) to setup 1 master (fed-master) and 2 or more nodes. Make sure that all nodes have different names (fed-node1, fed-node2 and so on) and labels (fed-node1-label, fed-node2-label, and so on) to avoid any conflict. Also make sure that the Kubernetes master host is running etcd, kube-controller-manager, kube-scheduler, and kube-apiserver services, and the nodes are running docker, kube-proxy and kubelet services. Now install flannel on Kubernetes nodes. flannel on each node configures an overlay network that docker uses. flannel runs on each node to setup a unique class-C container network.
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -4,7 +4,8 @@ title: "Getting started on Google Compute Engine"
The example below creates a Kubernetes cluster with 4 worker node Virtual Machines and a master Virtual Machine (i.e. 5 VMs in your cluster). This cluster is set up and controlled from your workstation (or wherever you find convenient).
{% include pagetoc.html %}
* TOC
{:toc}
### Before you start

View File

@ -5,7 +5,8 @@ Kubernetes can run on a range of platforms, from your laptop, to VMs on a cloud
bare metal servers. The effort required to set up a cluster varies from running a single command to
crafting your own customized cluster. We'll guide you in picking a solution that fits for your needs.
{% include pagetoc.html %}
* TOC
{:toc}
## Picking the Right Solution

View File

@ -6,7 +6,8 @@ Kubernetes by provisioning, installing and configuring all the systems in
the cluster. Once deployed the cluster can easily scale up with one command
to increase the cluster size.
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -1,7 +1,8 @@
---
title: "Getting started with libvirt CoreOS"
---
{% include pagetoc.html %}
* TOC
{:toc}
### Highlights

View File

@ -1,7 +1,8 @@
---
title: "Getting started locally"
--
{% include pagetoc.html %}
---
* TOC
{:toc}
### Requirements

View File

@ -5,7 +5,8 @@ title: "Getting Started With Kubernetes on Mesos on Docker"
The mesos/docker provider uses docker-compose to launch Kubernetes as a Mesos framework, running in docker with its
dependencies (etcd & mesos).
{% include pagetoc.html %}
* TOC
{:toc}
## Cluster Goals

View File

@ -1,7 +1,8 @@
---
title: "Getting started with Kubernetes on Mesos"
---
{% include pagetoc.html %}
* TOC
{:toc}
## About Kubernetes on Mesos

View File

@ -1,7 +1,8 @@
---
title: "Getting started on oVirt"
---
{% include pagetoc.html %}
* TOC
{:toc}
## What is oVirt

View File

@ -14,7 +14,8 @@ The current cluster design is inspired by:
- [corekube](https://github.com/metral/corekube)
- [Angus Lees](https://github.com/anguslees/kube-openstack)
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -13,7 +13,8 @@ pre-defined guides.
This guide is also useful for those wanting to understand at a high level some of the
steps that existing cluster setup scripts are making.
{% include pagetoc.html %}
* TOC
{:toc}
## Designing and Preparing

View File

@ -8,7 +8,8 @@ work, which has been merge into this document.
[Cloud team from Zhejiang University](https://github.com/ZJU-SEL) will maintain this work.
{% include pagetoc.html %}
* TOC
{:toc}
## Prerequisites

View File

@ -3,7 +3,8 @@ title: "Getting started with Vagrant"
---
Running Kubernetes with Vagrant (and VirtualBox) is an easy way to run/test/develop on your local machine (Linux, Mac OS X).
{% include pagetoc.html %}
* TOC
{:toc}
### Prerequisites

View File

@ -6,7 +6,8 @@ Machines and a master Virtual Machine (i.e. 5 VMs in your cluster). This
cluster is set up and controlled from your workstation (or wherever you find
convenient).
{% include pagetoc.html %}
* TOC
{:toc}
### Prerequisites

View File

@ -1,7 +1,8 @@
---
title: "Kubernetes User Guide: Managing Applications"
---
{% include pagetoc.html %}
* TOC
{:toc}
The user guide is intended for anyone who wants to run programs and services on an existing Kubernetes cluster. Setup and administration of a Kubernetes cluster is described in the [Cluster Admin Guide](/{{page.version}}/docs/admin/README). The [Developer Guide](/{{page.version}}/docs/devel/README) is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project.

View File

@ -1,7 +1,8 @@
---
title: "Accessing Clusters"
---
{% include pagetoc.html %}
* TOC
{:toc}
## Accessing the cluster API

View File

@ -5,7 +5,8 @@ This guide is to help users debug applications that are deployed into Kubernetes
This is *not* a guide for people who want to debug their cluster. For that you should check out
[this guide](../admin/cluster-troubleshooting)
{% include pagetoc.html %}
* TOC
{:toc}
## FAQ

View File

@ -1,7 +1,8 @@
---
title: "Compute Resources"
---
{% include pagetoc.html %}
* TOC
{:toc}
When specifying a [pod](pods), you can optionally specify how much CPU and memory (RAM) each
container needs. When containers have their resource requests specified, the scheduler is

View File

@ -1,7 +1,8 @@
---
title: "Kubernetes User Guide: Managing Applications: Configuring and launching containers"
---
{% include pagetoc.html %}
* TOC
{:toc}
## Configuration in Kubernetes

View File

@ -1,7 +1,8 @@
---
title: "Kubernetes User Guide: Managing Applications: Connecting applications"
---
{% include pagetoc.html %}
* TOC
{:toc}
# The Kubernetes model for connecting containers

View File

@ -10,7 +10,8 @@ Another important part of the container environment is the file system that is a
The following sections describe both the cluster information provided to containers, as well as the hooks and life-cycle that allows containers to interact with the management system.
{% include pagetoc.html %}
* TOC
{:toc}
## Cluster Information

View File

@ -1,7 +1,8 @@
---
title: "Containers with Kubernetes"
---
{% include pagetoc.html %}
* TOC
{:toc}
## Containers and commands

View File

@ -6,7 +6,8 @@ that `Services` are not working properly. You've run all your `Pod`s and
`ReplicationController`s, but you get no response when you try to access them.
This document will hopefully help you to figure out what's going wrong.
{% include pagetoc.html %}
* TOC
{:toc}
## Conventions

View File

@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Deploying continuously run
---
You previously read about how to quickly deploy a simple replicated application using [`kubectl run`](quick-start) and how to configure and launch single-run containers using pods ([Configuring containers](configuring-containers)). Here you'll use the configuration-based approach to deploy a continuously running, replicated application.
{% include pagetoc.html %}
* TOC
{:toc}
## Launching a set of replicas using a configuration file

View File

@ -1,7 +1,8 @@
---
title: "Deployments"
---
{% include pagetoc.html %}
* TOC
{:toc}
## What is a _Deployment_?

View File

@ -3,7 +3,8 @@ title: "kubectl for docker users"
---
In this doc, we introduce the Kubernetes command line for interacting with the api to docker-cli users. The tool, kubectl, is designed to be familiar to docker-cli users but there are a few necessary differences. Each section of this doc highlights a docker subcommand explains the kubectl equivalent.
{% include pagetoc.html %}
* TOC
{:toc}
#### docker run

View File

@ -7,7 +7,8 @@ You create your Docker image and push it to a registry before referring to it in
The `image` property of a container supports the same syntax as the `docker` command does, including private registries and tags.
{% include pagetoc.html %}
* TOC
{:toc}
## Updating Images

View File

@ -1,7 +1,8 @@
---
title: "Kubernetes User Guide: Managing Applications"
---
{% include pagetoc.html %}
* TOC
{:toc}
The user guide is intended for anyone who wants to run programs and services on an existing Kubernetes cluster. Setup and administration of a Kubernetes cluster is described in the [Cluster Admin Guide](/{{page.version}}/docs/admin/README). The [Developer Guide](/{{page.version}}/docs/devel/README) is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project.

View File

@ -1,7 +1,8 @@
---
title: "Ingress"
---
{% include pagetoc.html %}
* TOC
{:toc}
__Terminology__

View File

@ -5,7 +5,8 @@ Once your application is running, you'll inevitably need to debug problems with
Earlier we described how you can use `kubectl get pods` to retrieve simple status information about
your pods. But there are a number of ways to get even more information about your application.
{% include pagetoc.html %}
* TOC
{:toc}
## Using `kubectl describe pod` to fetch details about pods

View File

@ -1,7 +1,8 @@
---
title: "Jobs"
---
{% include pagetoc.html %}
* TOC
{:toc}
## What is a _job_?

View File

@ -15,7 +15,8 @@ Each object can have a set of key/value labels defined. Each Key must be unique
We'll eventually index and reverse-index labels for efficient queries and watches, use them to sort and group in UIs and CLIs, etc. We don't want to pollute labels with non-identifying, especially large and/or structured, data. Non-identifying information should be recorded using [annotations](annotations).
{% include pagetoc.html %}
* TOC
{:toc}
## Motivation

View File

@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Managing deployments"
---
You've deployed your application and exposed it via a service. Now what? Kubernetes provides a number of tools to help you manage your application deployment, including scaling and updating. Among the features we'll discuss in more depth are [configuration files](configuring-containers.html#configuration-in-kubernetes) and [labels](deploying-applications.html#labels).
{% include pagetoc.html %}
* TOC
{:toc}
## Organizing resource configurations

View File

@ -3,7 +3,8 @@ title: "Persistent Volumes and Claims"
---
This document describes the current state of `PersistentVolumes` in Kubernetes. Familiarity with [volumes](volumes) is suggested.
{% include pagetoc.html %}
* TOC
{:toc}
## Introduction

View File

@ -1,7 +1,8 @@
---
title: "Pods"
---
{% include pagetoc.html %}
* TOC
{:toc}
In Kubernetes, rather than individual application containers, _pods_ are the smallest deployable units that can be created, scheduled, and managed.

View File

@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Working with pods and cont
---
You've seen [how to configure and deploy pods and containers](configuring-containers), using some of the most common configuration parameters. This section dives into additional features that are especially useful for running applications in production.
{% include pagetoc.html %}
* TOC
{:toc}
## Persistent storage

View File

@ -3,7 +3,8 @@ title: "Kubernetes User Guide: Managing Applications: Quick start"
---
This guide will help you get oriented to Kubernetes and running your first containers on the cluster. If you are already familiar with the docker-cli, you can also checkout the docker-cli to kubectl migration guide [here](docker-cli-to-kubectl).
{% include pagetoc.html %}
* TOC
{:toc}
## Launching a simple application

View File

@ -1,7 +1,8 @@
---
title: "Replication Controller"
---
{% include pagetoc.html %}
* TOC
{:toc}
## What is a _replication controller_?
@ -74,7 +75,4 @@ For instance, a service might target all pods with `tier in (frontend), environm
Replication controller is a top-level resource in the kubernetes REST API. More details about the
API object can be found at: [ReplicationController API
object](http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_replicationcontroller).
object](http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_replicationcontroller).

View File

@ -6,7 +6,8 @@ passwords, OAuth tokens, and ssh keys. Putting this information in a `secret`
is safer and more flexible than putting it verbatim in a `pod` definition or in
a docker image. See [Secrets design document](../design/secrets) for more information.
{% include pagetoc.html %}
* TOC
{:toc}
## Overview of Secrets

View File

@ -30,7 +30,8 @@ that is updated whenever the set of `Pods` in a `Service` changes. For
non-native applications, Kubernetes offers a virtual-IP-based bridge to Services
which redirects to the backend `Pods`.
{% include pagetoc.html %}
* TOC
{:toc}
## Defining a service

View File

@ -10,7 +10,8 @@ Kubernetes `Volume` abstraction solves both of these problems.
Familiarity with [pods](pods) is suggested.
{% include pagetoc.html %}
* TOC
{:toc}
## Background

View File

@ -8,7 +8,8 @@ In order for the kubectl usage examples to work, make sure you have an examples
{% include pagetoc.html %}
* TOC
{:toc}
## Kubectl CLI

View File

@ -5,7 +5,8 @@ For Kubernetes 101, we will cover kubectl, pods, volumes, and multiple container
In order for the kubectl usage examples to work, make sure you have an examples directory locally, either from [a release](https://github.com/kubernetes/kubernetes/releases) or [the source](https://github.com/kubernetes/kubernetes).
{% include pagetoc.html %}
* TOC
{:toc}
## Kubectl CLI

View File

@ -8,7 +8,8 @@ scaling.
In order for the kubectl usage examples to work, make sure you have an examples directory locally, either from [a release](https://github.com/kubernetes/kubernetes/releases) or [the source](https://github.com/kubernetes/kubernetes).
{% include pagetoc.html %}
* TOC
{:toc}
## Labels