Merge pull request #25099 from mikebrow/devel-tree-80col-updates

Automatic merge from submit-queue

devel/ tree minor edits

Address line wrap issue #1488. Also cleans up other minor editing issues in the docs/devel/* tree such as spelling errors, links,...

Signed-off-by: Mike Brown <brownwm@us.ibm.com>

1 files changed, 57 insertions, 24 deletions

diff --git a/e2e-node-tests.md b/e2e-node-tests.md
index 98450796..840d3c3a 100644
--- a/e2e-node-tests.md
+++ b/e2e-node-tests.md
@@ -34,32 +34,39 @@ Documentation for other releases can be found at
 
 # Node End-To-End tests
 
-Node e2e tests start kubelet and minimal supporting infrastructure to validate the kubelet on a host.
-Tests can be run either locally, against a remote host or against a GCE image.
+Node e2e tests start kubelet and minimal supporting infrastructure to validate
+the kubelet on a host. Tests can be run either locally, against a remote host or
+against a GCE image.
 
 *Note: Linux only. Mac and Windows unsupported.*
 
 ## Running tests locally
 
-etcd must be installed and on the PATH to run the node e2e tests.  To verify etcd is installed: `which etcd`.
-You can find instructions for installing etcd [on the etcd releases page](https://github.com/coreos/etcd/releases).
+etcd must be installed and on the PATH to run the node e2e tests.  To verify
+etcd is installed: `which etcd`. You can find instructions for installing etcd
+[on the etcd releases page](https://github.com/coreos/etcd/releases).
 
 Run the tests locally: `make test_e2e_node`
 
-Running the node e2e tests locally will build the kubernetes go source files and then start the
-kubelet, kube-apiserver, and etcd binaries on localhost before executing the ginkgo tests under
-test/e2e_node against the local kubelet instance.
+Running the node e2e tests locally will build the kubernetes go source files and
+then start the kubelet, kube-apiserver, and etcd binaries on localhost before
+executing the ginkgo tests under test/e2e_node against the local kubelet
+instance.
 
 ## Running tests against a remote host
 
-The node e2e tests can be run against one or more remote hosts using one of
-* [e2e-node-jenkins.sh](../../test/e2e_node/jenkins/e2e-node-jenkins.sh) (gce only)
-* [run_e2e.go](../../test/e2e_node/runner/run_e2e.go) (requires passwordless ssh and remote passwordless sudo access over ssh)
-* using [run_e2e.go](../../test/e2e_node/runner/run_e2e.go) to build a tar.gz and executing on host (requires host access w/ remote sudo)
+The node e2e tests can be run against one or more remote hosts using one of:
+* [e2e-node-jenkins.sh](../../test/e2e_node/jenkins/e2e-node-jenkins.sh) (gce
+only)
+* [run_e2e.go](../../test/e2e_node/runner/run_e2e.go) (requires passwordless ssh
+and remote passwordless sudo access over ssh)
+* using [run_e2e.go](../../test/e2e_node/runner/run_e2e.go) to build a tar.gz
+and executing on host (requires host access w/ remote sudo)
 
 ### Configuring a new remote host for testing
 
-The host must contain a environment capable of supporting a mini-kubernetes cluster.  Includes:
+The host must contain a environment capable of supporting a mini-kubernetes
+cluster. Includes:
 * install etcd
 * install docker
 * install lxc and update grub commandline
@@ -70,35 +77,60 @@ See [setup_host.sh](../../test/e2e_node/environment/setup_host.sh)
 ### Running the tests
 
 1. If running against a host on gce
+
   * Copy [template.properties](../../test/e2e_node/jenkins/template.properties)
+
     * Fill in `GCE_HOSTS`
     * Set `INSTALL_GODEP=true` to install `godep`, `gomega`, `ginkgo`
+
   * Make sure host names are resolvable to ssh `ssh <host>`.
-    * If needed, you can run `gcloud compute config-ssh` to add gce hostnames to your .ssh/config so they are resolvable by ssh.
+
+    * If needed, you can run `gcloud compute config-ssh` to add gce hostnames to
+your .ssh/config so they are resolvable by ssh.
+
   * Run `test/e2e_node/jenkins/e2e-node-jenkins.sh <path to properties file>`
     * **Must be run from kubernetes root**
 
 2. If running against a host anywhere else
+
   * **Requires password-less ssh and sudo access**
+
     * Make sure this works - e.g. `ssh <hostname> -- sudo echo "ok"`
-    * If ssh flags are required (e.g. `-i`), they can be used and passed to the tests with `--ssh-options`
-  * `go run test/e2e_node/runner/run_e2e.go --logtostderr --hosts <comma separated hosts>`
+    * If ssh flags are required (e.g. `-i`), they can be used and passed to the
+tests with `--ssh-options`
+
+  * `go run test/e2e_node/runner/run_e2e.go --logtostderr --hosts <comma
+separated hosts>`
+
     * **Must be run from kubernetes root**
-    * requires (go get): `github.com/tools/godep`, `github.com/onsi/gomega`, `github.com/onsi/ginkgo/ginkgo`
+    * requires (go get): `github.com/tools/godep`, `github.com/onsi/gomega`,
+`github.com/onsi/ginkgo/ginkgo`
+
+3. Alternatively, manually build and copy `e2e_node_test.tar.gz` to a remote
+host
+
+  * Build the tar.gz `go run test/e2e_node/runner/run_e2e.go --logtostderr
+--build-only`
+
+    * requires (go get): `github.com/tools/godep`, `github.com/onsi/gomega`,
+`github.com/onsi/ginkgo/ginkgo`
 
-3. Alternatively, manually build and copy `e2e_node_test.tar.gz` to a remote host
-  * Build the tar.gz `go run test/e2e_node/runner/run_e2e.go --logtostderr --build-only`
-    * requires (go get): `github.com/tools/godep`, `github.com/onsi/gomega`, `github.com/onsi/ginkgo/ginkgo`
   * Copy `e2e_node_test.tar.gz` to the remote host
+
   * Extract the archive on the remote host `tar -xzvf e2e_node_test.tar.gz`
-  * Run the tests `./e2e_node.test --logtostderr --vmodule=*=2 --build-services=false --node-name=<hostname>`
-    * Note: This must be run from the directory containing the kubelet and kube-apiserver binaries.
+
+  * Run the tests `./e2e_node.test --logtostderr --vmodule=*=2
+--build-services=false --node-name=<hostname>`
+
+      * Note: This must be run from the directory containing the kubelet and
+kube-apiserver binaries.
 
 ## Running tests against a gce image
 
 * Build a gce image from a prepared gce host
   * Create the host from a base image and configure it (see above)
-    * Run tests against this remote host to ensure that it is setup correctly before doing anything else
+    * Run tests against this remote host to ensure that it is setup correctly
+before doing anything else
   * Create a gce *snapshot* of the instance
   * Create a gce *disk* from the snapshot
   * Create a gce *image* from the disk
@@ -112,8 +144,9 @@ See [setup_host.sh](../../test/e2e_node/environment/setup_host.sh)
 
 ## Kubernetes Jenkins CI and PR builder
 
-Node e2e tests are run against a static list of host environments continuously or when manually triggered on a github.com
-pull requests using the trigger phrase `@k8s-bot test node e2e experimental` - *results not yet publish, pending
+Node e2e tests are run against a static list of host environments continuously
+or when manually triggered on a github.com pull requests using the trigger
+phrase `@k8s-bot test node e2e experimental` - *results not yet publish, pending
 evaluation of test stability.*.