Add CONTRIBUTING section on build #36590

thockin · 2016-11-10T18:06:38Z

@kubernetes/contributor-experience

This change is

chrislovecnm · 2016-11-10T18:22:32Z

YAY ... assigned to a PR :)

grodrigues3 · 2016-11-10T18:24:10Z

the content looks good to me. when i click view md (not raw), the numbered list doesn't seem to be recognized and it's displayed as a single paragraph.

dims · 2016-11-10T18:25:19Z

CONTRIBUTING.md

+To build Kubernetes, simply type `make`.  This should figure out what it needs
+to do and not need any input from you.  If you want to just build a subset of
+code, you can pass the `WHAT` variable to `make`: e.g. `make
+WHAT="pkg/kubelet"`.


"cmd/kubectl" may be a better example as it generates a binary folks can use!

chrislovecnm

A couple of tweaks to talk about. Excited that we are improving this!!!

chrislovecnm · 2016-11-10T18:22:51Z

CONTRIBUTING.md

@@ -82,6 +82,27 @@ some bugs or smaller features.  We have a [feature development
 process](https://github.com/kubernetes/features/blob/master/README.md), but
 navigating the Kubernetes system as a newcomer can be very challenging.

+### Building the project
+
+There are a few things you need to build and test Kubernetes:


Build and test Kubernetes

This project?

chrislovecnm · 2016-11-10T18:25:17Z

CONTRIBUTING.md

+1. `docker` - some parts of the build/test system depend on `docker`.  You
+   need a relatively recent version of Docker installed, and available to you.
+1. `go` - Kubernetes is written in Go (aka golang), so you need a relatively
+   recent version of the Go toolchain installed.


Which platforms does this work on? Windows? Also should we link a n00b doc that has links to install instructions for each. I always approach this as a really really dumb perspective :)

chrislovecnm · 2016-11-10T18:25:34Z

CONTRIBUTING.md

+To build Kubernetes, simply type `make`.  This should figure out what it needs
+to do and not need any input from you.  If you want to just build a subset of
+code, you can pass the `WHAT` variable to `make`: e.g. `make
+WHAT="pkg/kubelet"`.


disagree - this is a commandline, not a console log.

Sounds good

chrislovecnm · 2016-11-10T18:25:50Z

CONTRIBUTING.md

+1. `go` - Kubernetes is written in Go (aka golang), so you need a relatively
+   recent version of the Go toolchain installed.
+
+To build Kubernetes, simply type `make`.  This should figure out what it needs


Type on a command line...

You will need to git clone it first too :)

ok, adding some words about downloads.

chrislovecnm · 2016-11-10T18:26:11Z

CONTRIBUTING.md

+
+To run basic tests, simply type `make test`.  This will run all of the unit
+tests in the project.  If you want to just test a subset of the project, you
+can pass the `WHAT` variable to `make`: e.g. `make test WHAT=pkg/kubelet`.


variable

environment variable :)

This is not an env var, it is a make var. I think env vars also work, but that is not what is being shown here

philips

Improvement

philips · 2016-11-10T18:34:17Z

CONTRIBUTING.md

+   features of `Makefile`s and other tools, so most commonly available versions
+   should work.
+1. `docker` - some parts of the build/test system depend on `docker`.  You
+   need a relatively recent version of Docker installed, and available to you.


this needs a link to our recommendation. I would suggest minikube onboarding and docker-env.

According to Dan Lorenc, minikube is targeting k8s end users. Using it for development of Kubernetes may be not very convenient. Or did I miss something here? Also, minikube by itself is probably overkill if the developer just wants to have docker.

+1 for Ivan, minikube is not for developers of k8s, for developers of k8s look at #36590 (comment) or #36590 (comment)

For local docker, pretty much any recent version works. I used 1.9 until recently.

Sure "but pretty much any recent version" is not sufficient and I would really just like us to punt to somewhere where we know a known good version is being maintained. For cross-platform availability for workstations the closest thing we got is minikube.

@ivan4th @pigmej Also, it isn't for k8s developer but it is a known good version of the Docker engine that the k8s community tests and packages as VMs.

philips · 2016-11-10T18:34:49Z

CONTRIBUTING.md

+1. `go` - Kubernetes is written in Go (aka golang), so you need a relatively
+   recent version of the Go toolchain installed.
+
+To build Kubernetes, simply type `make`.  This should figure out what it needs


You will need to git clone it first too :)

spxtr · 2016-11-10T18:46:48Z

It might be worth adding a line saying that we are investigating bazel with a link to the doc about that.

chrislovecnm · 2016-11-10T19:30:17Z

@spxtr I don't want to talk about how the build runs, I would recommend talking about how to run the build :) Bazel is awesome, but can we document that separately.

spxtr · 2016-11-10T19:34:21Z

CONTRIBUTING.md

@@ -82,6 +82,27 @@ some bugs or smaller features.  We have a [feature development
 process](https://github.com/kubernetes/features/blob/master/README.md), but
 navigating the Kubernetes system as a newcomer can be very challenging.

+### Building the project
+
+There are a few things you need to build and test Kubernetes:


You need a newline after this or the list won't render properly.

spxtr · 2016-11-10T19:34:59Z

@chrislovecnm that's reasonable.

pigmej · 2016-11-10T20:46:51Z

I have some suggestion can we somehow recommend using https://github.com/Mirantis/k8s-devbox and/or https://github.com/Mirantis/kubeadm-dind-cluster as a fast way to test your stuff? devbox is supposed to create reproducible development environment for working on Kubernetes project and there are some plans to add kubeadm to it which will allow to play with remote clusters too. I'm open to suggestions there. (cc @ivan4th author of these). Devbox has some shortcuts for newcomers (e2e simplification etc)

ivan4th · 2016-11-10T21:11:43Z

@jnowak: to be more precise, k8s-devbox tries to help getting k8s development environment up&running quickly and also tries to help new developers getting acquinted with k8s development workflow. As of now it uses kubernetes-dind-cluster as a fast method of multinode test cluster startup, but it will support kubeadm-dind-cluster soon. The latter uses kubeadm to create docker-in-docker-based cluster and supports workflows based on remote docker engine (copy binaries directly from the build data container & run the test cluster on the same remote docker where they were built). Both of these projects support running e2e tests locally, including ones requiring multiple nodes (unlike local-up-cluster). They're also much faster than VM-based clusters.

thockin · 2016-11-11T07:37:36Z

All, this doc is NOT an encyclopedic listing of everythign you need to know about how to use kube. It is an intro doc. Feel free to send followups that link to more details.

chrislovecnm · 2016-11-11T20:28:45Z

@thockin do we need an issue for an encyclopedic version of this doc?

thockin · 2016-11-11T22:59:59Z

Probably. I am on mobile now, can do later

On Nov 11, 2016 12:29 PM, "Chris Love" notifications@github.com wrote:

@thockin https://github.com/thockin do we need an issue for an
encyclopedic version of this doc?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#36590 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AFVgVFwMq_KokVih5hyMSsV2We8DUdJvks5q9NAKgaJpZM4Ku9rn
.

bgrant0607 · 2016-11-14T23:37:30Z

@thockin It shouldn't block this PR, but I'd like this doc to be very brief, with links to more information, which won't live in the kubernetes repo.

bgrant0607 · 2016-11-14T23:39:38Z

CONTRIBUTING.md

+   While Linux is the primary platform for Kubernetes, it should compile on a
+   Mac, too.  Windows is in progress.
+
+To build Kubernetes, simply type `make`.  This should figure out what it needs


#36655 claims that this doesn't work.

it does not work, if you don't have a go environment setup and use the documented build-tools/run.sh make

bgrant0607 · 2016-11-14T23:39:53Z

cc @sebgoa

bgrant0607 · 2016-11-14T23:40:34Z

Let's merge and iterate.
LGTM.

philips

Overall I am not going to fight this Docker version thing but we are honestly too close to the tech here to think "just install some known good version of Docker" is good enough as a developer onramp.

philips · 2016-11-22T19:55:06Z

CONTRIBUTING.md

+   features of `Makefile`s and other tools, so most commonly available versions
+   should work.
+1. `docker` - some parts of the build/test system depend on `docker`.  You
+   need a relatively recent version of Docker installed, and available to you.


Sure "but pretty much any recent version" is not sufficient and I would really just like us to punt to somewhere where we know a known good version is being maintained. For cross-platform availability for workstations the closest thing we got is minikube.

@ivan4th @pigmej Also, it isn't for k8s developer but it is a known good version of the Docker engine that the k8s community tests and packages as VMs.

thockin · 2016-11-22T20:02:34Z

If I knew where to punt, I would

On Tue, Nov 22, 2016 at 11:57 AM, Brandon Philips notifications@github.com
wrote:

@philips commented on this pull request.

Overall I am not going to fight this Docker version thing but we are
honestly too close to the tech here to think "just install some known good

version of Docker" is good enough as a developer onramp.

In CONTRIBUTING.md
#36590 (review)
:

@@ -82,6 +82,27 @@ some bugs or smaller features. We have a feature development
process, but
navigating the Kubernetes system as a newcomer can be very challenging.

+### Building the project
+
+There are a few things you need to build and test Kubernetes:
+1. make - the human interface to the Kubernetes build is make, so you must

have this tool installed on your machine. We try not to use too many crazy

features of Makefiles and other tools, so most commonly available versions

should work.
+1. docker - some parts of the build/test system depend on docker. You

need a relatively recent version of Docker installed, and available to you.

Sure "but pretty much any recent version" is not sufficient and I would
really just like us to punt to somewhere where we know a known good version
is being maintained. For cross-platform availability for workstations the
closest thing we got is minikube.

@ivan4th https://github.com/ivan4th @pigmej https://github.com/pigmej
Also, it isn't for k8s developer but it is a known good version of the
Docker engine that the k8s community tests and packages as VMs.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#36590 (review),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AFVgVFODNXFc9BHHMWXzbVWdDpsh1fIFks5rA0kbgaJpZM4Ku9rn
.

philips · 2016-11-22T22:48:56Z

@thockin I am suggesting we punt to minikube and force minikube to have a good docker install story on all platforms.

k8s-github-robot · 2016-11-28T19:42:39Z

Automatic merge from submit-queue

thockin assigned chrislovecnm and bgrant0607 Nov 10, 2016

googlebot added the cla: yes label Nov 10, 2016

k8s-github-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. release-note-label-needed labels Nov 10, 2016

dims reviewed Nov 10, 2016

View reviewed changes

chrislovecnm suggested changes Nov 10, 2016

View reviewed changes

philips reviewed Nov 10, 2016

View reviewed changes

spxtr reviewed Nov 10, 2016

View reviewed changes

k8s-github-robot added the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Nov 11, 2016

thockin added release-note-none Denotes a PR that doesn't merit a release note. and removed release-note-label-needed do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. labels Nov 11, 2016

thockin force-pushed the contrib-doc branch 2 times, most recently from 1864741 to 0916a81 Compare November 11, 2016 07:39

Add CONTRIBUTING section on build

20b7e9b

thockin force-pushed the contrib-doc branch from 0916a81 to 20b7e9b Compare November 11, 2016 07:40

k8s-github-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 11, 2016

bgrant0607 reviewed Nov 14, 2016

View reviewed changes

bgrant0607 added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2016

philips reviewed Nov 22, 2016

View reviewed changes

k8s-github-robot merged commit 3406000 into kubernetes:master Nov 28, 2016

thockin deleted the contrib-doc branch August 14, 2019 17:45

Add CONTRIBUTING section on build #36590

Add CONTRIBUTING section on build #36590

Conversation

thockin commented Nov 10, 2016 • edited by Q-Lee Loading

chrislovecnm commented Nov 10, 2016

grodrigues3 commented Nov 10, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrislovecnm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philips left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pigmej Nov 10, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spxtr commented Nov 10, 2016

chrislovecnm commented Nov 10, 2016

Choose a reason for hiding this comment

spxtr commented Nov 10, 2016

pigmej commented Nov 10, 2016 • edited Loading

ivan4th commented Nov 10, 2016

thockin commented Nov 11, 2016

chrislovecnm commented Nov 11, 2016

thockin commented Nov 11, 2016

bgrant0607 commented Nov 14, 2016

Choose a reason for hiding this comment

sebgoa Nov 15, 2016 • edited Loading

Choose a reason for hiding this comment

bgrant0607 commented Nov 14, 2016

bgrant0607 commented Nov 14, 2016

philips left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thockin commented Nov 22, 2016

version of Docker" is good enough as a developer onramp.

philips commented Nov 22, 2016

k8s-github-robot commented Nov 28, 2016

thockin commented Nov 10, 2016 •

edited by Q-Lee

Loading

grodrigues3 commented Nov 10, 2016 •

edited

Loading

pigmej Nov 10, 2016 •

edited

Loading

pigmej commented Nov 10, 2016 •

edited

Loading

sebgoa Nov 15, 2016 •

edited

Loading