diff --git a/docs/getting-started-guides/aws.md b/docs/getting-started-guides/aws.md index 9a21ceafb2598..99ecc7aafe692 100644 --- a/docs/getting-started-guides/aws.md +++ b/docs/getting-started-guides/aws.md @@ -3,15 +3,15 @@ Getting started on AWS EC2 **Table of Contents** - - [Prerequisites](#prerequisites) - - [Cluster turnup](#cluster-turnup) - - [Supported procedure: `get-kube`](#supported-procedure-get-kube) - - [Alternatives](#alternatives) - - [Getting started with your cluster](#getting-started-with-your-cluster) - - [Command line administration tool: `kubectl`](#command-line-administration-tool-kubectl) - - [Examples](#examples) - - [Tearing down the cluster](#tearing-down-the-cluster) - - [Further reading](#further-reading) +- [Prerequisites](#prerequisites) +- [Cluster turnup](#cluster-turnup) + - [Supported procedure: `get-kube`](#supported-procedure-get-kube) + - [Alternatives](#alternatives) +- [Getting started with your cluster](#getting-started-with-your-cluster) + - [Command line administration tool: `kubectl`](#command-line-administration-tool-kubectl) + - [Examples](#examples) +- [Tearing down the cluster](#tearing-down-the-cluster) +- [Further reading](#further-reading) ## Prerequisites diff --git a/docs/getting-started-guides/coreos/azure/README.md b/docs/getting-started-guides/coreos/azure/README.md index 7f5ab30b1b5c1..717d980f6068a 100644 --- a/docs/getting-started-guides/coreos/azure/README.md +++ b/docs/getting-started-guides/coreos/azure/README.md @@ -3,14 +3,14 @@ Kubernetes on Azure with CoreOS and [Weave](http://weave.works) **Table of Contents** - - [Introduction](#introduction) - - [Prerequisites](#prerequisites) - - [Let's go!](#lets-go) - - [Deploying the workload](#deploying-the-workload) - - [Scaling](#scaling) - - [Exposing the app to the outside world](#exposing-the-app-to-the-outside-world) - - [Next steps](#next-steps) - - [Tear down...](#tear-down) +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Let's go!](#lets-go) +- [Deploying the workload](#deploying-the-workload) +- [Scaling](#scaling) +- [Exposing the app to the outside world](#exposing-the-app-to-the-outside-world) +- [Next steps](#next-steps) +- [Tear down...](#tear-down) ## Introduction diff --git a/docs/getting-started-guides/coreos/bare_metal_offline.md b/docs/getting-started-guides/coreos/bare_metal_offline.md index 6bb1411e9a74d..51b75cb3f8c2e 100644 --- a/docs/getting-started-guides/coreos/bare_metal_offline.md +++ b/docs/getting-started-guides/coreos/bare_metal_offline.md @@ -4,22 +4,20 @@ Deploy a CoreOS running Kubernetes environment. This particular guild is made to **Table of Contents** - - [Prerequisites](#prerequisites) - - [High Level Design](#high-level-design) - - [This Guides variables](#this-guides-variables) - - [Setup PXELINUX CentOS](#setup-pxelinux-centos) - - [Adding CoreOS to PXE](#adding-coreos-to-pxe) - - [DHCP configuration](#dhcp-configuration) - - [Kubernetes](#kubernetes) - - [Cloud Configs](#cloud-configs) - - [master.yml](#masteryml) -- [cloud-config](#cloud-config) - - [node.yml](#nodeyml) -- [cloud-config](#cloud-config) - - [New pxelinux.cfg file](#new-pxelinuxcfg-file) - - [Specify the pxelinux targets](#specify-the-pxelinux-targets) - - [Creating test pod](#creating-test-pod) - - [Helping commands for debugging](#helping-commands-for-debugging) +- [Prerequisites](#prerequisites) +- [High Level Design](#high-level-design) +- [This Guides variables](#this-guides-variables) +- [Setup PXELINUX CentOS](#setup-pxelinux-centos) +- [Adding CoreOS to PXE](#adding-coreos-to-pxe) +- [DHCP configuration](#dhcp-configuration) +- [Kubernetes](#kubernetes) +- [Cloud Configs](#cloud-configs) + - [master.yml](#masteryml) + - [node.yml](#nodeyml) +- [New pxelinux.cfg file](#new-pxelinuxcfg-file) +- [Specify the pxelinux targets](#specify-the-pxelinux-targets) +- [Creating test pod](#creating-test-pod) +- [Helping commands for debugging](#helping-commands-for-debugging) ## Prerequisites diff --git a/docs/getting-started-guides/docker-multinode.md b/docs/getting-started-guides/docker-multinode.md index fac56ab9eaf6f..a134a99ea5c12 100644 --- a/docs/getting-started-guides/docker-multinode.md +++ b/docs/getting-started-guides/docker-multinode.md @@ -7,12 +7,12 @@ interested in just starting to explore Kubernetes, we recommend that you start t **Table of Contents** - - [Prerequisites](#prerequisites) - - [Overview](#overview) - - [Bootstrap Docker](#bootstrap-docker) - - [Master Node](#master-node) - - [Adding a worker node](#adding-a-worker-node) - - [Testing your cluster](#testing-your-cluster) +- [Prerequisites](#prerequisites) +- [Overview](#overview) + - [Bootstrap Docker](#bootstrap-docker) +- [Master Node](#master-node) +- [Adding a worker node](#adding-a-worker-node) +- [Testing your cluster](#testing-your-cluster) ## Prerequisites 1. You need a machine with docker installed. diff --git a/docs/getting-started-guides/docker.md b/docs/getting-started-guides/docker.md index 121a80f6634f4..477484eb9fdd9 100644 --- a/docs/getting-started-guides/docker.md +++ b/docs/getting-started-guides/docker.md @@ -3,15 +3,15 @@ Running kubernetes locally via Docker **Table of Contents** - - [Overview](#setting-up-a-cluster) - - [Prerequisites](#prerequisites) - - [Step One: Run etcd](#step-one-run-etcd) - - [Step Two: Run the master](#step-two-run-the-master) - - [Step Three: Run the service proxy](#step-three-run-the-service-proxy) - - [Test it out](#test-it-out) - - [Run an application](#run-an-application) - - [Expose it as a service:](#expose-it-as-a-service) - - [A note on turning down your cluster](#a-note-on-turning-down-your-cluster) +- [Overview](#setting-up-a-cluster) +- [Prerequisites](#prerequisites) +- [Step One: Run etcd](#step-one-run-etcd) +- [Step Two: Run the master](#step-two-run-the-master) +- [Step Three: Run the service proxy](#step-three-run-the-service-proxy) +- [Test it out](#test-it-out) +- [Run an application](#run-an-application) +- [Expose it as a service:](#expose-it-as-a-service) +- [A note on turning down your cluster](#a-note-on-turning-down-your-cluster) ### Overview diff --git a/docs/getting-started-guides/fedora/fedora_ansible_config.md b/docs/getting-started-guides/fedora/fedora_ansible_config.md index 850a586ea1bad..0926c895b0b51 100644 --- a/docs/getting-started-guides/fedora/fedora_ansible_config.md +++ b/docs/getting-started-guides/fedora/fedora_ansible_config.md @@ -5,12 +5,12 @@ Configuring kubernetes on Fedora via Ansible offers a simple way to quickly crea **Table of Contents** - - [Prerequisites](#prerequisites) - - [Architecture of the cluster](#architecture-of-the-cluster) - - [Configuring ssh access to the cluster](#configuring-ssh-access-to-the-cluster) - - [Configuring the internal kubernetes network](#configuring-the-internal-kubernetes-network) - - [Setting up the cluster](#setting-up-the-cluster) - - [Testing and using your new cluster](#testing-and-using-your-new-cluster) +- [Prerequisites](#prerequisites) +- [Architecture of the cluster](#architecture-of-the-cluster) +- [Configuring ssh access to the cluster](#configuring-ssh-access-to-the-cluster) +- [Configuring the internal kubernetes network](#configuring-the-internal-kubernetes-network) +- [Setting up the cluster](#setting-up-the-cluster) +- [Testing and using your new cluster](#testing-and-using-your-new-cluster) ##Prerequisites diff --git a/docs/getting-started-guides/fedora/fedora_manual_config.md b/docs/getting-started-guides/fedora/fedora_manual_config.md index 4423e8fc7d316..3d6b173d36d9e 100644 --- a/docs/getting-started-guides/fedora/fedora_manual_config.md +++ b/docs/getting-started-guides/fedora/fedora_manual_config.md @@ -3,8 +3,8 @@ Getting started on [Fedora](http://fedoraproject.org) **Table of Contents** - - [Prerequisites](#prerequisites) - - [Instructions](#instructions) +- [Prerequisites](#prerequisites) +- [Instructions](#instructions) ## Prerequisites 1. You need 2 or more machines with Fedora installed. diff --git a/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md b/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md index 8dc7ff494e8da..336c311abedcc 100644 --- a/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md +++ b/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md @@ -3,11 +3,11 @@ Kubernetes multiple nodes cluster with flannel on Fedora **Table of Contents** - - [Introduction](#introduction) - - [Prerequisites](#prerequisites) - - [Master Setup](#master-setup) - - [Node Setup](#node-setup) - - [**Test the cluster and flannel configuration**](#test-the-cluster-and-flannel-configuration) +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Master Setup](#master-setup) +- [Node Setup](#node-setup) +- [**Test the cluster and flannel configuration**](#test-the-cluster-and-flannel-configuration) ## Introduction diff --git a/docs/getting-started-guides/gce.md b/docs/getting-started-guides/gce.md index 80ae17ab63c43..a1f49e0a248f5 100644 --- a/docs/getting-started-guides/gce.md +++ b/docs/getting-started-guides/gce.md @@ -3,20 +3,20 @@ Getting started on Google Compute Engine **Table of Contents** - - [Before you start](#before-you-start) - - [Prerequisites](#prerequisites) - - [Starting a cluster](#starting-a-cluster) - - [Installing the kubernetes command line tools on your workstation](#installing-the-kubernetes-command-line-tools-on-your-workstation) - - [Getting started with your cluster](#getting-started-with-your-cluster) - - [Inspect your cluster](#inspect-your-cluster) - - [Run some examples](#run-some-examples) - - [Tearing down the cluster](#tearing-down-the-cluster) - - [Customizing](#customizing) - - [Troubleshooting](#troubleshooting) - - [Project settings](#project-settings) - - [Cluster initialization hang](#cluster-initialization-hang) - - [SSH](#ssh) - - [Networking](#networking) +- [Before you start](#before-you-start) +- [Prerequisites](#prerequisites) +- [Starting a cluster](#starting-a-cluster) +- [Installing the kubernetes command line tools on your workstation](#installing-the-kubernetes-command-line-tools-on-your-workstation) +- [Getting started with your cluster](#getting-started-with-your-cluster) + - [Inspect your cluster](#inspect-your-cluster) + - [Run some examples](#run-some-examples) +- [Tearing down the cluster](#tearing-down-the-cluster) +- [Customizing](#customizing) +- [Troubleshooting](#troubleshooting) + - [Project settings](#project-settings) + - [Cluster initialization hang](#cluster-initialization-hang) + - [SSH](#ssh) + - [Networking](#networking) 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). diff --git a/docs/getting-started-guides/juju.md b/docs/getting-started-guides/juju.md index dd1a38405e60a..658b257d671c5 100644 --- a/docs/getting-started-guides/juju.md +++ b/docs/getting-started-guides/juju.md @@ -7,17 +7,17 @@ services has been deployed. **Table of Contents** - - [Prerequisites](#prerequisites) - - [On Ubuntu](#on-ubuntu) - - [With Docker](#with-docker) - - [Launch Kubernetes cluster](#launch-kubernetes-cluster) - - [Exploring the cluster](#exploring-the-cluster) - - [Run some containers!](#run-some-containers) - - [Scale out cluster](#scale-out-cluster) - - [Launch the "k8petstore" example app](#launch-the-k8petstore-example-app) - - [Tear down cluster](#tear-down-cluster) - - [More Info](#more-info) - - [Cloud compatibility](#cloud-compatibility) +- [Prerequisites](#prerequisites) + - [On Ubuntu](#on-ubuntu) + - [With Docker](#with-docker) +- [Launch Kubernetes cluster](#launch-kubernetes-cluster) +- [Exploring the cluster](#exploring-the-cluster) +- [Run some containers!](#run-some-containers) +- [Scale out cluster](#scale-out-cluster) +- [Launch the "k8petstore" example app](#launch-the-k8petstore-example-app) +- [Tear down cluster](#tear-down-cluster) +- [More Info](#more-info) + - [Cloud compatibility](#cloud-compatibility) ## Prerequisites diff --git a/docs/getting-started-guides/libvirt-coreos.md b/docs/getting-started-guides/libvirt-coreos.md index 99c68b30a9366..567a46beb7eb0 100644 --- a/docs/getting-started-guides/libvirt-coreos.md +++ b/docs/getting-started-guides/libvirt-coreos.md @@ -3,16 +3,16 @@ Getting started with libvirt CoreOS **Table of Contents** - - [Highlights](#highlights) - - [Prerequisites](#prerequisites) - - [Setup](#setup) - - [Interacting with your Kubernetes cluster with the `kube-*` scripts.](#interacting-with-your-kubernetes-cluster-with-the-kube--scripts) - - [Troubleshooting](#troubleshooting) - - [!!! Cannot find kubernetes-server-linux-amd64.tar.gz](#-cannot-find-kubernetes-server-linux-amd64targz) - - [Can't find virsh in PATH, please fix and retry.](#cant-find-virsh-in-path-please-fix-and-retry) - - [error: Failed to connect socket to '/var/run/libvirt/libvirt-sock': No such file or directory](#error-failed-to-connect-socket-to-varrunlibvirtlibvirt-sock-no-such-file-or-directory) - - [error: Failed to connect socket to '/var/run/libvirt/libvirt-sock': Permission denied](#error-failed-to-connect-socket-to-varrunlibvirtlibvirt-sock-permission-denied) - - [error: Out of memory initializing network (virsh net-create...)](#error-out-of-memory-initializing-network-virsh-net-create) +- [Highlights](#highlights) +- [Prerequisites](#prerequisites) +- [Setup](#setup) +- [Interacting with your Kubernetes cluster with the `kube-*` scripts.](#interacting-with-your-kubernetes-cluster-with-the-kube--scripts) +- [Troubleshooting](#troubleshooting) + - [!!! Cannot find kubernetes-server-linux-amd64.tar.gz](#-cannot-find-kubernetes-server-linux-amd64targz) + - [Can't find virsh in PATH, please fix and retry.](#cant-find-virsh-in-path-please-fix-and-retry) + - [error: Failed to connect socket to '/var/run/libvirt/libvirt-sock': No such file or directory](#error-failed-to-connect-socket-to-varrunlibvirtlibvirt-sock-no-such-file-or-directory) + - [error: Failed to connect socket to '/var/run/libvirt/libvirt-sock': Permission denied](#error-failed-to-connect-socket-to-varrunlibvirtlibvirt-sock-permission-denied) + - [error: Out of memory initializing network (virsh net-create...)](#error-out-of-memory-initializing-network-virsh-net-create) ### Highlights diff --git a/docs/getting-started-guides/locally.md b/docs/getting-started-guides/locally.md index 39ad930ec4f1d..521b2f8f9df95 100644 --- a/docs/getting-started-guides/locally.md +++ b/docs/getting-started-guides/locally.md @@ -3,20 +3,20 @@ Getting started locally **Table of Contents** - - [Requirements](#requirements) - - [Linux](#linux) - - [Docker](#docker) - - [etcd](#etcd) - - [go](#go) - - [Starting the cluster](#starting-the-cluster) - - [Running a container](#running-a-container) - - [Running a user defined pod](#running-a-user-defined-pod) - - [Troubleshooting](#troubleshooting) - - [I cannot reach service IPs on the network.](#i-cannot-reach-service-ips-on-the-network) - - [I cannot create a replication controller with replica size greater than 1! What gives?](#i-cannot-create-a-replication-controller-with-replica-size-greater-than-1--what-gives) - - [I changed Kubernetes code, how do I run it?](#i-changed-kubernetes-code-how-do-i-run-it) - - [kubectl claims to start a container but `get pods` and `docker ps` don't show it.](#kubectl-claims-to-start-a-container-but-get-pods-and-docker-ps-dont-show-it) - - [The pods fail to connect to the services by host names](#the-pods-fail-to-connect-to-the-services-by-host-names) +- [Requirements](#requirements) + - [Linux](#linux) + - [Docker](#docker) + - [etcd](#etcd) + - [go](#go) +- [Starting the cluster](#starting-the-cluster) +- [Running a container](#running-a-container) +- [Running a user defined pod](#running-a-user-defined-pod) +- [Troubleshooting](#troubleshooting) + - [I cannot reach service IPs on the network.](#i-cannot-reach-service-ips-on-the-network) + - [I cannot create a replication controller with replica size greater than 1! What gives?](#i-cannot-create-a-replication-controller-with-replica-size-greater-than-1--what-gives) + - [I changed Kubernetes code, how do I run it?](#i-changed-kubernetes-code-how-do-i-run-it) + - [kubectl claims to start a container but `get pods` and `docker ps` don't show it.](#kubectl-claims-to-start-a-container-but-get-pods-and-docker-ps-dont-show-it) + - [The pods fail to connect to the services by host names](#the-pods-fail-to-connect-to-the-services-by-host-names) ### Requirements diff --git a/docs/getting-started-guides/mesos.md b/docs/getting-started-guides/mesos.md index 90a884a9f0154..c6cd7f551653f 100644 --- a/docs/getting-started-guides/mesos.md +++ b/docs/getting-started-guides/mesos.md @@ -3,15 +3,15 @@ Getting started with Kubernetes on Mesos **Table of Contents** - - [About Kubernetes on Mesos](#about-kubernetes-on-mesos) - - [Prerequisites](#prerequisites) - - [Deploy Kubernetes-Mesos](#deploy-kubernetes-mesos) - - [Deploy etcd](#deploy-etcd) - - [Start Kubernetes-Mesos Services](#start-kubernetes-mesos-services) - - [Validate KM Services](#validate-km-services) - - [Spin up a pod](#spin-up-a-pod) - - [Run the Example Guestbook App](#run-the-example-guestbook-app) - - [Test Guestbook App](#test-guestbook-app) +- [About Kubernetes on Mesos](#about-kubernetes-on-mesos) + - [Prerequisites](#prerequisites) + - [Deploy Kubernetes-Mesos](#deploy-kubernetes-mesos) + - [Deploy etcd](#deploy-etcd) + - [Start Kubernetes-Mesos Services](#start-kubernetes-mesos-services) + - [Validate KM Services](#validate-km-services) +- [Spin up a pod](#spin-up-a-pod) +- [Run the Example Guestbook App](#run-the-example-guestbook-app) + - [Test Guestbook App](#test-guestbook-app) ## About Kubernetes on Mesos diff --git a/docs/getting-started-guides/ovirt.md b/docs/getting-started-guides/ovirt.md index 2c338c73e1c93..1450e81f85404 100644 --- a/docs/getting-started-guides/ovirt.md +++ b/docs/getting-started-guides/ovirt.md @@ -3,10 +3,10 @@ Getting started on oVirt **Table of Contents** - - [What is oVirt](#what-is-ovirt) - - [oVirt Cloud Provider Deployment](#ovirt-cloud-provider-deployment) - - [Using the oVirt Cloud Provider](#using-the-ovirt-cloud-provider) - - [oVirt Cloud Provider Screencast](#ovirt-cloud-provider-screencast) +- [What is oVirt](#what-is-ovirt) +- [oVirt Cloud Provider Deployment](#ovirt-cloud-provider-deployment) +- [Using the oVirt Cloud Provider](#using-the-ovirt-cloud-provider) +- [oVirt Cloud Provider Screencast](#ovirt-cloud-provider-screencast) ## What is oVirt diff --git a/docs/getting-started-guides/rackspace.md b/docs/getting-started-guides/rackspace.md index b5f5ae48fc8c7..79848635e74d2 100644 --- a/docs/getting-started-guides/rackspace.md +++ b/docs/getting-started-guides/rackspace.md @@ -3,13 +3,13 @@ Getting started on Rackspace **Table of Contents** - - [Introduction](#introduction) - - [Prerequisites](#prerequisites) - - [Provider: Rackspace](#provider-rackspace) - - [Build](#build) - - [Cluster](#cluster) - - [Some notes:](#some-notes) - - [Network Design](#network-design) +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Provider: Rackspace](#provider-rackspace) +- [Build](#build) +- [Cluster](#cluster) +- [Some notes:](#some-notes) +- [Network Design](#network-design) ## Introduction diff --git a/docs/getting-started-guides/vagrant.md b/docs/getting-started-guides/vagrant.md index a922676b422f1..1f23546bb3cb5 100644 --- a/docs/getting-started-guides/vagrant.md +++ b/docs/getting-started-guides/vagrant.md @@ -4,20 +4,20 @@ Running kubernetes with Vagrant (and VirtualBox) is an easy way to run/test/deve **Table of Contents** - - [Prerequisites](#prerequisites) - - [Setup](#setup) - - [Interacting with your Kubernetes cluster with Vagrant.](#interacting-with-your-kubernetes-cluster-with-vagrant) - - [Authenticating with your master](#authenticating-with-your-master) - - [Running containers](#running-containers) - - [Troubleshooting](#troubleshooting) - - [I keep downloading the same (large) box all the time!](#i-keep-downloading-the-same-large-box-all-the-time) - - [I just created the cluster, but I am getting authorization errors!](#i-just-created-the-cluster-but-i-am-getting-authorization-errors) - - [I just created the cluster, but I do not see my container running!](#i-just-created-the-cluster-but-i-do-not-see-my-container-running) - - [I want to make changes to Kubernetes code!](#i-want-to-make-changes-to-kubernetes-code) - - [I have brought Vagrant up but the nodes cannot validate!](#i-have-brought-vagrant-up-but-the-nodes-cannot-validate) - - [I want to change the number of nodes!](#i-want-to-change-the-number-of-nodes) - - [I want my VMs to have more memory!](#i-want-my-vms-to-have-more-memory) - - [I ran vagrant suspend and nothing works!](#i-ran-vagrant-suspend-and-nothing-works) +- [Prerequisites](#prerequisites) +- [Setup](#setup) +- [Interacting with your Kubernetes cluster with Vagrant.](#interacting-with-your-kubernetes-cluster-with-vagrant) +- [Authenticating with your master](#authenticating-with-your-master) +- [Running containers](#running-containers) +- [Troubleshooting](#troubleshooting) + - [I keep downloading the same (large) box all the time!](#i-keep-downloading-the-same-large-box-all-the-time) + - [I just created the cluster, but I am getting authorization errors!](#i-just-created-the-cluster-but-i-am-getting-authorization-errors) + - [I just created the cluster, but I do not see my container running!](#i-just-created-the-cluster-but-i-do-not-see-my-container-running) + - [I want to make changes to Kubernetes code!](#i-want-to-make-changes-to-kubernetes-code) + - [I have brought Vagrant up but the nodes cannot validate!](#i-have-brought-vagrant-up-but-the-nodes-cannot-validate) + - [I want to change the number of nodes!](#i-want-to-change-the-number-of-nodes) + - [I want my VMs to have more memory!](#i-want-my-vms-to-have-more-memory) + - [I ran vagrant suspend and nothing works!](#i-ran-vagrant-suspend-and-nothing-works) ### Prerequisites diff --git a/docs/getting-started-guides/vsphere.md b/docs/getting-started-guides/vsphere.md index 7f6c68e386997..1dfb736e06fa6 100644 --- a/docs/getting-started-guides/vsphere.md +++ b/docs/getting-started-guides/vsphere.md @@ -8,10 +8,10 @@ convenient). **Table of Contents** - - [Prerequisites](#prerequisites) - - [Setup](#setup) - - [Starting a cluster](#starting-a-cluster) - - [Extra: debugging deployment failure](#extra-debugging-deployment-failure) +- [Prerequisites](#prerequisites) +- [Setup](#setup) +- [Starting a cluster](#starting-a-cluster) +- [Extra: debugging deployment failure](#extra-debugging-deployment-failure) ### Prerequisites