standardize on - instead of _ in file names

nikhiljindal · Jul 14, 2015 · b155595 · b155595
1 parent 2c333e4
commit b155595
Show file tree

Hide file tree

Showing 38 changed files with 88 additions and 72 deletions.
diff --git a/docs/accessing-the-cluster.md b/docs/accessing-the-cluster.md
@@ -110,7 +110,7 @@ certificate.
 
 On some clusters, the apiserver does not require authentication; it may serve
 on localhost, or be protected by a firewall.  There is not a standard
-for this.  [Configuring Access to the API](accessing_the_api.md)
+for this.  [Configuring Access to the API](admin/accessing-the-api.md)
 describes how a cluster admin can configure this.  Such approaches may conflict
 with future high-availability support.
 
@@ -134,7 +134,7 @@ the `kubernetes` DNS name, which resolves to a Service IP which in turn
 will be routed to an apiserver.
 
 The recommended way to authenticate to the apiserver is with a
-[service account](service_accounts.md) credential.  By default, a pod
+[service account](service-accounts.md) credential.  By default, a pod
 is associated with a service account, and a credential (token) for that
 service account is placed into the filesystem tree of each container in that pod,
 at `/var/run/secrets/kubernetes.io/serviceaccount/token`.
@@ -153,7 +153,7 @@ In each case, the credentials of the pod are used to communicate securely with t
 ## Accessing services running on the cluster
 The previous section was about connecting the Kubernetes API server.  This section is about
 connecting to other services running on Kubernetes cluster.  In kubernetes, the
-[nodes](node.md), [pods](pods.md) and [services](services.md) all have
+[nodes](admin/node.md), [pods](pods.md) and [services](services.md) all have
 their own IPs.  In many cases, the node IPs, pod IPs, and some service IPs on a cluster will not be
 routable, so they will not be reachable from a machine outside the cluster,
 such as your desktop machine.

diff --git a/docs/admin/README.md b/docs/admin/README.md
@@ -15,12 +15,12 @@ certainly want the docs that go with that version.</h1>
 # Kubernetes Cluster Admin Guide
 
 The cluster admin guide is for anyone creating or administering a Kubernetes cluster.
-It assumes some familiarity with concepts in the [User Guide](user-guide.md).
+It assumes some familiarity with concepts in the [User Guide](../user-guide.md).
 
 ## Planning a cluster
 
 There are many different examples of how to setup a kubernetes cluster.  Many of them are listed in this
-[matrix](getting-started-guides/README.md).  We call each of the combinations in this matrix a *distro*.
+[matrix](../getting-started-guides/README.md).  We call each of the combinations in this matrix a *distro*.
 
 Before choosing a particular guide, here are some things to consider:
  - Are you just looking to try out Kubernetes on your laptop, or build a high-availability many-node cluster? Both
@@ -41,7 +41,7 @@ Before choosing a particular guide, here are some things to consider:
 
 ## Setting up a cluster
 
-Pick one of the Getting Started Guides from the [matrix](getting-started-guides/README.md) and follow it.
+Pick one of the Getting Started Guides from the [matrix](../getting-started-guides/README.md) and follow it.
 If none of the Getting Started Guides fits, you may want to pull ideas from several of the guides.
 
 One option for custom networking is *OpenVSwitch GRE/VxLAN networking* ([ovs-networking.md](ovs-networking.md)), which
@@ -52,7 +52,7 @@ If you are modifying an existing guide which uses Salt, this document explains [
 project.](salt.md).
 
 ## Upgrading a cluster
-[Upgrading a cluster](cluster_management.md).
+[Upgrading a cluster](cluster-management.md).
 
 ## Managing nodes
 
@@ -63,30 +63,30 @@ project.](salt.md).
 * **DNS Integration with SkyDNS** ([dns.md](dns.md)):
   Resolving a DNS name directly to a Kubernetes service.
 
-* **Logging** with [Kibana](logging.md)
+* **Logging** with [Kibana](../logging.md)
 
 ## Multi-tenant support
 
 * **Namespaces** ([namespaces.md](namespaces.md)): Namespaces help different
   projects, teams, or customers to share a kubernetes cluster.
 
-* **Resource Quota** ([resource_quota_admin.md](resource_quota_admin.md)) 
+* **Resource Quota** ([resource-quota.md](resource-quota.md)) 
 
 ## Security
 
-* **Kubernetes Container Environment** ([container-environment.md](container-environment.md)):
+* **Kubernetes Container Environment** ([docs/container-environment.md](../container-environment.md)):
   Describes the environment for Kubelet managed containers on a Kubernetes
   node.
 
-* **Securing access to the API Server** [accessing the api](accessing_the_api.md)
+* **Securing access to the API Server** [accessing the api](accessing-the-api.md)
 
 * **Authentication**  [authentication](authentication.md)
 
 * **Authorization** [authorization](authorization.md)
 
-* **Admission Controllers** [admission_controllers](admission_controllers.md)
+* **Admission Controllers** [admission_controllers](admission-controllers.md)
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/cluster-admin-guide.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/README.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/accessing-the-api.md b/docs/admin/accessing-the-api.md
@@ -20,7 +20,7 @@ cluster administrators who want to customize their cluster
 or understand the details.
 
 Most questions about accessing the cluster are covered
-in [Accessing the cluster](accessing-the-cluster.md).
+in [Accessing the cluster](../accessing-the-cluster.md).
 
 
 ## Ports and IPs Served On
@@ -90,5 +90,5 @@ variety of uses cases:
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/accessing_the_api.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/accessing-the-api.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md
@@ -81,20 +81,20 @@ commands in those containers, we strongly encourage enabling this plug-in.
 
 ### ServiceAccount
 
-This plug-in implements automation for [serviceAccounts](service_accounts.md).
+This plug-in implements automation for [serviceAccounts](../service-accounts.md).
 We strongly recommend using this plug-in if you intend to make use of Kubernetes ```ServiceAccount``` objects.
 
 ### SecurityContextDeny
 
-This plug-in will deny any pod with a [SecurityContext](security_context.md) that defines options that were not available on the ```Container```.
+This plug-in will deny any pod with a [SecurityContext](../security-context.md) that defines options that were not available on the ```Container```.
 
 ### ResourceQuota
 
 This plug-in will observe the incoming request and ensure that it does not violate any of the constraints
 enumerated in the ```ResourceQuota``` object in a ```Namespace```.  If you are using ```ResourceQuota```
 objects in your Kubernetes deployment, you MUST use this plug-in to enforce quota constraints.
 
-See the [resourceQuota design doc](design/admission_control_resource_quota.md).
+See the [resourceQuota design doc](../design/admission_control_resource_quota.md).
 
 It is strongly encouraged that this plug-in is configured last in the sequence of admission control plug-ins.  This is
 so that quota is not prematurely incremented only for the request to be rejected later in admission control.
@@ -105,7 +105,7 @@ This plug-in will observe the incoming request and ensure that it does not viola
 enumerated in the ```LimitRange``` object in a ```Namespace```.  If you are using ```LimitRange``` objects in
 your Kubernetes deployment, you MUST use this plug-in to enforce those constraints.
 
-See the [limitRange design doc](design/admission_control_limit_range.md).
+See the [limitRange design doc](../design/admission_control_limit_range.md).
 
 ### NamespaceExists
 
@@ -142,5 +142,5 @@ For Kubernetes 1.0, we strongly recommend running the following set of admission
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admission_controllers.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/admission-controllers.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md
@@ -55,5 +55,5 @@ github.com, google.com, enterprise directory, kerberos, etc.)
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/authentication.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/authentication.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/authorization.md b/docs/admin/authorization.md
@@ -94,7 +94,7 @@ To permit an action Policy with an unset namespace applies regardless of namespa
  3. Kubelet can read and write events: `{"user":"kubelet", "resource": "events"}`
  4. Bob can just read pods in namespace "projectCaribou": `{"user":"bob", "resource": "pods", "readonly": true, "ns": "projectCaribou"}`
 
-[Complete file example](../pkg/auth/authorizer/abac/example_policy_file.jsonl)
+[Complete file example](../../pkg/auth/authorizer/abac/example_policy_file.jsonl)
 
 ## Plugin Development
 
@@ -118,5 +118,5 @@ caching and revocation of permissions.
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/authorization.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/authorization.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/availability.md b/docs/admin/availability.md
@@ -134,7 +134,7 @@ you need `R + U` clusters.  If it is not (e.g you want to ensure low latency for
 cluster failure), then you need to have `R * U` clusters (`U` in each of `R` regions).  In any case, try to put each cluster in a different zone.
 
 Finally, if any of your clusters would need more than the maximum recommended number of nodes for a Kubernetes cluster, then
-you may need even more clusters.  Our [roadmap](roadmap.md)
+you may need even more clusters.  Our [roadmap](../roadmap.md)
 calls for maximum 100 node clusters at v1.0 and maximum 1000 node clusters in the middle of 2015.
 
 ## Working with multiple clusters
@@ -145,5 +145,5 @@ failures of a single cluster are not visible to end users.
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/availability.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/availability.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/cluster-management.md b/docs/admin/cluster-management.md
@@ -74,5 +74,5 @@ If you want more control over the upgrading process, you may use the following w
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/cluster_management.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/cluster-management.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/dns.md b/docs/admin/dns.md
@@ -14,7 +14,7 @@ certainly want the docs that go with that version.</h1>
 <!-- END MUNGE: UNVERSIONED_WARNING -->
 # DNS Integration with Kubernetes
 
-As of kubernetes 0.8, DNS is offered as a [cluster add-on](../cluster/addons/README.md).
+As of kubernetes 0.8, DNS is offered as a [cluster add-on](../../cluster/addons/README.md).
 If enabled, a DNS Pod and Service will be scheduled on the cluster, and the kubelets will be
 configured to tell individual containers to use the DNS Service's IP.
 
@@ -49,9 +49,9 @@ time.
 
 ## For more information
 
-See [the docs for the DNS cluster addon](../cluster/addons/dns/README.md).
+See [the docs for the DNS cluster addon](../../cluster/addons/dns/README.md).
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/dns.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/dns.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/namespaces.md b/docs/admin/namespaces.md
@@ -1,3 +1,17 @@
+<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
+
+<!-- BEGIN STRIP_FOR_RELEASE -->
+
+<h1>*** PLEASE NOTE: This document applies to the HEAD of the source
+tree only. If you are using a released version of Kubernetes, you almost
+certainly want the docs that go with that version.</h1>
+
+<strong>Documentation for specific releases can be found at
+[releases.k8s.io](http://releases.k8s.io).</strong>
+
+<!-- END STRIP_FOR_RELEASE -->
+
+<!-- END MUNGE: UNVERSIONED_WARNING -->
 # Namespaces
 
 Namespaces help different projects, teams, or customers to share a kubernetes cluster.  First, they provide a scope for [Names](../identifiers.md).  Second, as our access control code develops, it is expected that it will be convenient to attach authorization and other policy to namespaces.
@@ -12,4 +26,6 @@ policy creation, interaction with network.
 Namespaces are still under development.  For now, the best documentation is the [Namespaces Design Document](../design/namespaces.md).  The user documentation can be found at [Namespaces](../../docs/namespaces.md)
 
 
+<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
 [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/namespaces.md?pixel)]()
+<!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/networking.md b/docs/admin/networking.md
@@ -34,10 +34,10 @@ certainly want the docs that go with that version.</h1>
 Kubernetes approaches networking somewhat differently than Docker does by
 default.  There are 4 distinct networking problems to solve:
 1. Highly-coupled container-to-container communications: this is solved by
-   [pods](pods.md) and `localhost` communications.
+   [pods](../pods.md) and `localhost` communications.
 2. Pod-to-Pod communications: this is the primary focus of this document.
-3. Pod-to-Service communications: this is covered by [services](services.md).
-4. External-to-Service communications: this is covered by [services](services.md).
+3. Pod-to-Service communications: this is covered by [services](../services.md).
+4. External-to-Service communications: this is covered by [services](../services.md).
 
 ## Summary
 
@@ -204,9 +204,9 @@ IPs.
 
 The early design of the networking model and its rationale, and some future
 plans are described in more detail in the [networking design
-document](design/networking.md).
+document](../design/networking.md).
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/networking.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/networking.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/node.md b/docs/admin/node.md
@@ -36,9 +36,9 @@ certainly want the docs that go with that version.</h1>
 
 `Node` is a worker machine in Kubernetes, previously known as `Minion`. Node
 may be a VM or physical machine, depending on the cluster. Each node has
-the services necessary to run [Pods](pods.md) and be managed from the master
+the services necessary to run [Pods](../pods.md) and be managed from the master
 systems. The services include docker, kubelet and network proxy. See
-[The Kubernetes Node](design/architecture.md#the-kubernetes-node) section in design
+[The Kubernetes Node](../design/architecture.md#the-kubernetes-node) section in design
 doc for more details.
 
 ## Node Status
@@ -101,7 +101,7 @@ The information is gathered by Kubernetes from the node.
 
 ## Node Management
 
-Unlike [Pods](pods.md) and [Services](services.md), a Node is not inherently
+Unlike [Pods](../pods.md) and [Services](../services.md), a Node is not inherently
 created by Kubernetes: it is either created from cloud providers like Google Compute Engine,
 or from your physical or virtual machines. What this means is that when
 Kubernetes creates a node, it only creates a representation for the node.
@@ -216,5 +216,5 @@ on each kubelet where you want to reserve resources.
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/node.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/node.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/ovs-networking.md b/docs/admin/ovs-networking.md
@@ -29,5 +29,5 @@ Routing rules enable any 10.244.0.0/16 target to become reachable via the OVS br
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/ovs-networking.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/ovs-networking.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/resource-quota.md b/docs/admin/resource-quota.md
@@ -116,5 +116,5 @@ hard limits of each namespace.
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/resource_quota_admin.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/resource-quota.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/admin/salt.md b/docs/admin/salt.md
@@ -109,9 +109,9 @@ We should define a grains.conf key that captures more specifically what network
 
 ## Further reading
 
-The [cluster/saltbase](../cluster/saltbase/) tree has more details on the current SaltStack configuration.
+The [cluster/saltbase](../../cluster/saltbase/) tree has more details on the current SaltStack configuration.
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/salt.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/salt.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/service_accounts_admin.md → docs/admin/service-accounts-admin.md b/docs/service_accounts_admin.md → docs/admin/service-accounts-admin.md
@@ -15,7 +15,7 @@ certainly want the docs that go with that version.</h1>
 # Cluster Admin Guide to Service Accounts
 
 *This is a Cluster Administrator guide to service accounts.  It assumes knowledge of
-the [User Guide to Service Accounts](service_accounts.md).*
+the [User Guide to Service Accounts](../service-accounts.md).*
 
 *Support for authorization and user accounts is planned but incomplete.  Sometimes
 incomplete features are referred to in order to better describe service accounts.*
@@ -49,7 +49,7 @@ Three separate components cooperate to implement the automation around service a
 ### Service Account Admission Controller
 
 The modification of pods is implemented via a plugin
-called an [Admission Controller](admin/admission-controllers.md). It is part of the apiserver.
+called an [Admission Controller](admission-controllers.md). It is part of the apiserver.
 It acts synchronously to modify pods as they are created or updated. When this plugin is active
 (and it is by default on most distributions), then it does the following when a pod is created or modified:
   1. If the pod does not have a `ServiceAccount` set, it sets the `ServiceAccount` to `default`.
@@ -97,5 +97,5 @@ kubectl delete secret mysecretname
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
-[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/service_accounts_admin.md?pixel)]()
+[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/service-accounts-admin.md?pixel)]()
 <!-- END MUNGE: GENERATED_ANALYTICS -->