add explicit titles to docs

This commit is contained in:
Ben Balter
2016-12-15 15:16:54 -05:00
parent 2a0c64f9bd
commit bfa604351f
291 changed files with 409 additions and 212 deletions
+7 -7
View File
@@ -1,10 +1,10 @@
---
assignees:
- lavalamp
- mikedanese
---
---
assignees:
- lavalamp
- mikedanese
title: Accessing Clusters
---
* TOC
{:toc}
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Annotations
---
We have [labels](/docs/user-guide/labels) for identifying metadata.
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Troubleshooting Applications
---
This guide is to help users debug applications that are deployed into Kubernetes and not behaving correctly.
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Managing Compute Resources
---
* TOC
+1 -1
View File
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
title: Best Practices for Configuration
---
This document is meant to highlight and consolidate in one place configuration best practices that are introduced throughout the user-guide and getting-started documentation and examples. This is a living document so if you think of something that is not on this list but might be useful to others, please don't hesitate to file an issue or submit a PR.
+2 -1
View File
@@ -2,8 +2,9 @@
assignees:
- eparis
- pmorie
title: Using ConfigMap
---
Many applications require configuration via some combination of config files, command line
arguments, and environment variables. These configuration artifacts should be decoupled from image
content in order to keep containerized applications portable. The ConfigMap API resource provides
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- caesarxuchao
- thockin
title: Configuring Containers
---
* TOC
+1 -1
View File
@@ -3,7 +3,7 @@ assignees:
- caesarxuchao
- lavalamp
- thockin
title: Connecting Applications with Services
---
* TOC
@@ -2,7 +2,7 @@
assignees:
- caesarxuchao
- mikedanese
title: Connect with Port Forwarding
---
kubectl port-forward forwards connections to a local port to a port on a pod. Its man page is available [here](/docs/user-guide/kubectl/kubectl_port-forward). Compared to [kubectl proxy](/docs/user-guide/accessing-the-cluster/#using-kubectl-proxy), `kubectl port-forward` is more generic as it can forward TCP traffic while `kubectl proxy` can only forward HTTP traffic. This guide demonstrates how to use `kubectl port-forward` to connect to a Redis database, which may be useful for database debugging.
@@ -2,7 +2,7 @@
assignees:
- caesarxuchao
- lavalamp
title: Connect with Proxies
---
You have seen the [basics](/docs/user-guide/accessing-the-cluster) about `kubectl proxy` and `apiserver proxy`. This guide shows how to use them together to access a service([kube-ui](/docs/user-guide/ui)) running on the Kubernetes cluster from your workstation.
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Container Lifecycle Hooks
---
This document describes the environment for Kubelet managed containers on a Kubernetes node (kNode).  In contrast to the Kubernetes cluster API, which provides an API for creating and managing containers, the Kubernetes container environment provides the container access to information about what else is going on in the cluster.
+1 -1
View File
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
title: Commands and Capabilities
---
* TOC
+1 -1
View File
@@ -3,7 +3,7 @@ assignees:
- erictune
- soltysh
- janetkuo
title: Cron Jobs
---
* TOC
@@ -1,7 +1,7 @@
---
assignees:
- bprashanth
title: Debugging Pods and Replication Controllers
---
* TOC
+1 -1
View File
@@ -3,7 +3,7 @@ assignees:
- bprashanth
- janetkuo
- thockin
title: Debugging Services
---
An issue that comes up rather frequently for new installations of Kubernetes is
+1 -2
View File
@@ -3,10 +3,9 @@ assignees:
- bgrant0607
- caesarxuchao
- thockin
title: Deploying Applications
---
* TOC
{:toc}
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- bgrant0607
- janetkuo
title: Deployments
---
* TOC
+1 -1
View File
@@ -3,7 +3,7 @@ assignees:
- bgrant0607
- brendandburns
- thockin
title: kubectl for Docker Users
---
In this doc, we introduce the Kubernetes command line for interacting with the api to docker-cli users. The tool, kubectl, is designed to be familiar to docker-cli users but there are a few necessary differences. Each section of this doc highlights a docker subcommand explains the kubectl equivalent.
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- bgrant0607
- mikedanese
title: Using the Downward API to Convey Pod Properties
---
It is sometimes useful for a container to have information about itself, but we
@@ -1,4 +1,5 @@
---
title: Downward API Volumes
---
Following this example, you will create a pod with a downward API volume.
+6 -6
View File
@@ -1,9 +1,9 @@
---
assignees:
- mikedanese
---
---
assignees:
- mikedanese
title: Using Environment Variables
---
This example demonstrates running pods, replication controllers, and
services. It shows two types of pods: frontend and backend, with
services on top of both. Accessing the frontend pod will return
+1
View File
@@ -1,4 +1,5 @@
---
title: Federated ConfigMap
---
This guide explains how to use ConfigMaps in a Federation control plane.
+1
View File
@@ -1,4 +1,5 @@
---
title: Federated DaemonSet
---
This guide explains how to use DaemonSets in a federation control plane.
+1
View File
@@ -1,4 +1,5 @@
---
title: Federated Deployment
---
This guide explains how to use Deployments in the Federation control plane.
+1
View File
@@ -1,4 +1,5 @@
---
title: Federated Events
---
This guide explains how to use events in federation control plane to help in debugging.
@@ -1,4 +1,5 @@
---
title: Federated Ingress
---
This guide explains how to use Kubernetes Federated Ingress to deploy
@@ -2,7 +2,7 @@
assignees:
- bprashanth
- quinton-hoole
title: Cross-cluster Service Discovery using Federated Services
---
This guide explains how to use Kubernetes Federated Services to deploy
+1
View File
@@ -1,4 +1,5 @@
---
title: Federation User Guide
---
This guide explains how we can manage multiple kubernetes clusters using
+1
View File
@@ -1,4 +1,5 @@
---
title: Federated Namespaces
---
This guide explains how to use namespaces in Federation control plane.
@@ -1,4 +1,5 @@
---
title: Federated ReplicaSets
---
This guide explains how to use replica sets in the Federation control plane.
+1
View File
@@ -1,4 +1,5 @@
---
title: Federated Secrets
---
This guide explains how to use secrets in Federation control plane.
+1 -1
View File
@@ -1,7 +1,7 @@
---
assignees:
- caesarxuchao
title: Garbage Collection (Beta)
---
* TOC
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- caesarxuchao
- mikedanese
title: Running Commands in a Container with kubectl exec
---
Developers can use `kubectl exec` to run commands in a container. This guide demonstrates two use cases.
@@ -2,7 +2,7 @@
assignees:
- fgrzadkowski
- jszczepkowski
title: Horizontal Pod Autoscaling
---
This document describes the current state of Horizontal Pod Autoscaling in Kubernetes.
@@ -3,7 +3,7 @@ assignees:
- fgrzadkowski
- jszczepkowski
- justinsb
title: Horizontal Pod Autoscaling
---
Horizontal Pod Autoscaling automatically scales the number of pods
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
title: Names
---
All objects in the Kubernetes REST API are unambiguously identified by a Name and a UID.
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- erictune
- thockin
title: Images
---
Each container in a pod has its own image. Currently, the only type of image supported is a [Docker Image](https://docs.docker.com/engine/tutorials/dockerimages/).
+1 -1
View File
@@ -1,7 +1,7 @@
---
assignees:
- davidopp
title: Guides
---
The Kubernetes **Guides** can help you work with various aspects of the Kubernetes system.
+1 -1
View File
@@ -1,7 +1,7 @@
---
assignees:
- bprashanth
title: Ingress Resources
---
* TOC
@@ -2,7 +2,7 @@
assignees:
- janetkuo
- thockin
title: Application Introspection and Debugging
---
Once your application is running, you'll inevitably need to debug problems with it.
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- erictune
- soltysh
title: Jobs
---
* TOC
+1
View File
@@ -1,4 +1,5 @@
---
title: Parallel Processing using Expansions
---
* TOC
@@ -1,4 +1,5 @@
---
title: Coarse Parallel Processing using a Work Queue
---
* TOC
@@ -1,4 +1,5 @@
---
title: Fine Parallel Processing using a Work Queue
---
* TOC
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: JSONpath Support
---
JSONPath template is composed of JSONPath expressions enclosed by {}.
+7 -7
View File
@@ -1,10 +1,10 @@
---
assignees:
- mikedanese
- thockin
---
---
assignees:
- mikedanese
- thockin
title: Authenticating Across Clusters with kubeconfig
---
Authentication in kubernetes can differ for different individuals.
- A running kubelet might have one way of authenticating (i.e. certificates).
+1 -1
View File
@@ -4,7 +4,7 @@ assignees:
- erictune
- krousey
- clove
title: kubectl Cheat Sheet
---
See also: [Kubectl Overview](/docs/user-guide/kubectl-overview/) and [JsonPath Guide](/docs/user-guide/jsonpath).
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- bgrant0607
- janetkuo
title: kubectl Usage Conventions
---
* TOC
+1 -1
View File
@@ -2,7 +2,7 @@
assignees:
- bgrant0607
- hw-qiaolei
title: kubectl Overview
---
`kubectl` is a command line interface for running commands against Kubernetes clusters. This overview covers `kubectl` syntax, describes the command operations, and provides common examples. For details about each command, including all the supported flags and subcommands, see the [kubectl](/docs/user-guide/kubectl) reference documentation. For installation instructions see [prerequisites](/docs/user-guide/prereqs).
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl
---
## kubectl
kubectl controls the Kubernetes cluster manager
@@ -1,5 +1,7 @@
---
title: kubectl annotate
---
## kubectl annotate
Update the annotations on a resource
@@ -1,5 +1,7 @@
---
title: kubectl api-versions
---
## kubectl api-versions
Print the supported API versions on the server, in the form of "group/version"
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl apply
---
## kubectl apply
Apply a configuration to a resource by filename or stdin
@@ -1,5 +1,7 @@
---
title: kubectl attach
---
## kubectl attach
Attach to a running container
@@ -1,5 +1,7 @@
---
title: kubectl autoscale
---
## kubectl autoscale
Auto-scale a Deployment, ReplicaSet, or ReplicationController
@@ -1,5 +1,7 @@
---
title: kubectl cluster-info
---
## kubectl cluster-info
Display cluster info
@@ -1,5 +1,7 @@
---
title: kubectl config
---
## kubectl config
Modify kubeconfig files
@@ -1,5 +1,7 @@
---
title: kubectl config current-context
---
## kubectl config current-context
Displays the current-context
@@ -1,5 +1,7 @@
---
title: kubectl config set-cluster
---
## kubectl config set-cluster
Sets a cluster entry in kubeconfig
@@ -1,5 +1,7 @@
---
title: kubectl config set-context
---
## kubectl config set-context
Sets a context entry in kubeconfig
@@ -1,5 +1,7 @@
---
title: kubectl config set-credentials
---
## kubectl config set-credentials
Sets a user entry in kubeconfig
@@ -1,5 +1,7 @@
---
title: kubectl config set
---
## kubectl config set
Sets an individual value in a kubeconfig file
@@ -1,5 +1,7 @@
---
title: kubectl config unset
---
## kubectl config unset
Unsets an individual value in a kubeconfig file
@@ -1,5 +1,7 @@
---
title: kubectl config use-context
---
## kubectl config use-context
Sets the current-context in a kubeconfig file
@@ -1,5 +1,7 @@
---
title: kubectl config view
---
## kubectl config view
Display merged kubeconfig settings or a specified kubeconfig file
@@ -1,5 +1,7 @@
---
title: kubectl convert
---
## kubectl convert
Convert config files between different API versions
@@ -1,5 +1,7 @@
---
title: kubectl cordon
---
## kubectl cordon
Mark node as unschedulable
@@ -1,5 +1,7 @@
---
title: kubectl create
---
## kubectl create
Create a resource by filename or stdin
@@ -1,5 +1,7 @@
---
title: kubectl create configmap
---
## kubectl create configmap
Create a configmap from a local file, directory or literal value
@@ -1,5 +1,7 @@
---
title: kubectl create namespace
---
## kubectl create namespace
Create a namespace with the specified name
@@ -1,5 +1,7 @@
---
title: kubectl create secret
---
## kubectl create secret
Create a secret using specified subcommand
@@ -1,5 +1,7 @@
---
title: kubectl create secret docker-registry
---
## kubectl create secret docker-registry
Create a secret for use with a Docker registry
@@ -1,5 +1,7 @@
---
title: kubectl create secret generic
---
## kubectl create secret generic
Create a secret from a local file, directory or literal value
@@ -1,5 +1,7 @@
---
title: kubectl create serviceaccount
---
## kubectl create serviceaccount
Create a service account with the specified name
@@ -1,5 +1,7 @@
---
title: kubectl delete
---
## kubectl delete
Delete resources by filenames, stdin, resources and names, or by resources and label selector
@@ -1,5 +1,7 @@
---
title: kubectl describe
---
## kubectl describe
Show details of a specific resource or group of resources
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl drain
---
## kubectl drain
Drain node in preparation for maintenance
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl edit
---
## kubectl edit
Edit a resource on the server
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl exec
---
## kubectl exec
Execute a command in a container
@@ -1,5 +1,7 @@
---
title: kubectl explain
---
## kubectl explain
Documentation of resources
@@ -1,5 +1,7 @@
---
title: kubectl expose
---
## kubectl expose
Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl get
---
## kubectl get
Display one or many resources
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl label
---
## kubectl label
Update the labels on a resource
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl logs
---
## kubectl logs
Print the logs for a container in a pod
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl patch
---
## kubectl patch
Update field(s) of a resource using strategic merge patch
@@ -1,5 +1,7 @@
---
title: kubectl port-forward
---
## kubectl port-forward
Forward one or more local ports to a pod
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl proxy
---
## kubectl proxy
Run a proxy to the Kubernetes API server
@@ -1,5 +1,7 @@
---
title: kubectl replace
---
## kubectl replace
Replace a resource by filename or stdin
@@ -1,5 +1,7 @@
---
title: kubectl rolling-update
---
## kubectl rolling-update
Perform a rolling update of the given ReplicationController
@@ -1,5 +1,7 @@
---
title: kubectl rollout
---
## kubectl rollout
Manage a deployment rollout
@@ -1,5 +1,7 @@
---
title: kubectl rollout history
---
## kubectl rollout history
View rollout history
@@ -1,5 +1,7 @@
---
title: kubectl rollout pause
---
## kubectl rollout pause
Mark the provided resource as paused
@@ -1,5 +1,7 @@
---
title: kubectl rollout resume
---
## kubectl rollout resume
Resume a paused resource
@@ -1,5 +1,7 @@
---
title: kubectl rollout undo
---
## kubectl rollout undo
Undo a previous rollout
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl run
---
## kubectl run
Run a particular image on the cluster
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl scale
---
## kubectl scale
Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job
+2
View File
@@ -1,5 +1,7 @@
---
title: kubectl stop
---
## kubectl stop
Deprecated: Gracefully shut down a resource by name or filename.
@@ -1,5 +1,7 @@
---
title: kubectl uncordon
---
## kubectl uncordon
Mark node as schedulable
@@ -1,5 +1,7 @@
---
title: kubectl version
---
## kubectl version
Print the client and server version information
+1 -1
View File
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
title: Labels and Selectors
---
_Labels_ are key/value pairs that are attached to objects, such as pods.

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