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

Replaced all references to "master" #21815

Closed
wants to merge 2 commits into from
Closed

Conversation

punkdata
Copy link

Submitting this to PR to replace the term master on this page to Primary. I would suggest the community replace all the master references moving forward. #BlackLivesMatter

Submitting this to PR to replace the term master on this page to Primary. I would suggest the community replace all the `master` references moving forward. #BlackLivesMatter
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jun 16, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @punkdata!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 16, 2020
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jun 16, 2020
@punkdata
Copy link
Author

"I signed it"

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 16, 2020
@netlify
Copy link

netlify bot commented Jun 16, 2020

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 215344b

https://deploy-preview-21815--kubernetes-io-master-staging.netlify.app

@sftim
Copy link
Contributor

sftim commented Jun 16, 2020

Thanks for this PR @punkdata

Relevant to issue #21749
/hold

pending discussion on that issue and elsewhere

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 16, 2020
@sftim
Copy link
Contributor

sftim commented Jun 16, 2020

Ah, maybe not all references to “master”.
/hold cancel

@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 Jun 16, 2020
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

I recommend addressing the renaming with regard to issue #21800

Comment on lines +22 to +23
* The **Kubernetes Primary** is a collection of three processes that run on a single node in your cluster, which is designated as the primary node. Those processes are: [kube-apiserver](/docs/admin/kube-apiserver/), [kube-controller-manager](/docs/admin/kube-controller-manager/) and [kube-scheduler](/docs/admin/kube-scheduler/).
* Each individual non-primary node in your cluster runs two processes:
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs a bit more rewording (see issue #21800): these processes don't actually have to run on a single host.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is primary the preferred term to replace master elsewhere in the docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is primary the preferred term to replace master elsewhere in the docs?

“It depends”. primary pairs well with replica, but sometimes it is better to replace master with control plane, or other wording (“leader” if it's the result of an election, for example).

Copy link
Contributor

Choose a reason for hiding this comment

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

Well ... IMHO, "Kubernetes Control Plane" is the term we use elsewhere and the preferred replacement.

Copy link
Contributor

Choose a reason for hiding this comment

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

In other places throughout the documentation, the Master (I'll refer to this as the Primary down below) is discussed as one piece of the Kubernetes Control Plane, not a direct 1-to-1 replacement. The Kubelet is also part of the Control Plane but is not part of the Master.

If we were simply to replace the word "master" with the word "Kubernetes Control Plane", then we end up with awkward descriptions such as this at https://kubernetes.io/docs/concepts/#kubernetes-control-plane

The various parts of the Kubernetes Control Plane, such as the Kubernetes Master and kubelet processes

becomes the following, which doesn't make any sense:

The various parts of the Kubernetes Control Plane, such as the Kubernetes Control Plane and kubelet processes

We can of course re-word this to merge the Primary & CP concepts, but we need to be careful not to erase this architectural distinction. The Kubernetes documentation already has a lot of inconsistencies which are frustrating & confusing for new users. See #21755 for a similar example.

In that case, replacing "Master" with "Primary" would be the easy fix, as long the term "Primary" is the agreed-upon term and is used consistently throughout the documentation.

Copy link
Contributor

Choose a reason for hiding this comment

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

BTW, I don't count the kubelet as part of the control plane - see for example the diagram at https://kubernetes.io/docs/concepts/overview/components/#editPageButton

Copy link
Contributor

Choose a reason for hiding this comment

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

@zparnold
Copy link
Member

zparnold commented Jul 1, 2020

@punkdata Could you rebase your changes on the main branch for this repo (currently master) we'd love to get this change going!

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 1, 2020
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 1, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign jimangel
You can assign the PR to them by writing /assign @jimangel in a comment when ready.

The full list of commands accepted by this bot can be found 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

@punkdata punkdata closed this Jul 1, 2020
@punkdata
Copy link
Author

punkdata commented Jul 1, 2020

/assign @jimangel

@punkdata
Copy link
Author

punkdata commented Jul 1, 2020

@punkdata Could you rebase your changes on the main branch for this repo (currently master) we'd love to get this change going!

@zparnold MCs fixed and pushed thx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. 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.

7 participants