From d56138ba03389621f3ab0cb4df80efd61982476b Mon Sep 17 00:00:00 2001 From: Brian Grant Date: Tue, 14 Jul 2015 06:40:25 +0000 Subject: [PATCH] Thread user guide docs together with "What's next" sections, and add a couple missing TOCs. --- docs/user-guide/configuring-containers.md | 5 +++++ docs/user-guide/connecting-applications.md | 5 +++++ ...connecting-to-applications-port-forward.md | 2 +- docs/user-guide/deploying-applications.md | 15 +++++++++++++++ .../user-guide/introspection-and-debugging.md | 10 ++++++++++ docs/user-guide/managing-deployments.md | 5 +++++ docs/user-guide/prereqs.md | 4 ++++ docs/user-guide/production-pods.md | 19 +++++++++++++++++++ docs/user-guide/quick-start.md | 14 ++++++++++++++ 9 files changed, 78 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/configuring-containers.md b/docs/user-guide/configuring-containers.md index 12b702df559..877b64964dc 100644 --- a/docs/user-guide/configuring-containers.md +++ b/docs/user-guide/configuring-containers.md @@ -32,6 +32,7 @@ certainly want the docs that go with that version. - [Viewing pod status](#viewing-pod-status) - [Viewing pod output](#viewing-pod-output) - [Deleting pods](#deleting-pods) + - [What's next?](#what's-next?) @@ -166,6 +167,10 @@ Terminated pods aren’t currently automatically deleted, so that you can observ On the other hand, containers and their logs are eventually deleted automatically in order to free up disk space on the nodes. +## What's next? + +[Learn about deploying continuously running applications.](deploying-applications.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/configuring-containers.md?pixel)]() diff --git a/docs/user-guide/connecting-applications.md b/docs/user-guide/connecting-applications.md index 820c906e1ec..3e1d956f7cb 100644 --- a/docs/user-guide/connecting-applications.md +++ b/docs/user-guide/connecting-applications.md @@ -32,6 +32,7 @@ certainly want the docs that go with that version. - [Environment Variables](#environment-variables) - [DNS](#dns) - [Exposing the Service to the internet](#exposing-the-service-to-the-internet) + - [What's next?](#what's-next?) @@ -237,6 +238,10 @@ $ kubectl get service nginxsvc -o json | grep \"ip\" ``` Now you have a load balancer that automatically does what you would’ve in the previous step. Note that you cannot directly curl your nodes on port 80, you need to go to the ip of the load balancer. +## What's next? + +[Learn about more Kubernetes features that will help you run containers reliably in production.](production-pods.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/connecting-applications.md?pixel)]() diff --git a/docs/user-guide/connecting-to-applications-port-forward.md b/docs/user-guide/connecting-to-applications-port-forward.md index fb8416184f4..421beb88c7e 100644 --- a/docs/user-guide/connecting-to-applications-port-forward.md +++ b/docs/user-guide/connecting-to-applications-port-forward.md @@ -21,8 +21,8 @@ certainly want the docs that go with that version. #Connecting to applications: kubectl port-forward -kubectl port-forward forwards connections to a local port to a port on a pod. Its man page is available [here](kubectl/kubectl_port-forward.md). Compared to [kubectl proxy](accessing-the-cluster.md#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. +kubectl port-forward forwards connections to a local port to a port on a pod. Its man page is available [here](kubectl/kubectl_port-forward.md). Compared to [kubectl proxy](accessing-the-cluster.md#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. ## Creating a Redis master ``` diff --git a/docs/user-guide/deploying-applications.md b/docs/user-guide/deploying-applications.md index 6d63cd6c838..586862900ff 100644 --- a/docs/user-guide/deploying-applications.md +++ b/docs/user-guide/deploying-applications.md @@ -22,6 +22,17 @@ certainly want the docs that go with that version. # Kubernetes User Guide: Managing Applications: Deploying continuously running applications +**Table of Contents** + +- [Kubernetes User Guide: Managing Applications: Deploying continuously running applications](#kubernetes-user-guide:-managing-applications:-deploying-continuously-running-applications) + - [Launching a set of replicas using a configuration file](#launching-a-set-of-replicas-using-a-configuration-file) + - [Viewing replication controller status](#viewing-replication-controller-status) + - [Deleting replication controllers](#deleting-replication-controllers) + - [Labels](#labels) + - [What's next?](#what's-next?) + + + You previously read about how to quickly deploy a simple replicated application using [`kubectl run`](quick-start.md) and how to configure and launch single-run containers using pods (configuring-containers.md). Here, you’ll use the configuration-based approach to deploy a continuously running, replicated application. ## Launching a set of replicas using a configuration file @@ -113,6 +124,10 @@ map[app:nginx] You could also specify the `selector` explicitly, such as if you wanted to specify labels in the pod template that you didn’t want to select on, but you should ensure that the selector will match the labels of the pods created from the pod template, and that it won’t match pods created by other replication controllers. The most straightforward way to ensure the latter is to create a unique label value for the replication controller, and to specify it in both the pod template’s labels and in the selector. +## What's next? + +[Learn about exposing applications to users and clients, and connecting tiers of your application together.](connecting-applications.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/deploying-applications.md?pixel)]() diff --git a/docs/user-guide/introspection-and-debugging.md b/docs/user-guide/introspection-and-debugging.md index 43a8877afed..986bb9b830d 100644 --- a/docs/user-guide/introspection-and-debugging.md +++ b/docs/user-guide/introspection-and-debugging.md @@ -32,6 +32,7 @@ your pods. But there are a number of ways to get even more information about you - [Using ```kubectl describe pod``` to fetch details about pods](#using-```kubectl-describe-pod```-to-fetch-details-about-pods) - [Example: debugging Pending Pods](#example:-debugging-pending-pods) - [Example: debugging a down/unreachable node](#example:-debugging-a-down/unreachable-node) + - [What's next?](#what's-next?) @@ -317,6 +318,15 @@ status: systemUUID: ABE5F6B4-D44B-108B-C46A-24CCE16C8B6E ``` +## What's next? + +Learn about additional debugging tools, including: +* [Logging](logging.md) +* [Monitoring](monitoring.md) +* [Getting into containers via `exec`](getting-into-containers.md) +* [Connecting to containers via proxies](connecting-to-applications-proxy.md) +* [Connecting to containers via port forwarding](connecting-to-applications-port-forward.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/introspection-and-debugging.md?pixel)]() diff --git a/docs/user-guide/managing-deployments.md b/docs/user-guide/managing-deployments.md index f8be2451766..ada53195a25 100644 --- a/docs/user-guide/managing-deployments.md +++ b/docs/user-guide/managing-deployments.md @@ -36,6 +36,7 @@ You’ve deployed your application and exposed it via a service. Now what? Kuber - [Updating your application without a service outage](#updating-your-application-without-a-service-outage) - [In-place updates of resources](#in-place-updates-of-resources) - [Disruptive updates](#disruptive-updates) + - [What's next?](#what's-next?) @@ -396,6 +397,10 @@ replicationcontrollers/my-nginx-v4 replicationcontrollers/my-nginx-v4 ``` +## What's next? + +[Learn about how to use `kubectl` for application introspection and debugging.](introspection-and-debugging.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/managing-deployments.md?pixel)]() diff --git a/docs/user-guide/prereqs.md b/docs/user-guide/prereqs.md index 882b568f9be..29888a8c401 100644 --- a/docs/user-guide/prereqs.md +++ b/docs/user-guide/prereqs.md @@ -26,6 +26,10 @@ To deploy and manage applications on Kubernetes, you’ll use the Kubernetes com In order for kubectl to find and access the Kubernetes cluster, it needs a [kubeconfig file](kubeconfig-file.md), which is created automatically when creating a cluster using kube-up.sh (see the [getting started guides](../../docs/getting-started-guides/) for more about creating clusters). If you need access to a cluster you didn’t create, see the [Sharing Cluster Access document](sharing-clusters.md). +## What's next? + +[Learn how to launch and expose your application.](quick-start.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/prereqs.md?pixel)]() diff --git a/docs/user-guide/production-pods.md b/docs/user-guide/production-pods.md index c97a8ca6082..b62ab8aa0f3 100644 --- a/docs/user-guide/production-pods.md +++ b/docs/user-guide/production-pods.md @@ -22,6 +22,21 @@ certainly want the docs that go with that version. # Kubernetes User Guide: Managing Applications: Working with pods and containers in production +**Table of Contents** + +- [Kubernetes User Guide: Managing Applications: Working with pods and containers in production](#kubernetes-user-guide:-managing-applications:-working-with-pods-and-containers-in-production) + - [Persistent storage](#persistent-storage) + - [Distributing credentials](#distributing-credentials) + - [Authenticating with a private image registry](#authenticating-with-a-private-image-registry) + - [Helper containers](#helper-containers) + - [Resource management](#resource-management) + - [Liveness and readiness probes (aka health checks)](#liveness-and-readiness-probes-(aka-health-checks)) + - [Lifecycle hooks and termination notice](#lifecycle-hooks-and-termination-notice) + - [Termination message](#termination-message) + - [What's next?](#what's-next?) + + + You’ve seen [how to configure and deploy pods and containers](configuring-containers.md), using some of the most common configuration parameters. This section dives into additional features that are especially useful for running applications in production. ## Persistent storage @@ -336,6 +351,10 @@ $ kubectl get pods/pod-w-message -o template -t "{{range .status.containerStatus 0 ``` +## What's next? + +[Learn more about managing deployments.](managing-deployments.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/production-pods.md?pixel)]() diff --git a/docs/user-guide/quick-start.md b/docs/user-guide/quick-start.md index 7808a490208..290c1dcc562 100644 --- a/docs/user-guide/quick-start.md +++ b/docs/user-guide/quick-start.md @@ -22,6 +22,16 @@ certainly want the docs that go with that version. # Kubernetes User Guide: Managing Applications: Quick start +**Table of Contents** + +- [Kubernetes User Guide: Managing Applications: Quick start](#kubernetes-user-guide:-managing-applications:-quick-start) + - [Launching a simple application](#launching-a-simple-application) + - [Exposing your application to the Internet](#exposing-your-application-to-the-internet) + - [Killing the application](#killing-the-application) + - [What's next?](#what's-next?) + + + This guide will help you get oriented to Kubernetes and running your first containers on the cluster. ## Launching a simple application @@ -74,6 +84,10 @@ $ kubectl delete svc my-nginx services/my-nginx ``` +## What's next? + +[Learn about how to configure common container parameters, such as commands and environment variables.](configuring-containers.md) + [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/quick-start.md?pixel)]()