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

Update k8s-infra-prow-build README to clarify access instructions. #1735

Merged
merged 1 commit into from
Mar 2, 2021

Conversation

cjwagner
Copy link
Member

The instructions for accessing the cluster were a bit hidden in the setup instructions. I pulled them out into their own section for clarity (and to link to more easily) and also fixed a minor mistake and an omission.

/assign @spiffxp

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. area/prow Setting up or working with prow in general, prow.k8s.io, prow build clusters labels Feb 27, 2021
@k8s-ci-robot k8s-ci-robot added sig/testing Categorizes an issue or PR as relevant to SIG Testing. wg/k8s-infra size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 27, 2021
Copy link
Member

@spiffxp spiffxp left a comment

Choose a reason for hiding this comment

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

So actually...

Comment on lines 9 to 16
The k8s-infra-prow-build cluster is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters).
It cannot be directly accessed with kubectl from outside the GCP project,
cloud-shell must first be used as follows:
```shell
# Start a cloud shell
gcloud alpha cloud-shell ssh --project=k8s-infra-prow-build

# Login to set the authenticated user for gcloud in the cloud shell session.
Copy link
Member

@spiffxp spiffxp Feb 27, 2021

Choose a reason for hiding this comment

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

As of #1727 this part is no longer true, so here's my suggestion to make this more relevant. Can move the bookmarks to the bottom of the page.

Suggested change
The k8s-infra-prow-build cluster is a [private GKE cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters).
It cannot be directly accessed with kubectl from outside the GCP project,
cloud-shell must first be used as follows:
```shell
# Start a cloud shell
gcloud alpha cloud-shell ssh --project=k8s-infra-prow-build
# Login to set the authenticated user for gcloud in the cloud shell session.
Access to the [k8s-infra-prow-build project][k8s-infra-prow-build-console] hosting the cluster is granted by membership in one of two @kubernetes.io groups:
- [k8s-infra-prow-oncall@kubernetes.io][k8s-infra-prow-oncall@]: grants [`roles/owner`][roles/owner] access
- [k8s-infra-prow-viewers@kubernetes.io][k8s-infra-prow-viewers@]: grants [`prow.viewer`][roles/prow.viewer] access
If you are not a member of either of these groups, please [follow these instructions to join][join-groups]
[k8s-infra-prow-build-console]: https://console.cloud.google.com/home/dashboard?project=k8s-infra-prow-build
[k8s-infra-prow-oncall]: https://github.com/kubernetes/k8s.io/blob/3a1aea1652f02a95253402bde2bca63cb4292f8e/groups/groups.yaml#L647-L670
[k8s-infra-prow-viewers]: https://github.com/kubernetes/k8s.io/blob/3a1aea1652f02a95253402bde2bca63cb4292f8e/groups/groups.yaml#L672-L699
[roles/owner]: https://cloud.google.com/iam/docs/understanding-roles#basic-definitions
[roles/prow.viewer]: https://github.com/kubernetes/k8s.io/blob/main/infra/gcp/roles/prow.viewer.yaml
[join-groups]: https://github.com/kubernetes/k8s.io/tree/main/groups#making-changes
```shell
# Login to set the authenticated user for gcloud

Copy link
Member Author

Choose a reason for hiding this comment

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

Awesome, added these changes.

@cjwagner cjwagner force-pushed the accessing-k8s-infra branch from b92ce51 to 7d341b1 Compare March 1, 2021 23:54
Copy link
Member

@spiffxp spiffxp left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 2, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cjwagner, spiffxp

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 2, 2021
@k8s-ci-robot k8s-ci-robot merged commit 2720de1 into kubernetes:main Mar 2, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.21 milestone Mar 2, 2021
@cjwagner cjwagner deleted the accessing-k8s-infra branch March 2, 2021 00:44
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/prow Setting up or working with prow in general, prow.k8s.io, prow build clusters 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. sig/testing Categorizes an issue or PR as relevant to SIG Testing. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants