Guide style update

- Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2025-09-07 20:21:20 +00:00 · 2015-12-03 16:15:07 -08:00
parent b9f31ca2c4
commit c3c7c81b33
4 changed files with 159 additions and 104 deletions
--- a/docs/getting-started-guides/mesos-docker.md
+++ b/docs/getting-started-guides/mesos-docker.md
@@ -31,12 +31,33 @@ Documentation for other releases can be found at

 <!-- END MUNGE: UNVERSIONED_WARNING -->

-## Getting Started With Kubernetes on Mesos on Docker
+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).

-### Cluster Goals
+**Table of Contents**
+<!-- BEGIN MUNGE: GENERATED_TOC -->
+
+  - [Cluster Goals](#cluster-goals)
+  - [Cluster Topology](#cluster-topology)
+  - [Prerequisites](#prerequisites)
+    - [Install on Mac (Homebrew)](#install-on-mac-homebrew)
+    - [Install on Linux](#install-on-linux)
+    - [Boot2Docker Config (Mac)](#boot2docker-config-mac)
+  - [Walkthrough](#walkthrough)
+  - [Addons](#addons)
+    - [KubeUI](#kubeui)
+  - [End To End Testing](#end-to-end-testing)
+  - [Kubernetes CLI](#kubernetes-cli)
+  - [Helpful scripts](#helpful-scripts)
+  - [Build Locally](#build-locally)
+
+<!-- END MUNGE: GENERATED_TOC -->
+
+
+## Cluster Goals

 - kubernetes development
 - pod/service development
@@ -58,7 +79,7 @@ Non-Goals:
 - long running
 - state persistence across restarts

-### Cluster Topology
+## Cluster Topology

 The cluster consists of several docker containers linked together by docker-managed hostnames:

@@ -72,7 +93,7 @@ The cluster consists of several docker containers linked together by docker-mana
 | Kubernetes Controller Manager | controller                  |                                                                                         |
 | Kubernetes Scheduler          | scheduler                   | Schedules container deployment by accepting Mesos offers                                |

-### Prerequisites
+## Prerequisites

 Required:
 - [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - version control system
@@ -89,7 +110,7 @@ Optional:
 - [Make](https://en.wikipedia.org/wiki/Make_(software))  - Utility for building executables from source
  - Required to build Kubernetes locally with make

-#### Install on Mac (Homebrew)
+### Install on Mac (Homebrew)

 It's possible to install all of the above via [Homebrew](http://brew.sh/) on a Mac.

@@ -106,7 +127,7 @@ boot2docker up
 brew install docker-compose
 ```

-#### Install on Linux
+### Install on Linux

 Most of the above are available via apt and yum, but depending on your distribution, you may have to install via other
 means to get the latest versions.
@@ -118,7 +139,7 @@ In order to build Kubernetes, the current user must be in a docker group with su
 See the docker docs for [instructions](https://docs.docker.com/installation/ubuntulinux/#create-a-docker-group).


-#### Boot2Docker Config (Mac)
+### Boot2Docker Config (Mac)

 If on a mac using boot2docker, the following steps will make the docker IPs (in the virtualbox VM) reachable from the
 host machine (mac).
@@ -146,7 +167,7 @@ host machine (mac).
    To delete the route later: `sudo route delete 172.17.0.0`


-### Walkthrough
+## Walkthrough

 1. Checkout source

@@ -226,10 +247,10 @@ host machine (mac).

 1. Explore examples

-   To learn more about Pods, Volumes, Labels, Services, and Replication Controllers, start with the
-   [Kubernetes Walkthrough](../user-guide/walkthrough/).
+    To learn more about Pods, Volumes, Labels, Services, and Replication Controllers, start with the
+    [Kubernetes Walkthrough](../user-guide/walkthrough/).

-   To skip to a more advanced example, see the [Guestbook Example](../../examples/guestbook/)
+    To skip to a more advanced example, see the [Guestbook Example](../../examples/guestbook/)

 1. Destroy cluster

@@ -237,7 +258,7 @@ host machine (mac).
    ./cluster/kube-down.sh
    ```

-### Addons
+## Addons

 The `kube-up` for the mesos/docker provider will automatically deploy KubeDNS and KubeUI addons as pods/services.

@@ -247,7 +268,7 @@ Check their status with:
 ./cluster/kubectl.sh get pods --namespace=kube-system
 ```

-#### KubeUI
+### KubeUI

 The web-based Kubernetes UI is accessible in a browser through the API Server proxy: `https://<apiserver>:6443/ui/`.

@@ -256,7 +277,7 @@ By default, basic-auth is configured with user `admin` and password `admin`.
 The IP of the API Server can be found using `./cluster/kubectl.sh cluster-info`.


-### End To End Testing
+## End To End Testing

 Warning: e2e tests can take a long time to run. You may not want to run them immediately if you're just getting started.

@@ -277,7 +298,7 @@ make test_e2e
 ```


-### Kubernetes CLI
+## Kubernetes CLI

 When compiling from source, it's simplest to use the `./cluster/kubectl.sh` script, which detects your platform &
 architecture and proxies commands to the appropriate `kubectl` binary.
@@ -285,7 +306,7 @@ architecture and proxies commands to the appropriate `kubectl` binary.
 ex: `./cluster/kubectl.sh get pods`


-### Helpful scripts
+## Helpful scripts

 - Kill all docker containers

@@ -299,7 +320,7 @@ ex: `./cluster/kubectl.sh get pods`
    docker run -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker:/var/lib/docker --rm martin/docker-cleanup-volumes
    ```

-### Build Locally
+## Build Locally

 The steps above tell you how to build in a container, for minimal local dependencies. But if you have Go and Make installed you can build locally much faster: