Add DNS provider for YandexCloud #1694

kluevandrew · 2022-08-09T14:19:32Z

DNS Provider implementation for Yandex Cloud - 1 of 2 largest cloud providers in Russia

ldez · 2022-08-09T14:23:53Z

Hello, in order for a PR adding a DNS provider to be accepted, you have to:

add a description to your PR
be able to maintain this provider
have a homogeneous design with the other providers
add tests (units)

make test

add tests ("live")

lego/providers/dns/cloudflare/cloudflare_test.go

Lines 125 to 151 in c938de6

    
           func TestLivePresent(t *testing.T) { 
        
           	if !envTest.IsLiveTest() { 
        
           		t.Skip("skipping live test") 
        
           	} 
        
           	envTest.RestoreEnv() 
        
           	provider, err := NewDNSProvider() 
        
           	require.NoError(t, err) 
        
           	err = provider.Present(envTest.GetDomain(), "", "123d==") 
        
           	require.NoError(t, err) 
        
           } 
        
           func TestLiveCleanUp(t *testing.T) { 
        
           	if !envTest.IsLiveTest() { 
        
           		t.Skip("skipping live test") 
        
           	} 
        
           	envTest.RestoreEnv() 
        
           	provider, err := NewDNSProvider() 
        
           	require.NoError(t, err) 
        
           	time.Sleep(2 * time.Second) 
        
           	err = provider.CleanUp(envTest.GetDomain(), "", "123d==") 
        
           	require.NoError(t, err) 
        
           }

make test

add a provider descriptor
generate CLI help, documentation, and readme.

make generate-dns

be able to do: (and put the output of this command to a comment in your PR)

rm -rf .lego

./lego -m your@email.com --dns YOUR_PROVIDER_NAME -d *.example.com -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run

Note the wildcard domain is important.

pass the linter (golangci-lint must be installed):

make checks

do go mod tidy

kluevandrew · 2022-08-09T14:47:40Z

I do not promise to do everything in one day, but I will try, I will keep a checklist in this comment

add a description to your PR
be able to maintain this provider
have a homogeneous design with the other providers
add tests (units)
add tests ("live")
add a provider descriptor
generate CLI help, documentation, and readme.
be able to do: (and put the output of this command to a comment in your PR)

rm -rf .lego

./lego -m your@email.com --dns YOUR_PROVIDER_NAME -d *.example.com -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run

Result without envs:

➜  dist git:(yandexcloud) ./lego -m your@email.com --dns yandexcloud -d "*.example.com" -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run
2022/08/09 17:29:44 yandexcloud: some credentials information are missing: YANDEX_CLOUD_IAM_TOKEN,YANDEX_CLOUD_FOLDER_ID

Result with real credentials in envs but with domain that i do not owns:

➜  dist git:(yandexcloud) export YANDEX_CLOUD_IAM_TOKEN="private info"
➜  dist git:(yandexcloud) export YANDEX_CLOUD_FOLDER_ID="private info"
➜  dist git:(yandexcloud) ./lego -m andrey.klyuev@newbydev.team --dns yandexcloud -d "*.example.com" -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run

2022/08/09 17:35:47 [INFO] [*.example.com, example.com] acme: Obtaining bundled SAN certificate
2022/08/09 17:35:48 [INFO] [*.example.com] AuthURL: https://acme-staging-v02.api.letsencrypt.org/acme/authz-v3/3285370364
2022/08/09 17:35:48 [INFO] [example.com] AuthURL: https://acme-staging-v02.api.letsencrypt.org/acme/authz-v3/3285370374
2022/08/09 17:35:48 [INFO] [*.example.com] acme: use dns-01 solver
2022/08/09 17:35:48 [INFO] [example.com] acme: Could not find solver for: tls-alpn-01
2022/08/09 17:35:48 [INFO] [example.com] acme: Could not find solver for: http-01
2022/08/09 17:35:48 [INFO] [example.com] acme: use dns-01 solver
2022/08/09 17:35:48 [INFO] [*.example.com] acme: Preparing to solve DNS-01
2022/08/09 17:35:48 [INFO] [*.example.com] acme: Cleaning DNS-01 challenge
2022/08/09 17:35:48 [INFO] [example.com] acme: Preparing to solve DNS-01
2022/08/09 17:35:48 [INFO] [example.com] acme: Cleaning DNS-01 challenge
2022/08/09 17:35:49 [INFO] Deactivating auth: https://acme-staging-v02.api.letsencrypt.org/acme/authz-v3/3285370364
2022/08/09 17:35:49 [INFO] Deactivating auth: https://acme-staging-v02.api.letsencrypt.org/acme/authz-v3/3285370374
2022/08/09 17:35:50 Could not obtain certificates:
        error: one or more domains had a problem:
[*.example.com] [*.example.com] acme: error presenting token: yandexcloud: cant find dns zone example.com. in yandex cloud
[example.com] [example.com] acme: error presenting token: yandexcloud: cant find dns zone example.com. in yandex cloud

Result with real credentials in envs and domain that i owns:

➜  dist git:(yandexcloud) export YANDEX_CLOUD_IAM_TOKEN="private info"
➜  dist git:(yandexcloud) export YANDEX_CLOUD_FOLDER_ID="private info"
➜  dist git:(yandexcloud) ./lego -m andrey.klyuev@newbydev.team --dns yandexcloud -d "*.newbydev.team" -d newbydev.team -s https://acme-staging-v02.api.letsencrypt.org/directory run
2022/08/09 17:36:52 [INFO] [*.newbydev.team, newbydev.team] acme: Obtaining bundled SAN certificate
2022/08/09 17:36:53 [INFO] [*.newbydev.team] AuthURL: https://acme-staging-v02.api.letsencrypt.org/acme/authz-v3/3285385164
2022/08/09 17:36:53 [INFO] [newbydev.team] AuthURL: https://acme-staging-v02.api.letsencrypt.org/acme/authz-v3/3285385174
2022/08/09 17:36:53 [INFO] [*.newbydev.team] acme: use dns-01 solver
2022/08/09 17:36:53 [INFO] [newbydev.team] acme: Could not find solver for: tls-alpn-01
2022/08/09 17:36:53 [INFO] [newbydev.team] acme: Could not find solver for: http-01
2022/08/09 17:36:53 [INFO] [newbydev.team] acme: use dns-01 solver
2022/08/09 17:36:53 [INFO] [*.newbydev.team] acme: Preparing to solve DNS-01
2022/08/09 17:36:54 [INFO] [*.newbydev.team] acme: Trying to solve DNS-01
2022/08/09 17:36:54 [INFO] [*.newbydev.team] acme: Checking DNS record propagation using [100.99.0.231:53 100.99.0.230:53]
2022/08/09 17:36:56 [INFO] Wait for propagation [timeout: 1m0s, interval: 2s]
2022/08/09 17:36:59 [INFO] [*.newbydev.team] The server validated our request
2022/08/09 17:36:59 [INFO] [*.newbydev.team] acme: Cleaning DNS-01 challenge
2022/08/09 17:37:00 [INFO] sequence: wait for 1m0s
2022/08/09 17:38:00 [INFO] [newbydev.team] acme: Preparing to solve DNS-01
2022/08/09 17:38:01 [INFO] [newbydev.team] acme: Trying to solve DNS-01
2022/08/09 17:38:01 [INFO] [newbydev.team] acme: Checking DNS record propagation using [100.99.0.231:53 100.99.0.230:53]
2022/08/09 17:38:03 [INFO] Wait for propagation [timeout: 1m0s, interval: 2s]
2022/08/09 17:38:10 [INFO] [newbydev.team] The server validated our request
2022/08/09 17:38:10 [INFO] [newbydev.team] acme: Cleaning DNS-01 challenge
2022/08/09 17:38:10 [INFO] [*.newbydev.team, newbydev.team] acme: Validations succeeded; requesting certificates
2022/08/09 17:38:12 [INFO] [*.newbydev.team] Server responded with a certificate.

pass the linter (golangci-lint must be installed):

make checks

Result: lot of nosnakecase errors, but no errors in my code

do go mod tidy

…cloud

# Conflicts: # providers/dns/yandexcloud/yandexcloud.go

kluevandrew · 2022-08-09T15:15:31Z

Done as i think

kluevandrew · 2022-08-11T09:51:22Z

Is there anything else I should do as part of this pull request?

kluevandrew · 2022-08-18T10:35:22Z

Please give me a feedback about this

ldez · 2022-08-27T21:53:53Z

@kluevandrew have you used the Sequential approach because Yandex doesn't support multiple TXT record for the same domain?

kluevandrew · 2022-08-28T10:00:15Z

@kluevandrew have you used the Sequential approach because Yandex doesn't support multiple TXT record for the same domain?

Yes, yandex supports only one TXT record for domain, but with multiple values

PS After your question, I stopped being sure that this is really necessary.

ldez · 2022-08-28T10:54:43Z

Yes, yandex supports only one TXT record for domain, but with multiple values

In fact, this means that Yandex supports multiple TXT records for a domain because DNSes are just key-value stores.

Maybe you have to change your implementation.

kluevandrew · 2022-08-28T16:15:15Z

In fact, this means that Yandex supports multiple TXT records for a domain because DNSes are just key-value stores.

No problem, i will check all cases and fix implementation in few days

Respect cases when TXT record already present. Fix linter errors

kluevandrew · 2022-08-30T12:32:13Z

@ldez done, now it's not sequential, work normally even if TXT record for _acme_challenge is already present and does not produces if it already has needed value

ldez

Thank you 👍

Add YandexCloud DNS Provider

b87319b

ldez added area/dnsprovider contrib/waiting-for-correction labels Aug 9, 2022

ldez self-requested a review August 9, 2022 14:23

Updates for review

c40a2a3

ldez and others added 7 commits August 9, 2022 16:50

review

eb1a59f

Generated documentation

17a2ad5

Merge branch 'yandexcloud' of github.com:kluevandrew/lego into yandex…

25e4da7

…cloud

review

caac7a1

Fix by review

32735aa

Merge remote-tracking branch 'fork/yandexcloud' into yandexcloud

cdfd748

# Conflicts: # providers/dns/yandexcloud/yandexcloud.go

review

203cefe

kluevandrew added 2 commits August 10, 2022 12:18

Fix typo in docs

65a09d5

Merge remote-tracking branch 'fork/yandexcloud' into yandexcloud

4ce2a9b

ldez added 2 commits August 27, 2022 23:48

review

4df659a

Merge remote-tracking branch 'upstream/master' into 1694--yandexcloud

e15c921

ldez force-pushed the yandexcloud branch from 51ab3af to e15c921 Compare August 27, 2022 21:52

ldez added enhancement and removed contrib/waiting-for-correction labels Aug 27, 2022

ldez added this to the v4.9 milestone Aug 27, 2022

ldez added the contrib/waiting-for-feedback label Aug 27, 2022

Make yandexcloud dns provider non-sequential.

4e4473c

Respect cases when TXT record already present. Fix linter errors

ldez removed the contrib/waiting-for-feedback label Aug 30, 2022

ldez added 3 commits September 1, 2022 22:13

review

dfd0f8b

review

6e6f909

review

eab5480

ldez approved these changes Sep 1, 2022

View reviewed changes

ldez enabled auto-merge (squash) September 1, 2022 20:45

ldez changed the title ~~Add YandexCloud DNS Provider~~ Add DNS provider for YandexCloud Sep 1, 2022

ldez merged commit be0c6c7 into go-acme:master Sep 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add DNS provider for YandexCloud #1694

Add DNS provider for YandexCloud #1694

kluevandrew commented Aug 9, 2022 •

edited

Loading

ldez commented Aug 9, 2022 •

edited

Loading

kluevandrew commented Aug 9, 2022 •

edited

Loading

kluevandrew commented Aug 9, 2022

kluevandrew commented Aug 11, 2022

kluevandrew commented Aug 18, 2022

ldez commented Aug 27, 2022

kluevandrew commented Aug 28, 2022 •

edited

Loading

ldez commented Aug 28, 2022

kluevandrew commented Aug 28, 2022 •

edited

Loading

kluevandrew commented Aug 30, 2022

ldez left a comment

Add DNS provider for YandexCloud #1694

Add DNS provider for YandexCloud #1694

Conversation

kluevandrew commented Aug 9, 2022 • edited Loading

ldez commented Aug 9, 2022 • edited Loading

kluevandrew commented Aug 9, 2022 • edited Loading

kluevandrew commented Aug 9, 2022

kluevandrew commented Aug 11, 2022

kluevandrew commented Aug 18, 2022

ldez commented Aug 27, 2022

kluevandrew commented Aug 28, 2022 • edited Loading

ldez commented Aug 28, 2022

kluevandrew commented Aug 28, 2022 • edited Loading

kluevandrew commented Aug 30, 2022

ldez left a comment

Choose a reason for hiding this comment

kluevandrew commented Aug 9, 2022 •

edited

Loading

ldez commented Aug 9, 2022 •

edited

Loading

kluevandrew commented Aug 9, 2022 •

edited

Loading

kluevandrew commented Aug 28, 2022 •

edited

Loading

kluevandrew commented Aug 28, 2022 •

edited

Loading