From f249edaed09f6238567ef41139d4714dea09262c Mon Sep 17 00:00:00 2001 From: John Mulhausen Date: Wed, 17 Feb 2016 18:32:18 -0800 Subject: [PATCH] Switch to native kramdown in-page TOCs instead of proprietary --- _includes/pagetoc.html | 1 - v1.1/docs/admin/admission-controllers.md | 3 ++- v1.1/docs/admin/cluster-large.md | 3 ++- v1.1/docs/admin/daemons.md | 3 ++- v1.1/docs/admin/high-availability.md | 3 ++- v1.1/docs/admin/introduction.md | 3 ++- v1.1/docs/admin/networking.md | 3 ++- v1.1/docs/admin/node.md | 3 ++- v1.1/docs/devel/api-conventions.md | 3 ++- v1.1/docs/devel/kubectl-conventions.md | 3 ++- v1.1/docs/getting-started-guides/README.md | 3 ++- v1.1/docs/getting-started-guides/aws.md | 3 ++- .../centos/centos_manual_config.md | 3 ++- v1.1/docs/getting-started-guides/cloudstack.md | 3 ++- v1.1/docs/getting-started-guides/coreos.md | 3 ++- v1.1/docs/getting-started-guides/coreos/azure/README.md | 3 ++- v1.1/docs/getting-started-guides/coreos/azure/index.md | 3 ++- .../getting-started-guides/coreos/bare_metal_offline.md | 3 ++- v1.1/docs/getting-started-guides/dcos.md | 3 ++- v1.1/docs/getting-started-guides/docker-multinode.md | 3 ++- v1.1/docs/getting-started-guides/docker.md | 9 +++++---- v1.1/docs/getting-started-guides/fedora/fedora-calico.md | 3 ++- .../fedora/fedora_ansible_config.md | 3 ++- .../fedora/fedora_manual_config.md | 3 ++- .../fedora/flannel_multi_node_cluster.md | 3 ++- v1.1/docs/getting-started-guides/gce.md | 3 ++- v1.1/docs/getting-started-guides/index.md | 3 ++- v1.1/docs/getting-started-guides/juju.md | 3 ++- v1.1/docs/getting-started-guides/libvirt-coreos.md | 3 ++- v1.1/docs/getting-started-guides/locally.md | 5 +++-- v1.1/docs/getting-started-guides/mesos-docker.md | 3 ++- v1.1/docs/getting-started-guides/mesos.md | 3 ++- v1.1/docs/getting-started-guides/ovirt.md | 3 ++- v1.1/docs/getting-started-guides/rackspace.md | 3 ++- v1.1/docs/getting-started-guides/scratch.md | 3 ++- v1.1/docs/getting-started-guides/ubuntu.md | 3 ++- v1.1/docs/getting-started-guides/vagrant.md | 3 ++- v1.1/docs/getting-started-guides/vsphere.md | 3 ++- v1.1/docs/user-guide/README.md | 3 ++- v1.1/docs/user-guide/accessing-the-cluster.md | 3 ++- v1.1/docs/user-guide/application-troubleshooting.md | 3 ++- v1.1/docs/user-guide/compute-resources.md | 3 ++- v1.1/docs/user-guide/configuring-containers.md | 3 ++- v1.1/docs/user-guide/connecting-applications.md | 3 ++- v1.1/docs/user-guide/container-environment.md | 3 ++- v1.1/docs/user-guide/containers.md | 3 ++- v1.1/docs/user-guide/debugging-services.md | 3 ++- v1.1/docs/user-guide/deploying-applications.md | 3 ++- v1.1/docs/user-guide/deployments.md | 3 ++- v1.1/docs/user-guide/docker-cli-to-kubectl.md | 3 ++- v1.1/docs/user-guide/images.md | 3 ++- v1.1/docs/user-guide/index.md | 3 ++- v1.1/docs/user-guide/ingress.md | 3 ++- v1.1/docs/user-guide/introspection-and-debugging.md | 3 ++- v1.1/docs/user-guide/jobs.md | 3 ++- v1.1/docs/user-guide/labels.md | 3 ++- v1.1/docs/user-guide/managing-deployments.md | 3 ++- v1.1/docs/user-guide/persistent-volumes.md | 3 ++- v1.1/docs/user-guide/pods.md | 3 ++- v1.1/docs/user-guide/production-pods.md | 3 ++- v1.1/docs/user-guide/quick-start.md | 3 ++- v1.1/docs/user-guide/replication-controller.md | 8 +++----- v1.1/docs/user-guide/secrets.md | 3 ++- v1.1/docs/user-guide/services.md | 3 ++- v1.1/docs/user-guide/volumes.md | 3 ++- v1.1/docs/user-guide/walkthrough/README.md | 3 ++- v1.1/docs/user-guide/walkthrough/index.md | 3 ++- v1.1/docs/user-guide/walkthrough/k8s201.md | 3 ++- 68 files changed, 139 insertions(+), 76 deletions(-) delete mode 100644 _includes/pagetoc.html diff --git a/_includes/pagetoc.html b/_includes/pagetoc.html deleted file mode 100644 index b6ff9446f5..0000000000 --- a/_includes/pagetoc.html +++ /dev/null @@ -1 +0,0 @@ -
\ No newline at end of file diff --git a/v1.1/docs/admin/admission-controllers.md b/v1.1/docs/admin/admission-controllers.md index 317a5a2bf3..327d4f4ae3 100644 --- a/v1.1/docs/admin/admission-controllers.md +++ b/v1.1/docs/admin/admission-controllers.md @@ -1,7 +1,8 @@ --- title: "Admission Controllers" --- -{% include pagetoc.html %} +* TOC +{:toc} ## What are they? diff --git a/v1.1/docs/admin/cluster-large.md b/v1.1/docs/admin/cluster-large.md index 1be6c67da6..c110c9b560 100644 --- a/v1.1/docs/admin/cluster-large.md +++ b/v1.1/docs/admin/cluster-large.md @@ -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 diff --git a/v1.1/docs/admin/daemons.md b/v1.1/docs/admin/daemons.md index 7b9a9d846c..b2a1adcfe7 100644 --- a/v1.1/docs/admin/daemons.md +++ b/v1.1/docs/admin/daemons.md @@ -1,7 +1,8 @@ --- title: "Daemon Sets" --- -{% include pagetoc.html %} +* TOC +{:toc} ## What is a _Daemon Set_? diff --git a/v1.1/docs/admin/high-availability.md b/v1.1/docs/admin/high-availability.md index 38bcba314d..1e4d0823ff 100644 --- a/v1.1/docs/admin/high-availability.md +++ b/v1.1/docs/admin/high-availability.md @@ -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 diff --git a/v1.1/docs/admin/introduction.md b/v1.1/docs/admin/introduction.md index ff443ae4fa..e5382b8e8f 100644 --- a/v1.1/docs/admin/introduction.md +++ b/v1.1/docs/admin/introduction.md @@ -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 diff --git a/v1.1/docs/admin/networking.md b/v1.1/docs/admin/networking.md index 2da55e4f4c..799bf90d0f 100644 --- a/v1.1/docs/admin/networking.md +++ b/v1.1/docs/admin/networking.md @@ -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: diff --git a/v1.1/docs/admin/node.md b/v1.1/docs/admin/node.md index 4f79772539..1db25d195d 100644 --- a/v1.1/docs/admin/node.md +++ b/v1.1/docs/admin/node.md @@ -1,7 +1,8 @@ --- title: "Node" --- -{% include pagetoc.html %} +* TOC +{:toc} ## What is a node? diff --git a/v1.1/docs/devel/api-conventions.md b/v1.1/docs/devel/api-conventions.md index ad2e2b3280..0cc4df9a66 100644 --- a/v1.1/docs/devel/api-conventions.md +++ b/v1.1/docs/devel/api-conventions.md @@ -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. diff --git a/v1.1/docs/devel/kubectl-conventions.md b/v1.1/docs/devel/kubectl-conventions.md index 64ac7dc610..97e30d1d60 100644 --- a/v1.1/docs/devel/kubectl-conventions.md +++ b/v1.1/docs/devel/kubectl-conventions.md @@ -3,7 +3,8 @@ title: "Kubectl Conventions" --- Updated: 8/27/2015 -{% include pagetoc.html %} +* TOC +{:toc} ## Principles diff --git a/v1.1/docs/getting-started-guides/README.md b/v1.1/docs/getting-started-guides/README.md index babc2ad16b..1b80126748 100644 --- a/v1.1/docs/getting-started-guides/README.md +++ b/v1.1/docs/getting-started-guides/README.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/aws.md b/v1.1/docs/getting-started-guides/aws.md index 411064d325..3df81357b8 100644 --- a/v1.1/docs/getting-started-guides/aws.md +++ b/v1.1/docs/getting-started-guides/aws.md @@ -1,7 +1,8 @@ --- title: "Getting started on AWS EC2" --- -{% include pagetoc.html %} +* TOC +{:toc} ## Prerequisites diff --git a/v1.1/docs/getting-started-guides/centos/centos_manual_config.md b/v1.1/docs/getting-started-guides/centos/centos_manual_config.md index 29143438ea..6799b4e1a6 100644 --- a/v1.1/docs/getting-started-guides/centos/centos_manual_config.md +++ b/v1.1/docs/getting-started-guides/centos/centos_manual_config.md @@ -1,7 +1,8 @@ --- title: "Getting started on CentOS" --- -{% include pagetoc.html %} +* TOC +{:toc} ## Prerequisites diff --git a/v1.1/docs/getting-started-guides/cloudstack.md b/v1.1/docs/getting-started-guides/cloudstack.md index 416bf46ea1..203123d0fa 100644 --- a/v1.1/docs/getting-started-guides/cloudstack.md +++ b/v1.1/docs/getting-started-guides/cloudstack.md @@ -16,7 +16,8 @@ This [Ansible](http://ansibleworks.com) playbook deploys Kubernetes on a CloudSt -{% include pagetoc.html %} +* TOC +{:toc} ## Prerequisites diff --git a/v1.1/docs/getting-started-guides/coreos.md b/v1.1/docs/getting-started-guides/coreos.md index 070690eea4..f2d92a946f 100644 --- a/v1.1/docs/getting-started-guides/coreos.md +++ b/v1.1/docs/getting-started-guides/coreos.md @@ -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/): diff --git a/v1.1/docs/getting-started-guides/coreos/azure/README.md b/v1.1/docs/getting-started-guides/coreos/azure/README.md index 5106d34418..f5d8c2120f 100644 --- a/v1.1/docs/getting-started-guides/coreos/azure/README.md +++ b/v1.1/docs/getting-started-guides/coreos/azure/README.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/coreos/azure/index.md b/v1.1/docs/getting-started-guides/coreos/azure/index.md index cd14df6521..87e3d9c924 100644 --- a/v1.1/docs/getting-started-guides/coreos/azure/index.md +++ b/v1.1/docs/getting-started-guides/coreos/azure/index.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/coreos/bare_metal_offline.md b/v1.1/docs/getting-started-guides/coreos/bare_metal_offline.md index 46d46ab110..32810d2bc7 100644 --- a/v1.1/docs/getting-started-guides/coreos/bare_metal_offline.md +++ b/v1.1/docs/getting-started-guides/coreos/bare_metal_offline.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/dcos.md b/v1.1/docs/getting-started-guides/dcos.md index 9b40d25069..7860ef7b51 100644 --- a/v1.1/docs/getting-started-guides/dcos.md +++ b/v1.1/docs/getting-started-guides/dcos.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/docker-multinode.md b/v1.1/docs/getting-started-guides/docker-multinode.md index 141cb2c5cd..8fd87b364d 100644 --- a/v1.1/docs/getting-started-guides/docker-multinode.md +++ b/v1.1/docs/getting-started-guides/docker-multinode.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/docker.md b/v1.1/docs/getting-started-guides/docker.md index e5293618e8..fdc5ee6435 100644 --- a/v1.1/docs/getting-started-guides/docker.md +++ b/v1.1/docs/getting-started-guides/docker.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/fedora/fedora-calico.md b/v1.1/docs/getting-started-guides/fedora/fedora-calico.md index 316f4d6e10..491bb4041f 100644 --- a/v1.1/docs/getting-started-guides/fedora/fedora-calico.md +++ b/v1.1/docs/getting-started-guides/fedora/fedora-calico.md @@ -1,7 +1,8 @@ --- title: "Running Kubernetes with Calico Networking on a Digital Ocean Fedora Host" --- -{% include pagetoc.html %} +* TOC +{:toc} ## Prerequisites diff --git a/v1.1/docs/getting-started-guides/fedora/fedora_ansible_config.md b/v1.1/docs/getting-started-guides/fedora/fedora_ansible_config.md index 99e53b6b54..06c72a92f8 100644 --- a/v1.1/docs/getting-started-guides/fedora/fedora_ansible_config.md +++ b/v1.1/docs/getting-started-guides/fedora/fedora_ansible_config.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/fedora/fedora_manual_config.md b/v1.1/docs/getting-started-guides/fedora/fedora_manual_config.md index 14b650f027..e87c1a38c3 100644 --- a/v1.1/docs/getting-started-guides/fedora/fedora_manual_config.md +++ b/v1.1/docs/getting-started-guides/fedora/fedora_manual_config.md @@ -1,7 +1,8 @@ --- title: "Getting started on Fedora" --- -{% include pagetoc.html %} +* TOC +{:toc} ## Prerequisites diff --git a/v1.1/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md b/v1.1/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md index 4f376f92a1..0538f25152 100644 --- a/v1.1/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md +++ b/v1.1/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/gce.md b/v1.1/docs/getting-started-guides/gce.md index 2186087855..32e69d087f 100644 --- a/v1.1/docs/getting-started-guides/gce.md +++ b/v1.1/docs/getting-started-guides/gce.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/index.md b/v1.1/docs/getting-started-guides/index.md index 53b70a74e2..6969c932e7 100644 --- a/v1.1/docs/getting-started-guides/index.md +++ b/v1.1/docs/getting-started-guides/index.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/juju.md b/v1.1/docs/getting-started-guides/juju.md index 529b4237ce..52aa2d8fdd 100644 --- a/v1.1/docs/getting-started-guides/juju.md +++ b/v1.1/docs/getting-started-guides/juju.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/libvirt-coreos.md b/v1.1/docs/getting-started-guides/libvirt-coreos.md index b9d57b34ce..4c4b984ce4 100644 --- a/v1.1/docs/getting-started-guides/libvirt-coreos.md +++ b/v1.1/docs/getting-started-guides/libvirt-coreos.md @@ -1,7 +1,8 @@ --- title: "Getting started with libvirt CoreOS" --- -{% include pagetoc.html %} +* TOC +{:toc} ### Highlights diff --git a/v1.1/docs/getting-started-guides/locally.md b/v1.1/docs/getting-started-guides/locally.md index 0ad177edf1..383c0ce7f6 100644 --- a/v1.1/docs/getting-started-guides/locally.md +++ b/v1.1/docs/getting-started-guides/locally.md @@ -1,7 +1,8 @@ --- title: "Getting started locally" --- -{% include pagetoc.html %} +--- +* TOC +{:toc} ### Requirements diff --git a/v1.1/docs/getting-started-guides/mesos-docker.md b/v1.1/docs/getting-started-guides/mesos-docker.md index 9175411116..bbaea4b3d0 100644 --- a/v1.1/docs/getting-started-guides/mesos-docker.md +++ b/v1.1/docs/getting-started-guides/mesos-docker.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/mesos.md b/v1.1/docs/getting-started-guides/mesos.md index 796e5df14c..df4eaa4cb2 100644 --- a/v1.1/docs/getting-started-guides/mesos.md +++ b/v1.1/docs/getting-started-guides/mesos.md @@ -1,7 +1,8 @@ --- title: "Getting started with Kubernetes on Mesos" --- -{% include pagetoc.html %} +* TOC +{:toc} ## About Kubernetes on Mesos diff --git a/v1.1/docs/getting-started-guides/ovirt.md b/v1.1/docs/getting-started-guides/ovirt.md index e299c42dfa..e2fb075139 100644 --- a/v1.1/docs/getting-started-guides/ovirt.md +++ b/v1.1/docs/getting-started-guides/ovirt.md @@ -1,7 +1,8 @@ --- title: "Getting started on oVirt" --- -{% include pagetoc.html %} +* TOC +{:toc} ## What is oVirt diff --git a/v1.1/docs/getting-started-guides/rackspace.md b/v1.1/docs/getting-started-guides/rackspace.md index 3b75391d38..89cf1d9f02 100644 --- a/v1.1/docs/getting-started-guides/rackspace.md +++ b/v1.1/docs/getting-started-guides/rackspace.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/scratch.md b/v1.1/docs/getting-started-guides/scratch.md index d7ce566212..d4d4f76ef5 100644 --- a/v1.1/docs/getting-started-guides/scratch.md +++ b/v1.1/docs/getting-started-guides/scratch.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/ubuntu.md b/v1.1/docs/getting-started-guides/ubuntu.md index b2d1684232..1f2c78cda2 100644 --- a/v1.1/docs/getting-started-guides/ubuntu.md +++ b/v1.1/docs/getting-started-guides/ubuntu.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/vagrant.md b/v1.1/docs/getting-started-guides/vagrant.md index 0b383428bf..540b5625aa 100644 --- a/v1.1/docs/getting-started-guides/vagrant.md +++ b/v1.1/docs/getting-started-guides/vagrant.md @@ -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 diff --git a/v1.1/docs/getting-started-guides/vsphere.md b/v1.1/docs/getting-started-guides/vsphere.md index fb4008088a..4b24c2d031 100644 --- a/v1.1/docs/getting-started-guides/vsphere.md +++ b/v1.1/docs/getting-started-guides/vsphere.md @@ -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 diff --git a/v1.1/docs/user-guide/README.md b/v1.1/docs/user-guide/README.md index d253184575..b69fedf9a1 100644 --- a/v1.1/docs/user-guide/README.md +++ b/v1.1/docs/user-guide/README.md @@ -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. diff --git a/v1.1/docs/user-guide/accessing-the-cluster.md b/v1.1/docs/user-guide/accessing-the-cluster.md index 9a45caf710..9c49d4fa89 100644 --- a/v1.1/docs/user-guide/accessing-the-cluster.md +++ b/v1.1/docs/user-guide/accessing-the-cluster.md @@ -1,7 +1,8 @@ --- title: "Accessing Clusters" --- -{% include pagetoc.html %} +* TOC +{:toc} ## Accessing the cluster API diff --git a/v1.1/docs/user-guide/application-troubleshooting.md b/v1.1/docs/user-guide/application-troubleshooting.md index 20289d403b..f347bb10e9 100644 --- a/v1.1/docs/user-guide/application-troubleshooting.md +++ b/v1.1/docs/user-guide/application-troubleshooting.md @@ -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 diff --git a/v1.1/docs/user-guide/compute-resources.md b/v1.1/docs/user-guide/compute-resources.md index 0726b178f5..36ed90e58f 100644 --- a/v1.1/docs/user-guide/compute-resources.md +++ b/v1.1/docs/user-guide/compute-resources.md @@ -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 diff --git a/v1.1/docs/user-guide/configuring-containers.md b/v1.1/docs/user-guide/configuring-containers.md index e457bc6aaa..55201f37b9 100644 --- a/v1.1/docs/user-guide/configuring-containers.md +++ b/v1.1/docs/user-guide/configuring-containers.md @@ -1,7 +1,8 @@ --- title: "Kubernetes User Guide: Managing Applications: Configuring and launching containers" --- -{% include pagetoc.html %} +* TOC +{:toc} ## Configuration in Kubernetes diff --git a/v1.1/docs/user-guide/connecting-applications.md b/v1.1/docs/user-guide/connecting-applications.md index 5935183de5..93e51b3f75 100644 --- a/v1.1/docs/user-guide/connecting-applications.md +++ b/v1.1/docs/user-guide/connecting-applications.md @@ -1,7 +1,8 @@ --- title: "Kubernetes User Guide: Managing Applications: Connecting applications" --- -{% include pagetoc.html %} +* TOC +{:toc} # The Kubernetes model for connecting containers diff --git a/v1.1/docs/user-guide/container-environment.md b/v1.1/docs/user-guide/container-environment.md index c33fa34424..e14ded1c50 100644 --- a/v1.1/docs/user-guide/container-environment.md +++ b/v1.1/docs/user-guide/container-environment.md @@ -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 diff --git a/v1.1/docs/user-guide/containers.md b/v1.1/docs/user-guide/containers.md index f2710ee5c4..03e6ab3856 100644 --- a/v1.1/docs/user-guide/containers.md +++ b/v1.1/docs/user-guide/containers.md @@ -1,7 +1,8 @@ --- title: "Containers with Kubernetes" --- -{% include pagetoc.html %} +* TOC +{:toc} ## Containers and commands diff --git a/v1.1/docs/user-guide/debugging-services.md b/v1.1/docs/user-guide/debugging-services.md index 204529d049..f1f3719aae 100644 --- a/v1.1/docs/user-guide/debugging-services.md +++ b/v1.1/docs/user-guide/debugging-services.md @@ -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 diff --git a/v1.1/docs/user-guide/deploying-applications.md b/v1.1/docs/user-guide/deploying-applications.md index dba7b44879..aff4093747 100644 --- a/v1.1/docs/user-guide/deploying-applications.md +++ b/v1.1/docs/user-guide/deploying-applications.md @@ -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 diff --git a/v1.1/docs/user-guide/deployments.md b/v1.1/docs/user-guide/deployments.md index 9b01cb3e4c..a7abb95950 100644 --- a/v1.1/docs/user-guide/deployments.md +++ b/v1.1/docs/user-guide/deployments.md @@ -1,7 +1,8 @@ --- title: "Deployments" --- -{% include pagetoc.html %} +* TOC +{:toc} ## What is a _Deployment_? diff --git a/v1.1/docs/user-guide/docker-cli-to-kubectl.md b/v1.1/docs/user-guide/docker-cli-to-kubectl.md index be67a607f6..29354e6f15 100644 --- a/v1.1/docs/user-guide/docker-cli-to-kubectl.md +++ b/v1.1/docs/user-guide/docker-cli-to-kubectl.md @@ -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 diff --git a/v1.1/docs/user-guide/images.md b/v1.1/docs/user-guide/images.md index 629ecb5bf1..04ec3fe0f8 100644 --- a/v1.1/docs/user-guide/images.md +++ b/v1.1/docs/user-guide/images.md @@ -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 diff --git a/v1.1/docs/user-guide/index.md b/v1.1/docs/user-guide/index.md index d253184575..b69fedf9a1 100644 --- a/v1.1/docs/user-guide/index.md +++ b/v1.1/docs/user-guide/index.md @@ -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. diff --git a/v1.1/docs/user-guide/ingress.md b/v1.1/docs/user-guide/ingress.md index cb4d2e23c9..0eef149d20 100644 --- a/v1.1/docs/user-guide/ingress.md +++ b/v1.1/docs/user-guide/ingress.md @@ -1,7 +1,8 @@ --- title: "Ingress" --- -{% include pagetoc.html %} +* TOC +{:toc} __Terminology__ diff --git a/v1.1/docs/user-guide/introspection-and-debugging.md b/v1.1/docs/user-guide/introspection-and-debugging.md index 9d099ec50b..d3b2a83508 100644 --- a/v1.1/docs/user-guide/introspection-and-debugging.md +++ b/v1.1/docs/user-guide/introspection-and-debugging.md @@ -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 diff --git a/v1.1/docs/user-guide/jobs.md b/v1.1/docs/user-guide/jobs.md index 094b3652b7..1c46455c3a 100644 --- a/v1.1/docs/user-guide/jobs.md +++ b/v1.1/docs/user-guide/jobs.md @@ -1,7 +1,8 @@ --- title: "Jobs" --- -{% include pagetoc.html %} +* TOC +{:toc} ## What is a _job_? diff --git a/v1.1/docs/user-guide/labels.md b/v1.1/docs/user-guide/labels.md index 49e64e5ff7..d93df7df87 100644 --- a/v1.1/docs/user-guide/labels.md +++ b/v1.1/docs/user-guide/labels.md @@ -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 diff --git a/v1.1/docs/user-guide/managing-deployments.md b/v1.1/docs/user-guide/managing-deployments.md index c161081426..45aef1e0ac 100644 --- a/v1.1/docs/user-guide/managing-deployments.md +++ b/v1.1/docs/user-guide/managing-deployments.md @@ -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 diff --git a/v1.1/docs/user-guide/persistent-volumes.md b/v1.1/docs/user-guide/persistent-volumes.md index c86cf2d390..5da7be3b00 100644 --- a/v1.1/docs/user-guide/persistent-volumes.md +++ b/v1.1/docs/user-guide/persistent-volumes.md @@ -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 diff --git a/v1.1/docs/user-guide/pods.md b/v1.1/docs/user-guide/pods.md index 6c381116d5..972c313f67 100644 --- a/v1.1/docs/user-guide/pods.md +++ b/v1.1/docs/user-guide/pods.md @@ -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. diff --git a/v1.1/docs/user-guide/production-pods.md b/v1.1/docs/user-guide/production-pods.md index 8ba3e0d7f5..4ab7475110 100644 --- a/v1.1/docs/user-guide/production-pods.md +++ b/v1.1/docs/user-guide/production-pods.md @@ -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 diff --git a/v1.1/docs/user-guide/quick-start.md b/v1.1/docs/user-guide/quick-start.md index 354bcd8840..b1a64b1535 100644 --- a/v1.1/docs/user-guide/quick-start.md +++ b/v1.1/docs/user-guide/quick-start.md @@ -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 diff --git a/v1.1/docs/user-guide/replication-controller.md b/v1.1/docs/user-guide/replication-controller.md index ada2351231..ea1434a83b 100644 --- a/v1.1/docs/user-guide/replication-controller.md +++ b/v1.1/docs/user-guide/replication-controller.md @@ -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). \ No newline at end of file diff --git a/v1.1/docs/user-guide/secrets.md b/v1.1/docs/user-guide/secrets.md index 69dd5dc669..4cfa8f38dc 100644 --- a/v1.1/docs/user-guide/secrets.md +++ b/v1.1/docs/user-guide/secrets.md @@ -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 diff --git a/v1.1/docs/user-guide/services.md b/v1.1/docs/user-guide/services.md index b1d4c972ed..d49f30ad5b 100644 --- a/v1.1/docs/user-guide/services.md +++ b/v1.1/docs/user-guide/services.md @@ -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 diff --git a/v1.1/docs/user-guide/volumes.md b/v1.1/docs/user-guide/volumes.md index 70db51a921..29458f97bb 100644 --- a/v1.1/docs/user-guide/volumes.md +++ b/v1.1/docs/user-guide/volumes.md @@ -10,7 +10,8 @@ Kubernetes `Volume` abstraction solves both of these problems. Familiarity with [pods](pods) is suggested. -{% include pagetoc.html %} +* TOC +{:toc} ## Background diff --git a/v1.1/docs/user-guide/walkthrough/README.md b/v1.1/docs/user-guide/walkthrough/README.md index cf2d244082..b403d5466a 100644 --- a/v1.1/docs/user-guide/walkthrough/README.md +++ b/v1.1/docs/user-guide/walkthrough/README.md @@ -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 diff --git a/v1.1/docs/user-guide/walkthrough/index.md b/v1.1/docs/user-guide/walkthrough/index.md index aa9f05f5a1..d0e497d412 100644 --- a/v1.1/docs/user-guide/walkthrough/index.md +++ b/v1.1/docs/user-guide/walkthrough/index.md @@ -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 diff --git a/v1.1/docs/user-guide/walkthrough/k8s201.md b/v1.1/docs/user-guide/walkthrough/k8s201.md index 2e4d2ef7a4..79964fe5c8 100644 --- a/v1.1/docs/user-guide/walkthrough/k8s201.md +++ b/v1.1/docs/user-guide/walkthrough/k8s201.md @@ -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