[![PyPI Version][pypi-image]][pypi-url]
Project description
YandexCloud DNS provider for octoDNS
An (unofficial) octoDNS provider that targets Yandex Cloud DNS.
And an additional provider for Yandex 360 for business.
Installation
Command line
pip install octodns-yandex
requirements.txt/setup.py
Pinning specific versions or SHAs is recommended to avoid unplanned upgrades.
Versions
# Start with the latest versions and don't just copy what's here
octodns==1.6.1
octodns-yandex==0.0.3
SHAs
# Start with the latest/specific versions and don't just copy what's here
-e git+https://git@github.com/octodns/octodns.git@384ce2018291f15c1d021a70f46820315af478cc#egg=octodns
-e git+https://git@github.com/90victor09/octodns-yandex.git@0067b545710050b7e4f85471bbe7bfe66a6a0c10#egg=octodns_yandex
Configuration
Yandex Cloud Provider
Required roles:
dns.editor
- for dump and syncdns.viewer
- for dump only
providers:
yandexcloud:
class: octodns_yandex.YandexCloudProvider
# Cloud folder id to look up DNS zones
folder_id: a1bc...
# YandexCloud allows creation of multiple zones with the same name.
# By default, provider picks first found zone (null)
# You can specify to search public zone, if it exists (true)
# Or first found internal zone (false)
# If you have several internal zones with the same name - see zone_ids_map
prioritize_public: true
# Optionally, provide ids to map zones exactly
zone_ids_map:
example.com.: dns1abc...
# Auth type. Available options:
# oauth - use OAuth token
# iam - use IAM token
# metadata - automatic auth inside of VM instance/function with assigned Service Account
# sa-key - use Service Account Key
# yc-cli - call 'yc' command to get OAuth token from its config
auth_type: yc-cli
# (oauth) OAuth token
#oauth_token: env/YC_OAUTH_TOKEN
# (iam) IAM token
#iam_token: env/YC_IAM_TOKEN
# (sa-key) File with SA key JSON
#sa_key_file: key.json
# (sa-key) Or, its in-config values
#sa_key:
# id: env/YC_SA_KEY_ID
# service_account_id: env/YC_SA_KEY_ACCOUNT_ID
# private_key: env/YC_SA_KEY_PRIVATE_KEY
Yandex Cloud CM Source
Provides records for ACME DNS challenges.
Required role:
certificate-manager.viewer
providers:
yandexcloud_cm:
class: octodns_yandex.YandexCloudCMSource
# Cloud folder id to look up DNS zones
folder_id: a1bc...
# Challenge type to use: CNAME or TXT
record_type: CNAME
# Challenge records TTL
record_ttl: 3600
# Auth options are the same as for octodns_yandex.YandexCloudProvider
auth_type: yc-cli
Yandex Cloud CDN Source
Provides CNAME records for CDN.
Required role:
cdn.viewer
providers:
yandexcloud_cdn:
class: octodns_yandex.YandexCloudCDNSource
# Cloud folder id to look up DNS zones
folder_id: a1bc...
# CDN records TTL
record_ttl: 3600
# Auth options are the same as for octodns_yandex.YandexCloudProvider
auth_type: yc-cli
Yandex 360
You can obtain OAuth token through existing application:
https://oauth.yandex.ru/authorize?response_type=token&client_id=daf031bc5d83471d88c5932e8ddef46c
Or you can create your own application with following permissions:
directory:read_organization
directory:read_domains
directory:manage_dns
providers:
yandex360:
class: octodns_yandex.Yandex360Provider
# OAuth token
oauth_token: env/Y360_TOKEN
Support Information
Records
What | Supported records |
---|---|
YandexCloudProvider |
A , AAAA , CAA , CNAME , MX , NS , PTR , SRV , TXT , ANAME |
Yandex360Provider |
A , AAAA , CAA , CNAME , MX , NS , SRV , TXT |
YandexCloudCMSource |
CNAME , TXT |
YandexCloudCDNSource |
CNAME |
Root NS Records
YandexCloudProvider
supports root NS record management, but changing them doesn't seem to do anything.
Yandex360Provider
does not support root NS record management.
Dynamic
YandexCloudProvider
does not support dynamic records.
Yandex360Provider
does not support dynamic records.
Provider Specific Types
YandexCloudProvider/ANAME
record acts like ALIAS
, but supports subdomains.
aname:
type: YandexCloudProvider/ANAME
value: example.com.
Development
See the /script/ directory for some tools to help with the development process. They generally follow the Script to rule them all pattern. Most useful is ./script/bootstrap
which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.
If you are using PyCharm with yc-cli
auth type, it could be easier to create a symlink to 'yc' binary in your venv's bin directory rather than trying to get it working the proper way :/ .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file octodns-yandex-0.0.3.tar.gz
.
File metadata
- Download URL: octodns-yandex-0.0.3.tar.gz
- Upload date:
- Size: 27.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9981d03af46f7504b277cd11ce28ac10599103993a945fc536eea38de472ee3 |
|
MD5 | 293a386458ceca2845898d6a058a677c |
|
BLAKE2b-256 | 818f79d590592e77e1d2535255cffd3fc0ce903096c9cea507894fbb206bb1fc |
File details
Details for the file octodns_yandex-0.0.3-py3-none-any.whl
.
File metadata
- Download URL: octodns_yandex-0.0.3-py3-none-any.whl
- Upload date:
- Size: 35.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54507f93b283acb92e1d9f5f24cea7a3e6afb78c767d8d37395461e132fe0d1a |
|
MD5 | a11983938c0f3e5eaee512fafa57402a |
|
BLAKE2b-256 | 2b0520dd07cfb227a18fa43c6a4412d06dc4d6d7dc15e1de0d637caec7427c2a |