Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

populate the instructions on installing kubectl in getting-started-guides #11276

Merged
merged 1 commit into from
Jul 17, 2015

Conversation

caesarxuchao
Copy link
Member

Fixes #9632 and some nits in getting-started-guides

Regarding this comment, because there is no TOC page for docs/user-guide, so I followed the previous comment

@nikhiljindal @janetkuo

@k8s-bot
Copy link

k8s-bot commented Jul 14, 2015

GCE e2e build/test passed for commit e981a39d3ad946253cca436a5979bf2c69edd3d1.

@caesarxuchao
Copy link
Member Author

I will address this comment in this PR.

cc @bgrant0607

Update: Pushed

@caesarxuchao caesarxuchao force-pushed the doc1 branch 2 times, most recently from 62d4458 to fa64fbc Compare July 15, 2015 04:16
@k8s-bot
Copy link

k8s-bot commented Jul 15, 2015

GCE e2e build/test failed for commit 62d4458a463ad077b0e06266e52819ec35e0a494.

@bgrant0607
Copy link
Member

cc @erictune

@k8s-bot
Copy link

k8s-bot commented Jul 15, 2015

GCE e2e build/test failed for commit fa64fbcaf27458561252266be56ea80361a4c1d3.

@@ -38,7 +38,7 @@ no security tokens, no basic auth). For demonstration purposes only.

* [aws CLI](http://aws.amazon.com/cli)
* [CoreOS image for AWS](https://coreos.com/docs/running-coreos/cloud-providers/ec2/)
* [kubectl CLI](aws/kubectl.md)
* [kubectl CLI](aws/kubectl.md) ([installation](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/getting-started-guides/aws.md#command-line-administration-tool-kubectl))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Must use relative links.

@bgrant0607
Copy link
Member

@jlowdermilk @deads2k PTAL

@bgrant0607
Copy link
Member

The user guide TOC is in docs/user-guide/README.md, but I would link directly to docs/user-guide/prereqs.md.

@bgrant0607 bgrant0607 added this to the v1.0 milestone Jul 15, 2015
export PATH=<path/to/kubernetes-directory>/platforms/linux/amd64:$PATH
```

An alternate method, useful if you're building from source and do not want to configure the PATH, is using ./cluster/kubectl.sh instead of kubectl. That script will auto-detect the location of kubectl and proxy commands to it (eg., ./cluster/kubectl.sh cluster-info).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer we not direct users to this method. We want to stop using cluster/kubectl.sh as a command proxy and instead have it find the binary location and export PATH=...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bonus points if someone can better organize and cross-refernece the kubectl installation and kubeconfig docs, including this one, the text in the getting-started guides and examples (e.g., docs/user-guide/walkthrough), docs/user-guide/accessing-the-cluster.md, docs/user-guide/sharing-clusters.md, ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree we shouldn't mention kubectl.sh, btw. See #8817

@caesarxuchao
Copy link
Member Author

I've pushed a commit to address the comments.

@bgrant0607 I'm not sure what this comment is about.

@bgrant0607
Copy link
Member

LGTM. Please squash.

@bgrant0607 bgrant0607 added lgtm "Looks good to me", indicates that a PR is ready to be merged. kind/documentation Categorizes issue or PR as related to documentation. ok-to-merge labels Jul 16, 2015
@caesarxuchao
Copy link
Member Author

Squashed. Thanks.

@k8s-bot
Copy link

k8s-bot commented Jul 16, 2015

GCE e2e build/test passed for commit a9f979bc739578161317240f2b28d864421a4a58.

@j3ffml
Copy link
Contributor

j3ffml commented Jul 16, 2015

LGTM

@k8s-bot
Copy link

k8s-bot commented Jul 16, 2015

GCE e2e build/test passed for commit 10d76a5.

ArtfulCoder added a commit that referenced this pull request Jul 17, 2015
populate the instructions on installing kubectl in getting-started-guides
@ArtfulCoder ArtfulCoder merged commit 665c951 into kubernetes:master Jul 17, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants