tfnotify - Show Terraform execution plan beautifully on GitHub

https://hashicorp.connpass.com/event/98386/

Transcript

1. tfnotify
   @b4b4r07 (Sep 11, 2018) / HashiCorp Meetup #3

   DevOps Λࢧ͑Δࠓ࿩୊ͷ HashiCorp πʔϧ܈ʹ͍ͭͯ
   Show Terraform execution plan beautifully on GitHub
   

   View Slide

2. BABAROT / @b4b4r07
   Mercari, Inc.

   SRE, Microservices Platform
   Blog / tellme.tokyo
   

   View Slide

3. 1. mercari/tfnotify
   2. Why tfnotify?
   3. Implementations
   Agenda
   

   View Slide

4. mercari/tfnotify
   

   View Slide

5. • Go ੡ CLI πʔϧ
   
   • Terraform ͷ࣮ߦ݁ՌΛύʔε͠ɺ

   ద੾ͳϑΥʔϚοτʹ͋ͯ͸Ίͯɺ

   ೚ҙͷ௨஌ઌ (GitHub ͷίϝϯτ౳)

   ΁௨஌͢Δ
   tfnotify ͱ͸
   

   View Slide

6. tfnotify
   Workflow
   DSFBUFE
   UFSSBGPSNQMBOcUGOPUJGZQMBO
   1045DPN
   N
   FOU
   PVUQVU
   

   View Slide

7. tfnotify
   Workflow
   N
   FSHFE
   UFSSBGPSNBQQMZcUGOPUJGZBQQMZ
   1045DPN
   N
   FOU
   PVUQVU
   

   View Slide

8. Example
   • fmt
   
   • plan
   
   • apply
   

   View Slide

9. Example
   {{.Title}}
   {{.Message}} {{.Result}}
   {{.Body}}
   ࣮ߦग़ྗ͢΂ͯ
   ࣮ߦ݁ՌͷαϚϦ
   --messageͰ౉ͤΔ
   ೚ҙͷλΠτϧ
   

   View Slide

10. Why tfnotify?
    

    View Slide

11. ͳͥඞཁͱͳͬͨͷ͔
    • ϝϧΧϦͰ͸ Microservices ྖҬͰ Terraform Λར༻͍ͯ͠Δ
    
    • Ownership ͷ؍఺͔ΒΠϯϑϥ؅ཧʹ͓͍ͯ΋ϨϏϡʔɾϚʔδ͸
    ֤ Micorservices νʔϜʹΑͬͯ͞ΕΔ΂͖
    
    • ͱ͸͍ͬͯ΋ɺPlatform νʔϜʹϨϏϡʔ͞Ε͍ͨέʔε΋͋Δ
    

    View Slide

12. ͳͥඞཁͱͳͬͨͷ͔
    • Platform νʔϜͱͯ͠΋ɺ֤ Microservices νʔϜͱͯ͠΋ɺ

    Infrastructure as Code ͷॏཁੑΛཧղ͠ Terraform ͰίʔυԽ͠ɺ
    ͦͷ࣮ߦܭըΛຖճݟΔ͜ͱΛश׳͚͍ͮͨ
    
    • ຖ೔ଟ͘ͷ P-R ͕͋ΔதɺCircle CI ʹݟʹ͍͘खؒΛল͖͍ͨ
    →ϨϏϡʔͷྲྀΕͰ GitHub ্ͰΫΠοΫʹ֬ೝ͍ͨ͠
    

    View Slide

13. ϝϧΧϦͰͷ HashiCorp πʔϧ
    

    View Slide

14. ϝϧΧϦͰͷ HashiCorp πʔϧ
    • ϝϧΧϦʹ͸ 70 Ҏ্ͷ Microservices ͕͋Δ

    (ࠓ೔ݱࡏɽ૿͑ଓ͚͍ͯΔ)
    
    • ͢΂ͯͷ Microservices ͱͦͷ Platform ͷ

    Πϯϑϥߏஙʹ͸ Terraform Λར༻͍ͯ͠Δ
    
    • Developers ʹ Infrastructure as Code Λ

    ࣮ફͯ͠΋Β͏
    

    View Slide

15. ϝϧΧϦͰͷ Terraform ར༻ࣄྫ
    

    View Slide

16. ϝϧΧϦͰͷ Terraform ར༻ࣄྫ
    

    View Slide

17. ϝϧΧϦͰͷ Terraform ར༻ࣄྫ
    

    View Slide

18. ϝϧΧϦͰͷ Terraform ར༻ࣄྫ
    

    View Slide

19. ϝϧΧϦͰͷ Terraform ར༻ࣄྫ
    • Insights
    
    • 110+ Contributors
    
    • 8 ~ 10 Pull Requests / week (5 days)
    
    • 140+ state files (70+ Microservices * 2 Env)
    
    • ͻͱͭͷதԝϦϙδτϦͰ͢΂ͯͷ Terraform ίʔυΛ؅ཧ͍ͯ͠Δ
    
    • CI pipeline ͷߏங͕Ұ౓ͰࡁΉ
    
    • Platform νʔϜ͕ϨϏϡʔʹೖΓ΍͍͢
    

    View Slide

20. ϦϙδτϦߏ੒
    • ֤ Microservice ͝ͱʹ

    σΟϨΫτϦΛ෼͚Δ
    
    • Service ͝ͱʹ tfstate Λ෼͚Δ
    
    • ӨڹΛଞ΁೾ٴͤ͞ͳ͍
    
    • Resource ͝ͱʹ file Λ෼͚Δ
    
    • Ϧιʔεఆٛ৔ॴΛ໌֬Խ
    
    • CODEOWNERS Ͱݖݶҕৡ
    

    View Slide

21. ϦϙδτϦߏ੒
    • ֤ Microservice ͝ͱʹ

    σΟϨΫτϦΛ෼͚Δ
    
    • Service ͝ͱʹ tfstate Λ෼͚Δ
    
    • ӨڹΛଞ΁೾ٴͤ͞ͳ͍
    
    • Resource ͝ͱʹ file Λ෼͚Δ
    
    • Ϧιʔεఆٛ৔ॴΛ໌֬Խ
    
    • CODEOWNERS Ͱݖݶҕৡ
    தԝूݖ
    ཱࣗ෼ࢄ
    

    View Slide

22. ݖݶҕৡ
    IUUQTCMPHHJUIVCDPNJOUSPEVDJOHDPEFPXOFST
    • GitHub ͷػೳ
    
    • CODEOWNERS ʹهࡌ͞Ε
    ͨਓ͔Β Approve ͞ΕΔ

    ·ͰϚʔδͰ͖ͳ͍Α͏ʹ
    Ͱ͖Δ
    
    • ͜ΕʹΑΓݖݶҕৡΛ࣮ݱ
    
    • (উखʹมߋͰ͖ͳ͍)
    

    View Slide

23. ݖݶҕৡ
    IUUQTIFMQHJUIVCDPNBSUJDMFTBCPVUDPEFPXOFST
    

    View Slide

24. Ϟδϡʔϧ
    • microservices-starter-kit (Terraform Ϟδϡʔϧ)
    
    • Template Provider Λ࢖͍σΟϨΫτϦ࡞੒ɺϑΝΠϧు͖ग़͠
    
    • Microservices ͷ্ཱͪ͛ʹඞཁͳϦιʔεΛ Bootstrap ͢Δ
    
    • GCP Project, Service account ͳͲ
    
    • PagerDuty, DataDog, Kubernetes (Namespace, Secret) ͳͲ
    
    • GitHub Teams (CODEOWNERS ͷݖݶҕৡʹ࢖͏)
    IUUQTTQFBLFSEFDLDPNCCSUFSSBGPSNPQTGPSNJDSPTFSWJDFT
    

    View Slide

25. Implementations
    

    View Slide

26. ࣮૷
    • io.TeeReader Λ࢖͍ͬͯΔ
    
    • GitHub ʹ POST ͢Δ͚ͩͰ͸
    ͳ͘ CI ͷ Console ʹ΋ग़ྗ
    
    • Terraform ͷ࣮ߦ݁Ռ͸ࣗલͷ
    ύʔαͰߏ଄Խ͢Δ (regexp)
    
    • POST ͢Δϝοηʔδ͸ Go ͷ

    ςϯϓϨʔτͰॻ͘͜ͱ͕Ͱ͖Δ
    
    • ઃఆ͸ YAML Ͱ࣋ͭ
    

    View Slide

27. ࣮૷
    • ॏෳͨ͠಺༰͕͋Δ৔߹ɺ

    ݹ͍΋ͷ͕࡟আ͞ΕΔ
    
    • ࣮ߦ݁Ռ͸௕͍ͷͰ Details λά
    ͰғͬͯંΓͨͨΈɺҰṮʹඞཁ
    ͳ৘ใ͚͕ͩݟ΍͘͢දࣔ͞ΕΔ

    {{.Title}}, {{.Message}} ͷॏෳΛݟΔ
    

    View Slide

28. Conclusion
    

    View Slide

29. ·ͱΊ
    • ϝϧΧϦͰ͸ Microservices ྖҬͰ Terraform Λར༻͍ͯ͠Δ
    
    • ूݖͱ෼ࢄͷόϥϯεͰ Terraform ϦϙδτϦΛӡ༻͍ͯ͠Δ
    
    • ͨ͘͞Μͷ P-R Λޮ཰Α͘ϨϏϡʔ͢ΔͨΊ tfnotify Λॻ͍ͨ
    
    • Terraform ͷ࣮ߦ݁ՌΛखܰʹ֬ೝ͍ͨ͠
    
    • Infrastructure as Code ͷจԽΛࠜ෇͔ͤΔ
    
    • ຖճ plan, apply ݁ՌΛݟΔश׳Λ΋ͭ / ΋ͬͯ΋Β͏
    
    • ઌߦ࣮૷͕ͳ͍ͨΊ OSS ʹͨ͠
    

    View Slide

30. Thanks
    

    View Slide