From 96cb95bdfd6c360a8d28920cbff28ecedc623258 Mon Sep 17 00:00:00 2001 From: Budh Ram Gurung Date: Fri, 16 Jun 2017 17:56:51 +0530 Subject: [PATCH] Fix typo, grammar, punctuations and formatting --- Makefile | 2 +- cmd/localkube/cmd/start.go | 2 +- cmd/minikube/cmd/completion.go | 2 +- cmd/minikube/cmd/env.go | 4 ++-- cmd/minikube/cmd/env_test.go | 2 +- cmd/minikube/cmd/ip.go | 2 +- cmd/minikube/cmd/mount.go | 4 ++-- cmd/minikube/cmd/root_test.go | 4 ++-- cmd/minikube/cmd/service.go | 4 ++-- cmd/minikube/cmd/ssh.go | 2 +- cmd/util/util.go | 4 ++-- docs/README.md | 2 +- docs/addons.md | 4 ++-- docs/contributors/adding_a_dependency.md | 2 +- docs/contributors/build_guide.md | 14 +++++++------- docs/contributors/roadmap.md | 4 ++-- docs/contributors/updating_kubernetes.md | 4 ++-- docs/debugging.md | 4 ++-- docs/env_vars.md | 4 ++-- docs/host_folder_mount.md | 4 ++-- docs/insecure_registry.md | 2 +- docs/reusing_the_docker_daemon.md | 2 +- 22 files changed, 39 insertions(+), 39 deletions(-) diff --git a/Makefile b/Makefile index d17bfb806e..abc78f76c5 100644 --- a/Makefile +++ b/Makefile @@ -205,7 +205,7 @@ buildroot-image: $(ISO_BUILD_IMAGE) # convenient alias to build the docker conta $(ISO_BUILD_IMAGE): deploy/iso/minikube-iso/Dockerfile docker build -t $@ -f $< $(dir $<) @echo "" - @echo "$(@) succesfully built" + @echo "$(@) successfully built" .PHONY: release-iso release-iso: minikube_iso checksum diff --git a/cmd/localkube/cmd/start.go b/cmd/localkube/cmd/start.go index 1216721a5b..8429f1d189 100644 --- a/cmd/localkube/cmd/start.go +++ b/cmd/localkube/cmd/start.go @@ -74,7 +74,7 @@ func SetupServer(s *localkube.LocalkubeServer) { } } - //Set feature gates + // Set feature gates if s.FeatureGates != "" { glog.Infof("Setting Feature Gates: %s", s.FeatureGates) err := feature.DefaultFeatureGate.Set(s.FeatureGates) diff --git a/cmd/minikube/cmd/completion.go b/cmd/minikube/cmd/completion.go index 7c639dc83c..10905003ee 100644 --- a/cmd/minikube/cmd/completion.go +++ b/cmd/minikube/cmd/completion.go @@ -40,7 +40,7 @@ const longDescription = ` $ source /etc/bash-completion $ source <(minikube completion bash) - Additionally, you may want to output completion to a file and source in your .bashrc + Additionally, you may want to output the completion to a file and source in your .bashrc ` const boilerPlate = ` diff --git a/cmd/minikube/cmd/env.go b/cmd/minikube/cmd/env.go index 20cd6f514b..cd9136fb05 100644 --- a/cmd/minikube/cmd/env.go +++ b/cmd/minikube/cmd/env.go @@ -178,7 +178,7 @@ func shellCfgSet(api libmachine.API) (*ShellConfig, error) { case noProxyValue == "": noProxyValue = ip case strings.Contains(noProxyValue, ip): - //ip already in no_proxy list, nothing to do + // ip already in no_proxy list, nothing to do default: noProxyValue = fmt.Sprintf("%s,%s", noProxyValue, ip) } @@ -283,7 +283,7 @@ func (EnvNoProxyGetter) GetNoProxyVar() (string, string) { var dockerEnvCmd = &cobra.Command{ Use: "docker-env", Short: "Sets up docker env variables; similar to '$(docker-machine env)'", - Long: `sets up docker env variables; similar to '$(docker-machine env)'`, + Long: `Sets up docker env variables; similar to '$(docker-machine env)'.`, Run: func(cmd *cobra.Command, args []string) { api, err := machine.NewAPIClient() diff --git a/cmd/minikube/cmd/env_test.go b/cmd/minikube/cmd/env_test.go index 5f4557fd9e..28fc00cc3d 100644 --- a/cmd/minikube/cmd/env_test.go +++ b/cmd/minikube/cmd/env_test.go @@ -57,7 +57,7 @@ var defaultAPI = &tests.MockAPI{ }, } -//Most of the shell cfg isn't configurable +// Most of the shell cfg isn't configurable func newShellCfg(shell, prefix, suffix, delim string) *ShellConfig { return &ShellConfig{ DockerCertPath: constants.MakeMiniPath("certs"), diff --git a/cmd/minikube/cmd/ip.go b/cmd/minikube/cmd/ip.go index 4020fb662f..65985a59e0 100644 --- a/cmd/minikube/cmd/ip.go +++ b/cmd/minikube/cmd/ip.go @@ -29,7 +29,7 @@ import ( // ipCmd represents the ip command var ipCmd = &cobra.Command{ Use: "ip", - Short: "Retrieve the IP address of the running cluster.", + Short: "Retrieves the IP address of the running cluster", Long: `Retrieves the IP address of the running cluster, and writes it to STDOUT.`, Run: func(cmd *cobra.Command, args []string) { api, err := machine.NewAPIClient() diff --git a/cmd/minikube/cmd/mount.go b/cmd/minikube/cmd/mount.go index 8ecf0de0ad..b66bdfe1bd 100644 --- a/cmd/minikube/cmd/mount.go +++ b/cmd/minikube/cmd/mount.go @@ -72,7 +72,7 @@ var mountCmd = &cobra.Command{ errText := fmt.Sprintf("Cannot find directory %s for mount", hostPath) fmt.Fprintln(os.Stderr, errText) } else { - errText := fmt.Sprintf("Error accesssing directory %s for mount", hostPath) + errText := fmt.Sprintf("Error accessing directory %s for mount", hostPath) fmt.Fprintln(os.Stderr, errText) } os.Exit(1) @@ -115,7 +115,7 @@ var mountCmd = &cobra.Command{ os.Exit(1) } } - fmt.Printf("Mounting %s into %s on the minikubeVM\n", hostPath, vmPath) + fmt.Printf("Mounting %s into %s on the minikube VM\n", hostPath, vmPath) fmt.Println("This daemon process needs to stay alive for the mount to still be accessible...") port, err := cmdUtil.GetPort() if err != nil { diff --git a/cmd/minikube/cmd/root_test.go b/cmd/minikube/cmd/root_test.go index 67095c69f2..b434f98ad6 100644 --- a/cmd/minikube/cmd/root_test.go +++ b/cmd/minikube/cmd/root_test.go @@ -97,8 +97,8 @@ func runCommand(f func(*cobra.Command, []string)) { f(&cmd, args) } -// Temporarily unsets the env variables for the test cases -// returns a function to reset them to their initial values +// Temporarily unsets the env variables for the test cases. +// Returns a function to reset them to their initial values. func hideEnv(t *testing.T) func(t *testing.T) { envs := make(map[string]string) for _, env := range os.Environ() { diff --git a/cmd/minikube/cmd/service.go b/cmd/minikube/cmd/service.go index 9f7bf75b06..c645120ec9 100644 --- a/cmd/minikube/cmd/service.go +++ b/cmd/minikube/cmd/service.go @@ -41,7 +41,7 @@ var ( var serviceCmd = &cobra.Command{ Use: "service [flags] SERVICE", Short: "Gets the kubernetes URL(s) for the specified service in your local cluster", - Long: `Gets the kubernetes URL(s) for the specified service in your local cluster. In the case of multiple URLs they will be printed one at a time`, + Long: `Gets the kubernetes URL(s) for the specified service in your local cluster. In the case of multiple URLs they will be printed one at a time.`, PersistentPreRun: func(cmd *cobra.Command, args []string) { t, err := template.New("serviceURL").Parse(serviceURLFormat) if err != nil { @@ -81,7 +81,7 @@ func init() { serviceCmd.Flags().BoolVar(&serviceURLMode, "url", false, "Display the kubernetes service URL in the CLI instead of opening it in the default browser") serviceCmd.Flags().BoolVar(&https, "https", false, "Open the service URL with https instead of http") - serviceCmd.PersistentFlags().StringVar(&serviceURLFormat, "format", defaultServiceFormatTemplate, "Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time.") + serviceCmd.PersistentFlags().StringVar(&serviceURLFormat, "format", defaultServiceFormatTemplate, "Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time.") RootCmd.AddCommand(serviceCmd) } diff --git a/cmd/minikube/cmd/ssh.go b/cmd/minikube/cmd/ssh.go index b9890ee75a..8a26f537f8 100644 --- a/cmd/minikube/cmd/ssh.go +++ b/cmd/minikube/cmd/ssh.go @@ -31,7 +31,7 @@ import ( var sshCmd = &cobra.Command{ Use: "ssh", Short: "Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'", - Long: "Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'", + Long: "Log into or run a command on a machine with SSH; similar to 'docker-machine ssh'.", Run: func(cmd *cobra.Command, args []string) { api, err := machine.NewAPIClient() if err != nil { diff --git a/cmd/util/util.go b/cmd/util/util.go index 4deef9bd09..fa046ab89d 100644 --- a/cmd/util/util.go +++ b/cmd/util/util.go @@ -173,7 +173,7 @@ func PromptUserForAccept(r io.Reader) bool { } else if response == "n" || response == "no" { return false } else { - fmt.Println("Invalid response, error reporting remains disabled. Must be in form [Y/n]") + fmt.Println("Invalid response, error reporting remains disabled. Must be in form [Y/n]") return false } case <-time.After(30 * time.Second): @@ -202,7 +202,7 @@ Add kubectl to your system PATH` if err != nil { fmt.Fprintf(out, `======================================== -kubectl could not be found on your path. kubectl is a requirement for using minikube +kubectl could not be found on your path. kubectl is a requirement for using minikube To install kubectl, please %s the following: %s diff --git a/docs/README.md b/docs/README.md index 956c7b30a1..2deb393325 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ * **Minikube Addons** ([addons.md](addons.md)): Information on configuring addons to be run on minikube -* **Configuring Kubernetes** ([configuring_kubernetes.md](configuring_kubernetes.md)): Configuring different kubernetes components in minikube +* **Configuring Kubernetes** ([configuring_kubernetes.md](configuring_kubernetes.md)): Configuring different Kubernetes components in minikube ### Installation and debugging diff --git a/docs/addons.md b/docs/addons.md index 79ab723de4..0e779a9e25 100644 --- a/docs/addons.md +++ b/docs/addons.md @@ -1,6 +1,6 @@ ## Add-ons -Minikube has a set of built in addons that can be used enabled, disabled, and opened inside of the local k8s environment. Below is an exampe of this functionality for the `heapster` addon: +Minikube has a set of built in addons that can be used enabled, disabled, and opened inside of the local k8s environment. Below is an example of this functionality for the `heapster` addon: ```shell $ minikube addons list - addon-manager: enabled @@ -25,6 +25,6 @@ The currently supported addons include: * [Heapster](https://github.com/kubernetes/heapster): [Troubleshooting Guide](https://github.com/kubernetes/heapster/blob/master/docs/influxdb.md) Note:You will need to login to Grafana as admin/admin in order to access the console * [Registry Credentials](https://github.com/upmc-enterprises/registry-creds) -If you would like to have minikube properly start/restart custom addons, place the addon(s) you wish to be launched with minikube in the `.minikube/addons` directory. Addons in this folder will be moved to the minikubeVM and launched each time minikube is started/restarted. +If you would like to have minikube properly start/restart custom addons, place the addon(s) you wish to be launched with minikube in the `.minikube/addons` directory. Addons in this folder will be moved to the minikube VM and launched each time minikube is started/restarted. If you have a request for an addon in minikube, please open an issue with the name and preferably a link to the addon with a description of its purpose and why it should be added. You can also attempt to add the addon to minikube by following the guide at [Adding an Addon](contributors/adding_an_addon.md) diff --git a/docs/contributors/adding_a_dependency.md b/docs/contributors/adding_a_dependency.md index 6c3f581601..330699eb0b 100644 --- a/docs/contributors/adding_a_dependency.md +++ b/docs/contributors/adding_a_dependency.md @@ -38,7 +38,7 @@ Here is a rough set of steps that usually works to add a new dependency. If it is a large dependency, please commit the vendor/ directory changes separately. - This makes review easier in Github. + This makes review easier in GitHub. NOTE: We have recently added a deprecation message regarding boot2docker. Make sure that this deprecation message ends up in the vendored code at `/vendor/github.com/docker/machine/libmachine/provision/boot2docker.go`: [https://github.com/kubernetes/minikube/blob/master/vendor/github.com/docker/machine/libmachine/provision/boot2docker.go#L220](https://github.com/kubernetes/minikube/blob/master/vendor/github.com/docker/machine/libmachine/provision/boot2docker.go#L220) diff --git a/docs/contributors/build_guide.md b/docs/contributors/build_guide.md index 99bb1137ae..22350c295f 100644 --- a/docs/contributors/build_guide.md +++ b/docs/contributors/build_guide.md @@ -6,7 +6,7 @@ #### Prerequisites for different GNU/Linux distributions ##### Fedora -On Fedora you need to install glibc-static +On Fedora you need to install _glibc-static_ ```shell $ sudo dnf install -y glibc-static @@ -47,13 +47,13 @@ make integration #### Conformance Tests -These are kubernetes tests that run against an arbitrary cluster and exercise a wide range of kubernetes features. +These are Kubernetes tests that run against an arbitrary cluster and exercise a wide range of Kubernetes features. You can run these against minikube by following these steps: -* Clone the kubernetes repo somewhere on your system. +* Clone the Kubernetes repo somewhere on your system. * Run `make quick-release` in the k8s repo. * Start up a minikube cluster with: `minikube start`. -* Set these two environment variables: +* Set following two environment variables: ```shell export KUBECONFIG=$HOME/.kube/config export KUBERNETES_CONFORMANCE_TEST=y @@ -63,9 +63,9 @@ export KUBERNETES_CONFORMANCE_TEST=y go run hack/e2e.go -v --test --test_args="--ginkgo.focus=\[Conformance\]" --check_version_skew=false --check_node_count=false ``` -To run a specific Conformance Test, you can use the `ginkgo.focus` flag to filter the set using a regular expression. -The hack/e2e.go wrapper and the e2e.sh wrappers have a little trouble with quoting spaces though, so use the `\s` regular expression character instead. -For example, to run the test `should update annotations on modification [Conformance]`, use this command: +To run a specific conformance test, you can use the `ginkgo.focus` flag to filter the set using a regular expression. +The `hack/e2e.go` wrapper and the `e2e.sh` wrappers have a little trouble with quoting spaces though, so use the `\s` regular expression character instead. +For example, to run the test `should update annotations on modification [Conformance]`, use following command: ```shell go run hack/e2e.go -v --test --test_args="--ginkgo.focus=should\supdate\sannotations\son\smodification" --check_version_skew=false --check_node_count=false diff --git a/docs/contributors/roadmap.md b/docs/contributors/roadmap.md index 2b3ccc94f5..3d5fc19f7e 100644 --- a/docs/contributors/roadmap.md +++ b/docs/contributors/roadmap.md @@ -13,7 +13,7 @@ Here are some specific features that align with our goal: * Becoming the default local-cluster setup for Kubernetes ## Non-Goals -* Simplifying kubernetes production deployment experience. Kube-deploy is attempting to tackle this problem. +* Simplifying Kubernetes production deployment experience. Kube-deploy is attempting to tackle this problem. * Supporting all possible deployment configurations of Kubernetes like various types of storage, networking, etc. ## Priorities @@ -45,4 +45,4 @@ This section is subject to change based on feedback and staffing. * Minikube no longer depends on existing KVM driver * Native drivers are made default and packaged with minikube * Improve minikube start time by 30% -* Add a no-vm driver for linux CI environments \ No newline at end of file +* Add a no-vm driver for linux CI environments diff --git a/docs/contributors/updating_kubernetes.md b/docs/contributors/updating_kubernetes.md index c3fd45766e..59d95dbc67 100644 --- a/docs/contributors/updating_kubernetes.md +++ b/docs/contributors/updating_kubernetes.md @@ -76,7 +76,7 @@ Server Version: version.Info{Major:"1", Minor:"3+", GitVersion:"v1.3.0-beta.2", The Server Version should contain the right tag in `version.Info.GitVersion`. If any manual changes were required, please commit the vendor changes separately. -This makes the change easier to view in Github. +This makes the change easier to view in GitHub. ```shell git add vendor/ @@ -85,4 +85,4 @@ git add --all git commit -m "Manual changes to update Kubernetes to foo" ``` -As a final part of updating kubernetes, a new version of localkube should be uploaded to GCS so that users can select this version of kubernetes/localkube in later minikube/localkube builds. For instructions on how to do this, see [releasing_localkube.md](https://github.com/kubernetes/minikube/blob/master/docs/contributors/releasing_localkube.md) +As a final part of updating Kubernetes, a new version of localkube should be uploaded to GCS so that users can select this version of Kubernetes/localkube in later minikube/localkube builds. For instructions on how to do this, see [releasing_localkube.md](https://github.com/kubernetes/minikube/blob/master/docs/contributors/releasing_localkube.md) diff --git a/docs/debugging.md b/docs/debugging.md index e1fc54c070..93e5d212c6 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -1,5 +1,5 @@ ### Debugging Issues With Minikube -To debug issues with minikube (not kubernetes but minikube itself), you can use the -v flag to see debug level info. The specified values for v will do the following (the values are all encompassing in that higher values will give you all lower value outputs as well): +To debug issues with minikube (not Kubernetes but minikube itself), you can use the -v flag to see debug level info. The specified values for v will do the following (the values are all encompassing in that higher values will give you all lower value outputs as well): * --v=0 INFO level logs * --v=1 WARNING level logs * --v=2 ERROR level logs @@ -10,4 +10,4 @@ If you need to access additional tools for debugging, minikube also includes the You can ssh into the toolbox and access these additional commands using: -`minikube ssh toolbox` \ No newline at end of file +`minikube ssh toolbox` diff --git a/docs/env_vars.md b/docs/env_vars.md index 402db1bf7c..053ee4ec69 100644 --- a/docs/env_vars.md +++ b/docs/env_vars.md @@ -1,6 +1,6 @@ ## Minikube Environment Variables -Minikube supports passing environment variables instead of flags for every value listed in `minikube config list`. This is done by passing an environment variable with the prefix `MINIKUBE_`For example the `minikube start --iso-url="$ISO_URL"` flag can also be set by setting the `MINIKUBE_ISO_URL="$ISO_URL"` environment variable. +Minikube supports passing environment variables instead of flags for every value listed in `minikube config list`. This is done by passing an environment variable with the prefix `MINIKUBE_`. For example the `minikube start --iso-url="$ISO_URL"` flag can also be set by setting the `MINIKUBE_ISO_URL="$ISO_URL"` environment variable. Some features can only be accessed by environment variables, here is a list of these features: @@ -27,4 +27,4 @@ Kubectl is now configured to use the cluster. # Then you can examine the profile with: $ go tool pprof /tmp/profile933201292/cpu.pprof -``` \ No newline at end of file +``` diff --git a/docs/host_folder_mount.md b/docs/host_folder_mount.md index 9028613c5e..c3ad1c3d9e 100644 --- a/docs/host_folder_mount.md +++ b/docs/host_folder_mount.md @@ -1,6 +1,6 @@ ## Mounting Host Folders -`minikube mount /path/to/dir/to/mount:/vm-mount-path` is the recommended way to mount directories into minikube so that they can be used in your local kubernetes cluster. The command works on all supported platforms. Below is an example workflow for using `minikube mount`: +`minikube mount /path/to/dir/to/mount:/vm-mount-path` is the recommended way to mount directories into minikube so that they can be used in your local Kubernetes cluster. The command works on all supported platforms. Below is an example workflow for using `minikube mount`: ``` # terminal 1 @@ -73,4 +73,4 @@ $ cat ~/mount-dir/hello-from-pod hello from pod ``` -Some drivers themselves provide host-folder sharing options, but we plan to deprecate these in the future as they are all implemented differently and they are not configurable through minikube. \ No newline at end of file +Some drivers themselves provide host-folder sharing options, but we plan to deprecate these in the future as they are all implemented differently and they are not configurable through minikube. diff --git a/docs/insecure_registry.md b/docs/insecure_registry.md index 0454fc451c..efa75221a3 100644 --- a/docs/insecure_registry.md +++ b/docs/insecure_registry.md @@ -23,4 +23,4 @@ $ minikube addons enable registry-creds For additional information on private container registries, see [this page](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). -We recommend you use ImagePullSecrets, but if you would like to configure access on the minikube VM you can place the `.dockercfg` in the `/home/docker` directory or the `config.json` in the `/home/docker/.docker` directory. \ No newline at end of file +We recommend you use _ImagePullSecrets_, but if you would like to configure access on the minikube VM you can place the `.dockercfg` in the `/home/docker` directory or the `config.json` in the `/home/docker/.docker` directory. diff --git a/docs/reusing_the_docker_daemon.md b/docs/reusing_the_docker_daemon.md index d7bcfff3aa..ea2ccbc41d 100644 --- a/docs/reusing_the_docker_daemon.md +++ b/docs/reusing_the_docker_daemon.md @@ -28,4 +28,4 @@ The fix is to update /etc/sysconfig/docker to ensure that minikube's environment > fi ``` -Remember to turn off the imagePullPolicy:Always, as otherwise kubernetes won't use images you built locally. \ No newline at end of file +Remember to turn off the _imagePullPolicy:Always_, as otherwise Kubernetes won't use images you built locally.