yandexcloud.toml raw

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