openstack

README

OpenStack Designate DNS module for Caddy

This package contains a DNS provider module for Caddy. It can be used to manage DNS records in OpenStack Designate DNS zones.

Caddy module name

dns.providers.openstack-designate

Authenticating

See the associated README in the libdns package for important information about credentials.

Building

To compile this Caddy module, follow the steps describe at the Caddy Build from Source instructions and import the github.com/caddy-dns/openstack-designate plugin

Config examples

To use this module for the ACME DNS challenge, configure the ACME issuer in your Caddy JSON like so:

{
  "module": "acme",
  "challenges": {
    "dns": {
      "provider": {
        "name": "openstack-designate",
        "region_name": "{env.OS_REGION_NAME}",
        "tenant_id": "{env.OS_TENANT_ID}",
        "identity_api_version": "{env.OS_IDENTITY_API_VERSION}",
        "password": "{env.OS_PASSWORD}",
        "username": "{env.OS_USERNAME}",
        "tenant_name": "{env.OS_TENANT_NAME}",
        "auth_url": "{env.OS_AUTH_URL}",
        "endpoint_type": "{env.OS_ENDPOINT_TYPE}"
      }
    }
  }
}

or with the Caddyfile:

tls {
  dns openstack-designate {
    region_name {$OS_REGION_NAME}
    tenant_id {$OS_TENANT_ID}
    identity_api_version {$OS_IDENTITY_API_VERSION}
    password {$OS_PASSWORD}
    username {$OS_USERNAME}
    tenant_name {$OS_TENANT_NAME}
    auth_url {$OS_AUTH_URL}
    endpoint_type {$OS_ENDPOINT_TYPE}
  }
}

Documentation

Index

• type Provider
  • func (Provider) CaddyModule() caddy.ModuleInfo
  • func (p *Provider) Provision(ctx caddy.Context) error
  • func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Provider

type Provider struct{ *designate.Provider }

Provider wraps the provider implementation as a Caddy module.

func (Provider) CaddyModule

func (Provider) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Provider) Provision

func (p *Provider) Provision(ctx caddy.Context) error

Provision implements the Provisioner interface to initialize the OpenStack Designate client

func (*Provider) UnmarshalCaddyfile

func (p *Provider) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile sets up the DNS provider from Caddyfile tokens. Syntax:

openstack-designate {
    region_name <string>
    tenant_id <string>
    identity_api_version <string>
    password <string>
    username <string>
    tenant_name <string>
    endpoint_type <string>
    auth_url <string>
}