Commit graph

90 commits

Author SHA1 Message Date
Xiao An
05c0f7161b Fix some typos in documents (#2592)
Signed-off-by: Xiao An <hac@zju.edu.cn>
2019-02-21 07:15:17 +00:00
Brian Bao
c2133ce6b1 Update README.md on compiling from GitHub (#2543) 2019-02-09 14:40:54 +00:00
Kenjiro Nakayama
92836cc6f9 Fix broken link (#2522)
This patch fixes broken link in README.md
2019-02-03 12:46:19 +00:00
Miek Gieben
f300fa9bb2
readme: add text on backward incompat changes (#2470)
* readme: add text on backward incompat changes

Document the process of releasing backwards incompatible changes.

Signed-off-by: Miek Gieben <miek@miek.nl>

* slightly better

Signed-off-by: Miek Gieben <miek@miek.nl>

* Add an example

Signed-off-by: Miek Gieben <miek@miek.nl>

* Be more explicit in naming the segments increased

Signed-off-by: Miek Gieben <miek@miek.nl>
2019-01-27 18:02:25 +00:00
Dan Kohn
74c8bf25dc s/incubating/graduated/ (#2500) 2019-01-25 13:17:54 +00:00
Chris Aniszczyk
ea5ee43d58 Reference security audit in README (#2468)
Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
2019-01-15 09:16:18 -08:00
Miek Gieben
0efa99e954
docs: update the compile-from-source section (#2449)
You can't go get coredns - update this section.

Signed-off-by: Miek Gieben <miek@miek.nl>
2019-01-09 09:28:08 +00:00
Miek Gieben
22bffa7282
Revert "Invite users to fill the survey (#2020)" (#2222)
This reverts commit 073708bc66.
2018-10-23 20:18:49 +01:00
Francois Tur
fdb31a27f3 Security release process description (#1861)
* - enhance README to include security release process compatible wiht k8s

* - second version of Security release process, including "Collaborating Projects"

* - reformulate the security release process within a separated doc.

* - add following comment from Sec Team .part 1

* - refactored with comments from Security IB
- refactored considering the same existing document in another CNCF project (envoy)

* - adjust seucrity of README to point the new security process page

* - revert change on FOSSA

* - fix comments from John.

* - removing the todos (I pushed them on the description of the PR)

* - define the PST members in OWNER file

* - fix from review
- add a cahpter for mailing list presentation

* - point the PST members in OWNER file

* - register PST under name 'security' in OWNER file
- early announce will be on coredns-distributors-announce@googlegroup.com
- remove hall of fame reference

* - remove list of security team members from owner file. mailing list of security@coredns.io will be the reference
2018-10-21 18:25:22 +01:00
Yong Tang
d00e8c3918 Update golang to 1.11 for README.md (#2076)
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2018-08-31 19:39:55 +01:00
Miek Gieben
ad63cf0b4f
Document updates: (#2075)
Update the how to release notes in Makefile.release
And some little community tweaks in the README.md

Signed-off-by: Miek Gieben <miek@miek.nl>
2018-08-31 19:28:33 +01:00
Karsten Weiss
6d8a078704 Typo fixes (#2031) 2018-08-14 08:55:55 -07:00
Francois Tur
073708bc66 Invite users to fill the survey (#2020)
* - invite users to fill the survey

* Update README.md
2018-08-03 12:33:54 +01:00
Miek Gieben
8d9cf95ee8 Remove license scan (#1971)
Automatically submitted.
2018-07-13 11:55:31 +00:00
Miek Gieben
2e322f6e8a
Various improvements in the release documention. (#1961)
Releasing 1.2.0 uncovered some rough edges that need to be documented.
Also fix github-push target and docker login.

Signed-off-by: Miek Gieben <miek@miek.nl>
2018-07-11 09:56:37 +01:00
Yong Tang
3c31011ced Add security report section in README.md (#1566)
This fix adds security report section in README.md

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2018-02-27 12:05:40 -05:00
Yong Tang
b1ce9ed6e5 Move to incubating project (#1565)
We are in incubating stage now:
https://lists.cncf.io/g/cncf-toc/topic/result_coredns_moving_to/12935200?p=,,,20,0,0,0::recentpostdate%2Fsticky,,,20,2,0,12935200

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2018-02-26 18:01:31 +00:00
Yong Tang
9194b4c29d Update golang.org/x/net and golang.org/x/text (#1553)
This fix updates golang.org/x/net to release-branch.go1.10
and golang.org/x/text to v0.3.0, for the purpose of
align with go version 1.10.

This fix also updates README.md to promote using go 1.10.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2018-02-22 07:25:40 +00:00
Chris O'Haver
a9af519f83 minor readme fix (#1547) 2018-02-21 14:21:04 +00:00
Miek Gieben
bfee92a705
doc: Slight README rewrite (#1546)
Drop prominent placement of SkyDNS, some cleanups
2018-02-21 12:33:22 +00:00
Yong Tang
e50c425d67 Add NSID description to README.md. (#1388)
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2018-01-13 16:17:59 +00:00
Yong Tang
0600f8c058 Add docker pulls badge as we passed 2M pulls (#1345)
We passed 2M docker pulls from DockerHub. Adds `docker pulls` badge
to README.md

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2018-01-03 15:03:29 +00:00
John Belamaric
93e481a247
Revert source graph branch (#1210)
I think this badge is misleading as we are not a library so the number of projects we are used in is not really relevant to our adoption. It is more-or-less just the number of external plugins people have built.
2017-11-08 15:21:44 -05:00
Yong Tang
5d3bfef732 Add source graph used by badge (#1209)
We are used by 10+ other projects now. Think it makes
sense to add this badge.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2017-11-08 18:34:45 +00:00
Miek Gieben
a63f2ae7a2
doc: update README (#1178)
People are using it in prod and some other updates.
2017-10-27 20:08:25 +01:00
Paul Hoffman
b5d8f2a3d1 Rearrange the compilation steps in the README (#1176)
Emphasize `go get` as the main way to get the project.
2017-10-26 07:47:19 +01:00
Paul Hoffman
d01028d6f0 Added note to README about go version requirements (#1175) 2017-10-25 21:27:51 +01:00
Miek Gieben
fcd0342e42 CIDR query routing (#1159)
* core: allow all CIDR ranges in zone specifications

Allow (e.g.) a v4 reverse on a /17. If a zone is specified in such a
way a FilterFunc is set in the config. This filter is checked against
incoming queries.

For all other queries this adds a 'x != nil' check which will not impact
performace too much. Benchmark function is added as well to check for
this as wel.

Add multiple tests in tests/server_reverse_test.go.

Benchmark shows in the non-reverse case this hardly impact the speed:

~~~
classless:
pkg: github.com/coredns/coredns/core/dnsserver
BenchmarkCoreServeDNS-4   	 1000000	      1431 ns/op	      16 B/op	       1 allocs/op

pkg: github.com/coredns/coredns/core/dnsserver
BenchmarkCoreServeDNS-4   	 1000000	      1429 ns/op	      16 B/op	       1 allocs/op

master:
pkg: github.com/coredns/coredns/core/dnsserver
BenchmarkCoreServeDNS-4   	 1000000	      1412 ns/op	      16 B/op	       1 allocs/op

pkg: github.com/coredns/coredns/core/dnsserver
BenchmarkCoreServeDNS-4   	 1000000	      1429 ns/op	      16 B/op	       1 allocs/op
~~~

* README.md updates
2017-10-24 10:16:03 +01:00
Miek Gieben
427aed6f5b doc update (#1140)
* doc update

Go through all README and fix mistakes, extend example and let more
corefile snippets be test for validity.

* Cant use spefic addr in test
2017-10-10 09:39:35 +02:00
Miek Gieben
f0837d9637 cleanup readme (#1087) 2017-09-15 23:49:20 +01:00
Miek Gieben
d8714e64e4 Remove the word middleware (#1067)
* Rename middleware to plugin

first pass; mostly used 'sed', few spots where I manually changed
text.

This still builds a coredns binary.

* fmt error

* Rename AddMiddleware to AddPlugin

* Readd AddMiddleware to remain backwards compat
2017-09-14 09:36:06 +01:00
Yong Tang
b984aa4559 Update documentation README.md for building coredns with docker (#1073)
* Update documentation README.md for building coredns with docker

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>

* Update README.md

* Update README.md
2017-09-13 16:36:20 -07:00
John Belamaric
deca1a2cc2 remove go 1.9 restriction, which is false 2017-09-13 17:28:07 -04:00
Chris West
0fc4a89544 Add non-Go-user friendly build instructions (#1071)
Go is not  super helpful if you checkout the code to a random path, then try and follow the build instructions in the README. Add some instructions that help users who don't deal with Go on a day-to-day basis to get it right.

Fixes #1070. Thanks to @johnbelamaric for reminding me about Go's deficiencies.
2017-09-13 17:03:56 -04:00
John Belamaric
b8e5f54de4 Add CII best practices badge (#1062) 2017-09-12 09:38:14 -04:00
Yong Tang
8d876c770c Use logo as the title of the README.md (#911)
The logo is pointing to https://coredns.io/images/CoreDNS_Colour_Horizontal.png
and provides the link to https://coredns.io

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2017-08-13 07:34:56 +01:00
Yong Tang
654d127a24 Change the style from flat to regular for consistency. (#866)
The current badge styles have 4 flat and 1 regular, which were
rather inconsistent. This fix changes to one style and matches
with Caddy.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2017-08-09 09:58:32 -07:00
Yong Tang
57692bbccf Change Travis status to only show master branch status. (#865)
So that pull request build failure does not impact project status.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2017-08-09 09:04:49 -07:00
Miek Gieben
e1c1521ad5 Core: convert IP addresses to reverse zone (#838)
* Core: convert IP addresses to reverse zone

If we see IP/mask syntax and the mask mod 8 == 0 we assume a reverse
zone and convert to in-addr or .arpa.

* typos

* integration test

* Addr is not used

* core: clean up normalize

Create a SplitHostPort function that can be used both from normalize.go
and address.go. This removes some (not all!) duplication between the
both and makes it work with reverse address notations.

* More tests
2017-08-07 13:24:09 -07:00
Jonas Östanbäck
6c774782e0 Fix typos (#682) 2017-05-30 15:03:35 +01:00
Chris Aniszczyk
9a951be7dd Add License Scanning badge (#663)
In CNCF, we are experimenting with FOSSA for license scanning on all of our projects.

https://app.fossa.io/reports/7d989803-8931-4221-a11f-330b7f333cdd
2017-05-08 15:31:26 +01:00
Miek Gieben
7132faae50 update readme (#650)
* update readme

* Add slack

Also add the slack channel.
2017-04-27 16:24:00 +01:00
John Belamaric
bfa18470e5 Point users to deployment repo (#643) 2017-04-24 16:45:47 +01:00
Christoph Görn
2196dde9da this paragraph was redundant (#611) 2017-04-06 09:43:41 +02:00
Michael
7f72c11716 readme: fixed typos (#607) 2017-03-29 09:24:08 +01:00
Miek Gieben
757f49d8ff dump travis to 1.8 (#606) 2017-03-19 09:12:18 +00:00
Miek Gieben
bfaf9e0aec core: add more transports (#574)
* core: add listening for other protocols

Allow CoreDNS to listen for TLS request coming over port 853. This can
be enabled with `tls://` in the config file.

Implement listening for grps:// as well.

a Corefile like:

~~~
. tls://.:1853 {
    whoami
    tls
}
~~~

Means we listen on 1853 for tls requests, the `tls` config item allows
configuration for TLS parameters. We *might* be tempted to use Caddy's
Let's Encrypt implementation here.

* Refactor coredns/grpc into CoreDNS

This makes gRPC a first class citizen in CoreDNS. Add defines as being
just another server.

* some cleanups

* unexport the servers

* Move protobuf dir

* Hook up TLS properly

* Fix test

* listen for TLS as well. README updates

* disable test, fix package

* fix test

* Fix tests

* Fix remaining test

* Some tests

* Make the test work

* Add grpc test from #580

* fix crash

* Fix tests

* Close conn

* README cleanups

* README

* link RFC
2017-03-13 20:24:37 +00:00
Chris Aniszczyk
22c9289458 Add reference to CNCF in README (#567)
https://cncf.io
2017-03-02 22:16:31 +00:00
Jonathan Boulle
0a4903571e README: fix a couple of small typos (#560) 2017-02-27 10:51:18 -05:00
Yong Tang
682957cc29 Fix incorrect link of the CodeCov in README.md (#551)
This fix fixes incorrect link of the CodeCov in README.md.
2017-02-22 10:26:06 +00:00