Documentation

Overview

    Package exoscale implements a DNS provider for solving the DNS-01 challenge using exoscale DNS.

    Index

    Constants

    View Source
    const (
    	EnvAPISecret = envNamespace + "API_SECRET"
    	EnvAPIKey    = envNamespace + "API_KEY"
    	EnvEndpoint  = envNamespace + "ENDPOINT"
    
    	EnvTTL                = envNamespace + "TTL"
    	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
    	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
    	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
    )

      Environment variables names.

      Variables

      This section is empty.

      Functions

      This section is empty.

      Types

      type Config

      type Config struct {
      	APIKey             string
      	APISecret          string
      	Endpoint           string
      	HTTPClient         *http.Client
      	PropagationTimeout time.Duration
      	PollingInterval    time.Duration
      	TTL                int
      }

        Config is used to configure the creation of the DNSProvider.

        func NewDefaultConfig

        func NewDefaultConfig() *Config

          NewDefaultConfig returns a default configuration for the DNSProvider.

          type DNSProvider

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

            DNSProvider implements the challenge.Provider interface.

            func NewDNSProvider

            func NewDNSProvider() (*DNSProvider, error)

              NewDNSProvider Credentials must be passed in the environment variables: EXOSCALE_API_KEY, EXOSCALE_API_SECRET, EXOSCALE_ENDPOINT.

              func NewDNSProviderConfig

              func NewDNSProviderConfig(config *Config) (*DNSProvider, error)

                NewDNSProviderConfig return a DNSProvider instance configured for Exoscale.

                func (*DNSProvider) CleanUp

                func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error

                  CleanUp removes the record matching the specified parameters.

                  func (*DNSProvider) FindExistingRecordID

                  func (d *DNSProvider) FindExistingRecordID(zone, recordName string) (int64, error)

                    FindExistingRecordID Query Exoscale to find an existing record for this name. Returns nil if no record could be found.

                    func (*DNSProvider) FindZoneAndRecordName

                    func (d *DNSProvider) FindZoneAndRecordName(fqdn, domain string) (string, string, error)

                      FindZoneAndRecordName Extract DNS zone and DNS entry name.

                      func (*DNSProvider) Present

                      func (d *DNSProvider) Present(domain, token, keyAuth string) error

                        Present creates a TXT record to fulfill the dns-01 challenge.

                        func (*DNSProvider) Timeout

                        func (d *DNSProvider) Timeout() (timeout, interval time.Duration)

                          Timeout returns the timeout and interval to use when checking for DNS propagation. Adjusting here to cope with spikes in propagation times.

                          Source Files