Skip to content

Commit

Permalink
Getting-started-guide cleanup.
Browse files Browse the repository at this point in the history 
Put a Prerequisites section in all the hosted gettting-started-guides.
Change how title and contents are formatted so they are not automatically
included in the ToC.  Tweak other section headers to improve ToCs.
  • Loading branch information
@erictune
erictune committed Jun 22, 2015
1 parent f39eead commit 179fa8c
Show file tree
Hide file tree
Showing 21 changed files with 151 additions and 163 deletions.
7 changes: 3 additions & 4 deletions docs/getting-started-guides/aws.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Getting started on AWS EC2
Getting started on AWS EC2
--------------------------

## Contents
**Table of Contents**

- [Getting started on AWS EC2](#getting-started-on-aws-ec2)
- [Contents](#contents)
- [Prerequisites](#prerequisites)
- [Cluster turnup](#cluster-turnup)
- [Supported procedure: `get-kube`](#supported-procedure-get-kube)
Expand Down
16 changes: 8 additions & 8 deletions docs/getting-started-guides/azure.md
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Getting started on Microsoft Azure
Getting started on Microsoft Azure
----------------------------------

## Contents
**Table of Contents**

- [Getting started on Microsoft Azure](#getting-started-on-microsoft-azure)
- [Contents](#contents)
- [Azure Prerequisites](#azure-prerequisites)
- [Prerequisites for your workstation](#prerequisites-for-your-workstation)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Getting started with your cluster](#getting-started-with-your-cluster)
- [Tearing down the cluster](#tearing-down-the-cluster)


## Azure Prerequisites
## Prerequisites

** Azure Prerequisites**

1. You need an Azure account. Visit http://azure.microsoft.com/ to get started.
2. Install and configure the Azure cross-platform command-line interface. http://azure.microsoft.com/en-us/documentation/articles/xplat-cli/
3. Make sure you have a default account set in the Azure cli, using `azure account set`

## Prerequisites for your workstation
**Prerequisites for your workstation**

1. Be running a Linux or Mac OS X.
2. Get or build a [binary release](binary_release.md)
Expand Down
10 changes: 6 additions & 4 deletions docs/getting-started-guides/centos/centos_manual_config.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
#Getting started on [CentOS](http://centos.org)
Getting started on [CentOS](http://centos.org)
----------------------------------------------

## Contents
**Table of Contents**

- [Getting started on [CentOS](http://centos.org)](#getting-started-on-centoshttpcentosorg)
- [Contents](#contents)
- [Prerequisites](#prerequisites)
- [Starting a cluster](#starting-a-cluster)
## Prerequisites
You need two machines with CentOS installed on them.

## Starting a cluster
This is a getting started guide for CentOS. It is a manual configuration so you understand all the underlying packages / services / ports, etc...
Expand Down
22 changes: 7 additions & 15 deletions docs/getting-started-guides/cloudstack.md
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,22 @@
## Deploying Kubernetes on [CloudStack](http://cloudstack.apache.org)
Getting started on [CloudStack](http://cloudstack.apache.org)
------------------------------------------------------------

## Contents
**Table of Contents**

- [Deploying Kubernetes on [CloudStack](http://cloudstack.apache.org)](#deploying-kubernetes-on-cloudstackhttpcloudstackapacheorg)
- [Contents](#contents)
- [Introduction](#introduction)
- [Ansible playbook](#ansible-playbook)
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Clone the playbook](#clone-the-playbook)
- [Create a Kubernetes cluster](#create-a-kubernetes-cluster)

## Introduction
### Introduction

CloudStack is a software to build public and private clouds based on hardware virtualization principles (traditional IaaS). To deploy Kubernetes on CloudStack there are several possibilities depending on the Cloud being used and what images are made available. [Exoscale](http://exoscale.ch) for instance makes a [CoreOS](http://coreos.com) template available, therefore instructions to deploy Kubernetes on coreOS can be used. CloudStack also has a vagrant plugin available, hence Vagrant could be used to deploy Kubernetes either using the existing shell provisioner or using new Salt based recipes.

[CoreOS](http://coreos.com) templates for CloudStack are built [nightly](http://stable.release.core-os.net/amd64-usr/current/). CloudStack operators need to [register](http://docs.cloudstack.apache.org/projects/cloudstack-administration/en/latest/templates.html) this template in their cloud before proceeding with these Kubernetes deployment instructions.

There are currently two deployment techniques.
This guide uses an [Ansible playbook](https://github.com/runseb/ansible-kubernetes).
This is a completely automated, a single playbook deploys Kubernetes based on the coreOS [instructions](http://docs.k8s.io/getting-started-guides/coreos/coreos_multinode_cluster.md).

* [Kubernetes on Exoscale](https://github.com/runseb/kubernetes-exoscale).
This uses [libcloud](http://libcloud.apache.org) to launch CoreOS instances and pass the appropriate cloud-config setup using userdata. Several manual steps are required. This is obsoleted by the Ansible playbook detailed below.

* [Ansible playbook](https://github.com/runseb/ansible-kubernetes).
This is completely automated, a single playbook deploys Kubernetes based on the coreOS [instructions](http://docs.k8s.io/getting-started-guides/coreos/coreos_multinode_cluster.md).

## Ansible playbook

This [Ansible](http://ansibleworks.com) playbook deploys Kubernetes on a CloudStack based Cloud using CoreOS images. The playbook, creates an ssh key pair, creates a security group and associated rules and finally starts coreOS instances configured via cloud-init.

Expand Down
11 changes: 7 additions & 4 deletions docs/getting-started-guides/coreos/azure/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Kubernetes on Azure with CoreOS and [Weave](http://weave.works)
Kubernetes on Azure with CoreOS and [Weave](http://weave.works)
---------------------------------------------------------------

## Contents
**Table of Contents**

- [Kubernetes on Azure with CoreOS and [Weave](http://weave.works)](#kubernetes-on-azure-with-coreos-and-weavehttpweaveworks)
- [Contents](#contents)
- [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Let's go!](#lets-go)
- [Deploying the workload](#deploying-the-workload)
- [Scaling](#scaling)
Expand All @@ -16,6 +16,9 @@

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.

### Prerequisites
1. You need an Azure account.

## Let's go!

To get started, you need to checkout the code:
Expand Down
17 changes: 8 additions & 9 deletions docs/getting-started-guides/coreos/bare_metal_offline.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Bare Metal CoreOS with Kubernetes (OFFLINE)
Bare Metal CoreOS with Kubernetes (OFFLINE)
------------------------------------------
Deploy a CoreOS running Kubernetes environment. This particular guild is made to help those in an OFFLINE system, wither for testing a POC before the real deal, or you are restricted to be totally offline for your applications.

## Contents
**Table of Contents**

- [Bare Metal CoreOS with Kubernetes (OFFLINE)](#bare-metal-coreos-with-kubernetes-offline)
- [Contents](#contents)
- [Prerequisites](#prerequisites)
- [High Level Design](#high-level-design)
- [Pre-requisites](#pre-requisites)
- [This Guides variables](#this-guides-variables)
- [Setup PXELINUX CentOS](#setup-pxelinux-centos)
- [Adding CoreOS to PXE](#adding-coreos-to-pxe)
Expand All @@ -23,6 +22,10 @@ Deploy a CoreOS running Kubernetes environment. This particular guild is made to
- [Helping commands for debugging](#helping-commands-for-debugging)


## Prerequisites
1. Installed *CentOS 6* for PXE server
2. At least two bare metal nodes to work with

## High Level Design
1. Manage the tftp directory
* /tftpboot/(coreos)(centos)(RHEL)
Expand All @@ -33,10 +36,6 @@ Deploy a CoreOS running Kubernetes environment. This particular guild is made to
5. Have no access to the public [etcd discovery tool](https://discovery.etcd.io/).
6. Installing the CoreOS slaves to become Kubernetes minions.

## Pre-requisites
1. Installed *CentOS 6* for PXE server
2. At least two bare metal nodes to work with

## This Guides variables
| Node Description | MAC | IP |
| :---------------------------- | :---------------: | :---------: |
Expand Down
11 changes: 7 additions & 4 deletions docs/getting-started-guides/docker-multinode.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# Running Multi-Node Kubernetes Using Docker
Running Multi-Node Kubernetes Using Docker
------------------------------------------

_Note_:
These instructions are somewhat significantly more advanced than the [single node](docker.md) instructions. If you are
interested in just starting to explore Kubernetes, we recommend that you start there.

## Table of Contents
**Table of Contents**

- [Running Multi-Node Kubernetes Using Docker](#running-multi-node-kubernetes-using-docker)
- [Table of Contents](#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
1. You need a machine with docker installed.

## Overview
This guide will set up a 2-node kubernetes cluster, consisting of a _master_ node which hosts the API server and orchestrates work
and a _worker_ node which receives work from the master. You can repeat the process of adding worker nodes an arbitrary number of
Expand Down
29 changes: 16 additions & 13 deletions docs/getting-started-guides/docker.md
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
# Running kubernetes locally via Docker
Running kubernetes locally via Docker
-------------------------------------

## Contents
**Table of Contents**

- [Running kubernetes locally via Docker](#running-kubernetes-locally-via-docker)
- [Contents](#contents)
- [Setting up a Cluster](#setting-up-a-cluster)
- [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)

## Setting up a Cluster
### Overview

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](k8s-singlenode-docker.png)

### Prerequisites
1. You need to have docker installed on one machine.

### Step One: Run etcd
```sh
docker run --net=host -d gcr.io/google_containers/etcd:2.0.9 /usr/local/bin/etcd --addr=127.0.0.1:4001 --bind-addr=0.0.0.0:4001 --data-dir=/var/etcd/data
Expand Down
11 changes: 5 additions & 6 deletions docs/getting-started-guides/fedora/fedora_ansible_config.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
#Configuring kubernetes on [Fedora](http://fedoraproject.org) via [Ansible](http://www.ansible.com/home).
Configuring kubernetes on [Fedora](http://fedoraproject.org) via [Ansible](http://www.ansible.com/home)
-------------------------------------------------------------------------------------------------------

Configuring kubernetes on Fedora via Ansible offers a simple way to quickly create a clustered environment with little effort.

## Contents
**Table of Contents**

- [Configuring kubernetes on [Fedora](http://fedoraproject.org) via [Ansible](http://www.ansible.com/home).](#configuring-kubernetes-on-fedorahttpfedoraprojectorg-via-ansiblehttpwwwansiblecomhome)
- [Contents](#contents)
- [Requirements](#requirements)
- [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)

##Requirements
##Prerequisites

1. Host able to run ansible and able to clone the following repo: [kubernetes-ansible](https://github.com/eparis/kubernetes-ansible)
2. A Fedora 20+ or RHEL7 host to act as cluster master
Expand Down
10 changes: 6 additions & 4 deletions docs/getting-started-guides/fedora/fedora_manual_config.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
#Getting started on [Fedora](http://fedoraproject.org)
Getting started on [Fedora](http://fedoraproject.org)
-----------------------------------------------------

## Contents
**Table of Contents**

- [Getting started on [Fedora](http://fedoraproject.org)](#getting-started-on-fedorahttpfedoraprojectorg)
- [Contents](#contents)
- [Prerequisites](#prerequisites)
- [Instructions](#instructions)
## Prerequisites
1. You need 2 or more machines with Fedora installed.

## Instructions

Expand Down
11 changes: 7 additions & 4 deletions docs/getting-started-guides/fedora/flannel_multi_node_cluster.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#Kubernetes multiple nodes cluster with flannel on Fedora
Kubernetes multiple nodes cluster with flannel on Fedora
--------------------------------------------------------

## Contents
**Table of Contents**

- [Kubernetes multiple nodes cluster with flannel on Fedora](#kubernetes-multiple-nodes-cluster-with-flannel-on-fedora)
- [Contents](#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)
Expand All @@ -13,6 +13,9 @@

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.md) to setup 1 master (fed-master) and 2 or more nodes (minions). Make sure that all nodes (minions) 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 (minions) are running docker, kube-proxy and kubelet services. Now install flannel on kubernetes nodes (minions). flannel on each node configures an overlay network that docker uses. flannel runs on each node to setup a unique class-C container network.

## Prerequisites
1. You need 2 or more machines with Fedora installed.

## Master Setup

**Perform following commands on the kubernetes master**
Expand Down
33 changes: 16 additions & 17 deletions docs/getting-started-guides/gce.md
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@

## Getting started on Google Compute Engine
Getting started on Google Compute Engine
----------------------------------------

**Table of Contents**

- [Getting started on Google Compute Engine](#getting-started-on-google-compute-engine)
- [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).
Expand Down
19 changes: 9 additions & 10 deletions docs/getting-started-guides/juju.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
## Getting started with Juju
Getting started with Juju
-------------------------

Juju handles provisioning machines and deploying complex systems to a
wide number of clouds, supporting service orchestration once the bundle of
services has been deployed.

## Contents
**Table of Contents**

- [Getting started with Juju](#getting-started-with-juju)
- [Contents](#contents)
- [Prerequisites](#prerequisites)
- [On Ubuntu](#on-ubuntu)
- [With Docker](#with-docker)
- [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)
Expand All @@ -21,13 +20,13 @@ services has been deployed.
- [Cloud compatibility](#cloud-compatibility)


### Prerequisites
## Prerequisites

> Note: If you're running kube-up, on ubuntu - all of the dependencies
> will be handled for you. You may safely skip to the section:
> [Launch Kubernetes Cluster](#launch-kubernetes-cluster)
#### On Ubuntu
### On Ubuntu

[Install the Juju client](https://juju.ubuntu.com/install) on your
local ubuntu system:
Expand All @@ -37,7 +36,7 @@ local ubuntu system:
sudo apt-get install juju-core juju-quickstart


#### With Docker
### With Docker

If you are not using ubuntu or prefer the isolation of docker, you may
run the following:
Expand Down
Loading

0 comments on commit 179fa8c

Please sign in to comment.