DNS as Code — CI/CDを利用したゾーン運用 —
6K Views
June 19, 24
スライド概要
DNS Summer Day 2024登壇資料です。
- クラウド時代におけるDNSゾーン運用の課題
- “DNS as Code”とは
- “DNS as Code”の実装
- DNSControl
- octoDNS
- CI/CDを利用したゾーン運用
ソフトウェアエンジニア
関連スライド
各ページのテキスト
DNS as Code — CI/CDを利用したゾーン運用 — DNS Summer Day 2024（2024年6月21日）登壇資料 2024-09-07 最終更新 所属：さくらインターネット株式会社 氏名：滝澤隆史
DNS as Code — CI/CDを利用したゾーン運用 — 自己紹介 氏名：滝澤隆史 所属：さくらインターネット株式会社 2024年2月から クラウドの中の人をやっている DNSとの関わり 趣味として何となくDNSで遊んでいる人 TAKIZAWA, Takashi 2
DNS as Code — CI/CDを利用したゾーン運用 — 概要 クラウド時代におけるDNSゾーン運用の課題 “DNS as Code”とは “DNS as Code”の実装 DNSControl octoDNS CI/CDを利用したゾーン運用 TAKIZAWA, Takashi 3
DNS as Code — CI/CDを利用したゾーン運用 — クラウド時代におけるDNSゾーン運用 の課題 TAKIZAWA, Takashi 4
DNS as Code — CI/CDを利用したゾーン運用 — クラウド時代におけるDNSゾーン運用 マネージドDNSサービスを利用することが主流になっている APIを利用可能なサービス サービスプロバイダーからSDK（ソフトウェア開発キット）やツールが提 供されていれば、それを利用してゾーンを運用できる SDKやツールはクラウドサービスを統合管理して利用するには便利だ が、DNSゾーンの運用に利用するには煩雑である 結局、WebUI（コントロールパネル）を利用している人が多いでしょう TAKIZAWA, Takashi 5
DNS as Code — CI/CDを利用したゾーン運用 — WebUI（コントロールパネル）起因による課題 変更管理ができない 変更履歴や変更理由を残せない いつ誰が何をなぜ変更したのか 変更内容（差分）を確認できない 問題発生時に切り戻しができない レビューや承認ができない コメントを記述できない TAKIZAWA, Takashi 6
DNS as Code — CI/CDを利用したゾーン運用 — WebUI（コントロールパネル）起因による課題の対策 WebUI（コントロールパネル）を使わない ゾーンデータを手元でテキストファイルとして運用し、APIを利用してDNSサ ービスに反映させる 変更管理に起因する課題 GitHubやGitLabのようなバージョン管理システムのプラットフォ ームを利用することで解決する コメントの課題 コメントを記述できるフォーマットを利用すれば解決する TAKIZAWA, Takashi 7
DNS as Code — CI/CDを利用したゾーン運用 — マネージドDNSサービスの大規模障害による課題 大規模障害が発生したとき 運用しているDNSゾーンに関する名前解決ができなくなる 運営しているサービスに影響がでる ゾーンデータの保管 一次情報としてのゾーンデータはマネージドDNSサービスにあり、手元 にはない 運用でカバー スプレッドシート管理（辛い） ゾーンデータを取り出したいときに取り出せるとは限らない 障害時に取り出せるとは思えない TAKIZAWA, Takashi 8
DNS as Code — CI/CDを利用したゾーン運用 — マネージドDNSサービスの大規模障害による課題の対 策、その1 あらかじめ他のマネージドDNSサービスに切り替えられる準備をしておく 障害時にゾーンデータを取り出せるとは限らない 一次情報としてゾーンデータを手元に持ち、APIを利用して、手元のゾ ーンデータをマネージドDNSサービスに反映させる 大規模障害時にはゾーンデータの反映先のマネージドDNSサービスを 切り替える TAKIZAWA, Takashi 9
DNS as Code — CI/CDを利用したゾーン運用 — マネージドDNSサービスの大規模障害による課題の対 策、その2 あらかじめ複数のマネージドDNSサービスを利用する WebUI（コントロールパネル）による運用は無理がある 一次情報としてゾーンデータを手元に持ち、APIを利用して、手元のゾ ーンデータを複数のマネージドDNSサービスに反映させる TAKIZAWA, Takashi 10
DNS as Code — CI/CDを利用したゾーン運用 — 課題の対策のまとめ 一次情報としてゾーンデータを手元に持つ APIを利用して、手元のゾーンデータをマネージドDNSサービスに反映させ る TAKIZAWA, Takashi 11
DNS as Code — CI/CDを利用したゾーン運用 — “DNS as Code” APIを利用して、手元のゾーンデータをマネージドDNSサービスに反映させ る どこかで見た光景 ITインフラの状態をコードで定義し、APIによりITインフラに反映させる → Infrastructure as Code DNSに特化する 「インフラ」を「DNSゾーン」に置き換える DNSゾーンの状態をコードで定義し、APIによりDNSゾーンに反映さ せる → “DNS as Code” TAKIZAWA, Takashi 12
DNS as Code — CI/CDを利用したゾーン運用 — “DNS as Code”とは TAKIZAWA, Takashi 13
DNS as Code — CI/CDを利用したゾーン運用 — “DNS as Code”とは “DNS as Code”を明確に定義した文章はない “DNS as Code”に言及している情報を見ていく TAKIZAWA, Takashi 14
DNS as Code — CI/CDを利用したゾーン運用 — DNSControl: A DSL for DNS as Code from StackOverflow.com 2017年3月14日、SREcon17 Americas Stack OverflowのSREチームのスタッフによるDNSControlの紹介 同日、DNSControlをオープンソースソフトウェアとして公開 https://www.usenix.org/conference/srecon17americas/pro gram/presentation/peterson TAKIZAWA, Takashi 15
DNS as Code — CI/CDを利用したゾーン運用 — octoDNS - README.md(v0.8.0) 2017年3月16日、octoDNS公開 公開当初（v0.8.0）のREADME.mdの見出しに「DNS as code - Tools for managing DNS across multiple providers」という記述がある https://github.com/octodns/octodns/blob/7957a4c018f72 9e47ce976fa89f065284b959a52/README.md TAKIZAWA, Takashi 16
DNS as Code — CI/CDを利用したゾーン運用 — Introducing DnsControl – “DNS as Code” has Arrived 2017年4月11日、Stack Exchange社のブログでDNSControlを紹介 記事のタイトルに“DNS as Code”が含まれている https://blog.serverfault.com/2017/04/11/introducingdnscontrol-dns-as-code-has-arrived/ TAKIZAWA, Takashi 17
DNS as Code — CI/CDを利用したゾーン運用 — DevOps and DNS 2017年7月、Andy Still (Intechnica), Phil Stanhope (Oracle Dyn)によるO'Reilly Mediaのレポート “Chapter 4. Managing DNS in a DevOps Culture”に“DNS as Code”についての言及がある https://www.oreilly.com/library/view/devops-anddns/9781492049241/ TAKIZAWA, Takashi 18
DNS as Code — CI/CDを利用したゾーン運用 — DevOps and DNS 該当箇所を要約すると （DevOpsの文脈で）すべてのDNSの変更を動的にAPIで管理できる ようになれば、すべてのDNSレコードを含めるようにInfrastructure as Codeを拡張し、コードの変更管理をし始めることが次の段階だ 注意）O’Reilly learning platformのサブスクリプションが必要 TAKIZAWA, Takashi 19
DNS as Code — CI/CDを利用したゾーン運用 — DNS as Code 2020年6月、Akamai社のブログ Edge DNSのDNSゾーンの管理にTerraformを利用する例を紹介してい る https://www.akamai.com/blog/security/dns-as-code- TAKIZAWA, Takashi 20
DNS as Code — CI/CDを利用したゾーン運用 — “DNS as Code”とは結局は何なのか 2017年から登場した言葉のようである Infrastructure as CodeをDNSに特化したもの DNSゾーンの状態をコードで定義し、APIによりDNSゾーンに反映させる TAKIZAWA, Takashi 21
DNS as Code — CI/CDを利用したゾーン運用 — なぜ2017年から登場したのか 2016年10月のマネージドDNSサービスプロバイダーのDynへの大規模 DDoSがきっかけ TAKIZAWA, Takashi 22
DNS as Code — CI/CDを利用したゾーン運用 — How Stack Overflow plans to survive the next DNS attack 2017年1月に公開されたStack Exchange社のブログ 2016年10月のDynへの大規模DDoS攻撃を背景として、次に同様な攻撃 が発生したときにどのようなアプローチをとれるかを検討した記事 https://blog.serverfault.com/2017/01/09/surviving-thenext-dns-attack/ TAKIZAWA, Takashi 23
DNS as Code — CI/CDを利用したゾーン運用 — “DNS as Code”の実装が公開 2017年3月14日：DNSControl v0.1.0公開 2017年3月16日：octoDNS v0.8.0公開 TAKIZAWA, Takashi 24
DNS as Code — CI/CDを利用したゾーン運用 — DNSControlとoctoDNSの主な特徴 ゾーンをコードとして記述するテキストファイル DNSControl: JavaScript octoDNS: YAML、マスターファイル 複数のDNSプロバイダーに対応 既存のDNSプロバイダーからのインポートに対応 プレビュー/dry-run機能により実際に登録されているゾーンデータからの 更新内容の確認 TAKIZAWA, Takashi 25
DNS as Code — CI/CDを利用したゾーン運用 — コード（テキストファイル）であることの利点 コメントを記述できる Gitのようなバージョン管理システムを利用できる GitHubやGitLabのようなバージョン管理システムのプラットフォームを利 用できる TAKIZAWA, Takashi 26
DNS as Code — CI/CDを利用したゾーン運用 — Gitのようなバージョン管理システムを利用できる 変更履歴や変更理由を残せる 変更内容（差分）を確認できる 問題発生時に切り戻しができる TAKIZAWA, Takashi 27
DNS as Code — CI/CDを利用したゾーン運用 — GitHubやGitLabのようなバージョン管理システムのプ ラットフォームを利用できる レビューや承認ができる プルリクエストやマージリクエスト CI（継続的インテグレーション）が利用できる 構文チェック 更新内容の確認（プレビュー/dry-run機能の利用） CD（継続的デリバリー）が利用できる DNSプロバイダーへのゾーンの反映 TAKIZAWA, Takashi 28
DNS as Code — CI/CDを利用したゾーン運用 — DNSControl TAKIZAWA, Takashi 29
DNS as Code — CI/CDを利用したゾーン運用 — DNSControlとは Stack Exchange社が開発・保守しているDNSゾーンの保守ツール Stack Exchange社はStack Overflow（開発者向けのQ&Aサイ ト）やServer Fault（システム・ネットワーク管理者向けのQ&Aサイト） の運営元 公式サイト https://docs.dnscontrol.org/ TAKIZAWA, Takashi 30
DNS as Code — CI/CDを利用したゾーン運用 — 背景・経緯 2016年10月：Dynへの大規模DDoS 2017年1月9日：ブログ記事『How Stack Overflow plans to survive the next DNS attack』 2017年3月14日：SREcon17 Americas『DNSControl: A DSL for DNS as Code from StackOverflow.com』 2017年3月14日：v0.1.0公開 2017年4月11日：ブログ記事『Introducing DnsControl – “DNS as Code” has Arrived』 TAKIZAWA, Takashi 31
DNS as Code — CI/CDを利用したゾーン運用 — DNSControlが行うこと 設定ファイルに記述されたゾーンデータをAPIでDNSプロバイダーに反映さ せる creds.json （プロバイダー設定ファイル） DNSControl API DNSプロバイダー dnsconfig.js （ゾーン設定ファイル） TAKIZAWA, Takashi 32
DNS as Code — CI/CDを利用したゾーン運用 — 複数のDNSプロバイダーへの対応 複数のDNSプロバイダーにも反映できる creds.json （プロバイダー設定ファイル） API DNSプロバイダーA API DNSプロバイダーB DNSControl dnsconfig.js （ゾーン設定ファイル） TAKIZAWA, Takashi 33
DNS as Code — CI/CDを利用したゾーン運用 — 対応しているマネージドDNSサービスプロバイダー Akamai Edge DNS Amazon Route 53 Azure DNS Cloudflare Google Cloud DNS Sakura Cloud（さくらのクラウド） 他、40プロバイダー以上 ※注記）本資料の実行例は「さくらのクラウド DNSアプライアンス」対応の DNSControl用のプロバイダー（滝澤が開発中）を利用したものであり、現 時点では正式リリースはされていない。 2024-09-07追記： TAKIZAWA, Takashi DNSControl v4.13.0でさくらのクラウドがサポートされた 34
DNS as Code — CI/CDを利用したゾーン運用 — 対応しているその他のDNSプロバイダー AXFR+DDNS ゾーンの取得にゾーン転送を、更新にDynamic Updateを利用 BIND マスターファイルを更新 DNS-over-HTTPS NSレコードが正しいか確認するだけの機能 Microsoft DNS Server on Microsoft Windows Server PowerDNS TAKIZAWA, Takashi 35
DNS as Code — CI/CDを利用したゾーン運用 — DNSControlの設定ファイル creds.json：DNSプロバイダー設定（認証情報含む） dnsconfig.js：ゾーン設定 TAKIZAWA, Takashi 36
DNS as Code — CI/CDを利用したゾーン運用 — DNSプロバイダー設定（認証情報含む） creds.json { } "sakuracloud": { "TYPE": "SAKURACLOUD", "access_token": "$SAKURACLOUD_ACCESS_TOKEN", "access_token_secret": "$SAKURACLOUD_ACCESS_TOKEN_SECRET" } ここでの sakuracloud はDNSプロバイダーを指定する任意の名前 TYPE はDNSプロバイダーのタイプ識別子 他のパラメーターは認証情報やAPIに関連するもので、DNSプロバイダーに 37 TAKIZAWA, より異なる Takashi
DNS as Code — CI/CDを利用したゾーン運用 — ゾーン設定（レジストラー、DNSプロバイダー指定） dnsconfig.js var REG_NONE = NewRegistrar("none"); var DSP_SAKURACLOUD = NewDnsProvider("sakuracloud"); ゾーンの設定はJavaScriptの記法で行う マクロとして利用できる関数や修飾子が用意されている NewRegistrar にはレジストラーを指定する。なければ、 none を指定する NewDnsProvider にはcreds.jsonに記述したDNSプロバイダーを指定す る TAKIZAWA, Takashi 38
DNS as Code — CI/CDを利用したゾーン運用 — ゾーン設定（ゾーンデータ） dnsconfig.js D("dnsbeer.com", REG_NONE, DnsProvider(DSP_SAKURACLOUD), DefaultTTL(3600), HTTPS("@", 1, "pale-ale.dnsbeer.com.", ""), A("pale-ale", "192.0.2.1"), END); ゾーンは関数 D の引数として記述し、引数は END で終わる ゾーン名（“.”で終わらない）、レジストラー、DNSプロバイダーを指定する リソースレコードタイプごとの修飾子を使ってリソースレコードを記述する リソースレコードタイプによってはRDATAをそのまま記述するのではなく、 TAKIZAWA, 要素ごとに記述する Takashi 39
DNS as Code — CI/CDを利用したゾーン運用 — DNSControlによるDNSプロバイダーへの反映の 実行例 実行例からどういうことができるかを確認する TAKIZAWA, Takashi 40
DNS as Code — CI/CDを利用したゾーン運用 — 変更前の状態 次のリソースレコードが登録されているとする（コントロールパネル） TAKIZAWA, Takashi 41
DNS as Code — CI/CDを利用したゾーン運用 — 設定内容 dnsconfig.jsの内容 var REG_NONE = NewRegistrar("none"); var DSP_SAKURACLOUD = NewDnsProvider("sakuracloud"); D("dnsbeer.com", REG_NONE, DnsProvider(DSP_SAKURACLOUD), DefaultTTL(3600), HTTPS("@", 1, "pale-ale.dnsbeer.com.", ""), A("pale-ale", "192.0.2.1"), END); HTTPSレコードの追加 pilsnerのAレコードの削除 TTLをデフォルト値に変更 TAKIZAWA, Takashi 42
DNS as Code — CI/CDを利用したゾーン運用 — プレビュー dnscontrol preview 作成、更新、削除されるリソースレコードが出力される 各種チェックも行う 構文チェック、MX/CNAMEの絶対ドメイン名チェック TAKIZAWA, Takashi 43
DNS as Code — CI/CDを利用したゾーン運用 — DNSプロバイダーへの反映 dnscontrol push 作成、更新、削除されるリソースレコードが表示され、DNSプロバイダーに反 映される TAKIZAWA, Takashi 44
DNS as Code — CI/CDを利用したゾーン運用 — 反映したことの確認 コントロールパネル TAKIZAWA, Takashi 45
DNS as Code — CI/CDを利用したゾーン運用 — ゾーンデータの取得（マスターファイル形式） dnscontrol get-zones --format=zone DNSプロバイダー - ゾーン ゾーンデータを取得できる TAKIZAWA, Takashi 46
DNS as Code — CI/CDを利用したゾーン運用 — ゾーンデータの取得（DNSControlの形式） dnscontrol get-zones --format=js DNSプロバイダー - ゾーン dnsconfig.jsの形式で取得できる DNSControlの新規利用開始時にこのコマンドを使うとよい TAKIZAWA, Takashi 47
DNS as Code — CI/CDを利用したゾーン運用 — JavaScript DSL JavaScriptのDSLであるため、変数や演算やマクロ関数が利用できる https://docs.dnscontrol.org/getting-started/examples var addrA = IP("1.2.3.4") var DSP_R53 = NewDnsProvider("route53_user1"); D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_R53), A("@", addrA), // 1.2.3.4 A("www", addrA + 1), // 1.2.3.5 END); この他にも便利なマクロ関数が多く用意されている TAKIZAWA, Takashi 48
DNS as Code — CI/CDを利用したゾーン運用 — octoDNS TAKIZAWA, Takashi 49
DNS as Code — CI/CDを利用したゾーン運用 — octoDNSとは GitHub社が開発・保守しているDNSゾーンの保守ツール 公式サイト https://github.com/github/octodns TAKIZAWA, Takashi 50
DNS as Code — CI/CDを利用したゾーン運用 — 背景・経緯 2016年10月：Dynへの大規模DDoS 2017年3月16日：v0.8.0公開 2017年4月27日：ブログ記事『Enabling DNS split authority with OctoDNS』 2017年5月31日：ブログ記事『DNS Infrastructure at GitHub』 TAKIZAWA, Takashi 51
DNS as Code — CI/CDを利用したゾーン運用 — octoDNSが行うこと ソースとして指定したDNSプロバイダーのゾーンデータをAPIでターゲット のDNSプロバイダーに反映させる ソースDNSプロバイダー TAKIZAWA, Takashi API octoDNS API ターゲットDNSプロバイダー 52
DNS as Code — CI/CDを利用したゾーン運用 — 複数のDNSプロバイダーへの対応 複数のDNSプロバイダーにも反映できる ソースDNSプロバイダー TAKIZAWA, Takashi API API ターゲットDNSプロバイダーA API ターゲットDNSプロバイダーB octoDNS 53
DNS as Code — CI/CDを利用したゾーン運用 — 対応しているマネージドDNSサービスプロバイダー Akamai Edge DNS Amazon Route 53 Azure DNS Cloudflare DNS Google Cloud DNS 計23プロバイダー ※注記）本資料の実行例は「さくらのクラウド DNSアプライアンス」対応のプロバ イダーパッケージoctodns-sakuracloud（滝澤が開発中）を利用したものであ り、現時点では正式リリースはされていない。 TAKIZAWA, Takashi 54
DNS as Code — CI/CDを利用したゾーン運用 — 対応しているその他のDNSプロバイダー Rfc2136Provider/BindProvider ゾーン転送＋Dynamic Update EtcHostsProvider /etc/hosts PowerDNS YamlProvider octoDNS独自のYAML形式のゾーンファイル TAKIZAWA, Takashi 55
DNS as Code — CI/CDを利用したゾーン運用 — 対応しているソース専用DNSプロバイダー EnvVarSource 環境変数 AxfrSource ゾーン転送 ZoneFileSource マスターファイル TinyDnsFileSource tinydns TAKIZAWA, Takashi 56
DNS as Code — CI/CDを利用したゾーン運用 — インストール DNSプロバイダーごとにPythonパッケージとして提供されているため、利 用するDNSプロバイダーのパッケージをインストールする pip3 install octodns pip3 install パッケージ名 例えば、ゾーンファイルを利用したいときには次のようにする pip3 install octodns pip3 install octodns-bind パッケージの一覧は公式サイトの「Providers」に掲載されている https://github.com/octodns/octodns#providers TAKIZAWA, Takashi 57
DNS as Code — CI/CDを利用したゾーン運用 — octoDNSの設定ファイル YAML形式の設定ファイル 設定ファイルは次の2つから構成される providers：DNSプロバイダー設定（認証情報含む） zones：ゾーンごとのDNSプロバイダーの指定 --providers: ... zones: ... TAKIZAWA, Takashi 58
DNS as Code — CI/CDを利用したゾーン運用 — DNSプロバイダー設定（認証情報含む） providers: zonefile: class: octodns_bind.ZoneFileSource directory: ./zones file_extension: .zone check_origin: false sakuracloud: class: octodns_sakuracloud.SakuraCloudProvider access_token: env/SAKURACLOUD_ACCESS_TOKEN access_token_secret: env/SAKURACLOUD_ACCESS_TOKEN_SECRET zonefile や sakuracloud はDNSプロバイダーを指定する任意の名前 class はDNSプロバイダーのクラス（開発言語Pythonのクラス） 他のパラメーターは認証情報などのもので、DNSプロバイダーにより異なる 59 TAKIZAWA, Takashi
DNS as Code — CI/CDを利用したゾーン運用 — ゾーンごとのDNSプロバイダーの指定 zones: '*': sources: - zonefile targets: - sakuracloud sources にソースDNSプロバイダー、 targets にターゲットDNSプロバ イダーを指定する 動的ゾーン構成（Dynamic Zone Config）の例であるため、ゾーン名は * になっている 静的ゾーン構成（Static Zone Config）の場合は、 example.com. （ . で 60 TAKIZAWA, 終わる）のようなゾーン名になる Takashi
DNS as Code — CI/CDを利用したゾーン運用 — ゾーンファイル バージョン管理システムの利用やCI/CDの利用を考慮すると、ソースDNS プロバイダーとしては以下のどちらかを利用することになる YamlProvider（YAML形式のゾーンファイル） ZoneFileSource（マスターファイル） TAKIZAWA, Takashi 61
DNS as Code — CI/CDを利用したゾーン運用 —
ゾーンファイル（YamlProvider）
--"":
ttl: 3600
type: HTTPS
value:
svcparams: {}
svcpriority: 0
targetname: pale-ale.dnsbeer.com.
pale-ale:
ttl: 3600
type: A
value: 192.0.2.1
value （1個の場合）あるいは values （複数の場合）はリソースレコードタイ
プにより記述形式が異なる
TAKIZAWA, Takashi
62
DNS as Code — CI/CDを利用したゾーン運用 — ゾーンファイル（ZoneFileSource） マスターファイル形式のゾーンファイルを利用できる ただし、利用できるリソースレコードタイプには制限がある A, AAAA, CAA, CNAME, LOC, MX, NS, PTR, SPF, SRV, SSHFP, TLSA, TXT ターゲットDNSプロバイダーにおいて、ゾーン頂点のSOAレコードやNSレコ ードが変更できないときには次の設定を追加する check_origin: false TAKIZAWA, Takashi 63
DNS as Code — CI/CDを利用したゾーン運用 — CLIツール octodns-sync octodns-sync --config-file=config.yaml --doit ソースDNSプロバイダーのゾーンデータをターゲットDNSプロバイダー にAPIで同期する デフォルトはdry-runで動作する --doit オプションを付けることでDNSプロバイダーに反映させる TAKIZAWA, Takashi 64
DNS as Code — CI/CDを利用したゾーン運用 — octoDNSによるDNSプロバイダーへの反映の実行 例 実行例からどういうことができるかを確認する TAKIZAWA, Takashi 65
DNS as Code — CI/CDを利用したゾーン運用 — 変更前の状態 次のリソースレコードが登録されているとする（コントロールパネル） TAKIZAWA, Takashi 66
DNS as Code — CI/CDを利用したゾーン運用 — マスターファイル zones/dnsbeer.com.zone $TTL 3600 pale-ale porter IN IN A A 192.0.2.1 192.0.2.3 pilsnerのAレコードの削除 porterのAレコードの追加 TTLの変更 TAKIZAWA, Takashi 67
DNS as Code — CI/CDを利用したゾーン運用 —
dry-runの実行
デフォルトはdry-runとして動作する
$ octodns-sync --config-file=config.yaml
...
**********************************************************************
* dnsbeer.com.
**********************************************************************
* sakuracloud (SakuraCloudProvider)
*
Delete <ARecord A 1800, pilsner.dnsbeer.com., ['192.0.2.2']>
*
Create <ARecord A 3600, porter.dnsbeer.com., ['192.0.2.3']> ()
*
Update
*
<ARecord A 1800, pale-ale.dnsbeer.com., ['192.0.2.1']> ->
*
<ARecord A 3600, pale-ale.dnsbeer.com., ['192.0.2.1']> ()
*
Summary: Creates=1, Updates=1, Deletes=1, Existing Records=2
**********************************************************************
...
TAKIZAWA, Takashi
68
DNS as Code — CI/CDを利用したゾーン運用 —
DNSプロバイダーへの反映
実際に反映するためには --doit オプションを付ける
$ octodns-sync --config-file=config.yaml --doit
...
**********************************************************************
* dnsbeer.com.
**********************************************************************
* sakuracloud (SakuraCloudProvider)
*
Delete <ARecord A 1800, pilsner.dnsbeer.com., ['192.0.2.2']>
*
Create <ARecord A 3600, porter.dnsbeer.com., ['192.0.2.3']> ()
*
Update
*
<ARecord A 1800, pale-ale.dnsbeer.com., ['192.0.2.1']> ->
*
<ARecord A 3600, pale-ale.dnsbeer.com., ['192.0.2.1']> ()
*
Summary: Creates=1, Updates=1, Deletes=1, Existing Records=2
**********************************************************************
2024-06-18T10:15:54 [8456129536] INFO SakuraCloudProvider[sakuracloud]
apply: making 3 changes to dnsbeer.com.
TAKIZAWA, Takashi
2024-06-18T10:15:55 [8456129536] INFO Manager sync:
3 total changes
69
DNS as Code — CI/CDを利用したゾーン運用 — 反映したことの確認 コントロールパネル TAKIZAWA, Takashi 70
DNS as Code — CI/CDを利用したゾーン運用 — ゾーンデータの取得（YAML形式） octodns-dumpを利用して、YAML形式で取得できる octoDNSの新規利用開始時にこのコマンドを使うとよい $ octodns-dump --config-file config.yaml --output-dir zones dnsbeer.com. sakuracloud ... $ cat zones/dnsbeer.com.yaml --pale-ale: type: A value: 192.0.2.1 porter: type: A TAKIZAWA, Takashi value: 192.0.2.3 71
DNS as Code — CI/CDを利用したゾーン運用 — CI/CDを利用したゾーン運用 TAKIZAWA, Takashi 72
DNS as Code — CI/CDを利用したゾーン運用 — GitHubやGitLabのようなバージョン管理システム のプラットフォームの利用 1. リポジトリのフォーク 2. git pull 3. ブランチ作成 4. ゾーンファイルの編集 5. git commit、git push TAKIZAWA, Takashi 73
DNS as Code — CI/CDを利用したゾーン運用 — GitHubやGitLabのようなバージョン管理システム のプラットフォームの利用 6. プルリクエストやマージリクエストの作成 7. CI（継続的インテグレーション） 構文チェック 更新内容の出力（プレビュー/dry-run機能の利用） 8. レビュー、承認 9. マージ 10. CD（継続的デリバリー） DNSプロバイダーへのゾーンの反映 TAKIZAWA, Takashi 74
DNS as Code — CI/CDを利用したゾーン運用 — GitHub Actionsでの利用例の紹介 GitHub Actionsとは GitHubの継続的インテグレーションと継続的デリバリー (CI/CD) の プラットフォーム GitHub Actionsを利用してDNSControlによるゾーン運用の例 TAKIZAWA, Takashi 75
DNS as Code — CI/CDを利用したゾーン運用 — GitHubのリポジトリに対して事前に行うこと デフォルトブランチ（main）に対してルールを設定する Settings → Rules → Ruleset Require a pull request before merging Required approvals: 1 ←承認が必要な場合 Require status checks to pass Status checks that are required PR時に実行するGitHub Actionsを指定 DNSプロバイダーで利用する認証情報をシークレットとして登録する Settings → Secrets and variables → Actions Repository secrets TAKIZAWA, Takashi 76
DNS as Code — CI/CDを利用したゾーン運用 — リポジトリのファイル構成 creds.json - DNSプロバイダー設定（認証情報含む） dnsconfig.js - ゾーンファイル .github/ workflows/ preview.yml - Pull Request作成・更新時に実行する push.yml - マージしたときに実行する TAKIZAWA, Takashi 77
DNS as Code — CI/CDを利用したゾーン運用 —
creds.json - DNSプロバイダー設定
認証情報を環境変数から取得するように設定する
{
}
"sakuracloud": {
"TYPE": "SAKURACLOUD",
"access_token": "$SAKURACLOUD_ACCESS_TOKEN",
"access_token_secret": "$SAKURACLOUD_ACCESS_TOKEN_SECRET"
}
TAKIZAWA, Takashi
78
DNS as Code — CI/CDを利用したゾーン運用 —
preview.yml
Pull Request作成時・更新時にワークフローを実行し、プレビューを行う
name: preview
on:
pull_request:
branches: [ 'main' ]
paths: [ 'creds.json', 'dnsconfig.js' ]
jobs:
preview:
runs-on: ubuntu-latest
container:
image: ttkzw/dnscontrol
steps:
- uses: actions/checkout@v4
- name: dnscontrol preview
run: dnscontrol preview
env:
SAKURACLOUD_ACCESS_TOKEN: ${{ secrets.SAKURACLOUD_ACCESS_TOKEN }}
SAKURACLOUD_ACCESS_TOKEN_SECRET: ${{ secrets.SAKURACLOUD_ACCESS_TOKEN_SECRET }}
TAKIZAWA, Takashi
79
DNS as Code — CI/CDを利用したゾーン運用 —
push.yml
mainブランチにマージするときにワークフローを実行し、ゾーンデータを
DNSプロバイダーに反映する
name: push
on:
push:
branches: [ 'main' ]
paths: [ 'creds.json', 'dnsconfig.js' ]
jobs:
push:
runs-on: ubuntu-latest
container:
image: ttkzw/dnscontrol
steps:
- uses: actions/checkout@v4
- name: dnscontrol push
run: dnscontrol push
env:
SAKURACLOUD_ACCESS_TOKEN: ${{ secrets.SAKURACLOUD_ACCESS_TOKEN }}
SAKURACLOUD_ACCESS_TOKEN_SECRET: ${{ secrets.SAKURACLOUD_ACCESS_TOKEN_SECRET }}
TAKIZAWA, Takashi
80
DNS as Code — CI/CDを利用したゾーン運用 — 実行例 D("dnsbeer.com", REG_NONE, DnsProvider(DSP_SAKURACLOUD), DefaultTTL(3600), A("pale-ale", "192.0.2.1", TTL(1800)), A("pilsner", "192.0.2.2"), END); ↓ D("dnsbeer.com", REG_NONE, DnsProvider(DSP_SAKURACLOUD), DefaultTTL(3600), HTTPS("@", 1, "pale-ale.dnsbeer.com.", ""), A("pale-ale", "192.0.2.1"), END); TAKIZAWA, Takashi 81
DNS as Code — CI/CDを利用したゾーン運用 — git diff $ git diff diff --git a/dnsconfig.js b/dnsconfig.js index 5d7717b..151134f 100644 --- a/dnsconfig.js +++ b/dnsconfig.js @@ -3,6 +3,6 @@ var DSP_SAKURACLOUD = NewDnsProvider("sakuracloud"); D("dnsbeer.com", REG_NONE, DnsProvider(DSP_SAKURACLOUD), DefaultTTL(3600), - A("pale-ale", "192.0.2.1", TTL(1800)), - A("pilsner", "192.0.2.2"), + HTTPS("@", 1, "pale-ale.dnsbeer.com.", ""), + A("pale-ale", "192.0.2.1"), END); TAKIZAWA, Takashi 82
DNS as Code — CI/CDを利用したゾーン運用 — git commit & push $ git commit -a -m "pilsnerの削除" [test 3e06266] pilsnerの削除 1 file changed, 2 insertions(+), 2 deletions(-) $ git push origin HEAD Enumerating objects: 5, done. Counting objects: 100% (5/5), done. Delta compression using up to 8 threads Compressing objects: 100% (3/3), done. Writing objects: 100% (3/3), 370 bytes | 370.00 KiB/s, done. Total 3 (delta 2), reused 0 (delta 0), pack-reused 0 remote: Resolving deltas: 100% (2/2), completed with 2 local objects. To github.com:ttkzw/dns-as-code-example.git bfe0ed3..3e06266 HEAD -> test TAKIZAWA, Takashi 83
DNS as Code — CI/CDを利用したゾーン運用 — Pull Request作成 TAKIZAWA, Takashi 84
DNS as Code — CI/CDを利用したゾーン運用 — Pull Request作成 TAKIZAWA, Takashi 85
DNS as Code — CI/CDを利用したゾーン運用 — Pull Request作成完了 Pull Request時のワークフローpreviewが実行される TAKIZAWA, Takashi 86
DNS as Code — CI/CDを利用したゾーン運用 — Pull Request時のGitHub Actionsの実行結果 TAKIZAWA, Takashi 87
DNS as Code — CI/CDを利用したゾーン運用 — マージ マージ時（mainブランチへのpush時）のワークフローpushが実行される TAKIZAWA, Takashi 88
DNS as Code — CI/CDを利用したゾーン運用 — マージ時のGitHub Actionsの実行結果 TAKIZAWA, Takashi 89
DNS as Code — CI/CDを利用したゾーン運用 — 失敗時のPull Request画面 TAKIZAWA, Takashi 90
DNS as Code — CI/CDを利用したゾーン運用 — 失敗時のGitHub Actions TAKIZAWA, Takashi 91
DNS as Code — CI/CDを利用したゾーン運用 — 承認を必要とする設定をしたとき TAKIZAWA, Takashi 92
DNS as Code — CI/CDを利用したゾーン運用 — まとめ TAKIZAWA, Takashi 93
DNS as Code — CI/CDを利用したゾーン運用 — まとめ “DNS as Code” Infrastructure as CodeをDNSに特化したもの DNSゾーンの状態をコードで定義し、APIによりDNSゾーンに反映さ せる CI/CDによるゾーンの運用ができる “DNS as Code”の主要な実装であるDNSControlとoctoDNSの紹介 GitHub ActionsとDNSControlを利用したCI/CDの例の紹介 TAKIZAWA, Takashi 94
DNS as Code — CI/CDを利用したゾーン運用 — おまけ TAKIZAWA, Takashi 95
DNS as Code — CI/CDを利用したゾーン運用 — おまけ 登壇時間内に収まりきらなかった資料をおまけとして掲載する。 DNS as Codeの実装 DNSControlの注意点 octoDNSの注意点 複数のマネージドDNSサービスの利用上の注意点 編集環境の注意点 DNSプロバイダーパッケージの作成 TAKIZAWA, Takashi 96
DNS as Code — CI/CDを利用したゾーン運用 — DNS as Codeの実装 TAKIZAWA, Takashi 97
DNS as Code — CI/CDを利用したゾーン運用 — DNS as Codeの実装 クラウドサービスプロバイダー提供プロビジョニングツール Terraform/OpenTofu DNSControl octoDNS TAKIZAWA, Takashi 98
DNS as Code — CI/CDを利用したゾーン運用 — リソースレコードの記述例 リソースレコードの記述しやすさ リソースレコードの数が少なけば、それほど問題にならない リソースレコードの数が多いと、記述しやすさは重要である リソースレコードの記述例をそれぞれの公式ドキュメントから見てみる TAKIZAWA, Takashi 99
DNS as Code — CI/CDを利用したゾーン運用 —
AWS CloudFormation (Amazon Route 53)
"myDNSRecord" : {
"Type" : "AWS::Route53::RecordSet",
"Properties" :
{
"HostedZoneId" : "Z3DG6IL3SJCGPX",
"Name" : "mysite.example.com.",
"Type" : "SPF",
"TTL" : "900",
"ResourceRecords" : [ "\"v=spf1 ip4:192.168.0.1/16 -all\"" ]
}
}
https://docs.aws.amazon.com/AWSCloudFormation/latest/User
Guide/quickref-route53.html
TAKIZAWA, Takashi
100
DNS as Code — CI/CDを利用したゾーン運用 —
Azure Resource Manager template (Azure
DNS)
{
略
"type": "Microsoft.Network/dnsZones/A",
"apiVersion": "2018-05-01",
"name": "[format('{0}/{1}', parameters('zoneName'), parameters('recordName'))]",
"properties": {
"TTL": 3600,
"ARecords": [
{
"ipv4Address": "1.2.3.4"
},
{
"ipv4Address": "1.2.3.5"
}
]
},
}
https://learn.microsoft.com/en-us/azure/dns/dns-get-started- 101
TAKIZAWA, Takashi
DNS as Code — CI/CDを利用したゾーン運用 —
Google Cloud Deployment Manager (Google
Cloud DNS)
- name: {{ properties["rrsetName"] }}
type: gcp-types/dns-v1:resourceRecordSets
properties:
name: {{ properties["rrsetDomain"] }}
managedZone: $(ref.{{ properties["zoneName"] }}.name)
records:
- type: A
ttl: 50
rrdatas:
- 10.40.10.0
https://github.com/GoogleCloudPlatform/deploymentmanagersamples/blob/master/google/resource-snippets/dns102
TAKIZAWA, Takashi
DNS as Code — CI/CDを利用したゾーン運用 — Terraform/OpenTofu (Amazon Route 53) resource "aws_route53_record" "www" { zone_id = aws_route53_zone.primary.zone_id name = "www.example.com" type = "A" ttl = 300 records = [aws_eip.lb.public_ip] } https://registry.terraform.io/providers/hashicorp/aws/latest/d ocs/resources/route53_record TAKIZAWA, Takashi 103
DNS as Code — CI/CDを利用したゾーン運用 — Terraform/OpenTofu (Azure DNS) resource "azurerm_dns_a_record" "example" { name = "test" zone_name = azurerm_dns_zone.example.name resource_group_name = azurerm_resource_group.example.name ttl = 300 records = ["10.0.180.17"] } https://registry.terraform.io/providers/hashicorp/azurerm/late st/docs/resources/dns_a_record TAKIZAWA, Takashi 104
DNS as Code — CI/CDを利用したゾーン運用 — Terraform/OpenTofu (Google Cloud DNS) resource "google_dns_record_set" "a" { name = "backend.${google_dns_managed_zone.prod.dns_name}" managed_zone = google_dns_managed_zone.prod.name type = "A" ttl = 300 } rrdatas = ["8.8.8.8"] https://registry.terraform.io/providers/hashicorp/google/latest /docs/resources/dns_record_set TAKIZAWA, Takashi 105
DNS as Code — CI/CDを利用したゾーン運用 — DNSControl JavaScriptベースのDSL A("test", "5.6.7.8") https://github.com/StackExchange/dnscontrol TAKIZAWA, Takashi 106
DNS as Code — CI/CDを利用したゾーン運用 — octoDNS YAML --'': ttl: 60 type: A values: - 1.2.3.4 - 1.2.3.5 https://github.com/octodns/octodns TAKIZAWA, Takashi 107
DNS as Code — CI/CDを利用したゾーン運用 — 【参考】マスターファイル（ゾーンファイル） test 300 IN A 192.0.2.1 TAKIZAWA, Takashi 108
DNS as Code — CI/CDを利用したゾーン運用 — リソースレコードの設定例のまとめ クラウドサービスプロバイダー提供プロビジョニングツールと Terraform/OpenTofu プロバイダーにより記述方法が異なる リソースレコードセットごとにリソースを定義するため、記述が冗長であ る 数個だけであれば大変ではないが、100個あるときはどうだろう か DNSControlとoctoDNSとマスターファイル DNSに特化しているため、記述が簡潔である TAKIZAWA, Takashi 109
DNS as Code — CI/CDを利用したゾーン運用 — DNSControlの注意点 TAKIZAWA, Takashi 110
DNS as Code — CI/CDを利用したゾーン運用 — 注意点 - リソースレコードタイプ SOA：ほとんどの場合はDNSプロバイダー側で管理しているため、記述不要 NS：変更できないDNSプロバイダーの場合は記述不要 ALIAS：疑似リソースレコードタイプはDNSプロバイダーが対応していれば 利用できる TXT：SPFやDMARCを利用するときには SPF_BUILDER や DMARC_BUILDER を利用できる CAA： CAA_BUILDER を利用できる TAKIZAWA, Takashi 111
DNS as Code — CI/CDを利用したゾーン運用 — SPF_BUILDER SPF用のTXTレコードを生成してくれる 10 DNS lookupsのチェックあり https://docs.dnscontrol.org/language-reference/domainmodifiers/spf_builder SPF_BUILDER({ label: "@", parts: [ "v=spf1", "ip4:198.252.206.0/24", // ny-mail* "ip4:192.111.0.0/24", // co-mail* "include:_spf.google.com", // GSuite 略 TAKIZAWA, Takashi "~all" 112
DNS as Code — CI/CDを利用したゾーン運用 — 注意点 - フォーマッター PrettierやBiomeなどのフォーマッターを利用していると次のように整形 されることがある DNSControlにおいては最後の引数の末尾のカンマは許容されないので、 Trailing Commasの設定を es5 にする D( "example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER), A("@", "192.0.2.1"), A("foo", "192.0.2.2"), END, ←このカンマは許容されない ); TAKIZAWA, Takashi 113
DNS as Code — CI/CDを利用したゾーン運用 — JavaScriptのフォーマッターの設定 Prettier (.prettier) { } "trailingComma": "es5" Biome (biome.json) { } "javascript": { "formatter": { "trailingCommas": "es5" } } TAKIZAWA, Takashi 114
DNS as Code — CI/CDを利用したゾーン運用 — octoDNSの注意点 TAKIZAWA, Takashi 115
DNS as Code — CI/CDを利用したゾーン運用 — ゾーンデータの取得（マスターファイル形式） マスターファイル形式としては取得できない ZoneFileSourceはソース専用のDNSプロバイダーであるため 試しにoctodns-dumpを実行するとエラーが発生する $ octodns-dump --config-file config.yaml --output-dir zones --output-provider zonefile dnsbeer.com. sakuracloud ... octodns.manager.ManagerException: output_provider=zonefile, does not support copy method TAKIZAWA, Takashi 116
DNS as Code — CI/CDを利用したゾーン運用 — 注意点 - リソースレコードタイプ DNSプロバイダーによっては、ゾーン頂点のSOAレコードとNSレコードは 扱えない DNSプロバイダーにより対応しているリソースレコードタイプは異なる 特にHTTPSとSVCBはoctoDNSの公式ドキュメント上ではサポート されていない DNSプロバイダーもサポートしていない 内部的には扱えるようになっているので実はYamlProviderでは 利用できる ALIASのような疑似リソースレコードタイプはDNSプロバイダーがサポート していれば利用できる TAKIZAWA, Takashi 117
DNS as Code — CI/CDを利用したゾーン運用 — 注意点 - 安全機能 ゾーンに10個以上のリソースレコードセットが存在するときに、次のそれぞ れの場合は中断される 全体の30%以上のリソースレコードセットが更新される場合 全体の30%以上のリソースレコードセットが削除される場合 --force オプションを付けて実行すると、この安全機能は無視される $ octodns-sync --config-file config.yaml ... octodns.provider.plan.TooMuchChange: [dnsbeer.com.] Too many updates, 100.00% is over 30.00% (10/10), force required TAKIZAWA, Takashi 118
DNS as Code — CI/CDを利用したゾーン運用 — 注意点 - APIリクエスト 1回のAPIリクエストで更新できるリソースレコードセットの数はDNSプロバ イダーにより異なる ゾーンのリソースレコードセットをまとめて更新できるもの 複数のリソースレコードセットの更新を一度にできるもの 1個のリソースレコードセットの更新しかできないもの 1回のリクエストで1個のリソースレコードセットしか更新できない場合は、リ ソースレコードセットの数だけAPIへのリクエストを行うため、更新に時間が かかる TAKIZAWA, Takashi 119
DNS as Code — CI/CDを利用したゾーン運用 — octoDNSのその他のコマンド octodns-compare 2つのDNSプロバイダー間のゾーンを比較する DNSプロバイダーの移行時のゾーン登録内容の比較にも利用できる octodns-report ソースDNSプロバイダーのゾーンとDNS権威サーバーへのDNSクエリ ー結果を比較する octodns-validate 設定ファイルを検査する octodns-versions バージョンを表示して終了する TAKIZAWA, Takashi 120
DNS as Code — CI/CDを利用したゾーン運用 — 複数のマネージドDNSサービスの利用 上の注意点 TAKIZAWA, Takashi 121
DNS as Code — CI/CDを利用したゾーン運用 — 複数のマネージドDNSサービスの利用上の注意点 ゾーン頂点のNSレコードを追加できる必要がある ゾーン頂点のNSレコードを追加・変更できないマネージドDNSサービ スは多い レジストラーに登録できるNSレコードの数に制限がある どのNSレコードを登録するか検討する マネージドDNSサービスによってリソースレコードの制限が異なる TAKIZAWA, Takashi 122
DNS as Code — CI/CDを利用したゾーン運用 — 編集環境の注意点 TAKIZAWA, Takashi 123
DNS as Code — CI/CDを利用したゾーン運用 — 編集環境の注意点 編集したときに以下のことが生じないようにする タブとスペースが混在する インデントのスペースの桁数が統一されていない 最終行が改行で終わったり終わらなかったりする .editorconfig を用意し、リポジトリに含める TAKIZAWA, Takashi 124
DNS as Code — CI/CDを利用したゾーン運用 — .editorconfigの例 root = true [*] indent_style = space indent_size = 2 tab_width = 2 end_of_line = lf charset = UTF-8 trim_trailing_whitespace = true insert_final_newline = true TAKIZAWA, Takashi 125
DNS as Code — CI/CDを利用したゾーン運用 — .editorconfigをサポートしていないエディター プラグインを入れて利用できるようにすることを徹底させる。 Vim用プラグイン https://github.com/editorconfig/editorconfig-vim Vim 9.0.1799, Neovim 0.9以降ではバンドルされている Emacs用プラグイン https://github.com/editorconfig/editorconfig-emacs VSCode用エクステンション https://marketplace.visualstudio.com/items? itemName=EditorConfig.EditorConfig TAKIZAWA, Takashi 126
DNS as Code — CI/CDを利用したゾーン運用 — DNSプロバイダーパッケージの作成 TAKIZAWA, Takashi 127
DNS as Code — CI/CDを利用したゾーン運用 — DNSプロバイダーパッケージの作成 DNSプロバイダーがAPIを公開していれば、DNSプロバイダーパッケージを 作成できる 開発言語 DNSControl: Go言語 octoDNS: Python 今回、実行例として利用したものはそれぞれ とりあえず動くようにするだけであれば1、2日あればできる DNSプロバイダーの制限に基づく例外的な処理とかテストとかドキュメ ント作成を加えて数日といったところ 公開およびコントリビュートする予定 TAKIZAWA, Takashi 128
DNS as Code — CI/CDを利用したゾーン運用 — DNSControl 開発ドキュメントが用意されている Code Style Guide https://docs.dnscontrol.org/developerinfo/styleguide-code Writing new DNS providers https://docs.dnscontrol.org/developer-info/writingproviders TAKIZAWA, Takashi 129
DNS as Code — CI/CDを利用したゾーン運用 — octoDNS 開発ドキュメントが十分には用意されていないので、他のプロバイダーパッケ ージを参考に開発する octodns.provider.base.BaseProvider を継承したクラスを作成し、以 下のメソッドを実装する __init__() 引数：self, id, 設定ファイルのパラメーター... list_zones() - ゾーン名一覧を取得する populate() - プロバイダーからゾーンデータを取得する _apply() - プロバイダーにゾーンデータを反映する TAKIZAWA, Takashi 130
DNS as Code — CI/CDを利用したゾーン運用 — octoDNS 同クラスに以下のインスタンス変数を設定する SUPPORTS - 対応しているリソースレコードタイプをset型として設定 SUPPORTS_GEO log - ロガーを設定する 同クラスに以下のインスタンス変数・プロパティーを設定する。デフォルトが Falseなので対応していなければ設定しなくてもよい SUPPORTS_MULTIVALUE_PTR SUPPORTS_POOL_VALUE_STATUS SUPPORTS_ROOT_NS SUPPORTS_DYNAMIC_SUBNETS TAKIZAWA, Takashi 131