1 Name = "Designate DNSaaS for Openstack"
2 Description = ''''''
3 URL = "https://docs.openstack.org/designate/latest/"
4 Code = "designate"
5 Since = "v2.2.0"
6 7 Example = '''
8 # With a `clouds.yaml`
9 OS_CLOUD=my_openstack \
10 lego --dns designate -d '*.example.com' -d example.com run
11 12 # or
13 14 OS_AUTH_URL=https://openstack.example.org \
15 OS_REGION_NAME=RegionOne \
16 OS_PROJECT_ID=23d4522a987d4ab529f722a007c27846
17 OS_USERNAME=myuser \
18 OS_PASSWORD=passw0rd \
19 lego --dns designate -d '*.example.com' -d example.com run
20 21 # or
22 23 OS_AUTH_URL=https://openstack.example.org \
24 OS_REGION_NAME=RegionOne \
25 OS_AUTH_TYPE=v3applicationcredential \
26 OS_APPLICATION_CREDENTIAL_ID=imn74uq0or7dyzz20dwo1ytls4me8dry \
27 OS_APPLICATION_CREDENTIAL_SECRET=68FuSPSdQqkFQYH5X1OoriEIJOwyLtQ8QSqXZOc9XxFK1A9tzZT6He2PfPw0OMja \
28 lego --dns designate -d '*.example.com' -d example.com run
29 '''
30 31 Additional = '''
32 ## Description
33 34 There are three main ways of authenticating with Designate:
35 36 1. The first one is by using the `OS_CLOUD` environment variable and a `clouds.yaml` file.
37 2. The second one is using your username and password, via the `OS_USERNAME`, `OS_PASSWORD` and `OS_PROJECT_NAME` environment variables.
38 3. The third one is by using an application credential, via the `OS_APPLICATION_CREDENTIAL_*` and `OS_USER_ID` environment variables.
39 40 For the username/password and application methods, the `OS_AUTH_URL` and `OS_REGION_NAME` environment variables are required.
41 42 For more information, you can read about the different methods of authentication with OpenStack in the Keystone's documentation and the gophercloud documentation:
43 44 - [Keystone username/password](https://docs.openstack.org/keystone/latest/user/supported_clients.html)
45 - [Keystone application credentials](https://docs.openstack.org/keystone/latest/user/application_credentials.html)
46 47 Public cloud providers with support for Designate:
48 49 - [Fuga Cloud](https://fuga.cloud/)
50 '''
51 52 [Configuration]
53 [Configuration.Credentials]
54 OS_AUTH_URL = "Identity endpoint URL"
55 OS_USERNAME = "Username"
56 OS_PASSWORD = "Password"
57 OS_USER_ID = "User ID"
58 OS_APPLICATION_CREDENTIAL_ID = "Application credential ID"
59 OS_APPLICATION_CREDENTIAL_NAME = "Application credential name"
60 OS_APPLICATION_CREDENTIAL_SECRET = "Application credential secret"
61 OS_PROJECT_NAME = "Project name"
62 OS_REGION_NAME = "Region name"
63 [Configuration.Additional]
64 OS_PROJECT_ID = "Project ID"
65 OS_TENANT_NAME = "Tenant name (deprecated see OS_PROJECT_NAME and OS_PROJECT_ID)"
66 DESIGNATE_ZONE_NAME = "The zone name to use in the OpenStack Project to manage TXT records."
67 DESIGNATE_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 10)"
68 DESIGNATE_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 600)"
69 DESIGNATE_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 10)"
70 71 [Links]
72 API = "https://docs.openstack.org/designate/latest/"
73 GoClient = "https://pkg.go.dev/github.com/gophercloud/gophercloud/openstack/dns/v2"
74