add explicit titles to docs

reviewable/pr1994/r1
Ben Balter 2016-12-15 15:16:54 -05:00
parent 2a0c64f9bd
commit bfa604351f
291 changed files with 409 additions and 212 deletions

View File

@ -3,7 +3,7 @@ assignees:
- bgrant0607
- erictune
- lavalamp
title: Overview
---
This document describes how access to the Kubernetes API is controlled.

View File

@ -1,4 +1,5 @@
---
title: Installing Addons
---
## Overview

View File

@ -6,7 +6,7 @@ assignees:
- erictune
- janetkuo
- thockin
title: Using Admission Controllers
---
* TOC

View File

@ -1,7 +1,7 @@
---
assignees:
- stclair
title: AppArmor
---
AppArmor is a Linux kernel enhancement that can reduce the potential attack surface of an

View File

@ -5,8 +5,9 @@ assignees:
- ericchiang
- deads2k
- liggitt
title: Authenticating
---
* TOC
{:toc}

View File

@ -4,7 +4,7 @@ assignees:
- lavalamp
- deads2k
- liggitt
title: Using Authorization Plugins
---
In Kubernetes, authorization happens as a separate step from authentication.

View File

@ -1,7 +1,7 @@
---
assignees:
- lavalamp
title: Kubernetes Components
---
This document outlines the various binary components that need to run to

View File

@ -1,11 +1,10 @@
---
assignees:
- davidopp
- lavalamp
---
---
assignees:
- davidopp
- lavalamp
title: Building Large Clusters
---
## Support
At {{page.version}}, Kubernetes supports clusters with up to 1000 nodes. More specifically, we support configurations that meet *all* of the following criteria:

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
title: Cluster Management Guide
---
* TOC

View File

@ -1,7 +1,7 @@
---
assignees:
- davidopp
title: Troubleshooting Clusters
---
This doc is about cluster troubleshooting; we assume you have already ruled out your application as the root cause of the

View File

@ -1,7 +1,7 @@
---
assignees:
- erictune
title: Daemon Sets
---
* TOC

View File

@ -3,7 +3,7 @@ assignees:
- ArtfulCoder
- davidopp
- lavalamp
title: Using DNS Pods and Services
---
## Introduction

View File

@ -1,10 +1,9 @@
---
assignees:
- lavalamp
title: Configuring Kubernetes Use of etcd
---
[etcd](https://coreos.com/etcd/docs/2.2.1/) is a highly-available key value
store which Kubernetes uses for persistent storage of all of its REST API
objects.

View File

@ -1,5 +1,7 @@
---
title: federation-apiserver
---
## federation-apiserver

View File

@ -1,5 +1,7 @@
---
title: federation-controller-mananger
---
## federation-controller-manager

View File

@ -3,8 +3,9 @@ assignees:
- madhusudancs
- mml
- nikhiljindal
title: Using `federation-up` and `deploy.sh`
---
This guide explains how to set up cluster federation that lets us control multiple Kubernetes clusters.

View File

@ -1,7 +1,7 @@
---
assignees:
- mikedanese
title: Configuring kubelet Garbage Collection
---
* TOC

View File

@ -1,7 +1,7 @@
---
---
---
title: Building High-Availability Clusters
---
## Introduction
This document describes how to build a high-availability (HA) Kubernetes cluster. This is a fairly advanced topic.

View File

@ -2,7 +2,7 @@
assignees:
- davidopp
- lavalamp
title: Admin Guide
---
The cluster admin guide is for anyone creating or administering a Kubernetes cluster.

View File

@ -1,5 +1,7 @@
---
title: kube-apiserver
---
## kube-apiserver

View File

@ -1,5 +1,7 @@
---
title: kube-controller-manager
---
## kube-controller-manager

View File

@ -1,5 +1,7 @@
---
title: kube-proxy
---
## kube-proxy

View File

@ -1,5 +1,7 @@
---
title: kube-scheduler
---
## kube-scheduler

View File

@ -4,10 +4,9 @@ assignees:
- luxas
- errordeveloper
- jbeda
title: kubeadm reference
---
This document provides information on how to use kubeadm's advanced options.
Running `kubeadm init` bootstraps a Kubernetes cluster. This consists of the

View File

@ -1,7 +1,7 @@
---
assignees:
- liggitt
title: Kubelet authentication/authorization
---
* TOC

View File

@ -1,7 +1,7 @@
---
assignees:
- mikedanese
title: TLS bootstrapping
---
* TOC

View File

@ -1,5 +1,7 @@
---
title: Overview
---
## kubelet

View File

@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
title: Setting Pod CPU and Memory Limits
---
By default, pods run with unbounded CPU and memory limits. This means that any pod in the

View File

@ -3,7 +3,7 @@ assignees:
- dchen1107
- roberthbailey
- liggitt
title: Master-Node communication
---
* TOC

View File

@ -1,7 +1,7 @@
---
assignees:
- davidopp
title: Using Multiple Clusters
---
You may want to set up multiple Kubernetes clusters, both to

View File

@ -2,7 +2,7 @@
assignees:
- davidopp
- madhusudancs
title: Configuring Multiple Schedulers
---
Kubernetes ships with a default scheduler that is described [here](/docs/admin/kube-scheduler/).

View File

@ -3,7 +3,7 @@ assignees:
- jlowdermilk
- justinsb
- quinton-hoole
title: Running in Multiple Zones
---
## Introduction

View File

@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
title: Sharing a Cluster with Namespaces
---
A Namespace is a mechanism to partition resources created by users into

View File

@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
title: Namespaces Walkthrough
---
Kubernetes _namespaces_ help different projects, teams, or customers to share a Kubernetes cluster.

View File

@ -3,7 +3,7 @@ assignees:
- dcbw
- freehan
- thockin
title: Network Plugins
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
title: Networking in Kubernetes
---
Kubernetes approaches networking somewhat differently than Docker does by

View File

@ -1,7 +1,7 @@
---
assignees:
- Random-Liu
title: Validate Node Setup
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- Random-Liu
- dchen1107
title: Monitoring Node Health
---
* TOC

View File

@ -3,7 +3,7 @@ assignees:
- caesarxuchao
- dchen1107
- lavalamp
title: Nodes
---
* TOC

View File

@ -3,7 +3,7 @@ assignees:
- derekwaynecarr
- vishh
- timstclair
title: Configuring Out Of Resource Handling
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
title: Kubernetes OpenVSwitch GRE/VxLAN networking
---
This document describes how OpenVSwitch is used to setup networking between pods across nodes.

View File

@ -1,7 +1,7 @@
---
assignees:
- derekwaynecarr
title: Resource Quotas
---
When several users or teams share a cluster with a fixed number of nodes,

View File

@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
title: Applying Resource Quotas and Limits
---
This example demonstrates a typical setup to control for resource usage in a namespace.

View File

@ -2,7 +2,7 @@
assignees:
- davidopp
- lavalamp
title: Configuring Kubernetes with Salt
---
The Kubernetes cluster can be configured using Salt.

View File

@ -4,7 +4,7 @@ assignees:
- davidopp
- lavalamp
- liggitt
title: Managing Service Accounts
---
*This is a Cluster Administrator guide to service accounts. It assumes knowledge of

View File

@ -1,7 +1,7 @@
---
assignees:
- jsafrane
title: Static Pods
---
**If you are running clustered Kubernetes and are using static pods to run a pod on every node, you should probably be using a [DaemonSet](/docs/admin/daemons/)!**

View File

@ -1,5 +1,7 @@
---
title: Autoscaling API Definitions
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -1,5 +1,7 @@
---
title: Autoscaling API Operations
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -1,5 +1,7 @@
---
title: Batch API Definitions
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -1,5 +1,7 @@
---
title: Batch API Operations
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -1,5 +1,7 @@
---
title: Extensions API Definitions
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -1,5 +1,7 @@
---
title: Extensions API Operations
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -1,5 +1,7 @@
---
title: Kubernetes API Definitions
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -1,5 +1,7 @@
---
title: Kubernetes API Operations
---
<!DOCTYPE html>
<html lang="en">
<head>

View File

@ -3,7 +3,7 @@ assignees:
- bgrant0607
- erictune
- lavalamp
title: Kubernetes API Overview
---
Primary system and API concepts are documented in the [User guide](/docs/user-guide/).

View File

@ -7,6 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
title: StatefulSets
---
{% capture overview %}

View File

@ -1,4 +1,5 @@
---
title: Concepts
---
The Concepts section of the Kubernetes documentation is a work in progress.

View File

@ -1,4 +1,5 @@
---
title: Annotations
---
{% capture overview %}

View File

@ -1,4 +1,5 @@
---
title: Creating a Documentation Pull Request
---
{% capture overview %}

View File

@ -1,7 +1,8 @@
---
redirect_from:
- /docs/templatedemos/
- /docs/templatedemos.html
- "/docs/templatedemos/"
- "/docs/templatedemos.html"
title: Using Page Templates
---
<!--<html>

View File

@ -1,4 +1,5 @@
---
title: Staging Your Documentation Changes
---
{% capture overview %}

View File

@ -1,4 +1,5 @@
---
title: Documentation Style Guide
---
{% capture overview %}

View File

@ -1,4 +1,5 @@
---
title: Writing a New Topic
---
{% capture overview %}

View File

@ -1,5 +1,7 @@
---
title: Federation API
---
# API Reference
Federation API server supports the following group versions:

View File

@ -1,6 +1,7 @@
---
assignees:
- pwittrock
title: Deprecated Alternatives
---
# *Stop. These guides are superseded by [Minikube](../minikube/). They are only listed here for completeness.*

View File

@ -3,7 +3,7 @@ assignees:
- justinsb
- lavalamp
- clove
title: Running Kubernetes on AWS EC2
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- colemickens
- jeffmendoza
title: Running Kubernetes on Azure
---
The recommended approach for deploying a Kubernetes 1.4 cluster on Azure is the

View File

@ -2,7 +2,7 @@
assignees:
- david-mcmahon
- jbeda
title: Downloading or Building Kubernetes
---
You can either build a release from sources or download a pre-built release. If you do not plan on developing Kubernetes itself, we suggest a pre-built release.

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
title: CentOS
---
* TOC

View File

@ -1,6 +1,7 @@
---
title: Running Kubernetes on CenturyLink Cloud
---
---
* TOC
{: toc}

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
title: Cloudstack
---
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.

View File

@ -1,4 +1,5 @@
---
title: Running Kubernetes on Azure (Weave-based)
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- erictune
- thockin
title: Offline
---
Deploy a CoreOS running Kubernetes environment. This particular guide 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.

View File

@ -1,5 +1,5 @@
---
title: CoreOS on AWS or GCE
---
* TOC

View File

@ -1,7 +1,7 @@
---
assignees:
- karlkfi
title: 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).

View File

@ -1,4 +1,5 @@
---
title: Portable Multi-Node Cluster
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- aveshagarwal
- erictune
title: Fedora via Ansible
---
Configuring Kubernetes on Fedora via Ansible offers a simple way to quickly create a clustered environment with little effort.

View File

@ -3,7 +3,7 @@ assignees:
- aveshagarwal
- eparis
- thockin
title: Fedora (Single Node)
---
* TOC

View File

@ -3,8 +3,9 @@ assignees:
- dchen1107
- erictune
- thockin
title: Fedora (Multi Node)
---
* TOC
{:toc}

View File

@ -4,10 +4,9 @@ assignees:
- jbeda
- mikedanese
- thockin
title: Running Kubernetes 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).
* TOC

View File

@ -3,7 +3,7 @@ assignees:
- brendandburns
- erictune
- mikedanese
title: Picking the Right Solution
---
Kubernetes can run on a range of platforms, from your laptop, to VMs on a cloud provider, to rack of

View File

@ -1,4 +1,5 @@
---
title: Installing Kubernetes on AWS with kops
---
<style>

View File

@ -4,7 +4,7 @@ assignees:
- luxas
- errordeveloper
- jbeda
title: Installing Kubernetes on Linux with kubeadm
---
<style>

View File

@ -1,4 +1,5 @@
---
title: Installing kubectl
---
<style>

View File

@ -2,7 +2,7 @@
assignees:
- erictune
- idvoretskyi
title: CoreOS on libvirt
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- satnam6502
title: Logging with Elasticsearch and Kibana
---
On the Google Compute Engine (GCE) platform, the default logging support targets

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- satnam6502
title: Logging
---
A Kubernetes cluster will typically be humming along running many system and application pods. How does the system administrator collect, manage and query the logs of the system pods? How does a user query the logs of their application which is composed of many pods which may be restarted or automatically generated by the Kubernetes system? These questions are addressed by the Kubernetes **cluster level logging** services.

View File

@ -1,5 +1,5 @@
---
title: MEAN stack on Google Cloud Platform
---
**By: Sandeep Dinesh** - _July 29, 2015_

View File

@ -2,10 +2,9 @@
assignees:
- jdef
- karlkfi
title: 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).

View File

@ -1,7 +1,7 @@
---
assignees:
- jdef
title: Kubernetes on Mesos
---
* TOC

View File

@ -3,7 +3,7 @@ assignees:
- dlorenc
- janetkuo
- jlowdermilk
title: Running Kubernetes Locally via Minikube
---
Minikube is a tool that makes it easy to run Kubernetes locally. Minikube runs a single-node Kubernetes cluster inside a VM on your laptop for users looking to try out Kubernetes or develop with it day-to-day.

View File

@ -1,7 +1,7 @@
---
assignees:
- caseydavenport
title: Using Calico for NetworkPolicy
---
You can deploy a cluster using Calico for network policy in the default [GCE deployment](/docs/getting-started-guides/gce) using the following set of commands:

View File

@ -1,7 +1,7 @@
---
assignees:
- chrismarino
title: Using Romana for NetworkPolicy
---
# Installation with kubeadm

View File

@ -1,7 +1,7 @@
---
assignees:
- caseydavenport
title: Example Walkthrough
---
Kubernetes can be used to declare network policies which govern how Pods can communicate with each other. This document helps you get started using the Kubernetes [NetworkPolicy API](/docs/user-guide/networkpolicies), and provides a demonstration thereof.

View File

@ -2,7 +2,7 @@
assignees:
- idvoretskyi
- xsgordon
title: OpenStack Heat
---
* TOC

View File

@ -2,7 +2,7 @@
assignees:
- caesarxuchao
- erictune
title: oVirt
---
* TOC

View File

@ -1,7 +1,7 @@
---
assignees:
- bprashanth
title: VMware Photon Controller
---
The example below creates a Kubernetes cluster using VMware's Photon

View File

@ -1,7 +1,7 @@
---
assignees:
- erictune
title: CoreOS on Rackspace
---
* Supported Version: v0.18.1

View File

@ -2,7 +2,7 @@
assignees:
- lavalamp
- yifan-gu
title: Running Kubernetes with rkt
---
This document describes how to run Kubernetes using [rkt](https://github.com/coreos/rkt) as the container runtime.

View File

@ -2,7 +2,7 @@
assignees:
- dchen1107
- yifan-gu
title: Known Issues when Using rkt
---
The following features either are not supported or have large caveats when using the rkt container runtime. Increasing support for these items and others, including reasonable feature parity with the default container engine, is planned through future releases.

Some files were not shown because too many files have changed in this diff Show More