teptools

package module
v0.8.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 13, 2021 License: MIT Imports: 25 Imported by: 0

README

teptools - CLI tool for creating and deleting MX records for TEP01 trainings.

Introduction

teptools 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

  • create, delete and use reusable delegation sets

Installation

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

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

Alternatively, on Mac you can install it using homebrew

$ brew install teptools

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 example:

    teptools list --profile my_profile

You can also assume a specific role by passing --role-arn to any command. For example:

    teptools list --role-arn arn:aws:iam::123456789012:role/myRole

You can combine role with profile. For example:

    teptools list --profile my_profile --role-arn arn:aws:iam::123456789012:role/myRole

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

Note: for Alpine on Docker, the pre-built binaries do not work, so either use Debian, or follow the instructions below for Building from source.

Building from source

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

$ export GO15VENDOREXPERIMENT=1
$ go get github.com/hhakkaev/teptools/cmd/teptools

This will produce a binary teptools in $GOPATH/bin, after this follow the steps as above.

Getting Started

Create a hosted zone:

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

Check what we've done:

$ teptools list

List also supports other output formats (eg. json for scripting using jq):

$ teptools list -format json | jq .[].Name

Import a BIND zone file:

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

Replace with an imported zone, waiting for completion:

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

Also you can 'dry-run' import, to check what will happen:

$ teptools import --file zonefile.txt --replace --wait --dry-run example.com

Upsert with an imported zone (replace existing and add new records, without deleting):

$ teptools import --file zonefile.txt --upsert example.com

Create an A record pointed to 192.168.0.1 with TTL of 60 seconds:

$ teptools rrcreate example.com 'www 60 A 192.168.0.1'

Update this A record to point to 192.168.0.2:

$ teptools rrcreate --replace example.com 'www 60 A 192.168.0.2'

Delete the A record:

$ teptools rrdelete example.com www A

Create an MX record:

$ teptools rrcreate example.com '@ MX 10 mail1.' '@ MX 20 mail2.'

Create a round robin A record:

$ teptools rrcreate example.com '@ A 127.0.0.1' '@ A 127.0.0.2'

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

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

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

$ teptools export example.com

Export fully-qualified domain names (instead of just prefixes) to stdout, and send AWS debug logging to stderr:

$ teptools export --full --debug example.com > example.com.txt 2> example.com.err.log

Create some weighted records:

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

Create an alias to an ELB:

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

Create an alias to an A record:

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

Create an alias to a CNAME:

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

Create some geolocation records:

$ teptools rrcreate -i Africa --continent-code AF example.com 'geo 300 IN A 127.0.0.1'
$ teptools rrcreate -i California --country-code US --subdivision-code CA example.com 'geo 300 IN A 127.0.0.2'

Create a primary/secondary pair of health checked records:

$ teptools rrcreate -i Primary --failover PRIMARY --health-check 2e668584-4352-4890-8ffe-6d3644702a1b example.com 'ha 300 IN A 127.0.0.1'
$ teptools rrcreate -i Secondary --failover SECONDARY example.com 'ha 300 IN A 127.0.0.2'

Create a multivalue record with health checks:

$ teptools rrcreate -i One --multivalue --health-check 2e668584-4352-4890-8ffe-6d3644702a1b example.com 'ha 300 IN A 127.0.0.1'
$ teptools rrcreate -i Two --multivalue --health-check 7c90445d-ad67-47bd-9649-3ca0985e1f88 example.com 'ha 300 IN A 127.0.0.2'

Create, list and then delete a reusable delegation set:

$ teptools dscreate
$ teptools dslist
$ teptools dsdelete NA24DEGBDGB32

Further documentation is available, e.g.:

$ teptools --help
$ teptools rrcreate --help

Bug reports

Please open a github issue including teptools version number teptools --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 teptools?

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

$ pip install git+https://github.com/hhakkaev/teptools.git@python

Please note 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|MX\s+\d+)\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 'teptools list'. eg:

$ teptools rrcreate ZZZZZZZZZZZZZ 'name A 127.0.0.1'

Setting Endpoint URL

Similar to the AWS CLI, the Route 53 endpoint can be set with the --endpoint-url flag. It can be a hostname or a fully qualified URL. This is particularly useful for testing.

$ teptools list --endpoint-url "http://localhost:4580"

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

See: CHANGELOG

Documentation

Index

Constants

View Source 
const ChangeBatchSize = 100
View Source 
const ClassAWS = 253
View Source 
const TypeALIAS = 0x0F99

Variables

View Source 
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{} },
	"MULTIVALUE":  func() AWSRoute { return &MultiValueAnswerRoute{} },
}

Functions

func ConvertAliasToRRSet 

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

ConvertAliasToRRSet will convert an alias to a ResourceRecordSet.

func ConvertBindToRR 

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

ConvertBindToRR will convert a DNS record into a route53 ResourceRecord.

func ConvertBindToRRSet 

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

ConvertBindToRRSet will 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

ConvertRRSetToBind will convert a ResourceRecordSet to an array of RR entries

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

Main entry point for teptools application

func NewALIASRdata 

func NewALIASRdata() dns.PrivateRdata

func UnexpandSelfAliases 

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

Types

type ALIASRdata 

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

func (*ALIASRdata) Copy 

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

func (*ALIASRdata) Len 

func (rd *ALIASRdata) Len() int

func (*ALIASRdata) Pack 

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

func (*ALIASRdata) Parse 

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

func (*ALIASRdata) String 

func (rr *ALIASRdata) String() string

func (*ALIASRdata) Unpack 

func (rd *ALIASRdata) 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 CSVFormatter 

type CSVFormatter struct {
}

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 Formatter 

type Formatter interface {
	// contains filtered or unexported methods
}

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 InstanceRecord 

type InstanceRecord struct {
	// contains filtered or unexported fields
}

type JlFormatter 

type JlFormatter struct {
}

type JsonFormatter 

type JsonFormatter struct {
}

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 MultiValueAnswerRoute 

type MultiValueAnswerRoute struct {
}

func (*MultiValueAnswerRoute) Parse 

func (f *MultiValueAnswerRoute) Parse(kvs KeyValues)

func (*MultiValueAnswerRoute) String 

func (f *MultiValueAnswerRoute) String() string

type TableFormatter 

type TableFormatter struct {
}

type TextFormatter 

type TextFormatter struct {
}

type WeightedRoute 

type WeightedRoute struct {
	Weight int64
}

func (*WeightedRoute) Parse 

func (f *WeightedRoute) Parse(kvs KeyValues)

func (*WeightedRoute) String 

func (f *WeightedRoute) String() string

Source Files

View all Source files

Directories

Path Synopsis
cmd
teptools

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.