From bfa604351ff04bd35c4d5af5cb24adae59ef2bf3 Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 15 Dec 2016 15:16:54 -0500 Subject: [PATCH 1/6] add explicit titles to docs --- docs/admin/accessing-the-api.md | 2 +- docs/admin/addons.md | 1 + docs/admin/admission-controllers.md | 2 +- docs/admin/apparmor/index.md | 2 +- docs/admin/authentication.md | 3 ++- docs/admin/authorization.md | 2 +- docs/admin/cluster-components.md | 2 +- docs/admin/cluster-large.md | 15 +++++++-------- docs/admin/cluster-management.md | 2 +- docs/admin/cluster-troubleshooting.md | 2 +- docs/admin/daemons.md | 2 +- docs/admin/dns.md | 2 +- docs/admin/etcd.md | 3 +-- docs/admin/federation-apiserver.md | 2 ++ docs/admin/federation-controller-manager.md | 2 ++ docs/admin/federation/index.md | 3 ++- docs/admin/garbage-collection.md | 2 +- docs/admin/high-availability/index.md | 8 ++++---- docs/admin/index.md | 2 +- docs/admin/kube-apiserver.md | 2 ++ docs/admin/kube-controller-manager.md | 2 ++ docs/admin/kube-proxy.md | 2 ++ docs/admin/kube-scheduler.md | 2 ++ docs/admin/kubeadm.md | 3 +-- .../admin/kubelet-authentication-authorization.md | 2 +- docs/admin/kubelet-tls-bootstrapping.md | 2 +- docs/admin/kubelet.md | 2 ++ docs/admin/limitrange/index.md | 2 +- docs/admin/master-node-communication.md | 2 +- docs/admin/multi-cluster.md | 2 +- docs/admin/multiple-schedulers.md | 2 +- docs/admin/multiple-zones.md | 2 +- docs/admin/namespaces/index.md | 2 +- docs/admin/namespaces/walkthrough.md | 2 +- docs/admin/network-plugins.md | 2 +- docs/admin/networking.md | 2 +- docs/admin/node-conformance.md | 2 +- docs/admin/node-problem.md | 2 +- docs/admin/node.md | 2 +- docs/admin/out-of-resource.md | 2 +- docs/admin/ovs-networking.md | 2 +- docs/admin/resourcequota/index.md | 2 +- docs/admin/resourcequota/walkthrough.md | 2 +- docs/admin/salt.md | 2 +- docs/admin/service-accounts-admin.md | 2 +- docs/admin/static-pods.md | 2 +- .../api-reference/autoscaling/v1/definitions.html | 2 ++ docs/api-reference/autoscaling/v1/operations.html | 2 ++ docs/api-reference/batch/v1/definitions.html | 2 ++ docs/api-reference/batch/v1/operations.html | 2 ++ .../extensions/v1beta1/definitions.html | 2 ++ .../extensions/v1beta1/operations.html | 2 ++ docs/api-reference/v1/definitions.html | 2 ++ docs/api-reference/v1/operations.html | 2 ++ docs/api.md | 2 +- .../abstractions/controllers/statefulsets.md | 1 + docs/concepts/index.md | 1 + docs/concepts/object-metadata/annotations.md | 1 + docs/contribute/create-pull-request.md | 1 + docs/contribute/page-templates.md | 5 +++-- docs/contribute/stage-documentation-changes.md | 1 + docs/contribute/style-guide.md | 1 + docs/contribute/write-new-topic.md | 1 + docs/federation/api-reference/README.md | 2 ++ docs/getting-started-guides/alternatives.md | 1 + docs/getting-started-guides/aws.md | 2 +- docs/getting-started-guides/azure.md | 2 +- docs/getting-started-guides/binary_release.md | 2 +- .../centos/centos_manual_config.md | 2 +- docs/getting-started-guides/clc.md | 3 ++- docs/getting-started-guides/cloudstack.md | 2 +- docs/getting-started-guides/coreos/azure/index.md | 1 + .../coreos/bare_metal_offline.md | 2 +- docs/getting-started-guides/coreos/index.md | 2 +- docs/getting-started-guides/dcos.md | 2 +- docs/getting-started-guides/docker-multinode.md | 1 + .../fedora/fedora_ansible_config.md | 2 +- .../fedora/fedora_manual_config.md | 2 +- .../fedora/flannel_multi_node_cluster.md | 3 ++- docs/getting-started-guides/gce.md | 3 +-- docs/getting-started-guides/index.md | 2 +- docs/getting-started-guides/kops.md | 1 + docs/getting-started-guides/kubeadm.md | 2 +- docs/getting-started-guides/kubectl.md | 1 + docs/getting-started-guides/libvirt-coreos.md | 2 +- .../logging-elasticsearch.md | 2 +- docs/getting-started-guides/logging.md | 2 +- docs/getting-started-guides/meanstack.md | 2 +- docs/getting-started-guides/mesos-docker.md | 3 +-- docs/getting-started-guides/mesos/index.md | 2 +- docs/getting-started-guides/minikube.md | 2 +- .../network-policy/calico.md | 2 +- .../network-policy/romana.md | 2 +- .../network-policy/walkthrough.md | 2 +- docs/getting-started-guides/openstack-heat.md | 2 +- docs/getting-started-guides/ovirt.md | 2 +- docs/getting-started-guides/photon-controller.md | 2 +- docs/getting-started-guides/rackspace.md | 2 +- docs/getting-started-guides/rkt/index.md | 2 +- docs/getting-started-guides/rkt/notes.md | 2 +- docs/getting-started-guides/scratch.md | 2 +- docs/getting-started-guides/vsphere.md | 2 +- docs/getting-started-guides/windows/index.md | 2 +- docs/hellonode.md | 2 +- docs/index.md | 2 +- docs/reference.md | 3 ++- docs/reporting-security-issues.md | 2 +- docs/samples.md | 3 ++- .../port-forward-access-application-cluster.md | 1 + .../http-proxy-access-api.md | 1 + .../tasks/administer-cluster/assign-pods-nodes.md | 1 + .../dns-horizontal-autoscaling.md | 1 + .../tasks/administer-cluster/safely-drain-node.md | 4 ++-- .../assign-cpu-ram-container.md | 1 + .../configure-volume-storage.md | 1 + .../define-command-argument-container.md | 1 + .../define-environment-variable-container.md | 1 + .../distribute-credentials-secure.md | 1 + .../determine-reason-pod-failure.md | 1 + docs/tasks/index.md | 1 + .../debugging-a-statefulset.md | 2 +- docs/tasks/manage-stateful-set/delete-pods.md | 2 +- .../manage-stateful-set/deleting-a-statefulset.md | 2 +- .../manage-stateful-set/scale-stateful-set.md | 2 +- .../upgrade-pet-set-to-stateful-set.md | 2 +- docs/tasks/troubleshoot/debug-init-containers.md | 2 +- docs/tools/index.md | 2 +- docs/troubleshooting.md | 2 +- docs/tutorials/index.md | 1 + .../kubernetes-basics/cluster-interactive.html | 1 + .../kubernetes-basics/cluster-intro.html | 5 +++-- .../kubernetes-basics/deploy-interactive.html | 1 + .../tutorials/kubernetes-basics/deploy-intro.html | 1 + .../kubernetes-basics/explore-interactive.html | 1 + .../kubernetes-basics/explore-intro.html | 1 + .../kubernetes-basics/expose-interactive.html | 1 + .../tutorials/kubernetes-basics/expose-intro.html | 1 + docs/tutorials/kubernetes-basics/index.html | 1 + .../kubernetes-basics/scale-interactive.html | 1 + docs/tutorials/kubernetes-basics/scale-intro.html | 1 + .../kubernetes-basics/update-interactive.html | 1 + .../tutorials/kubernetes-basics/update-intro.html | 1 + .../stateful-application/basic-stateful-set.md | 1 + .../run-replicated-stateful-application.md | 2 +- .../run-stateful-application.md | 1 + docs/tutorials/stateful-application/zookeeper.md | 1 + .../expose-external-ip-address-service.md | 1 + .../expose-external-ip-address.md | 1 + .../run-stateless-application-deployment.md | 1 + docs/user-guide/accessing-the-cluster.md | 14 +++++++------- docs/user-guide/annotations.md | 2 +- docs/user-guide/application-troubleshooting.md | 2 +- docs/user-guide/compute-resources.md | 2 +- docs/user-guide/config-best-practices.md | 2 +- docs/user-guide/configmap/index.md | 3 ++- docs/user-guide/configuring-containers.md | 2 +- docs/user-guide/connecting-applications.md | 2 +- .../connecting-to-applications-port-forward.md | 2 +- .../connecting-to-applications-proxy.md | 2 +- docs/user-guide/container-environment.md | 2 +- docs/user-guide/containers.md | 2 +- docs/user-guide/cron-jobs.md | 2 +- .../debugging-pods-and-replication-controllers.md | 2 +- docs/user-guide/debugging-services.md | 2 +- docs/user-guide/deploying-applications.md | 3 +-- docs/user-guide/deployments.md | 2 +- docs/user-guide/docker-cli-to-kubectl.md | 2 +- docs/user-guide/downward-api/index.md | 2 +- docs/user-guide/downward-api/volume/index.md | 1 + docs/user-guide/environment-guide/index.md | 12 ++++++------ docs/user-guide/federation/configmap.md | 1 + docs/user-guide/federation/daemonsets.md | 1 + docs/user-guide/federation/deployment.md | 1 + docs/user-guide/federation/events.md | 1 + docs/user-guide/federation/federated-ingress.md | 1 + docs/user-guide/federation/federated-services.md | 2 +- docs/user-guide/federation/index.md | 1 + docs/user-guide/federation/namespaces.md | 1 + docs/user-guide/federation/replicasets.md | 1 + docs/user-guide/federation/secrets.md | 1 + docs/user-guide/garbage-collection.md | 2 +- docs/user-guide/getting-into-containers.md | 2 +- .../horizontal-pod-autoscaling/index.md | 2 +- .../horizontal-pod-autoscaling/walkthrough.md | 2 +- docs/user-guide/identifiers.md | 2 +- docs/user-guide/images.md | 2 +- docs/user-guide/index.md | 2 +- docs/user-guide/ingress.md | 2 +- docs/user-guide/introspection-and-debugging.md | 2 +- docs/user-guide/jobs.md | 2 +- docs/user-guide/jobs/expansions/index.md | 1 + docs/user-guide/jobs/work-queue-1/index.md | 1 + docs/user-guide/jobs/work-queue-2/index.md | 1 + docs/user-guide/jsonpath.md | 2 +- docs/user-guide/kubeconfig-file.md | 14 +++++++------- docs/user-guide/kubectl-cheatsheet.md | 2 +- docs/user-guide/kubectl-conventions.md | 2 +- docs/user-guide/kubectl-overview.md | 2 +- docs/user-guide/kubectl/index.md | 2 ++ docs/user-guide/kubectl/kubectl_annotate.md | 2 ++ docs/user-guide/kubectl/kubectl_api-versions.md | 2 ++ docs/user-guide/kubectl/kubectl_apply.md | 2 ++ docs/user-guide/kubectl/kubectl_attach.md | 2 ++ docs/user-guide/kubectl/kubectl_autoscale.md | 2 ++ docs/user-guide/kubectl/kubectl_cluster-info.md | 2 ++ docs/user-guide/kubectl/kubectl_config.md | 2 ++ .../kubectl/kubectl_config_current-context.md | 2 ++ .../kubectl/kubectl_config_set-cluster.md | 2 ++ .../kubectl/kubectl_config_set-context.md | 2 ++ .../kubectl/kubectl_config_set-credentials.md | 2 ++ docs/user-guide/kubectl/kubectl_config_set.md | 2 ++ docs/user-guide/kubectl/kubectl_config_unset.md | 2 ++ .../kubectl/kubectl_config_use-context.md | 2 ++ docs/user-guide/kubectl/kubectl_config_view.md | 2 ++ docs/user-guide/kubectl/kubectl_convert.md | 2 ++ docs/user-guide/kubectl/kubectl_cordon.md | 2 ++ docs/user-guide/kubectl/kubectl_create.md | 2 ++ .../kubectl/kubectl_create_configmap.md | 2 ++ .../kubectl/kubectl_create_namespace.md | 2 ++ docs/user-guide/kubectl/kubectl_create_secret.md | 2 ++ .../kubectl_create_secret_docker-registry.md | 2 ++ .../kubectl/kubectl_create_secret_generic.md | 2 ++ .../kubectl/kubectl_create_serviceaccount.md | 2 ++ docs/user-guide/kubectl/kubectl_delete.md | 2 ++ docs/user-guide/kubectl/kubectl_describe.md | 2 ++ docs/user-guide/kubectl/kubectl_drain.md | 2 ++ docs/user-guide/kubectl/kubectl_edit.md | 2 ++ docs/user-guide/kubectl/kubectl_exec.md | 2 ++ docs/user-guide/kubectl/kubectl_explain.md | 2 ++ docs/user-guide/kubectl/kubectl_expose.md | 2 ++ docs/user-guide/kubectl/kubectl_get.md | 2 ++ docs/user-guide/kubectl/kubectl_label.md | 2 ++ docs/user-guide/kubectl/kubectl_logs.md | 2 ++ docs/user-guide/kubectl/kubectl_patch.md | 2 ++ docs/user-guide/kubectl/kubectl_port-forward.md | 2 ++ docs/user-guide/kubectl/kubectl_proxy.md | 2 ++ docs/user-guide/kubectl/kubectl_replace.md | 2 ++ docs/user-guide/kubectl/kubectl_rolling-update.md | 2 ++ docs/user-guide/kubectl/kubectl_rollout.md | 2 ++ .../user-guide/kubectl/kubectl_rollout_history.md | 2 ++ docs/user-guide/kubectl/kubectl_rollout_pause.md | 2 ++ docs/user-guide/kubectl/kubectl_rollout_resume.md | 2 ++ docs/user-guide/kubectl/kubectl_rollout_undo.md | 2 ++ docs/user-guide/kubectl/kubectl_run.md | 2 ++ docs/user-guide/kubectl/kubectl_scale.md | 2 ++ docs/user-guide/kubectl/kubectl_stop.md | 2 ++ docs/user-guide/kubectl/kubectl_uncordon.md | 2 ++ docs/user-guide/kubectl/kubectl_version.md | 2 ++ docs/user-guide/labels.md | 2 +- docs/user-guide/liveness/index.md | 2 +- docs/user-guide/load-balancer.md | 2 +- docs/user-guide/logging.md | 2 +- docs/user-guide/managing-deployments.md | 3 ++- docs/user-guide/monitoring.md | 2 +- docs/user-guide/namespaces.md | 2 +- docs/user-guide/networkpolicies.md | 2 +- docs/user-guide/node-selection/index.md | 2 +- docs/user-guide/persistent-volumes/index.md | 2 +- docs/user-guide/persistent-volumes/walkthrough.md | 2 +- docs/user-guide/petset.md | 2 +- docs/user-guide/petset/bootstrapping/index.md | 1 + docs/user-guide/pod-security-policy/index.md | 2 +- docs/user-guide/pod-states.md | 2 +- docs/user-guide/pods/index.md | 4 ++-- docs/user-guide/pods/multi-container.md | 2 +- docs/user-guide/pods/single-container.md | 2 +- docs/user-guide/prereqs.md | 2 +- docs/user-guide/production-pods.md | 2 +- docs/user-guide/quick-start.md | 2 +- docs/user-guide/replicasets.md | 2 +- docs/user-guide/replication-controller/index.md | 2 +- .../replication-controller/operations.md | 3 ++- .../resizing-a-replication-controller.md | 2 +- docs/user-guide/rolling-updates.md | 2 +- docs/user-guide/secrets/index.md | 2 +- docs/user-guide/secrets/walkthrough.md | 4 ++-- docs/user-guide/security-context.md | 2 +- docs/user-guide/service-accounts.md | 2 +- docs/user-guide/services-firewalls.md | 2 +- docs/user-guide/services/index.md | 2 +- docs/user-guide/services/operations.md | 3 ++- docs/user-guide/sharing-clusters.md | 2 +- docs/user-guide/simple-nginx.md | 2 +- docs/user-guide/thirdpartyresources.md | 2 +- docs/user-guide/ui.md | 3 +-- docs/user-guide/update-demo/index.md | 15 +++++++-------- docs/user-guide/volumes.md | 2 +- docs/user-guide/working-with-resources.md | 2 +- docs/whatisk8s.md | 3 +-- editdocs.md | 1 + kubernetes/third_party/swagger-ui/index.md | 4 ++++ 291 files changed, 409 insertions(+), 212 deletions(-) diff --git a/docs/admin/accessing-the-api.md b/docs/admin/accessing-the-api.md index cb3f3d4ce4..0e491ccf0d 100644 --- a/docs/admin/accessing-the-api.md +++ b/docs/admin/accessing-the-api.md @@ -3,7 +3,7 @@ assignees: - bgrant0607 - erictune - lavalamp - +title: Overview --- This document describes how access to the Kubernetes API is controlled. diff --git a/docs/admin/addons.md b/docs/admin/addons.md index 1555f8263c..d387c972b6 100644 --- a/docs/admin/addons.md +++ b/docs/admin/addons.md @@ -1,4 +1,5 @@ --- +title: Installing Addons --- ## Overview diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md index 24da796163..475f2e4be9 100644 --- a/docs/admin/admission-controllers.md +++ b/docs/admin/admission-controllers.md @@ -6,7 +6,7 @@ assignees: - erictune - janetkuo - thockin - +title: Using Admission Controllers --- * TOC diff --git a/docs/admin/apparmor/index.md b/docs/admin/apparmor/index.md index 9730c07953..4c2d02d989 100644 --- a/docs/admin/apparmor/index.md +++ b/docs/admin/apparmor/index.md @@ -1,7 +1,7 @@ --- assignees: - stclair - +title: AppArmor --- AppArmor is a Linux kernel enhancement that can reduce the potential attack surface of an diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md index 0cb5ea4dbe..ab41a6fd39 100644 --- a/docs/admin/authentication.md +++ b/docs/admin/authentication.md @@ -5,8 +5,9 @@ assignees: - ericchiang - deads2k - liggitt - +title: Authenticating --- + * TOC {:toc} diff --git a/docs/admin/authorization.md b/docs/admin/authorization.md index f1f46985b2..6f76a1c033 100644 --- a/docs/admin/authorization.md +++ b/docs/admin/authorization.md @@ -4,7 +4,7 @@ assignees: - lavalamp - deads2k - liggitt - +title: Using Authorization Plugins --- In Kubernetes, authorization happens as a separate step from authentication. diff --git a/docs/admin/cluster-components.md b/docs/admin/cluster-components.md index c1bcae8577..0b913d8956 100644 --- a/docs/admin/cluster-components.md +++ b/docs/admin/cluster-components.md @@ -1,7 +1,7 @@ --- assignees: - lavalamp - +title: Kubernetes Components --- This document outlines the various binary components that need to run to diff --git a/docs/admin/cluster-large.md b/docs/admin/cluster-large.md index d2285c3346..f41df12689 100644 --- a/docs/admin/cluster-large.md +++ b/docs/admin/cluster-large.md @@ -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: diff --git a/docs/admin/cluster-management.md b/docs/admin/cluster-management.md index 97362c4bab..b1c4c340a3 100644 --- a/docs/admin/cluster-management.md +++ b/docs/admin/cluster-management.md @@ -2,7 +2,7 @@ assignees: - lavalamp - thockin - +title: Cluster Management Guide --- * TOC diff --git a/docs/admin/cluster-troubleshooting.md b/docs/admin/cluster-troubleshooting.md index 8bab089ce6..89cd99926b 100644 --- a/docs/admin/cluster-troubleshooting.md +++ b/docs/admin/cluster-troubleshooting.md @@ -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 diff --git a/docs/admin/daemons.md b/docs/admin/daemons.md index bab12268ba..fd2bc8afcb 100644 --- a/docs/admin/daemons.md +++ b/docs/admin/daemons.md @@ -1,7 +1,7 @@ --- assignees: - erictune - +title: Daemon Sets --- * TOC diff --git a/docs/admin/dns.md b/docs/admin/dns.md index 6115be7363..6ed558859b 100644 --- a/docs/admin/dns.md +++ b/docs/admin/dns.md @@ -3,7 +3,7 @@ assignees: - ArtfulCoder - davidopp - lavalamp - +title: Using DNS Pods and Services --- ## Introduction diff --git a/docs/admin/etcd.md b/docs/admin/etcd.md index 14b36a33be..ea4f6b09b3 100644 --- a/docs/admin/etcd.md +++ b/docs/admin/etcd.md @@ -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. diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md index 9236c62d38..77b066854c 100644 --- a/docs/admin/federation-apiserver.md +++ b/docs/admin/federation-apiserver.md @@ -1,5 +1,7 @@ --- +title: federation-apiserver --- + ## federation-apiserver diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md index a65bbef5f3..5e87fce3d0 100644 --- a/docs/admin/federation-controller-manager.md +++ b/docs/admin/federation-controller-manager.md @@ -1,5 +1,7 @@ --- +title: federation-controller-mananger --- + ## federation-controller-manager diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md index ec40d581bb..478f7563de 100644 --- a/docs/admin/federation/index.md +++ b/docs/admin/federation/index.md @@ -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. diff --git a/docs/admin/garbage-collection.md b/docs/admin/garbage-collection.md index a3112a07f1..0276596f6c 100644 --- a/docs/admin/garbage-collection.md +++ b/docs/admin/garbage-collection.md @@ -1,7 +1,7 @@ --- assignees: - mikedanese - +title: Configuring kubelet Garbage Collection --- * TOC diff --git a/docs/admin/high-availability/index.md b/docs/admin/high-availability/index.md index ad78270e4a..42e51d3d51 100644 --- a/docs/admin/high-availability/index.md +++ b/docs/admin/high-availability/index.md @@ -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. diff --git a/docs/admin/index.md b/docs/admin/index.md index 3624bb4202..98f38b428a 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -2,7 +2,7 @@ assignees: - davidopp - lavalamp - +title: Admin Guide --- The cluster admin guide is for anyone creating or administering a Kubernetes cluster. diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md index 12d2b76a49..e8142fac4e 100644 --- a/docs/admin/kube-apiserver.md +++ b/docs/admin/kube-apiserver.md @@ -1,5 +1,7 @@ --- +title: kube-apiserver --- + ## kube-apiserver diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md index 68cca731e7..5dab0da7e2 100644 --- a/docs/admin/kube-controller-manager.md +++ b/docs/admin/kube-controller-manager.md @@ -1,5 +1,7 @@ --- +title: kube-controller-manager --- + ## kube-controller-manager diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md index 491a91d06e..f643748624 100644 --- a/docs/admin/kube-proxy.md +++ b/docs/admin/kube-proxy.md @@ -1,5 +1,7 @@ --- +title: kube-proxy --- + ## kube-proxy diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md index 9b4d7264e6..bb6799bb73 100644 --- a/docs/admin/kube-scheduler.md +++ b/docs/admin/kube-scheduler.md @@ -1,5 +1,7 @@ --- +title: kube-scheduler --- + ## kube-scheduler diff --git a/docs/admin/kubeadm.md b/docs/admin/kubeadm.md index e1c8537149..3dc59fd2d6 100644 --- a/docs/admin/kubeadm.md +++ b/docs/admin/kubeadm.md @@ -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 diff --git a/docs/admin/kubelet-authentication-authorization.md b/docs/admin/kubelet-authentication-authorization.md index b0617b8854..035f3068fa 100644 --- a/docs/admin/kubelet-authentication-authorization.md +++ b/docs/admin/kubelet-authentication-authorization.md @@ -1,7 +1,7 @@ --- assignees: - liggitt - +title: Kubelet authentication/authorization --- * TOC diff --git a/docs/admin/kubelet-tls-bootstrapping.md b/docs/admin/kubelet-tls-bootstrapping.md index 3458bdb310..f8d56923ee 100644 --- a/docs/admin/kubelet-tls-bootstrapping.md +++ b/docs/admin/kubelet-tls-bootstrapping.md @@ -1,7 +1,7 @@ --- assignees: - mikedanese - +title: TLS bootstrapping --- * TOC diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index a3004ea1aa..74186eb1ba 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -1,5 +1,7 @@ --- +title: Overview --- + ## kubelet diff --git a/docs/admin/limitrange/index.md b/docs/admin/limitrange/index.md index 0336264bc3..767513a1a3 100644 --- a/docs/admin/limitrange/index.md +++ b/docs/admin/limitrange/index.md @@ -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 diff --git a/docs/admin/master-node-communication.md b/docs/admin/master-node-communication.md index 9e8b9cfa9e..91ecff7ef9 100644 --- a/docs/admin/master-node-communication.md +++ b/docs/admin/master-node-communication.md @@ -3,7 +3,7 @@ assignees: - dchen1107 - roberthbailey - liggitt - +title: Master-Node communication --- * TOC diff --git a/docs/admin/multi-cluster.md b/docs/admin/multi-cluster.md index 6359782409..1d238d8e13 100644 --- a/docs/admin/multi-cluster.md +++ b/docs/admin/multi-cluster.md @@ -1,7 +1,7 @@ --- assignees: - davidopp - +title: Using Multiple Clusters --- You may want to set up multiple Kubernetes clusters, both to diff --git a/docs/admin/multiple-schedulers.md b/docs/admin/multiple-schedulers.md index 8ba152ac04..eb1c4c44f9 100644 --- a/docs/admin/multiple-schedulers.md +++ b/docs/admin/multiple-schedulers.md @@ -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/). diff --git a/docs/admin/multiple-zones.md b/docs/admin/multiple-zones.md index bfde54213e..e215b31716 100644 --- a/docs/admin/multiple-zones.md +++ b/docs/admin/multiple-zones.md @@ -3,7 +3,7 @@ assignees: - jlowdermilk - justinsb - quinton-hoole - +title: Running in Multiple Zones --- ## Introduction diff --git a/docs/admin/namespaces/index.md b/docs/admin/namespaces/index.md index 574f41b10a..b723a9c361 100644 --- a/docs/admin/namespaces/index.md +++ b/docs/admin/namespaces/index.md @@ -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 diff --git a/docs/admin/namespaces/walkthrough.md b/docs/admin/namespaces/walkthrough.md index 2a3e6298ea..9faecf89e9 100644 --- a/docs/admin/namespaces/walkthrough.md +++ b/docs/admin/namespaces/walkthrough.md @@ -2,7 +2,7 @@ assignees: - derekwaynecarr - janetkuo - +title: Namespaces Walkthrough --- Kubernetes _namespaces_ help different projects, teams, or customers to share a Kubernetes cluster. diff --git a/docs/admin/network-plugins.md b/docs/admin/network-plugins.md index 6c5f354423..6b80f1a002 100644 --- a/docs/admin/network-plugins.md +++ b/docs/admin/network-plugins.md @@ -3,7 +3,7 @@ assignees: - dcbw - freehan - thockin - +title: Network Plugins --- * TOC diff --git a/docs/admin/networking.md b/docs/admin/networking.md index 9b77b3557a..231b7b315d 100644 --- a/docs/admin/networking.md +++ b/docs/admin/networking.md @@ -2,7 +2,7 @@ assignees: - lavalamp - thockin - +title: Networking in Kubernetes --- Kubernetes approaches networking somewhat differently than Docker does by diff --git a/docs/admin/node-conformance.md b/docs/admin/node-conformance.md index 52935bc4cc..f53ba858b1 100644 --- a/docs/admin/node-conformance.md +++ b/docs/admin/node-conformance.md @@ -1,7 +1,7 @@ --- assignees: - Random-Liu - +title: Validate Node Setup --- * TOC diff --git a/docs/admin/node-problem.md b/docs/admin/node-problem.md index b6926ba15b..0d7b57005e 100644 --- a/docs/admin/node-problem.md +++ b/docs/admin/node-problem.md @@ -2,7 +2,7 @@ assignees: - Random-Liu - dchen1107 - +title: Monitoring Node Health --- * TOC diff --git a/docs/admin/node.md b/docs/admin/node.md index ad0867ffc8..3c3e16178d 100644 --- a/docs/admin/node.md +++ b/docs/admin/node.md @@ -3,7 +3,7 @@ assignees: - caesarxuchao - dchen1107 - lavalamp - +title: Nodes --- * TOC diff --git a/docs/admin/out-of-resource.md b/docs/admin/out-of-resource.md index 8af7114ed6..a663703d9c 100644 --- a/docs/admin/out-of-resource.md +++ b/docs/admin/out-of-resource.md @@ -3,7 +3,7 @@ assignees: - derekwaynecarr - vishh - timstclair - +title: Configuring Out Of Resource Handling --- * TOC diff --git a/docs/admin/ovs-networking.md b/docs/admin/ovs-networking.md index 7a8f89506c..9370dcec46 100644 --- a/docs/admin/ovs-networking.md +++ b/docs/admin/ovs-networking.md @@ -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. diff --git a/docs/admin/resourcequota/index.md b/docs/admin/resourcequota/index.md index ff76942702..c967975dec 100644 --- a/docs/admin/resourcequota/index.md +++ b/docs/admin/resourcequota/index.md @@ -1,7 +1,7 @@ --- assignees: - derekwaynecarr - +title: Resource Quotas --- When several users or teams share a cluster with a fixed number of nodes, diff --git a/docs/admin/resourcequota/walkthrough.md b/docs/admin/resourcequota/walkthrough.md index 7422f2abcf..d5ef21ff6c 100644 --- a/docs/admin/resourcequota/walkthrough.md +++ b/docs/admin/resourcequota/walkthrough.md @@ -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. diff --git a/docs/admin/salt.md b/docs/admin/salt.md index 5d82b54d39..ba4d4fe227 100644 --- a/docs/admin/salt.md +++ b/docs/admin/salt.md @@ -2,7 +2,7 @@ assignees: - davidopp - lavalamp - +title: Configuring Kubernetes with Salt --- The Kubernetes cluster can be configured using Salt. diff --git a/docs/admin/service-accounts-admin.md b/docs/admin/service-accounts-admin.md index 810f4d7515..4a31fbeced 100644 --- a/docs/admin/service-accounts-admin.md +++ b/docs/admin/service-accounts-admin.md @@ -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 diff --git a/docs/admin/static-pods.md b/docs/admin/static-pods.md index 531494fb04..36235929a3 100644 --- a/docs/admin/static-pods.md +++ b/docs/admin/static-pods.md @@ -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/)!** diff --git a/docs/api-reference/autoscaling/v1/definitions.html b/docs/api-reference/autoscaling/v1/definitions.html index 949fa2e507..768d4e1543 100755 --- a/docs/api-reference/autoscaling/v1/definitions.html +++ b/docs/api-reference/autoscaling/v1/definitions.html @@ -1,5 +1,7 @@ --- +title: Autoscaling API Definitions --- + diff --git a/docs/api-reference/autoscaling/v1/operations.html b/docs/api-reference/autoscaling/v1/operations.html index 0e38da7627..cfc457d1e5 100755 --- a/docs/api-reference/autoscaling/v1/operations.html +++ b/docs/api-reference/autoscaling/v1/operations.html @@ -1,5 +1,7 @@ --- +title: Autoscaling API Operations --- + diff --git a/docs/api-reference/batch/v1/definitions.html b/docs/api-reference/batch/v1/definitions.html index be391e4acd..9989f4c4ca 100755 --- a/docs/api-reference/batch/v1/definitions.html +++ b/docs/api-reference/batch/v1/definitions.html @@ -1,5 +1,7 @@ --- +title: Batch API Definitions --- + diff --git a/docs/api-reference/batch/v1/operations.html b/docs/api-reference/batch/v1/operations.html index 691318f810..5be3ce0b60 100755 --- a/docs/api-reference/batch/v1/operations.html +++ b/docs/api-reference/batch/v1/operations.html @@ -1,5 +1,7 @@ --- +title: Batch API Operations --- + diff --git a/docs/api-reference/extensions/v1beta1/definitions.html b/docs/api-reference/extensions/v1beta1/definitions.html index 3863ee11f8..b92378524f 100755 --- a/docs/api-reference/extensions/v1beta1/definitions.html +++ b/docs/api-reference/extensions/v1beta1/definitions.html @@ -1,5 +1,7 @@ --- +title: Extensions API Definitions --- + diff --git a/docs/api-reference/extensions/v1beta1/operations.html b/docs/api-reference/extensions/v1beta1/operations.html index c1d9c191ec..a97f64b789 100755 --- a/docs/api-reference/extensions/v1beta1/operations.html +++ b/docs/api-reference/extensions/v1beta1/operations.html @@ -1,5 +1,7 @@ --- +title: Extensions API Operations --- + diff --git a/docs/api-reference/v1/definitions.html b/docs/api-reference/v1/definitions.html index 6c2515eeaa..e207f68c0a 100755 --- a/docs/api-reference/v1/definitions.html +++ b/docs/api-reference/v1/definitions.html @@ -1,5 +1,7 @@ --- +title: Kubernetes API Definitions --- + diff --git a/docs/api-reference/v1/operations.html b/docs/api-reference/v1/operations.html index dfdb663b8b..f75e9a44f5 100755 --- a/docs/api-reference/v1/operations.html +++ b/docs/api-reference/v1/operations.html @@ -1,5 +1,7 @@ --- +title: Kubernetes API Operations --- + diff --git a/docs/api.md b/docs/api.md index 3479dbff94..7964f604d0 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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/). diff --git a/docs/concepts/abstractions/controllers/statefulsets.md b/docs/concepts/abstractions/controllers/statefulsets.md index 01825fc257..6f8e9629c3 100644 --- a/docs/concepts/abstractions/controllers/statefulsets.md +++ b/docs/concepts/abstractions/controllers/statefulsets.md @@ -7,6 +7,7 @@ assignees: - janetkuo - kow3ns - smarterclayton +title: StatefulSets --- {% capture overview %} diff --git a/docs/concepts/index.md b/docs/concepts/index.md index 72d1ecebb2..c26b972202 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -1,4 +1,5 @@ --- +title: Concepts --- The Concepts section of the Kubernetes documentation is a work in progress. diff --git a/docs/concepts/object-metadata/annotations.md b/docs/concepts/object-metadata/annotations.md index e337493fe1..fbf73f48fd 100644 --- a/docs/concepts/object-metadata/annotations.md +++ b/docs/concepts/object-metadata/annotations.md @@ -1,4 +1,5 @@ --- +title: Annotations --- {% capture overview %} diff --git a/docs/contribute/create-pull-request.md b/docs/contribute/create-pull-request.md index e74b49436e..4637c0b066 100644 --- a/docs/contribute/create-pull-request.md +++ b/docs/contribute/create-pull-request.md @@ -1,4 +1,5 @@ --- +title: Creating a Documentation Pull Request --- {% capture overview %} diff --git a/docs/contribute/page-templates.md b/docs/contribute/page-templates.md index 4b19cde39b..93fa03a6bb 100644 --- a/docs/contribute/page-templates.md +++ b/docs/contribute/page-templates.md @@ -1,7 +1,8 @@ --- redirect_from: - - /docs/templatedemos/ - - /docs/templatedemos.html +- "/docs/templatedemos/" +- "/docs/templatedemos.html" +title: Using Page Templates --- diff --git a/kubernetes/third_party/swagger-ui/index.md b/kubernetes/third_party/swagger-ui/index.md index c481f993f3..425a061477 100644 --- a/kubernetes/third_party/swagger-ui/index.md +++ b/kubernetes/third_party/swagger-ui/index.md @@ -1,3 +1,7 @@ +--- +title: Kubernetes API Swagger Spec +--- + --- Kubernetes swagger UI has now been replaced by our generated API reference docs From b301f4ad3a6f737d06f8653abc6b059bb179206d Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Thu, 15 Dec 2016 17:06:04 -0500 Subject: [PATCH 2/6] add notitle attribute to pages that shouldnt have a title --- docs/admin/federation-apiserver.md | 1 + docs/admin/federation-controller-manager.md | 1 + docs/admin/kube-apiserver.md | 1 + docs/admin/kube-controller-manager.md | 1 + docs/admin/kube-proxy.md | 1 + docs/admin/kube-scheduler.md | 1 + docs/admin/kubelet.md | 1 + 7 files changed, 7 insertions(+) diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md index 77b066854c..72d71547c7 100644 --- a/docs/admin/federation-apiserver.md +++ b/docs/admin/federation-apiserver.md @@ -1,5 +1,6 @@ --- title: federation-apiserver +notitle: true --- ## federation-apiserver diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md index 5e87fce3d0..d3dca5bf06 100644 --- a/docs/admin/federation-controller-manager.md +++ b/docs/admin/federation-controller-manager.md @@ -1,5 +1,6 @@ --- title: federation-controller-mananger +notitle: true --- ## federation-controller-manager diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md index e8142fac4e..bc08ef1f0a 100644 --- a/docs/admin/kube-apiserver.md +++ b/docs/admin/kube-apiserver.md @@ -1,5 +1,6 @@ --- title: kube-apiserver +notitle: true --- ## kube-apiserver diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md index 5dab0da7e2..f6f11c5f37 100644 --- a/docs/admin/kube-controller-manager.md +++ b/docs/admin/kube-controller-manager.md @@ -1,5 +1,6 @@ --- title: kube-controller-manager +notitle: true --- ## kube-controller-manager diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md index f643748624..31d3263b5d 100644 --- a/docs/admin/kube-proxy.md +++ b/docs/admin/kube-proxy.md @@ -1,5 +1,6 @@ --- title: kube-proxy +notitle: true --- ## kube-proxy diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md index bb6799bb73..6d3b8c9f64 100644 --- a/docs/admin/kube-scheduler.md +++ b/docs/admin/kube-scheduler.md @@ -1,5 +1,6 @@ --- title: kube-scheduler +notitle: true --- ## kube-scheduler diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index 74186eb1ba..b272f869ab 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -1,5 +1,6 @@ --- title: Overview +notitle: true --- ## kubelet From d8d99a171e577b27c4fe5bcc3ee3a107dd4490ba Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Mon, 19 Dec 2016 15:08:54 -0500 Subject: [PATCH 3/6] use in-page titles to generate sidebar nav --- Gemfile | 1 + Gemfile.lock | 3 + _config.yml | 13 + _data/concepts.yml | 9 +- _data/docs-home.yml | 3 +- _data/guides.yml | 372 +++++++++---------------- _data/reference.yml | 354 ++++++++--------------- _data/samples.yml | 6 +- _data/support.yml | 42 +-- _data/tasks.yml | 57 ++-- _data/tools.yml | 3 +- _data/tutorials.yml | 63 ++--- _includes/head-header.html | 1 - _includes/tocsearch.html | 16 +- _includes/tree.html | 32 ++- _layouts/docwithnav.html | 64 +++-- docs/user-guide/index.md | 4 +- docs/user-guide/kubectl/kubectl_get.md | 16 +- 18 files changed, 409 insertions(+), 650 deletions(-) diff --git a/Gemfile b/Gemfile index 0c8671cdee..3a9bc43ce1 100644 --- a/Gemfile +++ b/Gemfile @@ -1,3 +1,4 @@ source "https://rubygems.org" gem "github-pages", group: :jekyll_plugins +gem "jekyll-include-cache" diff --git a/Gemfile.lock b/Gemfile.lock index 4d72be803d..cd6d47a90f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -86,6 +86,8 @@ GEM jekyll-github-metadata (2.2.0) jekyll (~> 3.1) octokit (~> 4.0, != 4.4.0) + jekyll-include-cache (0.1.0) + jekyll (~> 3.3) jekyll-mentions (1.2.0) activesupport (~> 4.0) html-pipeline (~> 2.3) @@ -159,6 +161,7 @@ PLATFORMS DEPENDENCIES github-pages + jekyll-include-cache BUNDLED WITH 1.13.6 diff --git a/_config.yml b/_config.yml index 8b131eb433..d8aab803b3 100644 --- a/_config.yml +++ b/_config.yml @@ -34,8 +34,21 @@ gems: - jekyll-feed - jekyll-sitemap - jekyll-seo-tag + - jekyll-include-cache # SEO logo: /images/favicon.png twitter: username: kubernetesio + +# Tables of contents, stored in the _data folder, that control the sidebar nav +tocs: + - docs-home + - guides + - tutorials + - tasks + - concepts + - reference + - tools + - samples + - support diff --git a/_data/concepts.yml b/_data/concepts.yml index 93c790c0ab..a9a7c3eb29 100644 --- a/_data/concepts.yml +++ b/_data/concepts.yml @@ -1,13 +1,10 @@ bigheader: "Concepts" abstract: "Detailed explanations of Kubernetes system concepts and abstractions." toc: -- title: Concepts - path: /docs/concepts/ +- docs/concepts/index.md - title: Object Metadata section: - - title: Annotations - path: /docs/concepts/object-metadata/annotations/ + - docs/concepts/object-metadata/annotations.md - title: Controllers section: - - title: StatefulSets - path: /docs/concepts/abstractions/controllers/statefulsets/ + - docs/concepts/abstractions/controllers/statefulsets.md diff --git a/_data/docs-home.yml b/_data/docs-home.yml index 1cb8c9b05a..b80c025d5e 100644 --- a/_data/docs-home.yml +++ b/_data/docs-home.yml @@ -1,5 +1,4 @@ bigheader: "Kubernetes Documentation" abstract: "Documentation for using and learning about Kubernetes." toc: -- title: Kubernetes Documentation - path: /docs/ +- docs/index.md diff --git a/_data/guides.yml b/_data/guides.yml index 583deaeedd..179be261d7 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -1,311 +1,187 @@ bigheader: "Guides" abstract: "How to get started, and accomplish tasks, using Kubernetes." toc: -- title: Guides - path: /docs/user-guide/ +- docs/user-guide/index.md - title: Getting Started section: - - title: What is Kubernetes? - path: /docs/whatisk8s/ - - title: Installing Kubernetes on Linux with kubeadm - path: /docs/getting-started-guides/kubeadm/ - - title: Installing Kubernetes on AWS with kops - path: /docs/getting-started-guides/kops/ - - title: Hello World on Google Container Engine - path: /docs/hellonode/ - - title: Installing kubectl - path: /docs/getting-started-guides/kubectl/ - - title: Downloading or Building Kubernetes - path: /docs/getting-started-guides/binary_release/ + - docs/whatisk8s.md + - docs/getting-started-guides/kubeadm.md + - docs/getting-started-guides/kops.md + - docs/hellonode.md + - docs/getting-started-guides/kubectl.md + - docs/getting-started-guides/binary_release.md - title: Online Training Course path: https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615 - title: Accessing the Cluster section: - - title: Installing and Setting up kubectl - path: /docs/user-guide/prereqs/ - - title: Accessing Clusters - path: /docs/user-guide/accessing-the-cluster/ - - title: Sharing Cluster Access with kubeconfig - path: /docs/user-guide/sharing-clusters/ - - title: Authenticating Across Clusters with kubeconfig - path: /docs/user-guide/kubeconfig-file/ + - docs/user-guide/prereqs.md + - docs/user-guide/accessing-the-cluster.md + - docs/user-guide/sharing-clusters.md + - docs/user-guide/kubeconfig-file.md -- title: User Guide - path: /docs/user-guide/ +- docs/user-guide/index.md -- title: Web UI (Dashboard) - path: /docs/user-guide/ui/ +- docs/user-guide/ui.md - title: Workload Deployment and Management section: - - title: Launching, Exposing, and Killing Applications - path: /docs/user-guide/quick-start/ - - title: Deploying Applications - path: /docs/user-guide/deploying-applications/ - - title: Managing Resources - path: /docs/user-guide/managing-deployments/ - - title: Replication Controller Operations - path: /docs/user-guide/replication-controller/operations/ - - title: Resizing a Replication Controller - path: /docs/user-guide/resizing-a-replication-controller/ - - title: Rolling Updates - path: /docs/user-guide/rolling-updates/ - - title: Rolling Update Demo - path: /docs/user-guide/update-demo/ - - title: Secrets Walkthrough - path: /docs/user-guide/secrets/walkthrough/ - - title: Using ConfigMap - path: /docs/user-guide/configmap/ - - title: Horizontal Pod Autoscaling - path: /docs/user-guide/horizontal-pod-autoscaling/walkthrough/ - - title: Best Practices for Configuration - path: /docs/user-guide/config-best-practices/ - - title: Using kubectl to Manage Resources - path: /docs/user-guide/working-with-resources/ - - title: Garbage Collection (Beta) - path: /docs/user-guide/garbage-collection/ + - docs/user-guide/quick-start.md + - docs/user-guide/deploying-applications.md + - docs/user-guide/managing-deployments.md + - docs/user-guide/replication-controller/operations.md + - docs/user-guide/resizing-a-replication-controller.md + - docs/user-guide/rolling-updates.md + - docs/user-guide/update-demo/index.md + - docs/user-guide/secrets/walkthrough.md + - docs/user-guide/configmap/index.md + - docs/user-guide/horizontal-pod-autoscaling/walkthrough.md + - docs/user-guide/config-best-practices.md + - docs/user-guide/working-with-resources.md + - docs/user-guide/garbage-collection.md - title: Using NetworkPolicy section: - - title: Example Walkthrough - path: /docs/getting-started-guides/network-policy/walkthrough/ - - title: Using Calico for NetworkPolicy - path: /docs/getting-started-guides/network-policy/calico/ - - title: Using Romana for NetworkPolicy - path: /docs/getting-started-guides/network-policy/romana/ + - docs/getting-started-guides/network-policy/walkthrough.md + - docs/getting-started-guides/network-policy/calico.md + - docs/getting-started-guides/network-policy/romana.md - title: Batch Jobs section: - - title: Jobs - path: /docs/user-guide/jobs/ - - title: Parallel Processing using Expansions - path: /docs/user-guide/jobs/expansions/ - - title: Coarse Parallel Processing using a Work Queue - path: /docs/user-guide/jobs/work-queue-1/ - - title: Fine Parallel Processing using a Work Queue - path: /docs/user-guide/jobs/work-queue-2/ - - title: Cron Jobs - path: /docs/user-guide/cron-jobs/ + - docs/user-guide/jobs.md + - docs/user-guide/jobs/expansions/index.md + - docs/user-guide/jobs/work-queue-1/index.md + - docs/user-guide/jobs/work-queue-2/index.md + - docs/user-guide/cron-jobs.md - title: Service Discovery and Load Balancing section: - - title: Connecting Applications with Services - path: /docs/user-guide/connecting-applications/ - - title: Service Operations - path: /docs/user-guide/services/operations/ - - title: Creating an External Load Balancer - path: /docs/user-guide/load-balancer/ - - title: Configuring Your Cloud Provider's Firewalls - path: /docs/user-guide/services-firewalls/ - - title: Cross-cluster Service Discovery using Federated Services - path: /docs/user-guide/federation/federated-services/ + - docs/user-guide/connecting-applications.md + - docs/user-guide/services/operations.md + - docs/user-guide/load-balancer.md + - docs/user-guide/services-firewalls.md + - docs/user-guide/federation/federated-services.md - title: Containers and Pods section: - - title: Running Your First Containers - path: /docs/user-guide/simple-nginx/ - - title: Creating Single-Container Pods - path: /docs/user-guide/pods/single-container/ - - title: Creating Multi-Container Pods - path: /docs/user-guide/pods/multi-container/ - - title: Configuring Containers - path: /docs/user-guide/configuring-containers/ - - title: Working with Containers in Production - path: /docs/user-guide/production-pods/ - - title: Commands and Capabilities - path: /docs/user-guide/containers/ - - title: Using Environment Variables - path: /docs/user-guide/environment-guide/ - - title: Managing Compute Resources - path: /docs/user-guide/compute-resources/ - - title: The Lifecycle of a Pod - path: /docs/user-guide/pod-states/ - - title: Checking Pod Health - path: /docs/user-guide/liveness/ - - title: Container Lifecycle Hooks - path: /docs/user-guide/container-environment/ - - title: Assigning Pods to Nodes - path: /docs/user-guide/node-selection/ - - title: Using the Downward API to Convey Pod Properties - path: /docs/user-guide/downward-api/ - - title: Downward API Volumes - path: /docs/user-guide/downward-api/volume - - title: Persistent Volumes Walkthrough - path: /docs/user-guide/persistent-volumes/walkthrough/ - - title: Bootstrapping Pet Sets - path: /docs/user-guide/petset/bootstrapping/ + - docs/user-guide/simple-nginx.md + - docs/user-guide/pods/single-container.md + - docs/user-guide/pods/multi-container.md + - docs/user-guide/configuring-containers.md + - docs/user-guide/production-pods.md + - docs/user-guide/containers.md + - docs/user-guide/environment-guide/index.md + - docs/user-guide/compute-resources.md + - docs/user-guide/pod-states.md + - docs/user-guide/liveness/index.md + - docs/user-guide/container-environment.md + - docs/user-guide/node-selection/index.md + - docs/user-guide/downward-api/index.md + - docs/user-guide/downward-api/volume/index.md + - docs/user-guide/persistent-volumes/walkthrough.md + - docs/user-guide/petset/bootstrapping/index.md - title: Monitoring, Logging, and Debugging Containers section: - - title: Resource Usage Monitoring - path: /docs/user-guide/monitoring/ - - title: Logging - path: /docs/getting-started-guides/logging/ - - title: Logging with Elasticsearch and Kibana - path: /docs/getting-started-guides/logging-elasticsearch/ - - title: Running Commands in a Container with kubectl exec - path: /docs/user-guide/getting-into-containers/ - - title: Connect with Proxies - path: /docs/user-guide/connecting-to-applications-proxy/ - - title: Connect with Port Forwarding - path: /docs/user-guide/connecting-to-applications-port-forward/ + - docs/user-guide/monitoring.md + - docs/getting-started-guides/logging.md + - docs/getting-started-guides/logging-elasticsearch.md + - docs/user-guide/getting-into-containers.md + - docs/user-guide/connecting-to-applications-proxy.md + - docs/user-guide/connecting-to-applications-port-forward.md - title: Using Explorer to Examine the Runtime Environment path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/explorer - title: Creating a Cluster section: - - title: Picking the Right Solution - path: /docs/getting-started-guides/ + - docs/getting-started-guides/index.md - title: Running Kubernetes on Your Local Machine section: - - title: Running Kubernetes Locally via Minikube - path: /docs/getting-started-guides/minikube/ - - title: Deprecated Alternatives - path: /docs/getting-started-guides/alternatives/ + - docs/getting-started-guides/minikube.md + - docs/getting-started-guides/alternatives.md - title: Running Kubernetes on Turn-key Cloud Solutions section: - title: Running Kubernetes on Google Container Engine path: https://cloud.google.com/container-engine/docs/before-you-begin/ - - title: Running Kubernetes on Google Compute Engine - path: /docs/getting-started-guides/gce/ - - title: Running Kubernetes on AWS EC2 - path: /docs/getting-started-guides/aws/ - - title: Running Kubernetes on Azure - path: /docs/getting-started-guides/azure/ - - title: Running Kubernetes on Azure (Weave-based) - path: /docs/getting-started-guides/coreos/azure/ - - title: Running Kubernetes on CenturyLink Cloud - path: /docs/getting-started-guides/clc/ + - docs/getting-started-guides/gce.md + - docs/getting-started-guides/aws.md + - docs/getting-started-guides/azure.md + - docs/getting-started-guides/coreos/azure/index.md + - docs/getting-started-guides/clc.md - title: Running Kubernetes on IBM SoftLayer path: https://github.com/patrocinio/kubernetes-softlayer - title: Running Kubernetes on Custom Solutions section: - - title: Creating a Custom Cluster from Scratch - path: /docs/getting-started-guides/scratch/ + - docs/getting-started-guides/scratch.md - title: Custom Cloud Solutions section: - - title: CoreOS on AWS or GCE - path: /docs/getting-started-guides/coreos/ - - title: Ubuntu on AWS or Joyent - path: /docs/getting-started-guides/juju/ - - title: CoreOS on Rackspace - path: /docs/getting-started-guides/rackspace/ + - docs/getting-started-guides/coreos/index.md + - /docs/getting-started-guides/juju/ + - docs/getting-started-guides/rackspace.md - title: On-Premise VMs section: - - title: CoreOS on Vagrant - path: /docs/getting-started-guides/coreos/ - - title: Cloudstack - path: /docs/getting-started-guides/cloudstack/ - - title: VMware vSphere - path: /docs/getting-started-guides/vsphere/ - - title: VMware Photon Controller - path: /docs/getting-started-guides/photon-controller/ - - title: Juju - path: /docs/getting-started-guides/juju/ - - title: DCOS - path: /docs/getting-started-guides/dcos/ - - title: CoreOS on libvirt - path: /docs/getting-started-guides/libvirt-coreos/ - - title: oVirt - path: /docs/getting-started-guides/ovirt/ - - title: OpenStack Heat - path: /docs/getting-started-guides/openstack-heat/ + - docs/getting-started-guides/coreos/index.md + - docs/getting-started-guides/cloudstack.md + - docs/getting-started-guides/vsphere.md + - docs/getting-started-guides/photon-controller.md + - /docs/getting-started-guides/juju/ + - docs/getting-started-guides/dcos.md + - docs/getting-started-guides/libvirt-coreos.md + - docs/getting-started-guides/ovirt.md + - docs/getting-started-guides/openstack-heat.md - title: rkt section: - - title: Running Kubernetes with rkt - path: /docs/getting-started-guides/rkt/ - - title: Known Issues when Using rkt - path: /docs/getting-started-guides/rkt/notes/ - - title: Kubernetes on Mesos - path: /docs/getting-started-guides/mesos/ - - title: Kubernetes on Mesos on Docker - path: /docs/getting-started-guides/mesos-docker/ + - docs/getting-started-guides/rkt/index.md + - docs/getting-started-guides/rkt/notes.md + - docs/getting-started-guides/mesos/index.md + - docs/getting-started-guides/mesos-docker.md - title: Bare Metal section: - - title: Offline - path: /docs/getting-started-guides/coreos/bare_metal_offline/ - - title: Fedora via Ansible - path: /docs/getting-started-guides/fedora/fedora_ansible_config/ - - title: Fedora (Single Node) - path: /docs/getting-started-guides/fedora/fedora_manual_config/ - - title: Fedora (Multi Node) - path: /docs/getting-started-guides/fedora/flannel_multi_node_cluster/ - - title: CentOS - path: /docs/getting-started-guides/centos/centos_manual_config/ - - title: CoreOS - path: /docs/getting-started-guides/coreos - - title: Ubuntu - path: /docs/getting-started-guides/ubuntu/ - - title: Windows Server Containers - path: /docs/getting-started-guides/windows/ - - title: Validate Node Setup - path: /docs/admin/node-conformance - - title: Portable Multi-Node Cluster - path: /docs/getting-started-guides/docker-multinode/ - - title: Building Large Clusters - path: /docs/admin/cluster-large/ - - title: Running in Multiple Zones - path: /docs/admin/multiple-zones/ - - title: Building High-Availability Clusters - path: /docs/admin/high-availability/ + - docs/getting-started-guides/coreos/bare_metal_offline.md + - docs/getting-started-guides/fedora/fedora_ansible_config.md + - docs/getting-started-guides/fedora/fedora_manual_config.md + - docs/getting-started-guides/fedora/flannel_multi_node_cluster.md + - docs/getting-started-guides/centos/centos_manual_config.md + - docs/getting-started-guides/coreos/index.md + - /docs/getting-started-guides/ubuntu/ + - docs/getting-started-guides/windows/index.md + - docs/admin/node-conformance.md + - docs/getting-started-guides/docker-multinode.md + - docs/admin/cluster-large.md + - docs/admin/multiple-zones.md + - docs/admin/high-availability/index.md - title: Administering Clusters section: - - title: Admin Guide - path: /docs/admin/ - - title: Cluster Management Guide - path: /docs/admin/cluster-management/ - - title: kubeadm reference - path: /docs/admin/kubeadm/ - - title: Installing Addons - path: /docs/admin/addons/ - - title: Sharing a Cluster with Namespaces - path: /docs/admin/namespaces/ - - title: Namespaces Walkthrough - path: /docs/admin/namespaces/walkthrough/ - - title: Setting Pod CPU and Memory Limits - path: /docs/admin/limitrange/ - - title: Understanding Resource Quotas - path: /docs/admin/resourcequota/ - - title: Applying Resource Quotas and Limits - path: /docs/admin/resourcequota/walkthrough/ - - title: Kubernetes Components - path: /docs/admin/cluster-components/ - - title: Configuring Kubernetes Use of etcd - path: /docs/admin/etcd/ - - title: Using Multiple Clusters - path: /docs/admin/multi-cluster/ + - docs/admin/index.md + - docs/admin/cluster-management.md + - docs/admin/kubeadm.md + - docs/admin/addons.md + - docs/admin/namespaces/index.md + - docs/admin/namespaces/walkthrough.md + - docs/admin/limitrange/index.md + - docs/admin/resourcequota/index.md + - docs/admin/resourcequota/walkthrough.md + - docs/admin/cluster-components.md + - docs/admin/etcd.md + - docs/admin/multi-cluster.md - title: Changing Cluster Size path: https://github.com/kubernetes/kubernetes/wiki/User-FAQ#how-do-i-change-the-size-of-my-cluster/ - - title: Configuring Multiple Schedulers - path: /docs/admin/multiple-schedulers/ - - title: Networking in Kubernetes - path: /docs/admin/networking/ - - title: Using DNS Pods and Services - path: /docs/admin/dns/ + - docs/admin/multiple-schedulers.md + - docs/admin/networking.md + - docs/admin/dns.md - title: Setting Up and Configuring DNS path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/cluster-dns - - title: Master <-> Node Communication - path: /docs/admin/master-node-communication/ - - title: Network Plugins - path: /docs/admin/network-plugins/ - - title: Static Pods - path: /docs/admin/static-pods/ - - title: Configuring kubelet Garbage Collection - path: /docs/admin/garbage-collection/ - - title: Configuring Out Of Resource Handling - path: /docs/admin/out-of-resource/ - - title: Configuring Kubernetes with Salt - path: /docs/admin/salt/ - - title: Monitoring Node Health - path: /docs/admin/node-problem/ - - title: AppArmor - path: /docs/admin/apparmor/ + - docs/admin/master-node-communication.md + - docs/admin/network-plugins.md + - docs/admin/static-pods.md + - docs/admin/garbage-collection.md + - docs/admin/out-of-resource.md + - docs/admin/salt.md + - docs/admin/node-problem.md + - docs/admin/apparmor/index.md - title: Administering Federation section: - - title: Using `kubefed` - path: /docs/admin/federation/kubfed/ - - title: Using `federation-up` and `deploy.sh` - path: /docs/admin/federation/ + - /docs/admin/federation/kubfed/ + - docs/admin/federation/index.md diff --git a/_data/reference.yml b/_data/reference.yml index ce0504eed8..41d9d49558 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -1,247 +1,141 @@ bigheader: "Reference Documentation" abstract: "Design docs, concept definitions, and references for APIs and CLIs." toc: -- title: Reference Documentation - path: /docs/reference/ +- docs/reference.md - title: Kubernetes API section: - - title: Kubernetes API Overview - path: /docs/api/ + - docs/api.md - title: Accessing the API section: - - title: Overview - path: /docs/admin/accessing-the-api/ - - title: Authenticating - path: /docs/admin/authentication/ - - title: Using Authorization Plugins - path: /docs/admin/authorization/ - - title: Using Admission Controllers - path: /docs/admin/admission-controllers/ - - title: Managing Service Accounts - path: /docs/admin/service-accounts-admin/ - - title: Kubernetes API Operations - path: /docs/api-reference/v1/operations/ - - title: Kubernetes API Definitions - path: /docs/api-reference/v1/definitions/ - - title: Kubernetes API Swagger Spec - path: /kubernetes/third_party/swagger-ui/ + - docs/admin/accessing-the-api.md + - docs/admin/authentication.md + - docs/admin/authorization.md + - docs/admin/admission-controllers.md + - docs/admin/service-accounts-admin.md + - docs/api-reference/v1/operations.html + - docs/api-reference/v1/definitions.html + - kubernetes/third_party/swagger-ui/index.md - title: Autoscaling API section: - - title: Autoscaling API Operations - path: /docs/api-reference/autoscaling/v1/operations/ - - title: Autoscaling API Definitions - path: /docs/api-reference/autoscaling/v1/definitions/ + - docs/api-reference/autoscaling/v1/operations.html + - docs/api-reference/autoscaling/v1/definitions.html - title: Batch API section: - - title: Batch API Operations - path: /docs/api-reference/batch/v1/operations/ - - title: Batch API Definitions - path: /docs/api-reference/batch/v1/definitions/ + - docs/api-reference/batch/v1/operations.html + - docs/api-reference/batch/v1/definitions.html - title: Extensions API section: - - title: Extensions API Operations - path: /docs/api-reference/extensions/v1beta1/operations/ - - title: Extensions API Definitions - path: /docs/api-reference/extensions/v1beta1/definitions/ + - docs/api-reference/extensions/v1beta1/operations.html + - docs/api-reference/extensions/v1beta1/definitions.html - title: kubectl CLI section: - - title: kubectl Overview - path: /docs/user-guide/kubectl-overview/ - - title: kubectl for Docker Users - path: /docs/user-guide/docker-cli-to-kubectl/ - - title: kubectl Usage Conventions - path: /docs/user-guide/kubectl-conventions/ - - title: JSONpath Support - path: /docs/user-guide/jsonpath/ - - title: kubectl Cheat Sheet - path: /docs/user-guide/kubectl-cheatsheet/ + - docs/user-guide/kubectl-overview.md + - docs/user-guide/docker-cli-to-kubectl.md + - docs/user-guide/kubectl-conventions.md + - docs/user-guide/jsonpath.md + - docs/user-guide/kubectl-cheatsheet.md - title: kubectl Commands section: - - title: kubectl - path: /docs/user-guide/kubectl/ - - title: kubectl annotate - path: /docs/user-guide/kubectl/kubectl_annotate/ - - title: kubectl api-versions - path: /docs/user-guide/kubectl/kubectl_api-versions/ - - title: kubectl apply - path: /docs/user-guide/kubectl/kubectl_apply/ - - title: kubectl attach - path: /docs/user-guide/kubectl/kubectl_attach/ - - title: kubectl autoscale - path: /docs/user-guide/kubectl/kubectl_autoscale/ - - title: kubectl cluster-info - path: /docs/user-guide/kubectl/kubectl_cluster-info/ - - title: kubectl config - path: /docs/user-guide/kubectl/kubectl_config/ - - title: kubectl config current-context - path: /docs/user-guide/kubectl/kubectl_config_current-context/ - - title: kubectl config set-cluster - path: /docs/user-guide/kubectl/kubectl_config_set-cluster/ - - title: kubectl config set-context - path: /docs/user-guide/kubectl/kubectl_config_set-context/ - - title: kubectl config set-credentials - path: /docs/user-guide/kubectl/kubectl_config_set-credentials/ - - title: kubectl config set - path: /docs/user-guide/kubectl/kubectl_config_set/ - - title: kubectl config unset - path: /docs/user-guide/kubectl/kubectl_config_unset/ - - title: kubectl config use-context - path: /docs/user-guide/kubectl/kubectl_config_use-context/ - - title: kubectl config view - path: /docs/user-guide/kubectl/kubectl_config_view/ - - title: kubectl convert - path: /docs/user-guide/kubectl/kubectl_convert/ - - title: kubectl cordon - path: /docs/user-guide/kubectl/kubectl_cordon/ - - title: kubectl create - path: /docs/user-guide/kubectl/kubectl_create/ - - title: kubectl create configmap - path: /docs/user-guide/kubectl/kubectl_create_configmap/ - - title: kubectl create namespace - path: /docs/user-guide/kubectl/kubectl_create_namespace/ - - title: kubectl create secret docker-registry - path: /docs/user-guide/kubectl/kubectl_create_secret_docker-registry/ - - title: kubectl create secret - path: /docs/user-guide/kubectl/kubectl_create_secret/ - - title: kubectl create secret generic - path: /docs/user-guide/kubectl/kubectl_create_secret_generic/ - - title: kubectl create serviceaccount - path: /docs/user-guide/kubectl/kubectl_create_serviceaccount/ - - title: kubectl delete - path: /docs/user-guide/kubectl/kubectl_delete/ - - title: kubectl describe - path: /docs/user-guide/kubectl/kubectl_describe/ - - title: kubectl drain - path: /docs/user-guide/kubectl/kubectl_drain/ - - title: kubectl edit - path: /docs/user-guide/kubectl/kubectl_edit/ - - title: kubectl exec - path: /docs/user-guide/kubectl/kubectl_exec/ - - title: kubectl explain - path: /docs/user-guide/kubectl/kubectl_explain/ - - title: kubectl expose - path: /docs/user-guide/kubectl/kubectl_expose/ - - title: kubectl get - path: /docs/user-guide/kubectl/kubectl_get/ - - title: kubectl label - path: /docs/user-guide/kubectl/kubectl_label/ - - title: kubectl logs - path: /docs/user-guide/kubectl/kubectl_logs/ - - title: kubectl patch - path: /docs/user-guide/kubectl/kubectl_patch/ - - title: kubectl port-forward - path: /docs/user-guide/kubectl/kubectl_port-forward/ - - title: kubectl proxy - path: /docs/user-guide/kubectl/kubectl_proxy/ - - title: kubectl replace - path: /docs/user-guide/kubectl/kubectl_replace/ - - title: kubectl rolling-update - path: /docs/user-guide/kubectl/kubectl_rolling-update/ - - title: kubectl rollout - path: /docs/user-guide/kubectl/kubectl_rollout/ - - title: kubectl rollout history - path: /docs/user-guide/kubectl/kubectl_rollout_history/ - - title: kubectl rollout pause - path: /docs/user-guide/kubectl/kubectl_rollout_pause/ - - title: kubectl rollout resume - path: /docs/user-guide/kubectl/kubectl_rollout_resume/ - - title: kubectl rollout undo - path: /docs/user-guide/kubectl/kubectl_rollout_undo/ - - title: kubectl run - path: /docs/user-guide/kubectl/kubectl_run/ - - title: kubectl scale - path: /docs/user-guide/kubectl/kubectl_scale/ - - title: kubectl uncordon - path: /docs/user-guide/kubectl/kubectl_uncordon/ - - title: kubectl version - path: /docs/user-guide/kubectl/kubectl_version/ + - docs/user-guide/kubectl/index.md + - docs/user-guide/kubectl/kubectl_annotate.md + - docs/user-guide/kubectl/kubectl_api-versions.md + - docs/user-guide/kubectl/kubectl_apply.md + - docs/user-guide/kubectl/kubectl_attach.md + - docs/user-guide/kubectl/kubectl_autoscale.md + - docs/user-guide/kubectl/kubectl_cluster-info.md + - docs/user-guide/kubectl/kubectl_config.md + - docs/user-guide/kubectl/kubectl_config_current-context.md + - docs/user-guide/kubectl/kubectl_config_set-cluster.md + - docs/user-guide/kubectl/kubectl_config_set-context.md + - docs/user-guide/kubectl/kubectl_config_set-credentials.md + - docs/user-guide/kubectl/kubectl_config_set.md + - docs/user-guide/kubectl/kubectl_config_unset.md + - docs/user-guide/kubectl/kubectl_config_use-context.md + - docs/user-guide/kubectl/kubectl_config_view.md + - docs/user-guide/kubectl/kubectl_convert.md + - docs/user-guide/kubectl/kubectl_cordon.md + - docs/user-guide/kubectl/kubectl_create.md + - docs/user-guide/kubectl/kubectl_create_configmap.md + - docs/user-guide/kubectl/kubectl_create_namespace.md + - docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md + - docs/user-guide/kubectl/kubectl_create_secret.md + - docs/user-guide/kubectl/kubectl_create_secret_generic.md + - docs/user-guide/kubectl/kubectl_create_serviceaccount.md + - docs/user-guide/kubectl/kubectl_delete.md + - docs/user-guide/kubectl/kubectl_describe.md + - docs/user-guide/kubectl/kubectl_drain.md + - docs/user-guide/kubectl/kubectl_edit.md + - docs/user-guide/kubectl/kubectl_exec.md + - docs/user-guide/kubectl/kubectl_explain.md + - docs/user-guide/kubectl/kubectl_expose.md + - docs/user-guide/kubectl/kubectl_get.md + - docs/user-guide/kubectl/kubectl_label.md + - docs/user-guide/kubectl/kubectl_logs.md + - docs/user-guide/kubectl/kubectl_patch.md + - docs/user-guide/kubectl/kubectl_port-forward.md + - docs/user-guide/kubectl/kubectl_proxy.md + - docs/user-guide/kubectl/kubectl_replace.md + - docs/user-guide/kubectl/kubectl_rolling-update.md + - docs/user-guide/kubectl/kubectl_rollout.md + - docs/user-guide/kubectl/kubectl_rollout_history.md + - docs/user-guide/kubectl/kubectl_rollout_pause.md + - docs/user-guide/kubectl/kubectl_rollout_resume.md + - docs/user-guide/kubectl/kubectl_rollout_undo.md + - docs/user-guide/kubectl/kubectl_run.md + - docs/user-guide/kubectl/kubectl_scale.md + - docs/user-guide/kubectl/kubectl_uncordon.md + - docs/user-guide/kubectl/kubectl_version.md - title: Superseded and Deprecated Commands section: - - title: kubectl namespace - path: /docs/user-guide/kubectl/kubectl_namespace/ - - title: kubectl stop - path: /docs/user-guide/kubectl/kubectl_stop/ + - /docs/user-guide/kubectl/kubectl_namespace/ + - docs/user-guide/kubectl/kubectl_stop.md - title: Kubernetes Components section: - - title: kube-apiserver - path: /docs/admin/kube-apiserver/ - - title: kube-controller-manager - path: /docs/admin/kube-controller-manager/ - - title: kube-proxy - path: /docs/admin/kube-proxy/ - - title: kube-scheduler - path: /docs/admin/kube-scheduler/ + - docs/admin/kube-apiserver.md + - docs/admin/kube-controller-manager.md + - docs/admin/kube-proxy.md + - docs/admin/kube-scheduler.md - title: kubelet section: - - title: Overview - path: /docs/admin/kubelet/ - - title: Master-Node communication - path: /docs/admin/master-node-communication/ - - title: TLS bootstrapping - path: /docs/admin/kubelet-tls-bootstrapping/ - - title: Kubelet authentication/authorization - path: /docs/admin/kubelet-authentication-authorization/ + - docs/admin/kubelet.md + - docs/admin/master-node-communication.md + - docs/admin/kubelet-tls-bootstrapping.md + - docs/admin/kubelet-authentication-authorization.md - title: Glossary section: - - title: Annotations - path: /docs/user-guide/annotations/ - - title: Daemon Sets - path: /docs/admin/daemons/ - - title: Deployments - path: /docs/user-guide/deployments/ - - title: Horizontal Pod Autoscaling - path: /docs/user-guide/horizontal-pod-autoscaling/ - - title: Images - path: /docs/user-guide/images/ - - title: Ingress Resources - path: /docs/user-guide/ingress/ - - title: Jobs - path: /docs/user-guide/jobs/ - - title: Labels and Selectors - path: /docs/user-guide/labels/ - - title: Names - path: /docs/user-guide/identifiers/ - - title: Namespaces - path: /docs/user-guide/namespaces/ - - title: Network Policies - path: /docs/user-guide/networkpolicies/ - - title: Nodes - path: /docs/admin/node/ - - title: Persistent Volumes - path: /docs/user-guide/persistent-volumes/ - - title: Pet Sets - path: /docs/user-guide/petset/ - - title: Pods - path: /docs/user-guide/pods/ - - title: Pod Security Policies - path: /docs/user-guide/pod-security-policy/ - - title: Replica Sets - path: /docs/user-guide/replicasets/ - - title: Replication Controller - path: /docs/user-guide/replication-controller/ - - title: Resource Quotas - path: /docs/admin/resourcequota/ - - title: Cron Jobs - path: /docs/user-guide/cron-jobs/ - - title: Secrets - path: /docs/user-guide/secrets/ - - title: Security Context - path: /docs/user-guide/security-context/ - - title: Services - path: /docs/user-guide/services/ - - title: Service Accounts - path: /docs/user-guide/service-accounts/ - - title: Third Party Resources - path: /docs/user-guide/thirdpartyresources/ - - title: Volumes - path: /docs/user-guide/volumes/ + - docs/user-guide/annotations.md + - docs/admin/daemons.md + - docs/user-guide/deployments.md + - docs/user-guide/horizontal-pod-autoscaling/index.md + - docs/user-guide/images.md + - docs/user-guide/ingress.md + - docs/user-guide/jobs.md + - docs/user-guide/labels.md + - docs/user-guide/identifiers.md + - docs/user-guide/namespaces.md + - docs/user-guide/networkpolicies.md + - docs/admin/node.md + - docs/user-guide/persistent-volumes/index.md + - docs/user-guide/petset.md + - docs/user-guide/pods/index.md + - docs/user-guide/pod-security-policy/index.md + - docs/user-guide/replicasets.md + - docs/user-guide/replication-controller/index.md + - docs/admin/resourcequota/index.md + - docs/user-guide/cron-jobs.md + - docs/user-guide/secrets/index.md + - docs/user-guide/security-context.md + - docs/user-guide/services/index.md + - docs/user-guide/service-accounts.md + - docs/user-guide/thirdpartyresources.md + - docs/user-guide/volumes.md - title: Kubernetes Design Docs section: @@ -251,8 +145,7 @@ toc: path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/ - title: Kubernetes Identity and Access Management path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/access.md - - title: Kubernetes OpenVSwitch GRE/VxLAN networking - path: /docs/admin/ovs-networking/ + - docs/admin/ovs-networking.md - title: Security Contexts path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security_context.md - title: Security in Kubernetes @@ -260,29 +153,18 @@ toc: - title: Federation section: - - title: Federation User Guide - path: /docs/user-guide/federation/ - - title: Federated ConfigMap - path: /docs/user-guide/federation/configmap/ - - title: Federated DaemonSet - path: /docs/user-guide/federation/daemonsets/ - - title: Federated Deployment - path: /docs/user-guide/federation/deployment/ - - title: Federated Events - path: /docs/user-guide/federation/events/ - - title: Federated Ingress - path: /docs/user-guide/federation/federated-ingress/ - - title: Federated Namespaces - path: /docs/user-guide/federation/namespaces/ - - title: Federated ReplicaSets - path: /docs/user-guide/federation/replicasets/ - - title: Federated Secrets - path: /docs/user-guide/federation/secrets/ - - title: Federation API - path: /docs/federation/api-reference/README/ + - docs/user-guide/federation/index.md + - docs/user-guide/federation/configmap.md + - docs/user-guide/federation/daemonsets.md + - docs/user-guide/federation/deployment.md + - docs/user-guide/federation/events.md + - docs/user-guide/federation/federated-ingress.md + - docs/user-guide/federation/namespaces.md + - docs/user-guide/federation/replicasets.md + - docs/user-guide/federation/secrets.md + - docs/federation/api-reference/README.md - title: Federation Components section: - - title: federation-apiserver - path: /docs/admin/federation-apiserver + - docs/admin/federation-apiserver.md - title : federation-controller-mananger path: /docs/admin/federation-controller-manager diff --git a/_data/samples.yml b/_data/samples.yml index 3a9f0bcf28..e94f2b3223 100644 --- a/_data/samples.yml +++ b/_data/samples.yml @@ -1,8 +1,7 @@ bigheader: "Samples" abstract: "A collection of example applications that show how to use Kubernetes." toc: -- title: Samples - path: /docs/samples/ +- docs/samples.md - title: Storage / Database / KV section: @@ -67,8 +66,7 @@ toc: path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/guestbook-go/ - title: GuestBook - PHP Server path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/guestbook/ - - title: MEAN stack on Google Cloud Platform - path: /docs/getting-started-guides/meanstack/ + - docs/getting-started-guides/meanstack.md - title: MySQL + Wordpress path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/mysql-wordpress-pd/ - title: MySQL + Phabricator Server diff --git a/_data/support.yml b/_data/support.yml index 487ff3d614..efb049ccb1 100644 --- a/_data/support.yml +++ b/_data/support.yml @@ -1,38 +1,25 @@ bigheader: "Support" abstract: "Troubleshooting resources, frequently asked questions, and community support channels." toc: -- title: Support - path: /docs/troubleshooting/ +- docs/troubleshooting.md - title: Contributing to the Kubernetes Docs section: - - title: Contributing to the Kubernetes Documentation - path: /editdocs/ - - title: Creating a Documentation Pull Request - path: /docs/contribute/create-pull-request/ - - title: Writing a New Topic - path: /docs/contribute/write-new-topic/ - - title: Staging Your Documentation Changes - path: /docs/contribute/stage-documentation-changes/ - - title: Using Page Templates - path: /docs/contribute/page-templates/ - - title: Documentation Style Guide - path: /docs/contribute/style-guide/ + - editdocs.md + - docs/contribute/create-pull-request.md + - docs/contribute/write-new-topic.md + - docs/contribute/stage-documentation-changes.md + - docs/contribute/page-templates.md + - docs/contribute/style-guide.md - title: Troubleshooting section: - - title: Debugging Pods and Replication Controllers - path: /docs/user-guide/debugging-pods-and-replication-controllers/ - - title: Application Introspection and Debugging - path: /docs/user-guide/introspection-and-debugging/ - - title: Retrieving Logs - path: /docs/user-guide/logging/ - - title: Troubleshooting Applications - path: /docs/user-guide/application-troubleshooting/ - - title: Troubleshooting Clusters - path: /docs/admin/cluster-troubleshooting/ - - title: Debugging Services - path: /docs/user-guide/debugging-services/ + - docs/user-guide/debugging-pods-and-replication-controllers.md + - docs/user-guide/introspection-and-debugging.md + - docs/user-guide/logging.md + - docs/user-guide/application-troubleshooting.md + - docs/admin/cluster-troubleshooting.md + - docs/user-guide/debugging-services.md - title: Frequently Asked Questions section: @@ -47,8 +34,7 @@ toc: section: - title: Kubernetes Issue Tracker on GitHub path: https://github.com/kubernetes/kubernetes/issues/ - - title: Report a Security Vulnerability - path: /docs/reporting-security-issues/ + - docs/reporting-security-issues.md - title: Release Notes path: https://github.com/kubernetes/kubernetes/releases/ - title: Release Roadmap diff --git a/_data/tasks.yml b/_data/tasks.yml index 277efa4886..05a880637a 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -1,63 +1,44 @@ bigheader: "Tasks" abstract: "Step-by-step instructions for performing operations with Kuberentes." toc: -- title: Tasks - path: /docs/tasks/ +- docs/tasks/index.md - title: Configuring Pods and Containers section: - - title: Defining Environment Variables for a Container - path: /docs/tasks/configure-pod-container/define-environment-variable-container/ - - title: Defining a Command and Arguments for a Container - path: /docs/tasks/configure-pod-container/define-command-argument-container/ - - title: Assigning CPU and RAM Resources to a Container - path: /docs/tasks/configure-pod-container/assign-cpu-ram-container/ - - title: Configuring a Pod to Use a Volume for Storage - path: /docs/tasks/configure-pod-container/configure-volume-storage/ - - title: Distributing Credentials Securely - path: /docs/tasks/configure-pod-container/distribute-credentials-secure/ + - docs/tasks/configure-pod-container/define-environment-variable-container.md + - docs/tasks/configure-pod-container/define-command-argument-container.md + - docs/tasks/configure-pod-container/assign-cpu-ram-container.md + - docs/tasks/configure-pod-container/configure-volume-storage.md + - docs/tasks/configure-pod-container/distribute-credentials-secure.md - title: Accessing Applications in a Cluster section: - - title: Using Port Forwarding to Access Applications in a Cluster - path: /docs/tasks/access-application-cluster/port-forward-access-application-cluster/ + - docs/tasks/access-application-cluster/port-forward-access-application-cluster.md - title: Debugging Applications in a Cluster section: - - title: Determining the Reason for Pod Failure - path: /docs/tasks/debug-application-cluster/determine-reason-pod-failure/ + - docs/tasks/debug-application-cluster/determine-reason-pod-failure.md - title: Accessing the Kubernetes API section: - - title: Using an HTTP Proxy to Access the Kubernetes API - path: /docs/tasks/access-kubernetes-api/http-proxy-access-api/ + - docs/tasks/access-kubernetes-api/http-proxy-access-api.md - title: Administering a Cluster section: - - title: Assigning Pods to Nodes - path: /docs/tasks/administer-cluster/assign-pods-nodes/ + - docs/tasks/administer-cluster/assign-pods-nodes.md - - title: Autoscaling the DNS Service in a Cluster - path: /docs/tasks/administer-cluster/dns-horizontal-autoscaling/ - - title: Safely Draining a Node while Respecting Application SLOs - path: /docs/tasks/administer-cluster/safely-drain-node/ + - docs/tasks/administer-cluster/dns-horizontal-autoscaling.md + - docs/tasks/administer-cluster/safely-drain-node.md - title: Managing Stateful Applications section: - - title: Upgrading from PetSets to StatefulSets - path: /docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set/ - - title: Scaling a StatefulSet - path: /docs/tasks/manage-stateful-set/scale-stateful-set/ - - title: Deleting a Stateful Set - path: /docs/tasks/manage-stateful-set/deleting-a-statefulset/ - - title: Debugging a StatefulSet - path: /docs/tasks/manage-stateful-set/debugging-a-statefulset/ - - title: Force Deleting StatefulSet Pods - path: /docs/tasks/manage-stateful-set/delete-pods/ + - docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set.md + - docs/tasks/manage-stateful-set/scale-stateful-set.md + - docs/tasks/manage-stateful-set/deleting-a-statefulset.md + - docs/tasks/manage-stateful-set/debugging-a-statefulset.md + - docs/tasks/manage-stateful-set/delete-pods.md - title: Troubleshooting section: - - title: Debugging Init Containers - path: /docs/tasks/troubleshoot/debug-init-containers/ - - title: Configuring Access Control and Identity Management - path: /docs/tasks/administer-cluster/access-control-identity-management/ + - docs/tasks/troubleshoot/debug-init-containers.md + - /docs/tasks/administer-cluster/access-control-identity-management/ diff --git a/_data/tools.yml b/_data/tools.yml index cf2afca34c..6b743c2e95 100644 --- a/_data/tools.yml +++ b/_data/tools.yml @@ -1,5 +1,4 @@ bigheader: "Tools" abstract: "Tools to help you use and enhance Kubernetes." toc: -- title: Tools - path: /docs/tools/ +- docs/tools/index.md diff --git a/_data/tutorials.yml b/_data/tutorials.yml index 82396ca65a..a4ff243bfb 100644 --- a/_data/tutorials.yml +++ b/_data/tutorials.yml @@ -1,63 +1,42 @@ bigheader: "Tutorials" abstract: "Detailed walkthroughs of common Kubernetes operations and workflows." toc: -- title: Tutorials - path: /docs/tutorials/ +- docs/tutorials/index.md - title: Kubernetes Basics section: - - title: Overview - path: /docs/tutorials/kubernetes-basics/ + - docs/tutorials/kubernetes-basics/index.html - title: 1. Create a Cluster section: - - title: Using Minikube to Create a Cluster - path: /docs/tutorials/kubernetes-basics/cluster-intro/ - - title: Interactive Tutorial - Creating a Cluster - path: /docs/tutorials/kubernetes-basics/cluster-interactive/ + - docs/tutorials/kubernetes-basics/cluster-intro.html + - docs/tutorials/kubernetes-basics/cluster-interactive.html - title: 2. Deploy an App section: - - title: Using kubectl to Create a Deployment - path: /docs/tutorials/kubernetes-basics/deploy-intro/ - - title: Interactive Tutorial - Deploying an App - path: /docs/tutorials/kubernetes-basics/deploy-interactive/ + - docs/tutorials/kubernetes-basics/deploy-intro.html + - docs/tutorials/kubernetes-basics/deploy-interactive.html - title: 3. Explore Your App section: - - title: Viewing Pods and Nodes - path: /docs/tutorials/kubernetes-basics/explore-intro/ - - title: Interactive Tutorial - Exploring Your App - path: /docs/tutorials/kubernetes-basics/explore-interactive/ + - docs/tutorials/kubernetes-basics/explore-intro.html + - docs/tutorials/kubernetes-basics/explore-interactive.html - title: 4. Expose Your App Publicly section: - - title: Using a Service to Expose Your App - path: /docs/tutorials/kubernetes-basics/expose-intro/ - - title: Interactive Tutorial - Exposing Your App - path: /docs/tutorials/kubernetes-basics/expose-interactive/ + - docs/tutorials/kubernetes-basics/expose-intro.html + - docs/tutorials/kubernetes-basics/expose-interactive.html - title: 5. Scale Your App section: - - title: Running Multiple Instances of Your App - path: /docs/tutorials/kubernetes-basics/scale-intro/ - - title: Interactive Tutorial - Scaling Your App - path: /docs/tutorials/kubernetes-basics/scale-interactive/ + - docs/tutorials/kubernetes-basics/scale-intro.html + - docs/tutorials/kubernetes-basics/scale-interactive.html - title: 6. Update Your App section: - - title: Performing a Rolling Update - path: /docs/tutorials/kubernetes-basics/update-intro/ - - title: Interactive Tutorial - Updating Your App - path: /docs/tutorials/kubernetes-basics/update-interactive/ + - docs/tutorials/kubernetes-basics/update-intro.html + - docs/tutorials/kubernetes-basics/update-interactive.html - title: Stateless Applications section: - - title: Running a Stateless Application Using a Deployment - path: /docs/tutorials/stateless-application/run-stateless-application-deployment/ - - title: Using a Service to Access an Application in a Cluster - path: /docs/tutorials/stateless-application/expose-external-ip-address-service/ - - title: Exposing an External IP Address to Access an Application in a Cluster - path: /docs/tutorials/stateless-application/expose-external-ip-address/ + - docs/tutorials/stateless-application/run-stateless-application-deployment.md + - docs/tutorials/stateless-application/expose-external-ip-address-service.md + - docs/tutorials/stateless-application/expose-external-ip-address.md - title: Stateful Applications section: - - title: StatefulSet Basics - path: /docs/tutorials/stateful-application/basic-stateful-set/ - - title: Running a Single-Instance Stateful Application - path: /docs/tutorials/stateful-application/run-stateful-application/ - - title: Running a Replicated Stateful Application - path: /docs/tutorials/stateful-application/run-replicated-stateful-application/ - - title: Running ZooKeeper, A CP Distributed System - path: /docs/tutorials/stateful-application/zookeeper/ + - docs/tutorials/stateful-application/basic-stateful-set.md + - docs/tutorials/stateful-application/run-stateful-application.md + - docs/tutorials/stateful-application/run-replicated-stateful-application.md + - docs/tutorials/stateful-application/zookeeper.md diff --git a/_includes/head-header.html b/_includes/head-header.html index e2b18fa6ee..4a05708d6b 100644 --- a/_includes/head-header.html +++ b/_includes/head-header.html @@ -1,4 +1,3 @@ -{% if page.title %}{% assign title=page.title %}{% endif %} diff --git a/_includes/tocsearch.html b/_includes/tocsearch.html index 38587a21a4..5bd5c5fd50 100644 --- a/_includes/tocsearch.html +++ b/_includes/tocsearch.html @@ -1 +1,15 @@ -{% for item in tree %}{% if item.section %}{% assign tree = item.section %}{% include tocsearch.html %}{% else %}{% if item.path == page.url %}{% assign foundTOC = thistoc %}{% assign title = item.title %}{% break %}{% endif %}{% endif %}{% endfor %} \ No newline at end of file +{% capture whitespace %} + {% for item in include.tree %} + {% if found_toc %} + {% break %} + {% endif %} + {% if item.section %} + {% include tocsearch.html tree=item.section toc=include.toc %} + {% else %} + {% if item == page.path %} + {% assign found_toc = include.toc %} + {% break %} + {% endif %} + {% endif %} + {% endfor %} +{% endcapture %} diff --git a/_includes/tree.html b/_includes/tree.html index 4914c13eef..6387c171e7 100644 --- a/_includes/tree.html +++ b/_includes/tree.html @@ -1,6 +1,26 @@ -{% for item in tree %}{% if item.section %} -
-
{% assign tree = item.section %}{% include tree.html %} -
-
{% else %}{% assign prefix = item.path | slice: 0, 4 %}{% if prefix == "http" %}{% assign target=" target='_blank'" %}{% else %}{% assign target="" %}{% endif %} - {% endif %}{% endfor %} \ No newline at end of file +{% for item in include.tree %} + {% if item.section %} +
+
+ {% include_cached tree.html tree=item.section %} +
+
+ {% else %} + + {% capture whitespace %} + {% if item.path %} + {% assign path = item.path %} + {% assign title = item.title %} + {% assign target = " target='_blank'" %} + {% else %} + {% assign page = site.pages | where: "path", item | first %} + {% assign title = page.title %} + {% assign path = page.url %} + {% endif %} + {% endcapture %} + + {% if path %} + + {% endif %} + {% endif %} +{% endfor %} diff --git a/_layouts/docwithnav.html b/_layouts/docwithnav.html index b97f92d53a..4ac68e8acd 100755 --- a/_layouts/docwithnav.html +++ b/_layouts/docwithnav.html @@ -1,25 +1,32 @@ -{% for thistoc in site.data.globals.tocs %}{% if foundTOC %}{% break %}{% else %}{% assign tree = site.data[thistoc].toc %}{% include tocsearch.html %}{% endif %}{% endfor %} -{% for override in site.data.overrides.overrides %}{% if page.path contains override.path %}{% assign notitle = "true" %}{% endif %}{% endfor %} +{% for current_toc in site.tocs %} + {% if found_toc %} + {% break %} + {% else %} + {% assign toc=site.data[current_toc] %} + {% include tocsearch.html tree=toc.toc toc=toc %} + {% endif %} +{% endfor %} + - + {% include head-header.html %}
-

{{ site.data[foundTOC].bigheader }}

-
{{ site.data[foundTOC].abstract }}
+

{{ toc.bigheader }}

+
{{ toc.abstract }}