Commit de0fa533 authored by Miek Gieben's avatar Miek Gieben Committed by GitHub

Doc: add package docs (#296)

* Doc: add package docs

Add short package level docs to make godoc looks nicer.
Add some badges to the README.

* correct url
parent edc867fe
# CoreDNS
[![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/miekg/coredns)
[![Build Status](https://img.shields.io/travis/miekg/coredns.svg?style=flat-square&label=build)](https://travis-ci.org/miekg/coredns)
CoreDNS is a DNS server that started as a fork of [Caddy](https://github.com/mholt/caddy/). It has the
same model: it chains middleware. In fact it's so similar that CoreDNS is now a server type plugin for
Caddy.
......
// Package core registers the server and all plugins we support.
package core
import (
......
// Package DNS server implements all the interfaces from Caddy, so that
// CoreDNS can be a servertype plugin.
package dnsserver
import (
......
// Package coremain contains the functions for starting CoreDNS.
package coremain
import (
......
// Package bind allows binding to a specific interface instead of bind to all of them.
package bind
import "github.com/mholt/caddy"
......
// Package chaos implements a middleware that answer to 'CH version.bind TXT' type queries.
package chaos
import (
......
// Package dnssec implements a middleware that signs responses on-the-fly using
// NSEC black lies.
package dnssec
import (
......
// Package etcd provides the etcd backend.
// Package etcd provides the etcd backend middleware.
package etcd
import (
......
// Package msg defines the Service structure which is used for service discovery.
package msg
import (
......
// Package file implements a file backend.
package file
import (
......
// Package health implements an HTTP handler that responds to health checks.
package health
import (
......
......@@ -17,8 +17,8 @@ import (
"github.com/miekg/dns"
"k8s.io/kubernetes/pkg/api"
unversionedapi "k8s.io/kubernetes/pkg/api/unversioned"
unversionedclient "k8s.io/kubernetes/pkg/client/unversioned"
"k8s.io/kubernetes/pkg/client/restclient"
unversionedclient "k8s.io/kubernetes/pkg/client/unversioned"
"k8s.io/kubernetes/pkg/client/unversioned/clientcmd"
clientcmdapi "k8s.io/kubernetes/pkg/client/unversioned/clientcmd/api"
"k8s.io/kubernetes/pkg/labels"
......
// Package loadbalance shuffles A and AAAA records.
package loadbalance
import (
......
// Package metrics implement a handler and middleware that provides Prometheus
// metrics.
package metrics
import (
......
// Package dnsrecorder allows you to record a DNS response when it is send to the client.
package dnsrecorder
import (
......
// Package dnsutil contains DNS related helper functions.
package dnsutil
// Package edns provides function usefull for adding/inspecting OPT records to/in messages.
package edns
import (
......
// Package storage abstracts away where middleware can store assests (zones, keys, etc).
package storage
import (
......
// Package pprof implement a debug endpoint for getting profiles using the
// go pprof tooling.
package pprof
import (
......
// Package secondary implements a secondary middleware.
package secondary
import "github.com/miekg/coredns/middleware/file"
......
// Package test contains helper functions for writing middleware tests.
package test
// Package whoami implements a middleware that returns details about the resolving
// querying it.
package whoami
import (
......
// Package requests abstract a client's request so that all middleware
// will handle them in an unified way.
package request
import (
......
// Package test contains function and types useful for writing tests
package test
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment