Developer Guide End-to-end setup instructions for Linux, Windows, and macOS #5003

pymander · 2020-07-31T17:34:27Z

This covers E2E setup instructions for compiling Kubernetes locally on
Linux, Windows, and macOS workstations. There is also a substantial
rewrite of the instructions for running tests, along with relevant
links for more information.

Which issue(s) this PR fixes:
fixes: #1644

This covers E2E setup instructions for compiling Kubernetes locally on Linux, Windows, and macOS workstations. There is also a substantial rewrite of the instructions for running tests, along with relevant links for more information.

k8s-ci-robot · 2020-07-31T17:34:35Z

Hi @pymander. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

pymander · 2020-07-31T17:35:11Z

/assign @lavalamp

idvoretskyi · 2020-07-31T17:37:40Z

/hold

/ok-to-test

idvoretskyi · 2020-07-31T17:38:40Z

/unassign @lavalamp

/assign @guineveresaenger

lavalamp · 2020-07-31T17:39:50Z

Thanks, I don't have time to review this right now, sorry :)

…

On Fri, Jul 31, 2020 at 10:38 AM Ihor Dvoretskyi ***@***.***> wrote: /unassign @lavalamp <https://github.com/lavalamp> /assign @guineveresaenger <https://github.com/guineveresaenger> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5003 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAE6BFWX64XFH5WORCSNDQLR6L6TDANCNFSM4PQTTNUQ> .

parispittman · 2020-07-31T18:12:23Z

thank you so much Erik!!

mrbobbytables

Thanks @pymander :)
The changes look great.
I have a two small comments, but would not consider them blocking for merge. 👍

contributors/devel/development.md

Cleared up instructions for jq and etcd in the Developer Guide.

nikhita · 2020-08-03T16:27:35Z

/assign

I'll take a look at this today or first thing tomorrow :)

nikhita · 2020-08-03T16:29:25Z

cc @ykakarap -- can you also take a look when you get a chance? Especially since you recently set up your dev environment :)

@pymander Thank you SO MUCH for doing this btw! This work has been outstanding for years now, glad to see you overhaul the docs! 🎉 🙌

idvoretskyi · 2020-08-12T16:51:01Z

/assign

I'll check out the Win instructions here :)

mrbobbytables

I've verified the osx instructions 👍 and added one potential suggestion.

contributors/devel/development.md

pymander · 2020-08-24T19:54:45Z

/assign @idvoretskyi

mrbobbytables · 2020-08-25T13:21:57Z

/approve

idvoretskyi

/approve for Win10.

k8s-ci-robot · 2020-08-25T13:28:04Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: idvoretskyi, mrbobbytables, pymander

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~contributors/devel/OWNERS~~ [idvoretskyi,mrbobbytables]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

mrbobbytables · 2020-08-25T14:19:06Z

/hold cancel

I think that verifies the outliers and we're good to merge.

Is there any other blockers folks can think of that should be addressed?

nikhita

Left a few comments but most of that includes updating stale information. We can get that in as a follow-up. Thank you so much, @pymander! :)

/lgtm

nikhita · 2020-08-26T17:15:35Z

contributors/devel/development.md

-environment instructions.
-
-#### Upgrading Go
+##### A Note on Changing Go Versions


The original instructions are unfortunately out of date :(

We should probably remove this section, but can do that as a follow-up. The updated instructions would go in the sig-release handbook - kubernetes/sig-release#1109 (comment).

nikhita · 2020-08-26T17:17:01Z

contributors/devel/development.md

@@ -168,69 +278,87 @@ development environment, please [set one up](http://golang.org/doc/code.html).
 | 1.17 - 1.18    | 1.13.9      |
 | 1.18+          | 1.14.4      |


This needs to be go 1.15 now :)

nikhita · 2020-08-26T17:17:15Z

contributors/devel/development.md

@@ -168,69 +278,87 @@ development environment, please [set one up](http://golang.org/doc/code.html).
 | 1.17 - 1.18    | 1.13.9      |


This should be go 1.13.15

nikhita · 2020-08-26T17:18:10Z

contributors/devel/development.md

+
+#### etcd
+
+To test Kubernetes, you will need to install etcd, a consistent and highly-available key value store. As of Kubernetes 1.18, the required etcd version is at least 3.2.10. To install a local version of etcd, run the following command in your Kubernetes working directory.


I think we can probably avoid mentioning the etcd version here because it might get stale (we've faced this issue with the go versions).

We could probably just ask the reader to install the appropriate version of etcd by using this script.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 31, 2020

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. area/developer-guide Issues or PRs related to the developer guide labels Jul 31, 2020

k8s-ci-robot requested review from guineveresaenger and idvoretskyi July 31, 2020 17:34

k8s-ci-robot assigned lavalamp Jul 31, 2020

k8s-ci-robot assigned guineveresaenger and unassigned lavalamp Jul 31, 2020

mrbobbytables reviewed Aug 2, 2020

View reviewed changes

contributors/devel/development.md Outdated Show resolved Hide resolved

contributors/devel/development.md Show resolved Hide resolved

Clarification of a few changes to the Developer Guide

b67e2ec

Cleared up instructions for jq and etcd in the Developer Guide.

k8s-ci-robot assigned nikhita Aug 3, 2020

k8s-ci-robot assigned idvoretskyi Aug 12, 2020

mrbobbytables reviewed Aug 19, 2020

View reviewed changes

contributors/devel/development.md Show resolved Hide resolved

Developer guide: add note about shell init scripts in macOS

624d2a0

mrbobbytables added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Aug 25, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 25, 2020

idvoretskyi approved these changes Aug 25, 2020

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 25, 2020

nikhita reviewed Aug 26, 2020

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 26, 2020

k8s-ci-robot merged commit d7e353b into kubernetes:master Aug 26, 2020

pymander deleted the devel-building-guide branch August 26, 2020 17:26

pymander mentioned this pull request Sep 2, 2020

Developer Guide: Followup to correct stale information, missing step #5091

Merged

pymander mentioned this pull request Sep 30, 2020

REQUEST: New membership for @pymander kubernetes/org#2234

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Developer Guide End-to-end setup instructions for Linux, Windows, and macOS #5003

Developer Guide End-to-end setup instructions for Linux, Windows, and macOS #5003

pymander commented Jul 31, 2020 •

edited by mrbobbytables

Loading

k8s-ci-robot commented Jul 31, 2020

pymander commented Jul 31, 2020

idvoretskyi commented Jul 31, 2020

idvoretskyi commented Jul 31, 2020

lavalamp commented Jul 31, 2020 via email

parispittman commented Jul 31, 2020

mrbobbytables left a comment

nikhita commented Aug 3, 2020

nikhita commented Aug 3, 2020

idvoretskyi commented Aug 12, 2020

mrbobbytables left a comment

pymander commented Aug 24, 2020

mrbobbytables commented Aug 25, 2020

idvoretskyi left a comment

k8s-ci-robot commented Aug 25, 2020

mrbobbytables commented Aug 25, 2020

nikhita left a comment

nikhita Aug 26, 2020

nikhita Aug 26, 2020

nikhita Aug 26, 2020

nikhita Aug 26, 2020

		@@ -168,69 +278,87 @@ development environment, please [set one up](http://golang.org/doc/code.html).
		\| 1.17 - 1.18 \| 1.13.9 \|
		\| 1.18+ \| 1.14.4 \|


		#### etcd

		To test Kubernetes, you will need to install etcd, a consistent and highly-available key value store. As of Kubernetes 1.18, the required etcd version is at least 3.2.10. To install a local version of etcd, run the following command in your Kubernetes working directory.

Developer Guide End-to-end setup instructions for Linux, Windows, and macOS #5003

Developer Guide End-to-end setup instructions for Linux, Windows, and macOS #5003

Conversation

pymander commented Jul 31, 2020 • edited by mrbobbytables Loading

k8s-ci-robot commented Jul 31, 2020

pymander commented Jul 31, 2020

idvoretskyi commented Jul 31, 2020

idvoretskyi commented Jul 31, 2020

lavalamp commented Jul 31, 2020 via email

parispittman commented Jul 31, 2020

mrbobbytables left a comment

Choose a reason for hiding this comment

nikhita commented Aug 3, 2020

nikhita commented Aug 3, 2020

idvoretskyi commented Aug 12, 2020

mrbobbytables left a comment

Choose a reason for hiding this comment

pymander commented Aug 24, 2020

mrbobbytables commented Aug 25, 2020

idvoretskyi left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 25, 2020

mrbobbytables commented Aug 25, 2020

nikhita left a comment

Choose a reason for hiding this comment

nikhita Aug 26, 2020

Choose a reason for hiding this comment

nikhita Aug 26, 2020

Choose a reason for hiding this comment

nikhita Aug 26, 2020

Choose a reason for hiding this comment

nikhita Aug 26, 2020

Choose a reason for hiding this comment

pymander commented Jul 31, 2020 •

edited by mrbobbytables

Loading