yandexcloud.toml 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. Name = "Yandex Cloud"
  2. Description = ''''''
  3. URL = "https://cloud.yandex.com"
  4. Code = "yandexcloud"
  5. Since = "v4.9.0"
  6. Example = '''
  7. YANDEX_CLOUD_IAM_TOKEN=<base64_IAM_token> \
  8. YANDEX_CLOUD_FOLDER_ID=<folder/project_id> \
  9. lego --email you@example.com --dns yandexcloud -d '*.example.com' -d example.com run
  10. # ---
  11. YANDEX_CLOUD_IAM_TOKEN=$(echo '{ \
  12. "id": "<string id>", \
  13. "service_account_id": "<string id>", \
  14. "created_at": "<datetime>", \
  15. "key_algorithm": "RSA_2048", \
  16. "public_key": "-----BEGIN PUBLIC KEY-----<rsa public key>-----END PUBLIC KEY-----", \
  17. "private_key": "-----BEGIN PRIVATE KEY-----<rsa private key>-----END PRIVATE KEY-----" \
  18. }' | base64) \
  19. YANDEX_CLOUD_FOLDER_ID=<yandex cloud folder(project) id> \
  20. lego --email you@example.com --dns yandexcloud -d '*.example.com' -d example.com run
  21. '''
  22. Additional = '''
  23. ## IAM Token
  24. The simplest way to retrieve IAM access token is usage of yc-cli,
  25. follow [docs](https://cloud.yandex.ru/docs/iam/operations/iam-token/create-for-sa) to get it
  26. ```bash
  27. yc iam key create --service-account-name my-robot --output key.json
  28. cat key.json | base64
  29. ```
  30. '''
  31. [Configuration]
  32. [Configuration.Credentials]
  33. YANDEX_CLOUD_IAM_TOKEN = "The base64 encoded json which contains information about iam token of service account with `dns.admin` permissions"
  34. YANDEX_CLOUD_FOLDER_ID = "The string id of folder (aka project) in Yandex Cloud"
  35. [Configuration.Additional]
  36. YANDEX_CLOUD_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
  37. YANDEX_CLOUD_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)"
  38. YANDEX_CLOUD_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 60)"
  39. [Links]
  40. API = "https://cloud.yandex.com/en/docs/dns/quickstart"