Terraformディレクトリ構成のベスプラを考えてみた

Transcript

1. Terraformディレクトリ構成 のベスプラを考えてみた 2021.07.08 ⼭下 達也 1
2. ⾃⼰紹介 ⼭下 達也 - Work at - 技術開発本部 / 技術開発第⼆部⾨ - エンジニア - Skill - AWS / Ruby(Ruby on Rails) / Terraform - SNS - Github︓https://github.com/tatsuya4150 - Qiita︓https://qiita.com/tatsuya4150 - Certificate 2
3. 01 今回話すこと
4. Terraformでこんな経験ありませんか︖ - Terraformを仕事で使おうと思ったけど、 - 運⽤しやすく、引き継ぎやすいディレクトリの分割(構造化) - はどのように設計するのが良いのだろう︖︖ 4 01 今回話すこと
5. 今回話すこと - Terraformでは、どのように構造化すれば運⽤しやすくなるのかを話します。 5 01 今回話すこと
6. 今回話すこと - Terraformでは、どのように構造化すれば運⽤しやすくなるのかを話します。 - (注意)今回話すのはあくまで⼀例なので、インフラがデカくなれば違う管理をした ⽅が良いかもしれません。 6 01 今回話すこと
7. 02 最初にやること
8. モノリスな状態からの脱却 8 02 最初にやること 作り始めは、単⼀ファイルで書いちゃうが、 どこに何が書いてあるのかわからなくなる…. ./ └── main.tf
9. モノリスな状態からの脱却 9 02 最初にやること 作り始めは、単⼀ファイルで書いちゃうが、 どこに何が書いてあるのかわからなくなる…. ./ └── main.tf
10. モノリスな状態からの脱却 10 02 最初にやること 作り始めは、単⼀ファイルで書いちゃうが、 どこに何が書いてあるのかわからなくなる…. ./ └── main.tf ./ ├── main.tf ├── outputs.tf ├── providers.tf └── variables.tf
11. モノリスな状態からの脱却 11 さらにリソース別で分けておく ./ ├── main.tf ├── outputs.tf ├── providers.tf └── variables.tf 02 最初にやること
12. モノリスな状態からの脱却 12 さらにリソース別で分けておく ./ ├── main.tf ├── outputs.tf ├── providers.tf └── variables.tf 02 最初にやること
13. モノリスな状態からの脱却 13 さらにリソース別で分けておく ./ ├── main.tf ├── outputs.tf ├── providers.tf └── variables.tf 02 最初にやること
14. モノリスな状態からの脱却 14 さらにリソース別で分けておく ./ ├── main.tf ├── outputs.tf ├── providers.tf └── variables.tf ./ ├── aws_ec2.tf ├── aws_iam_role.tf ├── aws_internet_gateway.tf ├── aws_rds.tf ├── aws_route.tf ├── aws_route_table.tf ├── aws_route_table_association.tf ├── aws_security_group.tf ├── aws_subnet.tf ├── aws_vpc.tf ├── outputs.tf ├── providers.tf └── variables.tf 02 最初にやること
15. 03 構造化のポイント
16. 構造化のポイント モジュール毎の分割 Point 3 コンポーネント毎の分割 16 Point 1 03 構造化のポイント Point 2 環境毎の分割
17. 04 構造化 その1 モジュール毎の分割
18. モジュール毎の分割 18 04 構造化その1 モジュール毎の分割 • ワンセットで複数のリソースを作成する場合はモジュール化が有効
19. モジュール毎の分割 19 04 構造化その1 モジュール毎の分割 例えば… ./ ├── aws_ec2.tf ├── aws_iam_role.tf ├── aws_internet_gateway.tf ├── aws_rds.tf ├── aws_route.tf ├── aws_route_table.tf ├── aws_route_table_association.tf ├── aws_security_group.tf ├── aws_subnet.tf ├── aws_vpc.tf ├── outputs.tf ├── providers.tf └── variables.tf
20. モジュール毎の分割 20 04 構造化その1 モジュール毎の分割 例えば… ./ ├── aws_ec2.tf ├── aws_iam_role.tf ├── aws_internet_gateway.tf ├── aws_rds.tf ├── aws_route.tf ├── aws_route_table.tf ├── aws_route_table_association.tf ├── aws_security_group.tf ├── aws_subnet.tf ├── aws_vpc.tf ├── outputs.tf ├── providers.tf └── variables.tf
21. モジュール毎の分割 21 04 構造化その1 モジュール毎の分割 例えば… ./ ├── aws_ec2.tf ├── aws_iam_role.tf ├── aws_internet_gateway.tf ├── aws_rds.tf ├── aws_route.tf ├── aws_route_table.tf ├── aws_route_table_association.tf ├── aws_security_group.tf ├── aws_subnet.tf ├── aws_vpc.tf ├── outputs.tf ├── providers.tf └── variables.tf
22. モジュール毎の分割 22 04 構造化その1 モジュール毎の分割 例えば… ./ ├── aws_ec2.tf ├── aws_iam_role.tf ├── aws_internet_gateway.tf ├── aws_rds.tf ├── aws_route.tf ├── aws_route_table.tf ├── aws_route_table_association.tf ├── aws_security_group.tf ├── aws_subnet.tf ├── aws_vpc.tf ├── outputs.tf ├── providers.tf └── variables.tf ./ ├── aws_ec2.tf ├── … ├── modules │ └── vpc │ └── aws_internet_gateway.tf │ └── aws_route.tf │ └── aws_route_table.tf │ └── aws_route_table_association.tf │ └── aws_subnet.tf │ └── aws_vpc.tf │ └── variables.tf ├── main.tf ├── outputs.tf └── providers.tf
23. モジュール毎の分割 23 04 構造化その1 モジュール毎の分割 さらに残りのファイルもモジュール化 ./ ├── aws_ec2.tf ├── … ├── modules │ └── vpc │ └── aws_internet_gateway.tf │ └── aws_route.tf │ └── aws_route_table.tf │ └── aws_route_table_association.tf │ └── aws_subnet.tf │ └── aws_vpc.tf │ └── variables.tf ├── main.tf ├── outputs.tf └── providers.tf
24. モジュール毎の分割 24 04 構造化その1 モジュール毎の分割 さらに残りのファイルもモジュール化 ./ ├── aws_ec2.tf ├── … ├── modules │ └── vpc │ └── aws_internet_gateway.tf │ └── aws_route.tf │ └── aws_route_table.tf │ └── aws_route_table_association.tf │ └── aws_subnet.tf │ └── aws_vpc.tf │ └── variables.tf ├── main.tf ├── outputs.tf └── providers.tf
25. モジュール毎の分割 25 04 構造化その1 モジュール毎の分割 さらに残りのファイルもモジュール化 ./ ├── main.tf ├── modules │ ├── ec2 │ │ └── aws_ec2.tf │ │ └── variables.tf │ ├── iam_role │ │ └── aws_iam_role.tf │ │ └── variables.tf │ ├── rds │ │ └── aws_rds.tf │ │ └── variables.tf │ ├── security_group │ │ └── aws_security_group.tf │ │ └── variables.tf │ └── vpc │ └── … │ └── variables.tf ├── outputs.tf └── providers.tf ./ ├── aws_ec2.tf ├── … ├── modules │ └── vpc │ └── aws_internet_gateway.tf │ └── aws_route.tf │ └── aws_route_table.tf │ └── aws_route_table_association.tf │ └── aws_subnet.tf │ └── aws_vpc.tf │ └── variables.tf ├── main.tf ├── outputs.tf └── providers.tf
26. モジュール毎の分割 26 04 構造化その1 モジュール毎の分割 • モジュールは下記を意識して設計する
27. モジュール毎の分割 27 04 構造化その1 モジュール毎の分割 • モジュールは下記を意識して設計する - 疎結合︓他のモジュールに依存しないようにまとめる
28. モジュール毎の分割 28 04 構造化その1 モジュール毎の分割 • モジュールは下記を意識して設計する - 疎結合︓他のモジュールに依存しないようにまとめる - ⾼凝集︓同じタイミング、同じ理由で変更するリソースをまとめる
29. モジュール毎の分割 29 04 構造化その1 モジュール毎の分割 • モジュールは下記を意識して設計する - 疎結合︓他のモジュールに依存しないようにまとめる - ⾼凝集︓同じタイミング、同じ理由で変更するリソースをまとめる - 認知的負荷︓モジュールの⼊⼒値から必須項⽬を減らして、オプション項 ⽬を増やす
30. モジュール毎の分割 30 04 構造化その1 モジュール毎の分割 • とはいえ、モジュール分割は結構難しい… • Terraform Registryを参考にすると良いかも! https://registry.terraform.io/
31. 05 構造化 その2 環境毎の分割
32. 環境毎の分割 32 05 構造化その2 環境毎の分割 • ⼀般的には本番環境、検証環境、開発環境など複数の環境が⽤意される
33. 環境毎の分割 33 05 構造化その2 環境毎の分割 • ⼀般的には本番環境、検証環境、開発環境など複数の環境が⽤意される • 本番は「t3.large」、検証・開発環境は「t3.medium」で構築とかがあり得る
34. 環境毎の分割 34 05 構造化その2 環境毎の分割 • ⼀般的には本番環境、検証環境、開発環境など複数の環境が⽤意される • 本番は「t3.large」、検証・開発環境は「t3.medium」で構築とかがあり得る • 環境毎に分けないと、⼀つの環境の変更が、他の環境に影響しちゃう…
35. 環境毎の分割 35 05 構造化その2 環境毎の分割 • ⼀般的には本番環境、検証環境、開発環境など複数の環境が⽤意される • 本番は「t3.large」、検証・開発環境は「t3.medium」で構築とかがあり得る • 環境毎に分けないと、⼀つの環境の変更が、他の環境に影響しちゃう… • だから、環境毎の分割が必要。
36. 環境毎の分割 36 例えば… 05 構造化その2 環境毎の分割 ./ ├── main.tf ├── modules │ └── … ├── outputs.tf └── providers.tf
37. 環境毎の分割 37 例えば… 05 構造化その2 環境毎の分割 ./ ├── main.tf ├── modules │ └── … ├── outputs.tf └── providers.tf
38. 環境毎の分割 38 例えば… 05 構造化その2 環境毎の分割 ./ ├── main.tf ├── modules │ └── … ├── outputs.tf └── providers.tf
39. ./ ├── environments │ ├── development │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ ├── production │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ └── staging │ ├── main.tf │ ├── outputs.tf │ └── providers.tf └── modules └── … 環境毎の分割 39 例えば… 05 構造化その2 環境毎の分割 ./ ├── main.tf ├── modules │ └── … ├── outputs.tf └── providers.tf
40. ./ ├── environments │ ├── development │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ ├── production │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ └── staging │ ├── main.tf │ ├── outputs.tf │ └── providers.tf └── modules └── … 環境毎の分割 40 例えば… 05 構造化その2 環境毎の分割 ./ ├── main.tf ├── modules │ └── … ├── outputs.tf └── providers.tf
41. 06 構造化 その3 コンポーネント毎の分割
42. コンポーネント毎の分割 42 06 構造化その3 コンポーネント毎の分割 • 環境毎に分離した際に、⼀つの環境につき⼀つのtfstateファイルを⽤意することに なる
43. コンポーネント毎の分割 43 06 構造化その3 コンポーネント毎の分割 • 環境毎に分離した際に、⼀つの環境につき⼀つのtfstateファイルを⽤意することに なる • 何かしらミスをしたときにその環境全体に影響を与えてしまう
44. コンポーネント毎の分割 44 06 構造化その3 コンポーネント毎の分割 • 環境毎に分離した際に、⼀つの環境につき⼀つのtfstateファイルを⽤意することに なる • 何かしらミスをしたときにその環境全体に影響を与えてしまう • そのため、環境をさらにコンポーネントに分割していく
45. コンポーネント毎の分割 45 例えば… 06 構造化その3 コンポーネント毎の分割 ./ ├── environments │ ├── production │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ └── … └── modules └── …
46. コンポーネント毎の分割 46 例えば… 06 構造化その3 コンポーネント毎の分割 ./ ├── environments │ ├── production │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ └── … └── modules └── …
47. コンポーネント毎の分割 47 例えば… 06 構造化その3 コンポーネント毎の分割 ./ ├── environments │ ├── production │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ └── … └── modules └── …
48. ./ ├── environments │ ├── production │ │ ├── vpc │ │ │ ├── main.tf │ │ │ └── outputs.tf │ │ ├── app │ │ │ ├── main.tf │ │ │ └── outputs.tf │ │ ├── mysql │ │ │ ├── main.tf │ │ │ └── outputs.tf │ │ └── providers.tf │ └── … └── modules └── … コンポーネント毎の分割 48 例えば… 06 構造化その3 コンポーネント毎の分割 ./ ├── environments │ ├── production │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ └── … └── modules └── …
49. ./ ├── environments │ ├── production │ │ ├── vpc │ │ │ ├── main.tf │ │ │ └── outputs.tf │ │ ├── app │ │ │ ├── main.tf │ │ │ └── outputs.tf │ │ ├── mysql │ │ │ ├── main.tf │ │ │ └── outputs.tf │ │ └── providers.tf │ └── … └── modules └── … コンポーネント毎の分割 49 例えば… 06 構造化その3 コンポーネント毎の分割 ./ ├── environments │ ├── production │ │ ├── main.tf │ │ ├── outputs.tf │ │ └── providers.tf │ └── … └── modules └── …
50. コンポーネント毎の分割 50 06 構造化その3 コンポーネント毎の分割 • 分割するポイント
51. コンポーネント毎の分割 51 06 構造化その3 コンポーネント毎の分割 • 分割するポイント • 関⼼毎によって境界線を決める。
52. コンポーネント毎の分割 52 06 構造化その3 コンポーネント毎の分割 • 分割するポイント • 関⼼毎によって境界線を決める。 • 例えば,,, ・安定度 ・ステートフル ・影響範囲 ・組織のライフサイクル etc…
53. コンポーネント毎の分割 53 06 構造化その3 コンポーネント毎の分割 • 注意点
54. コンポーネント毎の分割 54 06 構造化その3 コンポーネント毎の分割 • 注意点 • 各コンポーネントの依存関係を⼀⽅向にしておく
55. コンポーネント毎の分割 55 06 構造化その3 コンポーネント毎の分割 • 注意点 • 各コンポーネントの依存関係を⼀⽅向にしておく • そうしないと、循環参照の状態になり、環境が壊れてしまう可能性がある
56. コンポーネント毎の分割 56 06 構造化その3 コンポーネント毎の分割 • 注意点 • 各コンポーネントの依存関係を⼀⽅向にしておく • そうしないと、循環参照の状態になり、環境が壊れてしまう可能性がある • 循環参照が起こっているかの確認は、依存グラフの出⼒コマンドがある ・`terraform graph -draw-cycles | dot -Tpng > graph.png`
57. コンポーネント毎の分割 57 06 構造化その3 コンポーネント毎の分割 • 注意点 • 各コンポーネントの依存関係を⼀⽅向にしておく • そうしないと、循環参照の状態になり、環境が壊れてしまう可能性がある • 循環参照が起こっているかの確認は、依存グラフの出⼒コマンドがある ・`terraform graph -draw-cycles | dot -Tpng > graph.png`
58. コンポーネント毎の分割 58 06 構造化その3 コンポーネント毎の分割 terragruntというツールを使えば、terragrunt.hclというファイルでコンポーネントの 依存関係管理や、コンポーネント毎の共通部分を⼀つにまとめれるようになる。 https://terragrunt.gruntwork.io/
59. 07 まとめ
60. まとめ 60 07 まとめ • 単⼀ファイルからリソース以外分ける
61. まとめ 61 07 まとめ • 単⼀ファイルからリソース以外分ける • リソース毎にファイルを分ける
62. まとめ 62 07 まとめ • 単⼀ファイルからリソース以外分ける • リソース毎にファイルを分ける • 構造化していく - 1. モジュールへの分割 - 2. 環境毎への分割 - 3. コンポーネント毎への分割
63. まとめ 63 07 まとめ • 単⼀ファイルからリソース以外分ける • リソース毎にファイルを分ける • 構造化していく - 1. モジュールへの分割 - 2. 環境毎への分割 - 3. コンポーネント毎への分割 • 3つのポイントがあるが、絶対ではない。
64. まとめ 64 07 まとめ • 単⼀ファイルからリソース以外分ける • リソース毎にファイルを分ける • 構造化していく - 1. モジュールへの分割 - 2. 環境毎への分割 - 3. コンポーネント毎への分割 • 3つのポイントがあるが、絶対ではない。 • 結局は「関⼼毎による分離」を意識すれば問題ない︕
65. 08 最後に
66. 最後に 66 08 最後に 神本！ 今日の内容もこちらを大いに参考にさせてもらいました！ ぜひ皆さん、購入してみてください！ https://www.amazon.co.jp/dp/4844378139/ref=cm_sw_em_r_mt_dp_9AV0EW402PVYZ3F4VTMY
67. ご清聴いただきありがとうございました Thank You We are Hiring ! https://recruit.fusic.co.jp/