github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-12 21:36:24 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #10191 from erictune/similar-structure-gsg

Browse Source 
Getting started guide cleanup
This commit is contained in:
Jeff Lowdermilk 2015-06-22 16:29:51 -07:00
commit e75edf2282
21 changed files with 149 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/getting-started-guides/aws.md
View File

@ -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) - [Prerequisites](#prerequisites)
- [Cluster turnup](#cluster-turnup) - [Cluster turnup](#cluster-turnup)
- [Supported procedure: `get-kube`](#supported-procedure-get-kube) - [Supported procedure: `get-kube`](#supported-procedure-get-kube)

16
docs/getting-started-guides/azure.md
View File

@ -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) - [Prerequisites](#prerequisites)
- [Contents](#contents)
- [Azure Prerequisites](#azure-prerequisites)
- [Prerequisites for your workstation](#prerequisites-for-your-workstation)
- [Setup](#setup) - [Setup](#setup)
- [Getting started with your cluster](#getting-started-with-your-cluster) - [Getting started with your cluster](#getting-started-with-your-cluster)
- [Tearing down the cluster](#tearing-down-the-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. 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/ 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` 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. 1. Be running a Linux or Mac OS X.
2. Get or build a [binary release](binary_release.md) 2. Get or build a [binary release](binary_release.md)

10
docs/getting-started-guides/centos/centos_manual_config.md
View File

@ -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) - [Prerequisites](#prerequisites)
- [Contents](#contents)
- [Starting a cluster](#starting-a-cluster) - [Starting a cluster](#starting-a-cluster)
## Prerequisites
You need two machines with CentOS installed on them.
## Starting a cluster ## 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... This is a getting started guide for CentOS. It is a manual configuration so you understand all the underlying packages / services / ports, etc...

22
docs/getting-started-guides/cloudstack.md
View File

@ -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) - [Introduction](#introduction)
- [Contents](#contents)
- [Introduction](#introduction)
- [Ansible playbook](#ansible-playbook)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Clone the playbook](#clone-the-playbook) - [Clone the playbook](#clone-the-playbook)
- [Create a Kubernetes cluster](#create-a-kubernetes-cluster) - [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. 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. [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. 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.

11
docs/getting-started-guides/coreos/azure/README.md
View File

@ -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) - [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Let's go!](#lets-go) - [Let's go!](#lets-go)
- [Deploying the workload](#deploying-the-workload) - [Deploying the workload](#deploying-the-workload)
- [Scaling](#scaling) - [Scaling](#scaling)
@ -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. 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! ## Let's go!
To get started, you need to checkout the code: To get started, you need to checkout the code:

17
docs/getting-started-guides/coreos/bare_metal_offline.md
View File

@ -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. 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) - [Prerequisites](#prerequisites)
- [Contents](#contents)
- [High Level Design](#high-level-design) - [High Level Design](#high-level-design)
- [Pre-requisites](#pre-requisites)
- [This Guides variables](#this-guides-variables) - [This Guides variables](#this-guides-variables)
- [Setup PXELINUX CentOS](#setup-pxelinux-centos) - [Setup PXELINUX CentOS](#setup-pxelinux-centos)
- [Adding CoreOS to PXE](#adding-coreos-to-pxe) - [Adding CoreOS to PXE](#adding-coreos-to-pxe)
@ -23,6 +22,10 @@ Deploy a CoreOS running Kubernetes environment. This particular guild is made to
- [Helping commands for debugging](#helping-commands-for-debugging) - [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 ## High Level Design
1. Manage the tftp directory 1. Manage the tftp directory
* /tftpboot/(coreos)(centos)(RHEL) * /tftpboot/(coreos)(centos)(RHEL)
@ -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/). 5. Have no access to the public [etcd discovery tool](https://discovery.etcd.io/).
6. Installing the CoreOS slaves to become Kubernetes minions. 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 ## This Guides variables
| Node Description | MAC | IP | | Node Description | MAC | IP |
| :---------------------------- | :---------------: | :---------: | | :---------------------------- | :---------------: | :---------: |

11
docs/getting-started-guides/docker-multinode.md
View File

@ -1,19 +1,22 @@
# Running Multi-Node Kubernetes Using Docker Running Multi-Node Kubernetes Using Docker
------------------------------------------
_Note_: _Note_:
These instructions are somewhat significantly more advanced than the [single node](docker.md) instructions. If you are 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. 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) - [Prerequisites](#prerequisites)
- [Table of Contents](#table-of-contents)
- [Overview](#overview) - [Overview](#overview)
- [Bootstrap Docker](#bootstrap-docker) - [Bootstrap Docker](#bootstrap-docker)
- [Master Node](#master-node) - [Master Node](#master-node)
- [Adding a worker node](#adding-a-worker-node) - [Adding a worker node](#adding-a-worker-node)
- [Testing your cluster](#testing-your-cluster) - [Testing your cluster](#testing-your-cluster)
## Prerequisites
1. You need a machine with docker installed.
## Overview ## Overview
This guide will set up a 2-node kubernetes cluster, consisting of a _master_ node which hosts the API server and orchestrates work 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 and a _worker_ node which receives work from the master. You can repeat the process of adding worker nodes an arbitrary number of

29
docs/getting-started-guides/docker.md
View File

@ -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) - [Overview](#setting-up-a-cluster)
- [Contents](#contents) - [Prerequisites](#prerequisites)
- [Setting up a Cluster](#setting-up-a-cluster) - [Step One: Run etcd](#step-one-run-etcd)
- [Step One: Run etcd](#step-one-run-etcd) - [Step Two: Run the master](#step-two-run-the-master)
- [Step Two: Run the master](#step-two-run-the-master) - [Step Three: Run the service proxy](#step-three-run-the-service-proxy)
- [Step Three: Run the service proxy](#step-three-run-the-service-proxy) - [Test it out](#test-it-out)
- [Test it out](#test-it-out) - [Run an application](#run-an-application)
- [Run an application](#run-an-application) - [Expose it as a service:](#expose-it-as-a-service)
- [Expose it as a service:](#expose-it-as-a-service) - [A note on turning down your cluster](#a-note-on-turning-down-your-cluster)
- [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. 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: Here's a diagram of what the final result will look like:
![Kubernetes Single Node on Docker](k8s-singlenode-docker.png) ![Kubernetes Single Node on Docker](k8s-singlenode-docker.png)
### Prerequisites
1. You need to have docker installed on one machine.
### Step One: Run etcd ### Step One: Run etcd
```sh ```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 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

11
docs/getting-started-guides/fedora/fedora_ansible_config.md
View File

@ -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. 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) - [Prerequisites](#prerequisites)
- [Contents](#contents)
- [Requirements](#requirements)
- [Architecture of the cluster](#architecture-of-the-cluster) - [Architecture of the cluster](#architecture-of-the-cluster)
- [Configuring ssh access to the cluster](#configuring-ssh-access-to-the-cluster) - [Configuring ssh access to the cluster](#configuring-ssh-access-to-the-cluster)
- [Configuring the internal kubernetes network](#configuring-the-internal-kubernetes-network) - [Configuring the internal kubernetes network](#configuring-the-internal-kubernetes-network)
- [Setting up the cluster](#setting-up-the-cluster) - [Setting up the cluster](#setting-up-the-cluster)
- [Testing and using your new cluster](#testing-and-using-your-new-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) 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 2. A Fedora 20+ or RHEL7 host to act as cluster master

10
docs/getting-started-guides/fedora/fedora_manual_config.md
View File

@ -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) - [Prerequisites](#prerequisites)
- [Contents](#contents)
- [Instructions](#instructions) - [Instructions](#instructions)
## Prerequisites
1. You need 2 or more machines with Fedora installed.
## Instructions ## Instructions

11
docs/getting-started-guides/fedora/flannel_multi_node_cluster.md
View File

@ -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) - [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Master Setup](#master-setup) - [Master Setup](#master-setup)
- [Node Setup](#node-setup) - [Node Setup](#node-setup)
- [**Test the cluster and flannel configuration**](#test-the-cluster-and-flannel-configuration) - [**Test the cluster and flannel configuration**](#test-the-cluster-and-flannel-configuration)
@ -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. 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 ## Master Setup
**Perform following commands on the kubernetes master** **Perform following commands on the kubernetes master**

33
docs/getting-started-guides/gce.md
View File

@ -1,23 +1,22 @@
Getting started on Google Compute Engine
## Getting started on Google Compute Engine ----------------------------------------
**Table of Contents** **Table of Contents**
- [Getting started on Google Compute Engine](#getting-started-on-google-compute-engine) - [Before you start](#before-you-start)
- [Before you start](#before-you-start) - [Prerequisites](#prerequisites)
- [Prerequisites](#prerequisites) - [Starting a cluster](#starting-a-cluster)
- [Starting a cluster](#starting-a-cluster) - [Installing the kubernetes command line tools on your workstation](#installing-the-kubernetes-command-line-tools-on-your-workstation)
- [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)
- [Getting started with your cluster](#getting-started-with-your-cluster) - [Inspect your cluster](#inspect-your-cluster)
- [Inspect your cluster](#inspect-your-cluster) - [Run some examples](#run-some-examples)
- [Run some examples](#run-some-examples) - [Tearing down the cluster](#tearing-down-the-cluster)
- [Tearing down the cluster](#tearing-down-the-cluster) - [Customizing](#customizing)
- [Customizing](#customizing) - [Troubleshooting](#troubleshooting)
- [Troubleshooting](#troubleshooting) - [Project settings](#project-settings)
- [Project settings](#project-settings) - [Cluster initialization hang](#cluster-initialization-hang)
- [Cluster initialization hang](#cluster-initialization-hang) - [SSH](#ssh)
- [SSH](#ssh) - [Networking](#networking)
- [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). 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).

19
docs/getting-started-guides/juju.md
View File

@ -1,16 +1,15 @@
## Getting started with Juju Getting started with Juju
-------------------------
Juju handles provisioning machines and deploying complex systems to a Juju handles provisioning machines and deploying complex systems to a
wide number of clouds, supporting service orchestration once the bundle of wide number of clouds, supporting service orchestration once the bundle of
services has been deployed. services has been deployed.
## Contents **Table of Contents**
- [Getting started with Juju](#getting-started-with-juju) - [Prerequisites](#prerequisites)
- [Contents](#contents) - [On Ubuntu](#on-ubuntu)
- [Prerequisites](#prerequisites) - [With Docker](#with-docker)
- [On Ubuntu](#on-ubuntu)
- [With Docker](#with-docker)
- [Launch Kubernetes cluster](#launch-kubernetes-cluster) - [Launch Kubernetes cluster](#launch-kubernetes-cluster)
- [Exploring the cluster](#exploring-the-cluster) - [Exploring the cluster](#exploring-the-cluster)
- [Run some containers!](#run-some-containers) - [Run some containers!](#run-some-containers)
@ -21,13 +20,13 @@ services has been deployed.
- [Cloud compatibility](#cloud-compatibility) - [Cloud compatibility](#cloud-compatibility)
### Prerequisites ## Prerequisites
> Note: If you're running kube-up, on ubuntu - all of the dependencies > 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: > will be handled for you. You may safely skip to the section:
> [Launch Kubernetes Cluster](#launch-kubernetes-cluster) > [Launch Kubernetes Cluster](#launch-kubernetes-cluster)
#### On Ubuntu ### On Ubuntu
[Install the Juju client](https://juju.ubuntu.com/install) on your [Install the Juju client](https://juju.ubuntu.com/install) on your
local ubuntu system: local ubuntu system:
@ -37,7 +36,7 @@ local ubuntu system:
sudo apt-get install juju-core juju-quickstart 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 If you are not using ubuntu or prefer the isolation of docker, you may
run the following: run the following:

27
docs/getting-started-guides/libvirt-coreos.md
View File

@ -1,19 +1,18 @@
## Getting started with libvirt CoreOS Getting started with libvirt CoreOS
-----------------------------------
## Contents **Table of Contents**
- [Getting started with libvirt CoreOS](#getting-started-with-libvirt-coreos) - [Highlights](#highlights)
- [Contents](#contents) - [Prerequisites](#prerequisites)
- [Highlights](#highlights) - [Setup](#setup)
- [Prerequisites](#prerequisites) - [Interacting with your Kubernetes cluster with the `kube-*` scripts.](#interacting-with-your-kubernetes-cluster-with-the-kube--scripts)
- [Setup](#setup) - [Troubleshooting](#troubleshooting)
- [Interacting with your Kubernetes cluster with the `kube-*` scripts.](#interacting-with-your-kubernetes-cluster-with-the-kube--scripts) - [!!! Cannot find kubernetes-server-linux-amd64.tar.gz](#-cannot-find-kubernetes-server-linux-amd64targz)
- [Troubleshooting](#troubleshooting) - [Can't find virsh in PATH, please fix and retry.](#cant-find-virsh-in-path-please-fix-and-retry)
- [!!! Cannot find kubernetes-server-linux-amd64.tar.gz](#-cannot-find-kubernetes-server-linux-amd64targz) - [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)
- [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': Permission denied](#error-failed-to-connect-socket-to-varrunlibvirtlibvirt-sock-permission-denied)
- [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: Out of memory initializing network (virsh net-create...)](#error-out-of-memory-initializing-network-virsh-net-create)
- [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

8
docs/getting-started-guides/locally.md
View File

@ -1,9 +1,8 @@
## Getting started locally Getting started locally
-----------------------
## Contents **Table of Contents**
- [Getting started locally](#getting-started-locally)
- [Contents](#contents)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Linux](#linux) - [Linux](#linux)
- [Docker](#docker) - [Docker](#docker)
@ -11,7 +10,6 @@
- [go](#go) - [go](#go)
- [Starting the cluster](#starting-the-cluster) - [Starting the cluster](#starting-the-cluster)
- [Running a container](#running-a-container) - [Running a container](#running-a-container)
- [introspect kubernetes!](#introspect-kubernetes)
- [Running a user defined pod](#running-a-user-defined-pod) - [Running a user defined pod](#running-a-user-defined-pod)
- [Troubleshooting](#troubleshooting) - [Troubleshooting](#troubleshooting)
- [I cannot reach service IPs on the network.](#i-cannot-reach-service-ips-on-the-network) - [I cannot reach service IPs on the network.](#i-cannot-reach-service-ips-on-the-network)

9
docs/getting-started-guides/mesos.md
View File

@ -1,9 +1,8 @@
## Getting started with Kubernetes on Mesos Getting started with Kubernetes on Mesos
----------------------------------------
## Contents **Table of Contents**
- [Getting started with Kubernetes on Mesos](#getting-started-with-kubernetes-on-mesos)
- [Contents](#contents)
- [About Kubernetes on Mesos](#about-kubernetes-on-mesos) - [About Kubernetes on Mesos](#about-kubernetes-on-mesos)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Deploy Kubernetes-Mesos](#deploy-kubernetes-mesos) - [Deploy Kubernetes-Mesos](#deploy-kubernetes-mesos)
@ -13,8 +12,6 @@
- [Spin up a pod](#spin-up-a-pod) - [Spin up a pod](#spin-up-a-pod)
- [Run the Example Guestbook App](#run-the-example-guestbook-app) - [Run the Example Guestbook App](#run-the-example-guestbook-app)
- [Test Guestbook App](#test-guestbook-app) - [Test Guestbook App](#test-guestbook-app)
- [determine the internal port for the frontend service](#determine-the-internal-port-for-the-frontend-service)
- [open up access to the internal port for the frontend service](#open-up-access-to-the-internal-port-for-the-frontend-service)
## About Kubernetes on Mesos ## About Kubernetes on Mesos
<!-- TODO: Update, clean up. --> <!-- TODO: Update, clean up. -->

8
docs/getting-started-guides/ovirt.md
View File

@ -1,13 +1,11 @@
# Getting started on oVirt Getting started on oVirt
------------------------
## Contents **Table of Contents**
- [Getting started on oVirt](#getting-started-on-ovirt)
- [Contents](#contents)
- [What is oVirt](#what-is-ovirt) - [What is oVirt](#what-is-ovirt)
- [oVirt Cloud Provider Deployment](#ovirt-cloud-provider-deployment) - [oVirt Cloud Provider Deployment](#ovirt-cloud-provider-deployment)
- [Using the oVirt Cloud Provider](#using-the-ovirt-cloud-provider) - [Using the oVirt Cloud Provider](#using-the-ovirt-cloud-provider)
- [Search query used to find nodes](#search-query-used-to-find-nodes)
- [oVirt Cloud Provider Screencast](#ovirt-cloud-provider-screencast) - [oVirt Cloud Provider Screencast](#ovirt-cloud-provider-screencast)
## What is oVirt ## What is oVirt

7
docs/getting-started-guides/rackspace.md
View File

@ -1,9 +1,8 @@
## Getting started on Rackspace Getting started on Rackspace
----------------------------
## Contents **Table of Contents**
- [Getting started on Rackspace](#getting-started-on-rackspace)
- [Contents](#contents)
- [Introduction](#introduction) - [Introduction](#introduction)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Provider: Rackspace](#provider-rackspace) - [Provider: Rackspace](#provider-rackspace)

33
docs/getting-started-guides/ubuntu.md
View File

@ -1,16 +1,13 @@
## Kubernetes Deployment On Bare-metal Ubuntu Nodes Kubernetes Deployment On Bare-metal Ubuntu Nodes
------------------------------------------------
## Contents - [Introduction](#introduction)
- [Prerequisites](#prerequisites)
- [Kubernetes Deployment On Bare-metal Ubuntu Nodes](#kubernetes-deployment-on-bare-metal-ubuntu-nodes) - [Starting a Cluster](#starting-a-cluster)
- [Contents](#contents) - [Make *kubernetes* , *etcd* and *flanneld* binaries](#make-kubernetes--etcd-and-flanneld-binaries)
- [Introduction](#introduction) - [Configure and start the kubernetes cluster](#configure-and-start-the-kubernetes-cluster)
- [**Prerequisites：**](#prerequisites) - [Deploy addons](#deploy-addons)
- [**Main Steps**](#main-steps) - [Trouble Shooting](#trouble-shooting)
- [I. Make *kubernetes* , *etcd* and *flanneld* binaries](#i-make-kubernetes--etcd-and-flanneld-binaries)
- [II. Configure and start the kubernetes cluster](#ii-configure-and-start-the-kubernetes-cluster)
- [IV. Deploy addons](#iv-deploy-addons)
- [IV. Trouble Shooting](#iv-trouble-shooting)
## Introduction ## Introduction
@ -18,7 +15,7 @@ This document describes how to deploy kubernetes on ubuntu nodes, including 1 ma
[Cloud team from Zhejiang University](https://github.com/ZJU-SEL) will maintain this work. [Cloud team from Zhejiang University](https://github.com/ZJU-SEL) will maintain this work.
### **Prerequisites：** ## Prerequisites
*1 The minion nodes have installed docker version 1.2+ and bridge-utils to manipulate linux bridge* *1 The minion nodes have installed docker version 1.2+ and bridge-utils to manipulate linux bridge*
*2 All machines can communicate with each other, no need to connect Internet (should use private docker registry in this case)* *2 All machines can communicate with each other, no need to connect Internet (should use private docker registry in this case)*
@ -30,8 +27,8 @@ This document describes how to deploy kubernetes on ubuntu nodes, including 1 ma
*5 All the remote servers can be ssh logged in without a password by using key authentication* *5 All the remote servers can be ssh logged in without a password by using key authentication*
### **Main Steps** ### Starting a Cluster
#### I. Make *kubernetes* , *etcd* and *flanneld* binaries #### Make *kubernetes* , *etcd* and *flanneld* binaries
First clone the kubernetes github repo, `$ git clone https://github.com/GoogleCloudPlatform/kubernetes.git` First clone the kubernetes github repo, `$ git clone https://github.com/GoogleCloudPlatform/kubernetes.git`
then `$ cd kubernetes/cluster/ubuntu`. then `$ cd kubernetes/cluster/ubuntu`.
@ -44,7 +41,7 @@ Please make sure that there are `kube-apiserver`, `kube-controller-manager`, `ku
> We used flannel here because we want to use overlay network, but please remember it is not the only choice, and it is also not a k8s' necessary dependence. Actually you can just build up k8s cluster natively, or use flannel, Open vSwitch or any other SDN tool you like, we just choose flannel here as a example. > We used flannel here because we want to use overlay network, but please remember it is not the only choice, and it is also not a k8s' necessary dependence. Actually you can just build up k8s cluster natively, or use flannel, Open vSwitch or any other SDN tool you like, we just choose flannel here as a example.
#### II. Configure and start the kubernetes cluster #### Configure and start the kubernetes cluster
An example cluster is listed as below: An example cluster is listed as below:
| IP Address|Role | | IP Address|Role |
@ -126,7 +123,7 @@ NAME LABELS STATUS
Also you can run kubernetes [guest-example](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/examples/guestbook) to build a redis backend cluster on the k8s． Also you can run kubernetes [guest-example](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/examples/guestbook) to build a redis backend cluster on the k8s．
#### IV. Deploy addons #### Deploy addons
After the previous parts, you will have a working k8s cluster, this part will teach you how to deploy addons like dns onto the existing cluster. After the previous parts, you will have a working k8s cluster, this part will teach you how to deploy addons like dns onto the existing cluster.
@ -160,7 +157,7 @@ $ KUBERNETES_PROVIDER=ubuntu ./deployAddons.sh
After some time, you can use `$ kubectl get pods` to see the dns pod is running in the cluster. Done! After some time, you can use `$ kubectl get pods` to see the dns pod is running in the cluster. Done!
#### IV. Trouble Shooting #### Trouble Shooting
Generally, what this approach did is quite simple: Generally, what this approach did is quite simple:

4
docs/getting-started-guides/vagrant.md
View File

@ -2,10 +2,8 @@
Running kubernetes with Vagrant (and VirtualBox) is an easy way to run/test/develop on your local machine (Linux, Mac OS X). Running kubernetes with Vagrant (and VirtualBox) is an easy way to run/test/develop on your local machine (Linux, Mac OS X).
## Contents **Table of Contents**
- [Getting started with Vagrant](#getting-started-with-vagrant)
- [Contents](#contents)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Setup](#setup) - [Setup](#setup)
- [Interacting with your Kubernetes cluster with Vagrant.](#interacting-with-your-kubernetes-cluster-with-vagrant) - [Interacting with your Kubernetes cluster with Vagrant.](#interacting-with-your-kubernetes-cluster-with-vagrant)

7
docs/getting-started-guides/vsphere.md
View File

@ -1,14 +1,13 @@
## Getting started with vSphere Getting started with vSphere
-------------------------------
The example below creates a Kubernetes cluster with 4 worker node Virtual 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 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 cluster is set up and controlled from your workstation (or wherever you find
convenient). convenient).
## Contents **Table of Contents**
- [Getting started with vSphere](#getting-started-with-vsphere)
- [Contents](#contents)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Setup](#setup) - [Setup](#setup)
- [Starting a cluster](#starting-a-cluster) - [Starting a cluster](#starting-a-cluster)