DNS-01 Exec Plugins

To support multiple DNS providers the kube-cert-manager supports an exec based plugin system.

Exec Interface

Environment Variables

COMMAND - The action to take. CREATE or DELETE.
- CREATE: The plugin MUST create a DNS TXT based on FQDN, TOKEN, and DOMAIN.
- DELETE: The plugin MUST delete a DNS TXT record based on FQDN.
FQDN - The fqdn of the DNS TXT record
TOKEN - The value of the DNS TXT record
DOMAIN - The domain where the TXT record must be created

Stdin

Arbitrary configuration data will be written on stdin. The contents of the configuration data will be provider specific and must be documented separately.

Error Handling

Exit Codes

0 - Success. The DNS TXT record was created or deleted successfully.
1 - Fail. Generic error such as failure to create or delete a DNS TXT record.
2 - Invalid Configuration. Use this when the configuration passed on stdin is invalid.

Error Messages

A single error should be printed to stderr that will be logged by the kube-cert-manager

Examples

The following example executes a binary named dns01-noop. The dns01-noop plugin does not create or delete DNS records. It simply logs a message describing the operation.

Create

cat dns01.json | \
  COMMAND="CREATE" \
  DOMAIN="example.com" \
  FQDN="_acme-challenge.example.com" \
  TOKEN="8bGFl9SNhZzukcwdR7e52gFwq6HaEHB43LbimZQwnLg" \
  dns01

Delete

cat dns01.json | \
  COMMAND="DELETE" \
  DOMAIN="example.com" \
  FQDN="_acme-challenge.example.com" \
  TOKEN="8bGFl9SNhZzukcwdR7e52gFwq6HaEHB43LbimZQwnLg" \
  dns01

elsonrodriguez/dns01-exec-plugins