sf

Documentation

Index

• func CleanupDeleteGraceRecords(cloudflareDNSRecords []cloudflare.DNSRecord, ...)
• func CreateCloudflareDNSRecord(record cloudflare.DNSRecord)
• func CreateDeleteGraceRecord(orphanedRecordName string)
• func DeleteCloudflareDNSRecord(record cloudflare.DNSRecord)
• func GetAdditionalRecords(userRecords []cloudflare.DNSRecord) []cloudflare.DNSRecord
• func GetCloudflareDNSRecords() []cloudflare.DNSRecord
• func GetCloudflareZoneID()
• func GetCurrentIP()
• func GetDeleteGraceRecord(orphanedRecordName string, deleteGraceRecords []cloudflare.DNSRecord) cloudflare.DNSRecord
• func GetDeleteGraceRecords() []cloudflare.DNSRecord
• func GetMissingDNSRecords(cloudflareDNSRecords []cloudflare.DNSRecord, ...) []cloudflare.DNSRecord
• func GetOrphanedDNSRecords(cloudflareDNSRecords []cloudflare.DNSRecord, ...) []cloudflare.DNSRecord
• func GetTraefikRules(userRecords []cloudflare.DNSRecord) []cloudflare.DNSRecord
• func ParseFlags() (string, bool, bool)
• func SendSlackMessage()
• func SetupCloudflareClient()
• func UpdateCloudflareDNSRecords(cloudflareDNSRecords []cloudflare.DNSRecord, ...)
• func UpdateDeleteGraceRecord(deleteGraceRecord cloudflare.DNSRecord, orphanedRecordName string)
• type Configuration
  • func GetConfig(configFilePath string) Configuration
• type TraefikRouter

Functions

func CleanupDeleteGraceRecords

func CleanupDeleteGraceRecords(cloudflareDNSRecords []cloudflare.DNSRecord, deleteGraceRecords []cloudflare.DNSRecord)

func CreateCloudflareDNSRecord

func CreateCloudflareDNSRecord(record cloudflare.DNSRecord)

CreateCloudflareDNSRecord is a wrapper function to create a DNS record

func CreateDeleteGraceRecord

func CreateDeleteGraceRecord(orphanedRecordName string)

func DeleteCloudflareDNSRecord

func DeleteCloudflareDNSRecord(record cloudflare.DNSRecord)

DeleteCloudflareDNSRecord is a wrapper function to delete a DNS record

func GetAdditionalRecords

func GetAdditionalRecords(userRecords []cloudflare.DNSRecord) []cloudflare.DNSRecord

GetAdditionalRecords gathers and checks configured additionalRecords

func GetCloudflareDNSRecords

func GetCloudflareDNSRecords() []cloudflare.DNSRecord

GetCloudflareDNSRecords gathers all DNS records in a given zone

func GetCloudflareZoneID

func GetCloudflareZoneID()

GetCloudflareZoneID creates a global var containing the zone id

func GetCurrentIP

func GetCurrentIP()

GetCurrentIP checks the current public IP

func GetDeleteGraceRecord

func GetDeleteGraceRecord(orphanedRecordName string, deleteGraceRecords []cloudflare.DNSRecord) cloudflare.DNSRecord

func GetDeleteGraceRecords

func GetDeleteGraceRecords() []cloudflare.DNSRecord

GetDeleteGraceRecords gathers all delete grace DNS records in a given zone

func GetMissingDNSRecords

func GetMissingDNSRecords(cloudflareDNSRecords []cloudflare.DNSRecord, userRecords []cloudflare.DNSRecord) []cloudflare.DNSRecord

GetMissingDNSRecords compares Cloudflare DNS records with Traefik rules and additionalRecords

func GetOrphanedDNSRecords

func GetOrphanedDNSRecords(cloudflareDNSRecords []cloudflare.DNSRecord, userRecords []cloudflare.DNSRecord) []cloudflare.DNSRecord

GetOrphanedDNSRecords compares Cloudflare DNS records with Traefik rules and additionalRecords

func GetTraefikRules

func GetTraefikRules(userRecords []cloudflare.DNSRecord) []cloudflare.DNSRecord

GetTraefikRules gathers and formats all Traefik http routers

func ParseFlags

func ParseFlags() (string, bool, bool)

ParseFlags returns the supplied flags

func SendSlackMessage

func SendSlackMessage()

SendSlackMessage sends a Slack message if configured

func SetupCloudflareClient

func SetupCloudflareClient()

SetupCloudflareClient creates a global var with a Cloudflare client instance

func UpdateCloudflareDNSRecords

func UpdateCloudflareDNSRecords(cloudflareDNSRecords []cloudflare.DNSRecord, userRecords []cloudflare.DNSRecord)

UpdateCloudflareDNSRecords updates the public IP and additionalRecords

func UpdateDeleteGraceRecord

func UpdateDeleteGraceRecord(deleteGraceRecord cloudflare.DNSRecord, orphanedRecordName string)

Types

type Configuration

type Configuration struct {
	RootDomain    string   `yaml:"rootDomain,omitempty"`
	IPProviders   []string `yaml:"ipProviders"`
	Notifications struct {
		Slack struct {
			WebhookURL string `yaml:"webhookURL"`
			Username   string `yaml:"username"`
			Channel    string `yaml:"channel"`
			IconURL    string `yaml:"iconURL"`
		} `yaml:"slack"`
	} `yaml:"notifications"`
	Traefik struct {
		URL          string   `yaml:"url"`
		Username     string   `yaml:"username"`
		Password     string   `yaml:"password"`
		IgnoredRules []string `yaml:"ignoredRules"`
	} `yaml:"traefik"`
	AdditionalRecords []cloudflare.DNSRecord `yaml:"additionalRecords"`
	Cloudflare        struct {
		Email       string `yaml:"email"`
		APIKey      string `yaml:"apiKey"`
		DeleteGrace int    `yaml:"deleteGrace"`
		ZoneName    string `yaml:"zoneName"`
		Defaults    struct {
			Type    string `yaml:"type"`
			Proxied bool   `yaml:"proxied"`
			TTL     int    `yaml:"ttl"`
		} `yaml:"defaults"`
	} `yaml:"cloudflare"`
}

Configuration is a struct to store the script's configuration

func GetConfig

func GetConfig(configFilePath string) Configuration

GetConfig creates a global var holding the configuration

type TraefikRouter

type TraefikRouter struct {
	EntryPoints []string `json:"entryPoints"`
	Middlewares []string `json:"middlewares,omitempty"`
	Service     string   `json:"service"`
	Rule        string   `json:"rule"`
	TLS         struct {
		CertResolver string `json:"certResolver"`
		Domains      []struct {
			Main string   `json:"main"`
			Sans []string `json:"sans"`
		} `json:"domains"`
	} `json:"tls,omitempty"`
	Status   string   `json:"status"`
	Using    []string `json:"using"`
	Name     string   `json:"name"`
	Provider string   `json:"provider"`
	Priority int64    `json:"priority,omitempty"`
}

TraefikRouter is a struct to store a router object of Traefik