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.

Sign up for GitHub

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

Jump to bottom

add cidr to glossary #17550

Merged

k8s-ci-robot merged 4 commits into kubernetes:master from mhamdisemah:add_cidr

Dec 3, 2019

Contributor

mhamdisemah commented Nov 12, 2019

Fixes #17507

Contributor

k8s-ci-robot commented Nov 12, 2019

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 added cncf-cla: no size/S labels

k8s-ci-robot requested review from Rajakavitha1 and sftim

November 12, 2019 19:51

k8s-ci-robot added language/en sig/docs labels

mhamdisemah force-pushed the add_cidr branch from ed1a9df to 628f25e Compare

November 12, 2019 19:52

netlify bot commented Nov 12, 2019

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

Built with commit ed1a9df

https://deploy-preview-17550--kubernetes-io-master-staging.netlify.com

netlify bot commented Nov 12, 2019 •

edited

Loading

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

Built with commit e97c827

https://deploy-preview-17550--kubernetes-io-master-staging.netlify.com

mhamdisemah force-pushed the add_cidr branch from 628f25e to 01a356c Compare

November 12, 2019 20:30

k8s-ci-robot added cncf-cla: yes size/XXL and removed cncf-cla: no size/S labels

mhamdisemah force-pushed the add_cidr branch from 01a356c to 55a27f8 Compare

November 12, 2019 20:36

Contributor

makoscafee commented Nov 13, 2019

Hi, @mhamdisemah mind deleting folder .git-rewrite you pushed along with the changes?

sftim reviewed

View reviewed changes

content/en/docs/reference/glossary/cidr.md Outdated Show resolved Hide resolved

content/en/docs/reference/glossary/cidr.md Outdated


		<!--more-->

		It is an IP addressing scheme that replaces the older system based on classes A, B, and C. With CIDR, a single IP address can be used to designate many unique IP addresses. A CIDR IP address looks like a normal IP address except that it ends with a slash followed by a number, called the IP network prefix.

Contributor

sftim Nov 13, 2019

That's the correct meaning of CIDR generally. However, Kubernetes uses CIDR to mean “a block of IP addresses that you can describe with an start address and a netmask”. For example, various IPv6 settings use the term CIDR even though CIDR itself is purely an IPv4 concept.

Contributor

christophercarney Nov 13, 2019

To that end, maybe something add something specific to how it is used in Kubernetes, like In Kubernetes, each node is assigned a range of IP addresses through the start address and a netmask. This allows nodes to assign each <Pod> a unique IP address.

mhamdisemah force-pushed the add_cidr branch from af3bdd1 to b3804a5 Compare

November 13, 2019 20:01

k8s-ci-robot added size/M and removed size/XXL labels


          add CIDR

8b99e8d

mhamdisemah force-pushed the add_cidr branch from b3804a5 to 8b99e8d Compare

November 13, 2019 20:12

k8s-ci-robot added size/S and removed size/M labels


          modify cidr definition

1a55be0

christophercarney reviewed

View reviewed changes

Contributor

christophercarney left a comment

Adding some informal, non-binding suggestions to clean-up the wording, let me know if you think it could be improved.

content/en/docs/reference/glossary/cidr.md Outdated Show resolved Hide resolved

content/en/docs/reference/glossary/cidr.md Outdated Show resolved Hide resolved

mhamdisemah and others added 2 commits

November 14, 2019 20:56


          Update content/en/docs/reference/glossary/cidr.md

84d0c5e

Co-Authored-By: Chris <[email protected]>


          Update content/en/docs/reference/glossary/cidr.md

e97c827

Co-Authored-By: Chris <[email protected]>

Contributor

tengqm commented Nov 18, 2019

/lgtm

k8s-ci-robot assigned tengqm

k8s-ci-robot added the lgtm label

sftim reviewed

View reviewed changes

content/en/docs/reference/glossary/cidr.md

+              date: 2019-11-12
+              full_link:
+              short_description: >
+                CIDR is a notation for describing blocks of IP addresses and is used heavily in various networking configurations.

Contributor

sftim Nov 18, 2019

Suggested change

      
              CIDR is a notation for describing blocks of IP addresses and is used heavily in various networking configurations.
          
              A notation for describing blocks of IP addresses

Contributor

sftim Nov 18, 2019

This could be a glossary tooltip. I think these work well when succinct; someone who wants to learn more can click.

content/en/docs/reference/glossary/cidr.md


		<!--more-->

		In the context of Kubernetes, each {{< glossary_tooltip text="Node" term_id="node" >}} is assigned a range of IP addresses through the start address and a subnet mask using CIDR. This allows Nodes to assign each {{< glossary_tooltip text="Pod" term_id="pod" >}} a unique IP address. Although originally a concept for IPv4, CIDR has also been expanded to include IPv6.

Contributor

sftim Nov 18, 2019

Kubernetes uses CIDR blocks for various things including this example.
ipBlock from NetworkPolicy also refers to blocks of IP addresses.

Is it helpful to show an actual example, eg mention 203.0.113.128/25 and show the range that it covers?

Contributor

christophercarney Nov 18, 2019 •

edited

Loading

Ok, maybe something then to the effect of: "CIDR is used in various networking aspects in Kubernetes. For example..."

I'm not sure providing an explicit example of CIDR would be useful, in my experience CIDR isn't super intuitive to people who have never seen it before so the example would probably be lost on them. I think there would be two main audiences for this glossary: people who don't know what CIDR is or people who know what CIDR is, but want to know how it applies to Kubernetes. Right now I think the definition helps more of the second audience and the discussion is how much should we cater towards the first audience (complete beginners to CIDR) and if trying to define CIDR for beginners is out-of-scope when there are a lot of good resources on the web for learning CIDR notation

Contributor

sftim Nov 18, 2019

How does SIG Docs feel about hyperlinking to, eg, Wikipedia's page about this?

Contributor

tengqm Nov 21, 2019

My feeling is that we don't need to dive into the details of CIDR which is pretty common an acronym in the community.

Contributor

tengqm commented Dec 1, 2019

Where are we now? Can we get this in?
/lgtm

Contributor

christophercarney commented Dec 2, 2019 •

edited

Loading

/lgtm to me as well.
/assign @tfogo
@tfogo mind approving this?

k8s-ci-robot assigned tfogo

Contributor

k8s-ci-robot commented Dec 2, 2019

@christophercarney: changing LGTM is restricted to collaborators

In response to this:

/lgtm
To me as well.
/assign @tfogo

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.

Contributor

tengqm commented Dec 3, 2019

/approve

Contributor

k8s-ci-robot commented Dec 3, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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:

~~content/en/OWNERS~~ [tengqm]

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 added the approved label

k8s-ci-robot merged commit bf92b9f into kubernetes:master

zacharysarah pushed a commit to zacharysarah/website that referenced this pull request


          add cidr to glossary (kubernetes#17550)

c4d1005

* add CIDR

* modify cidr definition

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

zacharysarah pushed a commit to zacharysarah/website that referenced this pull request


          add cidr to glossary (kubernetes#17550)

d24651f

* add CIDR

* modify cidr definition

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

zacharysarah pushed a commit to zacharysarah/website that referenced this pull request


          add cidr to glossary (kubernetes#17550)

68da5c1

* add CIDR

* modify cidr definition

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

gochist added a commit to gochist/website that referenced this pull request


          Reword commits that cause Prow warnings (#1)

ec5b784

* Fix a command in kubectl cheatsheet (kubernetes#17888)

* Remove dead links to old getting started guides (kubernetes#17889)

* Change PowerShell example to use the -Raw flag (kubernetes#17645)

* Spelling correction (kubernetes#17895)

* fix some broken links (kubernetes#17897)

* update exmaple for job (kubernetes#17903)

* Deleted duplicate sentence and corrected typo (kubernetes#17902)

* Corrected the typo of 'chck' with 'check'

* Removed the duplicate sentence

* Fix a dead link (kubernetes#17900)

* fix 404 urls in kustomization.md (kubernetes#17793)

* Update kustomization.md

fix 404 urls in kustomization.md

* Update content/en/docs/tasks/manage-kubernetes-objects/kustomization.md

Co-Authored-By: Tim Bannister <[email protected]>

* update kustomization.md to be more stable

* Fix broken link to AWS provider settings source (kubernetes#17899)

* update style guide for styling component names (kubernetes#17588)

* update style guide for styling component names

- Attempt to outline style conventions for components
  and component tools
- Interested in comments and feedback

* update style examples

* style edits

- removed code style for components not cmd tools
- added style suggestion for namespaces
- cleaned up a few stray spaces

* fix output example in automated-tasks-with-cron-jobs.md (kubernetes#17906)

* Update an out-of-date link (kubernetes#17907)

Signed-off-by: umiblue <[email protected]>

* en-fr: Append Note To Alternative Linux Install (kubernetes#17827)

* Blog post: Gardener Project Update (kubernetes#17516)

* Add Gardener Project Update blog post

* Update and rename 2019-11-10-gardener-project-update.md to 2019-11-27-gardener-project-update.md

* Update and rename 2019-11-27-gardener-project-update.md to 2019-12-02-gardener-project-update.md

* Update KubeCon buttons for Shanghai (kubernetes#17916)

* fix path not consistent (kubernetes#17923)

* updated 3 logos on case studies page (kubernetes#17628)

* Update kube-scheduler.md (kubernetes#17283)

Fix grammar typo

* Add missing `systemctl` step for running `cri-o` (kubernetes#17926)

After installing `cri-o`, we must run `systemctl daemon-reload` before
trying to run `systemctl start crio`. Otherwise, `systemd` doesn't know
about the crio configuration.

Similar instructions already exist for installing docker - this diff
adds these instructions for crio.

* add cidr to glossary (kubernetes#17550)

* add CIDR

* modify cidr definition

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

* Update content/en/docs/reference/glossary/cidr.md

Co-Authored-By: Chris <[email protected]>

* specify components requiring feature gate (kubernetes#17922)

* specify components requiring feature gate 

currently, TTLafterfinished feature gate is a flag that can be passed to kube-apiserver, kube-scheduler and kube-controller-manager. The current description doesn't state what components to pass the flag to.

* specify components requiring feature gate

* Fixed hot reload panic of local hugo issue. (kubernetes#17894)

* fix-up 404 urls (kubernetes#17936)

* fix-up 404 urls

* Revert "fix-up 404 urls"

This reverts commit 4515c4d.

* fix-ip 404 urls

* fix-up 404 urls

* Update guaranteed-scheduling-critical-addon-pods.md (kubernetes#17151)

* Update guaranteed-scheduling-critical-addon-pods.md

cleanup old stuff again

* Update content/en/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods.md

Co-Authored-By: Tim Bannister <[email protected]>

* Update guaranteed-scheduling-critical-addon-pods.md

remove whitespace

* correct diagram label (kubernetes#17942)

* fix-up 404 urls (kubernetes#17941)

* fix-up 404 urls

* Revert "fix-up 404 urls"

This reverts commit 4515c4d.

* fix-ip 404 urls

* fix-up 404 urls

* fix-up 404 urls

Revert "fix-up 404 urls"

This reverts commit 4515c4d.

fix-ip 404 urls

fix-up 404 urls

* fix-up 404 urls

* Translate Minikube environment to French (kubernetes#17939)

* Freshen the list of English content approvers for SIG Docs (kubernetes#17929)

* Add YouTube social button in header and footer (kubernetes#16838)

* Update the cluster create and disable commands (kubernetes#17947)

* Initialize DNS Pod Service for ID Localization. (kubernetes#16707)

Co-Authored-By: Giri Kuncoro <[email protected]>
Co-Authored-By: Tim Bannister <[email protected]>

* Add statefulsets for ID localization. (kubernetes#16700)

* Initialize Common Label for ID Localization. (kubernetes#16706)

* Add job running into completion in ID Localization. (kubernetes#16705)

* Updated kubeone URL (kubernetes#17766)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved cncf-cla: yes language/en lgtm sig/docs size/S