Skip to content

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

Merged
k8s-ci-robot merged 3 commits into
kubernetes:masterfrom
pymander:devel-building-guide
Aug 26, 2020
Merged

Developer Guide End-to-end setup instructions for Linux, Windows, and macOS#5003
k8s-ci-robot merged 3 commits into
kubernetes:masterfrom
pymander:devel-building-guide

Conversation

@pymander
Copy link
Copy Markdown
Contributor

@pymander pymander commented Jul 31, 2020 •
edited by mrbobbytables
Loading

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
@pymander
End-to-end setup instructions for Linux, Windows, and macOS
44dba2b 
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 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
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Jul 31, 2020

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.

Details

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.
@k8s-ci-robot 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
@pymander
Copy link
Copy Markdown
Contributor Author

pymander commented Jul 31, 2020

/assign @lavalamp
@idvoretskyi
Copy link
Copy Markdown
Member

idvoretskyi commented Jul 31, 2020

/hold

/ok-to-test
@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 31, 2020
@idvoretskyi
Copy link
Copy Markdown
Member

idvoretskyi commented Jul 31, 2020

/unassign @lavalamp

/assign @guineveresaenger
@lavalamp
Copy link
Copy Markdown
Contributor

lavalamp commented Jul 31, 2020 via email

@parispittman
Copy link
Copy Markdown
Contributor

parispittman commented Jul 31, 2020

thank you so much Erik!!
mrbobbytables
mrbobbytables reviewed Aug 2, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@mrbobbytables mrbobbytables left a comment

Choose a reason for hiding this comment

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

Thanks @pymander :)
The changes look great.
I have a two small comments, but would not consider them blocking for merge. 👍
Comment thread contributors/devel/development.md Outdated
Comment thread contributors/devel/development.md
@pymander
Clarification of a few changes to the Developer Guide
b67e2ec 
Cleared up instructions for jq and etcd in the Developer Guide.
@nikhita
Copy link
Copy Markdown
Member

nikhita commented Aug 3, 2020

/assign

I'll take a look at this today or first thing tomorrow :)
@nikhita
Copy link
Copy Markdown
Member

nikhita commented Aug 3, 2020

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
Copy link
Copy Markdown
Member

idvoretskyi commented Aug 12, 2020

/assign

I'll check out the Win instructions here :)
mrbobbytables
mrbobbytables reviewed Aug 19, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@mrbobbytables mrbobbytables left a comment

Choose a reason for hiding this comment

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

I've verified the osx instructions 👍 and added one potential suggestion.
Comment thread contributors/devel/development.md
@pymander
Copy link
Copy Markdown
Contributor Author

pymander commented Aug 24, 2020

/assign @idvoretskyi
@mrbobbytables mrbobbytables added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Aug 25, 2020
@mrbobbytables
Copy link
Copy Markdown
Member

mrbobbytables commented Aug 25, 2020

/approve
@k8s-ci-robot 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
idvoretskyi approved these changes Aug 25, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@idvoretskyi idvoretskyi left a comment

Choose a reason for hiding this comment

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

/approve for Win10.
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Aug 25, 2020

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
@mrbobbytables
Copy link
Copy Markdown
Member

mrbobbytables commented Aug 25, 2020

/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?
@k8s-ci-robot 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
nikhita reviewed Aug 26, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@nikhita nikhita left a comment

Choose a reason for hiding this comment

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

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
Comment thread contributors/devel/development.md
environment instructions.

#### Upgrading Go
##### A Note on Changing Go Versions
Copy link
Copy Markdown
Member

@nikhita nikhita Aug 26, 2020

Choose a reason for hiding this comment

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

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).
Comment thread 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 |
Copy link
Copy Markdown
Member

@nikhita nikhita Aug 26, 2020

Choose a reason for hiding this comment

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

This needs to be go 1.15 now :)
Comment thread 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 |
Copy link
Copy Markdown
Member

@nikhita nikhita Aug 26, 2020

Choose a reason for hiding this comment

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

This should be go 1.13.15
Comment thread 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.
Copy link
Copy Markdown
Member

@nikhita nikhita Aug 26, 2020

Choose a reason for hiding this comment

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

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 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 k8s-ci-robot merged commit d7e353b into kubernetes:master Aug 26, 2020
@pymander pymander deleted the devel-building-guide branch August 26, 2020 17:26
@pymander pymander mentioned this pull request Sep 2, 2020
Merged
@pymander pymander mentioned this pull request Sep 30, 2020
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/developer-guide Issues or PRs related to the developer guide cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.

8 participants

@pymander @k8s-ci-robot @idvoretskyi @lavalamp @parispittman @nikhita @mrbobbytables @guineveresaenger