Skip to content
Permalink
Browse files

Perfect documentations again

Signed-off-by: yuxiaobo <yuxiaobogo@163.com>
  • Loading branch information...
yuxiaobo96 committed Sep 29, 2019
1 parent e9a3109 commit c7b7499c916ccf7bafd42474e3f935e29aa00266
@@ -34,7 +34,7 @@ import (
// kindnetd will also write a templated cni config supplied with PodCIDR
//
// input envs:
// - HOST_IP: hould be populated by downward API
// - HOST_IP: should be populated by downward API
// - POD_IP: should be populated by downward API
// - CNI_CONFIG_TEMPLATE: the cni .conflist template, run with {{ .PodCIDR }}

@@ -26,7 +26,7 @@ import (
)

/*
This is adapated from:
This is adapted from:
https://github.com/kubernetes/kubernetes/blob/07a5488b2a8f67add543da72e8819407d8314204/pkg/kubelet/dockershim/helpers.go#L115-L155
*/
// generateMountBindings converts the mount list to a list of strings that
@@ -16,14 +16,14 @@ limitations under the License.

package exec

// DefaultCmder is a LocalCmder instance used for convienience, packages
// DefaultCmder is a LocalCmder instance used for convenience, packages
// originally using os/exec.Command can instead use pkg/kind/exec.Command
// which forwards to this instance
// TODO(bentheelder): swap this for testing
// TODO(bentheelder): consider not using a global for this :^)
var DefaultCmder = &LocalCmder{}

// Command is a convience wrapper over DefaultCmder.Command
// Command is a convenience wrapper over DefaultCmder.Command
func Command(command string, args ...string) Cmd {
return DefaultCmder.Command(command, args...)
}
@@ -156,7 +156,7 @@ func (b *DockerBuildBits) buildBash() error {
"build/run.sh", "make", "all",
"WHAT="+strings.Join(what, " "), "KUBE_BUILD_PLATFORMS="+dockerBuildOsAndArch(),
)
// ensure the build isn't especially noisy..., inheret existing env
// ensure the build isn't especially noisy..., inherit existing env
cmd.SetEnv(
append(
[]string{"KUBE_VERBOSE=0"},
@@ -103,7 +103,7 @@ func waitForReady(node nodes.Node, until time.Time) bool {
// then the status will have the following format: `True True True'.
status := strings.Fields(lines[0])
for _, s := range status {
// Check node status. If node is ready then this wil be 'True',
// Check node status. If node is ready then this will be 'True',
// 'False' or 'Unkown' otherwise.
if !strings.Contains(s, "True") {
return false
@@ -114,7 +114,7 @@ func waitForReady(node nodes.Node, until time.Time) bool {
}

// helper that calls `try()`` in a loop until the deadline `until`
// has passed or `try()`returns true, returns wether try ever returned true
// has passed or `try()`returns true, returns whether try ever returned true
func tryUntil(until time.Time, try func() bool) bool {
for until.After(time.Now()) {
if try() {
@@ -212,7 +212,7 @@ func (b *bufferPool) Get() *bytes.Buffer {
return b.Pool.Get().(*bytes.Buffer)
}

// Put returns a buffer to the pool, reseting it first
// Put returns a buffer to the pool, resetting it first
func (b *bufferPool) Put(x *bytes.Buffer) {
// only store small buffers to avoid pointless allocation
// avoid keeping arbitrarily large buffers
@@ -68,7 +68,7 @@ Kubernetes style configuration files.

While doing this we should respect the Kubernetes [API Conventions].

Addtionally we should minimize the number of flags used and avoid structured
Additionally we should minimize the number of flags used and avoid structured
values in flags as these cannot be versioned.

## Minimize Assumptions
@@ -187,7 +187,7 @@ Go to the **Advanced** settings page, and change the settings there, see
## Failing to properly start cluster
This issue is similar to a
[failure while building the node image](#failure-to-build-node-image).
If the cluster creation process was successul but you are unable to see any
If the cluster creation process was successful but you are unable to see any
Kubernetes resources running, for example:
```

0 comments on commit c7b7499

Please sign in to comment.
You can’t perform that action at this time.