cli53

README

cli53 - Command line tool for Amazon Route 53

Introduction

cli53 provides import and export from BIND format and simple command line management of Route 53 domains.

Features:

• import and export BIND format

• create, delete and list hosted zones

• create, delete and update individual records

• create AWS extensions: failover, geolocation, latency, weighted and ALIAS records

Installation

Installation is easy, just download the binary from the github releases page (builds are available for Linux, Mac and Windows): https://github.com/barnybug/cli53/releases/latest

$ sudo mv cli53-my-platform /usr/local/bin/cli53
$ sudo chmod +x /usr/local/bin/cli53

To configure your Amazon credentials, either place them in a file ~/.aws/credentials:

[default]
aws_access_key_id = AKID1234567890
aws_secret_access_key = MY-SECRET-KEY

Or set the environment variables: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

You can switch between different sets in the credentials file by passing --profile to any command, or setting the environment variable AWS_PROFILE.

For more information, see: http://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs

Building from source

To build yourself from source (you will need golang 1.5 installed):

$ export GO15VENDOREXPERIMENT=1
$ go get github.com/barnybug/cli53
$ cd $GOPATH/src/github.com/barnybug/cli53
$ make install

This will produce a binary cli53 in ~/go/bin, after this follow the steps as above.

Getting Started

Create a hosted zone:

$ cli53 create example.com --comment 'my first zone'

Check what we've done:

$ cli53 list

Import a BIND zone file:

$ cli53 import --file zonefile.txt example.com

Replace with an imported zone, waiting for completion:

$ cli53 import --file zonefile.txt --replace --wait example.com

Manually create some records:

$ cli53 rrcreate example.com 'www 3600 A 192.168.0.1'
$ cli53 rrcreate --replace example.com 'www 3600 A 192.168.0.2'
$ cli53 rrcreate example.com '@ MX "10 192.168.0.1" "20 192.168.0.2"'

For CNAME records, relative domains have no trailing dot, but absolute domains should:

$ cli53 rrcreate example.com 'login CNAME www'
$ cli53 rrcreate example.com 'mail CNAME ghs.googlehosted.com.'

Export as a BIND zone file (for backup!):

$ cli53 export example.com

Create some weighted records:

$ cli53 rrcreate --identifier server1 --weight 10 example.com 'www A 192.168.0.1'
$ cli53 rrcreate --identifier server2 --weight 20 example.com 'www A 192.168.0.2'

Create an alias to an ELB:

$ cli53 rrcreate example.com 'www AWS ALIAS A dns-name.elb.amazonaws.com. ABCDEFABCDE false'

Create an alias to an A record:

$ cli53 rrcreate example.com 'www AWS ALIAS A server1 $self false'

Create an alias to a CNAME:

$ cli53 rrcreate example.com 'docs AWS ALIAS CNAME mail $self false'

Further documentation is available, e.g.:

$ cli53 --help
$ cli53 rrcreate --help

Bug reports

Please open a github issue including cli53 version number cli53 --version and the commands or a zone file to reproduce the issue. A good bug report is much appreciated!

Pull requests

Pull requests are gratefully received, though please do include a test case too.

Where's python/pypi cli53?

I've since rewritten the original python cli53. As people were still installing the old version I've taken it off pypi. If you must, you can still install the python cli53 by giving pip the github branch:

$ pip install git+https://github.com/barnybug/cli53.git@python

Bare in mind I'll no longer be supporting this any more, so any bug reports will be flatly closed!

Broken CNAME exports (GoDaddy)

Some DNS providers export broken bind files, without the trailing '.' on CNAME records. This is a requirement for absolute records (i.e. ones outside of the qualifying domain).

If you see CNAME records being imported to route53 with an extra mydomain.com on the end (e.g. ghs.google.com.mydomain.com), then you need to fix your zone file before importing:

    $ perl -pe 's/(CNAME\s+[-a-zA-Z0-9.-_]+)(?!.)$/$1./i' broken.txt > fixed.txt

Private/public zones

To manage zones that have both a private and a public zone, you must specify the zone ID instead the domain name, which is ambiguous. This is the 13 character ID after '/hostedzone/' you can see in the output to 'cli53 list'. eg:

$ cli53 rrcreate ZZZZZZZZZZZZZ 'name A 127.0.0.1'

Caveats

As Amazon limits operations to a maximum of 100 changes, if you perform a large operation that changes over 100 resource records it will be split. An operation that involves deletes, followed by updates such as an import with --replace will very briefly leave the domain inconsistent. You have been warned!

Changelog

0.6.0 New go version released!

Documentation

Index

• Constants
• Variables
• func ConvertAliasToRRSet(alias *dns.PrivateRR) *route53.ResourceRecordSet
• func ConvertBindToRR(record dns.RR) []*route53.ResourceRecord
• func ConvertBindToRRSet(records []dns.RR) *route53.ResourceRecordSet
• func ConvertRRSetToBind(rrset *route53.ResourceRecordSet) []dns.RR
• func ExportBindToWriter(r53 *route53.Route53, zone *route53.HostedZone, full bool, out io.Writer)
• func ListAllRecordSets(r53 *route53.Route53, id string) (rrsets []*route53.ResourceRecordSet, err error)
• func Main(args []string) int
• func NewALIAS() dns.PrivateRdata
• func UnexpandSelfAliases(records []dns.RR, zone *route53.HostedZone, full bool)
• type ALIAS
  • func (rd *ALIAS) Copy(dest dns.PrivateRdata) error
  • func (rd *ALIAS) Len() int
  • func (rd *ALIAS) Pack(buf []byte) (int, error)
  • func (rd *ALIAS) Parse(txt []string) error
  • func (rr *ALIAS) String() string
  • func (rd *ALIAS) Unpack(buf []byte) (int, error)
• type AWSRR
  • func (rr *AWSRR) String() string
• type AWSRoute
• type FailoverRoute
  • func (f *FailoverRoute) Parse(kvs KeyValues)
  • func (f *FailoverRoute) String() string
• type GeoLocationRoute
  • func (f *GeoLocationRoute) Parse(kvs KeyValues)
  • func (f *GeoLocationRoute) String() string
• type Key
• type KeyValues
  • func ParseKeyValues(input string) (result KeyValues, err error)
  • func (kvs KeyValues) GetInt(key string) int
  • func (kvs KeyValues) GetOptString(key string) *string
  • func (kvs KeyValues) GetString(key string) string
  • func (kvs KeyValues) String() string
• type LatencyRoute
  • func (f *LatencyRoute) Parse(kvs KeyValues)
  • func (f *LatencyRoute) String() string
• type WeightedRoute
  • func (f *WeightedRoute) Parse(kvs KeyValues)
  • func (f *WeightedRoute) String() string

Constants

const ChangeBatchSize = 100

const ClassAWS = 253

const TypeALIAS = 0x0F99

Variables

var RoutingTypes = map[string]func() AWSRoute{
	"FAILOVER":    func() AWSRoute { return &FailoverRoute{} },
	"GEOLOCATION": func() AWSRoute { return &GeoLocationRoute{} },
	"LATENCY":     func() AWSRoute { return &LatencyRoute{} },
	"WEIGHTED":    func() AWSRoute { return &WeightedRoute{} },
}

Functions

func ConvertAliasToRRSet

func ConvertAliasToRRSet(alias *dns.PrivateRR) *route53.ResourceRecordSet

func ConvertBindToRR

func ConvertBindToRR(record dns.RR) []*route53.ResourceRecord

Convert a DNS record into a route53 ResourceRecord.

func ConvertBindToRRSet

func ConvertBindToRRSet(records []dns.RR) *route53.ResourceRecordSet

Convert some DNS records into a route53 ResourceRecordSet. The records should have been previously grouped by matching name, type and (if applicable) identifier.

func ConvertRRSetToBind

func ConvertRRSetToBind(rrset *route53.ResourceRecordSet) []dns.RR

func ExportBindToWriter

func ExportBindToWriter(r53 *route53.Route53, zone *route53.HostedZone, full bool, out io.Writer)

func ListAllRecordSets

func ListAllRecordSets(r53 *route53.Route53, id string) (rrsets []*route53.ResourceRecordSet, err error)

Paginate request to get all record sets.

func Main

func Main(args []string) int

Entry point for cli53 application

func NewALIAS

func NewALIAS() dns.PrivateRdata

func UnexpandSelfAliases

func UnexpandSelfAliases(records []dns.RR, zone *route53.HostedZone, full bool)

Types

type ALIAS

type ALIAS struct {
	Type                 string
	Target               string
	ZoneId               string
	EvaluateTargetHealth bool
}

func (*ALIAS) Copy

func (rd *ALIAS) Copy(dest dns.PrivateRdata) error

func (*ALIAS) Len

func (rd *ALIAS) Len() int

func (*ALIAS) Pack

func (rd *ALIAS) Pack(buf []byte) (int, error)

func (*ALIAS) Parse

func (rd *ALIAS) Parse(txt []string) error

func (*ALIAS) String

func (rr *ALIAS) String() string

func (*ALIAS) Unpack

func (rd *ALIAS) Unpack(buf []byte) (int, error)

type AWSRR

type AWSRR struct {
	dns.RR
	Route         AWSRoute
	HealthCheckId *string
	Identifier    string
}

func (*AWSRR) String

func (rr *AWSRR) String() string

type AWSRoute

type AWSRoute interface {
	String() string
	Parse(KeyValues)
}

type FailoverRoute

type FailoverRoute struct {
	Failover string
}

func (*FailoverRoute) Parse

func (f *FailoverRoute) Parse(kvs KeyValues)

func (*FailoverRoute) String

func (f *FailoverRoute) String() string

type GeoLocationRoute

type GeoLocationRoute struct {
	CountryCode     *string
	ContinentCode   *string
	SubdivisionCode *string
}

func (*GeoLocationRoute) Parse

func (f *GeoLocationRoute) Parse(kvs KeyValues)

func (*GeoLocationRoute) String

func (f *GeoLocationRoute) String() string

type Key

type Key struct {
	Name       string
	Rrtype     uint16
	Identifier string
}

type KeyValues

type KeyValues []interface{}

func ParseKeyValues

func ParseKeyValues(input string) (result KeyValues, err error)

func (KeyValues) GetInt

func (kvs KeyValues) GetInt(key string) int

func (KeyValues) GetOptString

func (kvs KeyValues) GetOptString(key string) *string

func (KeyValues) GetString

func (kvs KeyValues) GetString(key string) string

func (KeyValues) String

func (kvs KeyValues) String() string

type LatencyRoute

type LatencyRoute struct {
	Region string
}

func (*LatencyRoute) Parse

func (f *LatencyRoute) Parse(kvs KeyValues)

func (*LatencyRoute) String

func (f *LatencyRoute) String() string

type WeightedRoute

type WeightedRoute struct {
	Weight int64
}

func (*WeightedRoute) Parse

func (f *WeightedRoute) Parse(kvs KeyValues)

func (*WeightedRoute) String

func (f *WeightedRoute) String() string