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

ubuntu getting started guide #2857

Merged
merged 1 commit into from
Dec 16, 2014
Merged

ubuntu getting started guide #2857

merged 1 commit into from
Dec 16, 2014

Conversation

jainvipin
Copy link

instructions to help start kubernetes cluster on ubuntu systems. I didn't create an issue for this PR because this was a documentation change - please let me know if I should.

@jbeda jbeda self-assigned this Dec 11, 2014
@jbeda
Copy link
Contributor

jbeda commented Dec 11, 2014

@jainvipin Thanks for writing this!

I'd much prefer that we bring this stuff into the kubernetes repo instead of referring to an external repo. We'll then be able to both (a) keep it up to date as things change and (b) distribute it as part of our binary install packages.

At the very least, we shouldn't have binaries checked in to github but instead point users at our official binary releases.

Most of our install guides are in the form of:

Is this something you'd be willing to take on?

@jainvipin
Copy link
Author

@jbeda: what you suggest makes sense; I I wasn't sure about things so I let it go for now. Let me update the PR and put all the scripts in kubernetes guides dirs and keep all scripts in there natively.

@jbeda
Copy link
Contributor

jbeda commented Dec 11, 2014

Building an "official-ish" release tar is pretty easy. Just do a make release (or make quick-release to skip the unit/integration tests). the tar will get dropped in _output/release-tars/kubernetes.tar.gz. The unpacked staging area for that tar is _output/release-stage/full/kubernetes/.

@mikedanese
Copy link
Member

@jainvipin Nice work, I have a couple comments. First the upstart scripts are very nice to have versioned with the project. We have systemd configs but nothing for upstart yet. Second, without network setup included in the guide it feels very similar to the getting started locally guide. Have you tried including networking config into the guide so this could be an ubuntu-cluster getting started guide? Third, after the setup is complete, rather than going into usage specifics, you could refer users to the Kubernetes 101. This separates doc concerns and that doc is more likely to be maintained with new kubernetes releases whereas the setup guides might not change as much.

@jainvipin
Copy link
Author

@jbeda: yes 'make release' is a simple way; I was using 'hack/build-go.sh to get the binaries; thanks for the hint.

I have another question on the directory structure and preference for the docs: 'docs' and 'getting-started-guides' directories contains only '.md' files, What is the best place to keep the ubuntu upstart scripts for the basic config? Would it be best keeping them inline in the doc? Or, put them as checked in files some directory (if so what is the best place to keep those files)?

I will update the PR after your response.

@jainvipin
Copy link
Author

@mikedanese: thanks for your suggestions. Some comments and for my clarification:
First comment: can you please elaborate what you mean by checking version? Do you mean checking kubernetes version to ensure compatibility in the upstart scripts?
Second comment: Yes it looks similar except that when someone wants to try it like that it wouldn't work (the intent is the same, of course!) - so I felt that the need for ubuntu lanuch should be separate. Regarding showing setting up ubuntu cluster, is it okay if I do it after I am done updating the single-host part and incorporate jbeda's comments?
I will incorporate third comment i.e. refer to kubernetes-101.

@mikedanese
Copy link
Member

Okay great. When I said versioned, I meant versioned in git. So if I wanted an upstart script for kubernetes v0.4 or v0.6 I could checkout that git tag and there would be a set of upstart scripts that would work for me. This PR will satisfy that.

@jbeda
Copy link
Contributor

jbeda commented Dec 12, 2014

If you put the scripts under cluster/ubuntu/... they'll automatically get bundled up with the full release builds. That way the scripts, binaries and instructions will all be grabbed together.

@jainvipin
Copy link
Author

@jbeda: done; hopefully this one looks cleaner; binary check-ins was a bad idea :-)

### 1. Make kubernetes and etcd binaries
Either build or download the latest [kubernetest binaries] (https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/getting-started-guides/binary_release.md)

copy the kube binaries into /opt/bin or a path of your choice
Copy link
Contributor

Choose a reason for hiding this comment

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

Capitalize copy

Copy link
Author

Choose a reason for hiding this comment

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

thanks; done.
This occurred at two places, also first line had 'two' steps, changed it to 'three steps'.

@jbeda
Copy link
Contributor

jbeda commented Dec 15, 2014

Some nits, but looks good to me!

@jainvipin
Copy link
Author

also took care of backquotes in the doc; please let me know if you want me to squash my changes into one diff.

@jbeda
Copy link
Contributor

jbeda commented Dec 15, 2014

Shoot! One more thing that I forgot. Do you mind adding yourself to MAINTAINERS.md? That way we'll know who to reach out to if this breaks and such. You can help folks using this out.

@jbeda
Copy link
Contributor

jbeda commented Dec 15, 2014

Also, can you rebase/squash these? I can help if you haven't done that with git before.

@jainvipin
Copy link
Author

@jbeda - done with all; let me know if something is amiss

@jbeda
Copy link
Contributor

jbeda commented Dec 16, 2014

Very nice work. Thank you! Merging now.

jbeda added a commit that referenced this pull request Dec 16, 2014
ubuntu getting started guide
@jbeda jbeda merged commit 308b078 into kubernetes:master Dec 16, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants