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

Add readme for coredns #61040

Closed
wants to merge 2 commits into from
Closed

Add readme for coredns #61040

wants to merge 2 commits into from

Conversation

pacoxu
Copy link
Member

@pacoxu pacoxu commented Mar 12, 2018

What this PR does / why we need it:
No readme for coredns, only some for kube-dns

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:
add some links and descriptions like kube-dns

Release note:

NONE

Signed-off-by: Paco Xu <paco.xu@daocloud.io>
Add some links and simple descriptions to this folder as there are also another option "coredns"
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. retest-not-required-docs-only size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 12, 2018
@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.


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 cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 12, 2018
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pacoxu
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: mrhohn

Assign the PR to them by writing /assign @mrhohn in a comment when ready.

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

@pacoxu
Copy link
Member Author

pacoxu commented Mar 12, 2018

CLA registered

@MrHohn
Copy link
Member

MrHohn commented Mar 12, 2018

/assign @rajansandeep
I think it would be more clear if we keep coredns and kube-dns manifests in separate folders (e.g. dns/coredns, dns/kube-dns), though that requires changing cluster-up scripts.

@k8s-ci-robot
Copy link
Contributor

@MrHohn: GitHub didn't allow me to assign the following users: rajansandeep.

Note that only kubernetes members and repo collaborators can be assigned.

In response to this:

/assign @rajansandeep
I think it would be more clear if we keep coredns and kube-dns manifests in separate folders (e.g. dns/coredns, dns/kube-dns), though that requires changing cluster-up scripts.

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.

@MrHohn
Copy link
Member

MrHohn commented Mar 12, 2018

/ok-to-test

@k8s-ci-robot k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 12, 2018
@rajansandeep
Copy link
Contributor

@MrHohn Yes, keeping them in different folders is doable. Is this something we need to prioritize for 1.10 or it can be for later releases?

`coredns` is schedules DNS Pods and Service on the cluster, other pods in cluster
can use the DNS Service’s IP to resolve DNS names.

* [Administrators guide](https://coredns.io/2018/01/29/deploying-kubernetes-with-coredns-using-kubeadm/)
Copy link
Contributor

Choose a reason for hiding this comment

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

This guide applies to installing CoreDNS via kubeadm and doesn't apply here.

Copy link
Member

Choose a reason for hiding this comment

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

@rajansandeep i agree.
also given the ongoing transition to CoreDNS the above paragraph would be misleading for the next release. i would Close this PR, until we have settled.

@MrHohn
Copy link
Member

MrHohn commented Mar 12, 2018

@rajansandeep No worries, seems fine to do that for later releases.

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 7, 2018
@neolit123
Copy link
Member

/remove-lifecycle stale

@rajansandeep @MrHohn

hello, how do you want to proceed with this PR?

@pacoxu
given there are a couple of folders now under cluster/addons/dns/
the name of the file should not be coredns_README.md, but rather it should go as README.md in here:
https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/dns/coredns

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 7, 2018
@neolit123
Copy link
Member

@pacoxu also please sign the CLA.
instructions in the second comment.

@chrisohaver
Copy link
Contributor

FYI, cluster/addons per the Kubernetes docs has been described as "deprecated" for quite some time now.

From https://kubernetes.io/docs/concepts/cluster-administration/addons/ :

There are several other add-ons documented in the deprecated cluster/addons directory.
Well-maintained ones should be linked to here. PRs welcome!

I believe "here" above refers to the addons docs page itself, not the deprecated cluster/addons directory.

IMO, if the docs are wrong, they should be fixed.
If they are right, then we should mention that cluster/addons is deprecated in it's README. Something like this ...

This directory is deprecated, please link well maintained add-ons to the Addons section in the Kubernetes Documentation.

i.e. the reciprocal of the message in the docs.

@neolit123
Copy link
Member

@chrisohaver hm, i don't know if the docs are wrong in this case.
possibly the CoreDNS team should decide and action some new PRs here.

this particular PR might not get any further updates from the original author.
so let me know if you want me to close it.

@chrisohaver
Copy link
Contributor

I say close it. Per my understanding this addons directory is supposed to be deprecated (as of 10 months ago), and is also titled "Legacy Addons".

@neolit123
Copy link
Member

I say close it. Per my understanding this addons directory is supposed to be deprecated (as of 10 months ago), and is also titled "Legacy Addons".

ok

/close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. release-note-none Denotes a PR that doesn't merit a release note. 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.

None yet

7 participants