From 452f86bb4a6e798059fc501e728287cd4a0fcbe3 Mon Sep 17 00:00:00 2001 From: John Mulhausen Date: Thu, 11 Feb 2016 14:14:51 -0800 Subject: [PATCH] Start of Support section --- _data/v1_1/guides.yml | 8 ++--- _data/v1_1/support.yml | 24 ++++++------- v1.1/docs/admin/garbage-collection.md | 35 ++----------------- v1.1/docs/admin/salt.md | 26 ++------------ ...connecting-to-applications-port-forward.md | 24 ++----------- .../connecting-to-applications-proxy.md | 24 ++----------- .../user-guide/getting-into-containers.md | 24 ++----------- v1.1/docs/user-guide/liveness/README.md | 25 ++----------- v1.1/docs/user-guide/logging.md | 24 ++----------- v1.1/docs/user-guide/monitoring.md | 24 ++----------- v1.1/docs/user-guide/ui.md | 24 ++----------- 11 files changed, 37 insertions(+), 225 deletions(-) diff --git a/_data/v1_1/guides.yml b/_data/v1_1/guides.yml index 4000bc449c..b7747775b8 100644 --- a/_data/v1_1/guides.yml +++ b/_data/v1_1/guides.yml @@ -100,6 +100,10 @@ toc: path: /v1.1/docs/getting-started-guides/scratch - title: Authenticating Across Clusters with kubeconfig path: /v1.1/docs/user-guide/kubeconfig-file + - title: Configuring Garbage Collection + path: /v1.1/docs/admin/garbage-collection + - title: Configuring Kubernetes with Salt + path: /v1.1/docs/admin/salt - title: Common Tasks section: - title: Using Nodes @@ -110,12 +114,8 @@ toc: path: /v1.1/docs/user-guide/simple-yaml - title: Configuring Containers path: /v1.1/docs/user-guide/configuring-containers - - title: Configuring Kubernetes with Salt - path: /v1.1/docs/admin/salt - title: Using Environment Variables path: /v1.1/docs/user-guide/environment-guide/README - - title: Configuring Garbage Collection - path: /v1.1/docs/admin/garbage-collection - title: Managing Compute Resources path: /v1.1/docs/user-guide/compute-resources diff --git a/_data/v1_1/support.yml b/_data/v1_1/support.yml index 6939a4124f..f6a62c59dc 100644 --- a/_data/v1_1/support.yml +++ b/_data/v1_1/support.yml @@ -5,23 +5,21 @@ toc: path: /v1.1/support section: - title: Web Interface - path: /v1.1/docs/user-guide/ui.html + path: /v1.1/docs/user-guide/ui - title: Logging - path: /v1.1/docs/user-guide/logging.html - - title: Monitoring - path: /v1.1/docs/user-guide/monitoring.html + path: /v1.1/docs/user-guide/logging - title: Container Access (exec) - path: /v1.1/docs/user-guide/getting-into-containers.html + path: /v1.1/docs/user-guide/getting-into-containers - title: Connect with Proxies - path: /v1.1/docs/user-guide/connecting-to-applications-proxy.html + path: /v1.1/docs/user-guide/connecting-to-applications-proxy - title: Connect with Port Forwarding - path: /v1.1/docs/user-guide/connecting-to-applications-port-forward.html + path: /v1.1/docs/user-guide/connecting-to-applications-port-forward - title: Troubleshooting Applications - path: /v1.1/docs/user-guide/application-troubleshooting.html + path: /v1.1/docs/user-guide/application-troubleshooting - title: Troubleshooting Clusters - path: /v1.1/docs/admin/cluster-troubleshooting.html + path: /v1.1/docs/admin/cluster-troubleshooting - title: Best Practices for Configuration - path: /v1.1/docs/user-guide/config-best-practices.html + path: /v1.1/docs/user-guide/config-best-practices - title: Frequently Asked Questions section: @@ -35,14 +33,14 @@ toc: - title: Other Resources section: - title: Known Issues - path: /v1.1/docs/user-guide/known-issues.html + path: /v1.1/docs/user-guide/known-issues - title: Kubernetes Issue Tracker on GitHub path: https://github.com/kubernetes/kubernetes/issues - title: Report a Security Vulnerability - path: /v1.1/docs/reporting-security-issues.html + path: /v1.1/docs/reporting-security-issues - title: Release Notes path: https://github.com/kubernetes/kubernetes/releases - title: Release Roadmap - path: /v1.1/docs/roadmap.html + path: /v1.1/docs/roadmap - title: Contributing to Kubernetes Documentation path: /v1.1/editdocs diff --git a/v1.1/docs/admin/garbage-collection.md b/v1.1/docs/admin/garbage-collection.md index 354f29d44c..8830706f31 100644 --- a/v1.1/docs/admin/garbage-collection.md +++ b/v1.1/docs/admin/garbage-collection.md @@ -1,19 +1,7 @@ --- -layout: docwithnav -title: "Garbage Collection" +title: "Configuring Garbage Collection" +section: guides --- - - - - - -# Garbage Collection - -- [Introduction](#introduction) -- [Image Collection](#image-collection) -- [Container Collection](#container-collection) -- [User Configuration](#user-configuration) - ### Introduction Garbage collection is managed by kubelet automatically, mainly including unreferenced @@ -73,21 +61,4 @@ Default is 100. Note that we highly recommend a large enough value for `maximum-dead-containers-per-container` to allow at least 2 dead containers retaining per expected container when you customize the flag configuration. A loose value for `maximum-dead-containers` also assumes importance for a similar reason. -See [this issue](https://github.com/kubernetes/kubernetes/issues/13287) for more details. - - - - - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/garbage-collection.md?pixel)]() - - +See [this issue](https://github.com/kubernetes/kubernetes/issues/13287) for more details. \ No newline at end of file diff --git a/v1.1/docs/admin/salt.md b/v1.1/docs/admin/salt.md index 6613b72562..a3c4edb3ee 100644 --- a/v1.1/docs/admin/salt.md +++ b/v1.1/docs/admin/salt.md @@ -1,14 +1,7 @@ --- -layout: docwithnav -title: "Using Salt to configure Kubernetes" +title: "Configuring Kubernetes with Salt" +section: guides --- - - - - - -# Using Salt to configure Kubernetes - The Kubernetes cluster can be configured using Salt. The Salt scripts are shared across multiple hosting providers, so it's important to understand some background information prior to making a modification to ensure your changes do not break hosting Kubernetes across multiple environments. Depending on where you host your Kubernetes cluster, you may be using different operating systems and different networking configurations. As a result, it's important to understand some background information before making Salt changes in order to minimize introducing failures for other hosting providers. @@ -113,17 +106,4 @@ We should define a grains.conf key that captures more specifically what network ## Further reading -The [cluster/saltbase](http://releases.k8s.io/release-1.1/cluster/saltbase/) tree has more details on the current SaltStack configuration. - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/salt.md?pixel)]() - - +The [cluster/saltbase](http://releases.k8s.io/release-1.1/cluster/saltbase/) tree has more details on the current SaltStack configuration. \ No newline at end of file diff --git a/v1.1/docs/user-guide/connecting-to-applications-port-forward.md b/v1.1/docs/user-guide/connecting-to-applications-port-forward.md index d3921a4744..7d7ee6ca7b 100644 --- a/v1.1/docs/user-guide/connecting-to-applications-port-forward.md +++ b/v1.1/docs/user-guide/connecting-to-applications-port-forward.md @@ -1,14 +1,7 @@ --- -layout: docwithnav title: "Connecting to applications: kubectl port-forward" +section: support --- - - - - - -# 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.html). Compared to [kubectl proxy](accessing-the-cluster.html#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 @@ -63,17 +56,4 @@ PONG {% endraw %} {% endhighlight %} -Now one can debug the database from the local workstation. - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/connecting-to-applications-port-forward.md?pixel)]() - - +Now one can debug the database from the local workstation. \ No newline at end of file diff --git a/v1.1/docs/user-guide/connecting-to-applications-proxy.md b/v1.1/docs/user-guide/connecting-to-applications-proxy.md index da252ebd9c..3fb7450a6a 100644 --- a/v1.1/docs/user-guide/connecting-to-applications-proxy.md +++ b/v1.1/docs/user-guide/connecting-to-applications-proxy.md @@ -1,14 +1,7 @@ --- -layout: docwithnav title: "Connecting to applications: kubectl proxy and apiserver proxy" +section: support --- - - - - - -# Connecting to applications: kubectl proxy and apiserver proxy - You have seen the [basics](accessing-the-cluster.html) about `kubectl proxy` and `apiserver proxy`. This guide shows how to use them together to access a service([kube-ui](ui.html)) running on the Kubernetes cluster from your workstation. @@ -37,17 +30,4 @@ Starting to serve on localhost:8001 {% endraw %} {% endhighlight %} -Now you can access the kube-ui service on your local workstation at [http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kube-ui](http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kube-ui) - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/connecting-to-applications-proxy.md?pixel)]() - - +Now you can access the kube-ui service on your local workstation at [http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kube-ui](http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kube-ui) \ No newline at end of file diff --git a/v1.1/docs/user-guide/getting-into-containers.md b/v1.1/docs/user-guide/getting-into-containers.md index 9bf70ffef6..407d4eefdf 100644 --- a/v1.1/docs/user-guide/getting-into-containers.md +++ b/v1.1/docs/user-guide/getting-into-containers.md @@ -1,14 +1,7 @@ --- -layout: docwithnav title: "Getting into containers: kubectl exec" +section: support --- - - - - - -# Getting into containers: kubectl exec - Developers can use `kubectl exec` to run commands in a container. This guide demonstrates two use cases. ## Using kubectl exec to check the environment variables of a container @@ -91,17 +84,4 @@ root@storage:/data# {% endraw %} {% endhighlight %} -This gets you a terminal. - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/getting-into-containers.md?pixel)]() - - +This gets you a terminal. \ No newline at end of file diff --git a/v1.1/docs/user-guide/liveness/README.md b/v1.1/docs/user-guide/liveness/README.md index 0a98a56901..9558ec5b40 100644 --- a/v1.1/docs/user-guide/liveness/README.md +++ b/v1.1/docs/user-guide/liveness/README.md @@ -1,13 +1,7 @@ --- -layout: docwithnav -title: "Overview" +title: "Checking Pod Health" +section: guides --- - - - - - -## Overview This example shows two types of pod [health checks](../production-pods.html#liveness-and-readiness-probes-aka-health-checks): HTTP checks and container execution checks. @@ -101,17 +95,4 @@ Sat, 27 Jun 2015 13:44:44 +0200 Sat, 27 Jun 2015 13:44:44 +0200 1 {kube Sat, 27 Jun 2015 13:44:44 +0200 Sat, 27 Jun 2015 13:44:44 +0200 1 {kubelet kubernetes-minion-6fbi} spec.containers{liveness} created Created with docker id ed6bb004ee10 Sat, 27 Jun 2015 13:44:44 +0200 Sat, 27 Jun 2015 13:44:44 +0200 1 {kubelet kubernetes-minion-6fbi} spec.containers{liveness} started Started with docker id ed6bb004ee10 {% endraw %} -{% endhighlight %} - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/liveness/README.md?pixel)]() - - +{% endhighlight %} \ No newline at end of file diff --git a/v1.1/docs/user-guide/logging.md b/v1.1/docs/user-guide/logging.md index ba443238ba..d6f1891d18 100644 --- a/v1.1/docs/user-guide/logging.md +++ b/v1.1/docs/user-guide/logging.md @@ -1,13 +1,8 @@ --- -layout: docwithnav title: "Logging" +section: support --- - - - - - -# Logging +This page is designed to help you use logs to troubleshoot issues with your Kubernetes solution. ## Logging by Kubernetes Components @@ -104,17 +99,4 @@ running in containers. The guide [Collecting log files within containers with Fl ## Known issues -Kubernetes does log rotation for Kubernetes components and docker containers. The command `kubectl logs` currently only read the latest logs, not all historical ones. - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/logging.md?pixel)]() - - +Kubernetes does log rotation for Kubernetes components and docker containers. The command `kubectl logs` currently only read the latest logs, not all historical ones. \ No newline at end of file diff --git a/v1.1/docs/user-guide/monitoring.md b/v1.1/docs/user-guide/monitoring.md index e09e307a64..45509b50e8 100644 --- a/v1.1/docs/user-guide/monitoring.md +++ b/v1.1/docs/user-guide/monitoring.md @@ -1,14 +1,7 @@ --- -layout: docwithnav title: "Resource Usage Monitoring in Kubernetes" +section: guides --- - - - - - -# Resource Usage Monitoring in Kubernetes - Understanding how an application behaves when deployed is crucial to scaling the application and providing a reliable service. In a Kubernetes cluster, application performance can be examined at many different levels: containers, [pods](pods.html), [services](services.html), and whole clusters. As part of Kubernetes we want to provide users with detailed resource usage information about their running applications at all these levels. This will give users deep insights into how their applications are performing and where possible application bottlenecks may be found. In comes [Heapster](https://github.com/GoogleCloudPlatform/heapster), a project meant to provide a base monitoring platform on Kubernetes. ### Overview @@ -65,17 +58,4 @@ Now that you’ve learned a bit about Heapster, feel free to try it out on your *** *Authors: Vishnu Kannan and Victor Marmol, Google Software Engineers.* -*This article was originally posted in [Kubernetes blog](http://blog.kubernetes.io/2015/05/resource-usage-monitoring-kubernetes.html).* - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/monitoring.md?pixel)]() - - +*This article was originally posted in [Kubernetes blog](http://blog.kubernetes.io/2015/05/resource-usage-monitoring-kubernetes.html).* \ No newline at end of file diff --git a/v1.1/docs/user-guide/ui.md b/v1.1/docs/user-guide/ui.md index b5b2eee2c6..fa1e417ec0 100644 --- a/v1.1/docs/user-guide/ui.md +++ b/v1.1/docs/user-guide/ui.md @@ -1,14 +1,7 @@ --- -layout: docwithnav title: "Kubernetes User Interface" +section: support --- - - - - - -# Kubernetes User Interface - Kubernetes has a web-based user interface that displays the current cluster state graphically. ## Accessing the UI @@ -57,17 +50,4 @@ Other views (Pods, Nodes, Replication Controllers, Services, and Events) simply ## More Information -For more information, see the [Kubernetes UI development document](http://releases.k8s.io/release-1.1/www/README.md) in the www directory. - - - - - - - - - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/ui.md?pixel)]() - - +For more information, see the [Kubernetes UI development document](http://releases.k8s.io/release-1.1/www/README.md) in the www directory. \ No newline at end of file