-
Notifications
You must be signed in to change notification settings - Fork 301
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
Update docs for contributing #697
Conversation
@spencerhance Please take a look and leave comments. Would be great if you could walk through some of the steps to make sure they make sense + work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙌 Only a few comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@@ -29,14 +23,14 @@ under [core]/project is the one that contains your cluster. Second, ensure that | |||
the current logged-in account listed under [core]/account is the owner of the project. | |||
In other words, this account should have full project ownership permissions and be listed as | |||
having the "Owner" role on the IAM page of your GCP project. You might ask why this | |||
is needed? Well, the reason is that the script invokes a kubectl command which | |||
is needed? Well, the reason is that our [script](../resources/gke-self-managed.sh) invokes a kubectl command which |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to fix this link ../resources/gke-self-managed.sh
that comes by default: | ||
|
||
```console | ||
kubectl delete pod l7-lb-controller |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Humm.. IIUC kubelet on the master will bring this pod back as long as the manifest still exists. We probably need something like
$ gcloud compute ssh e2e-test-zihongz-master
$ sudo rm /etc/kubernetes/manifests/glbc.manifest
``` | ||
|
||
Note that the above command automatically destroys any existing cluster that | ||
was previously created with --up. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably link to https://github.com/kubernetes/community/blob/master/contributors/devel/sig-testing/e2e-tests.md for further details?
kubectl delete pod l7-lb-controller | ||
``` | ||
|
||
This ensures we can run our own copy of the controller locally. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be great to link to docs/deploy/local/README.md
?
project-id = foo-project | ||
network-name = foo-network | ||
subnetwork-name = foo-subnetwork | ||
node-instance-prefix = gke-foo-cluster |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Humm, what does it looks like in the e2e cluster case? Something like node-instance-prefix = e2e-test-zihongz
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bowei, rramkumar1 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:
Approvers can indicate their approval by writing |
@MrHohn This got merged before I resolved your comments. Will open another PR with those fixes plus others. Thanks! |
This PR organizes our contributor docs a bit better and removes lots of stale info. Specifically, there is now more information on:
There are also other misc. updates.
Ref: #557