Go Applicationでの設定情報の扱い方

エムスリー株式会社のTech Talkにて発表した内容です。
https://corporate.m3.com/

https://qiita.com/Khigashiguchi/items/525a5920b3953bfbf5fa

Transcript

1. Go ApplicationͰͷ ઃఆ৘ใͷѻ͍ํ 2018/8/22 (Wed) ΤϜεϦʔגࣜձࣾ ࣾ಺ษڧձ BASEגࣜձࣾ ౦ޱ࿨ᏻ @Khigashiguchi
2. ຊ೔͓अຐͤͯ͞΋Β͖͔͚ͬͨͬ IUUQTHPNPLVDPOOQBTTDPNFWFOU
3. ࣗݾ঺հ • ౦ޱ ࿨ᏻ @Khigashiguchi • BASE, Inc / BASE Product Division • Server Side EngineerʢPHP / Goʣ • Works • EίϚʔεϓϥοτϑΥʔϜʮBASEʯͷ ܾࡁྖҬ • PHP/CakePHPͷόʔδϣϯΞοϓ • BASE BANKʹͯۚ༥ࣄۀͷ্ཱͪ͛
4. ↑BASE BANK IUUQTXXXXBOUFEMZDPNQSPKFDUT
5. ઃఆ৘ใͱ͸
6. ઃఆ৘ใ ͱ͸ • σʔλϕʔεͷ઀ଓઌ΍ύεϫʔυͳͲ • 12factor.net ͷఆٛ • σʔλϕʔεɺMemcachedɺଞͷόοΫΤϯυαʔ ϏεͳͲͷϦιʔε΁ͷϋϯυϧ • Amazon S3΍TwitterͳͲͷ֎෦αʔϏεͷೝূ৘ใ • σϓϩΠ͞Εͨϗετͷਖ਼نԽ͞Εͨϗετ໊ͳͲɺ σϓϩΠ͝ͱͷ஋ https://12factor.net/ja/config
7. ઃఆ৘ใ ʹର͢Δʮئ͍ʯ • ઃఆ৘ใ͸؀ڥ͝ͱʹҧ͏ͷͰ෼͚͍ͨ • ηΩϡΞʹ؅ཧ͍ͨ͠ • ຊ൪؀ڥͳͲ΁ͷΞΫηεՄೳͳ৘ใ͸ɺ ίʔυϕʔε͔Β෼཭͍ͨ͠
8. > Ͳ͏͢Ε͹
9. > Twelve-Factor AppΛ ࢀߟʹݟͯΈΔ
10. The Twelve-Factor App IUUQTGBDUPSOFUKB
11. The Twelve-Factor App Ⅲ. ઃఆ IUUQTGBDUPSOFUKBDPOpH
12. ઃఆ ʹର͢Δཁٻ • ઃఆΛίʔυ͔Βݫີʹ෼཭͢Δ͜ͱ • ઃఆΛ ؀ڥม਺ ʹ֨ೲ͢Δ • ίʔυΛมߋ͢Δ͜ͱͳ͘σϓϩΠ͝ ͱʹ؆୯ʹมߋͰ͖Δ • ݴޠ΍OSʹґଘ͠ͳ͍
13. > ଞͷํ๏ʹର͢Δ Twelve-Factor AppͷධՁ
14. ଞઃఆํ๏ ʹର͢ΔධՁ(1) • όʔδϣϯ؅ཧγεςϜʹνΣοΫΠϯ͞ Εͳ͍ઃఆϑΝΠϧΛ࢖͏ • Railsͷconfig/database.yml • ઃఆϑΝΠϧ͕ޡͬͯϦϙδτϦʹ νΣοΫΠϯ͞Ε΍͍͢ • ͢΂ͯͷઃఆΛҰͭͷ৔ॴͰݟͨΓ؅ ཧͨ͠Γ͢Δͷ͕೉͘͠ͳΓ͕ͪ
15. ଞઃఆํ๏ ʹର͢ΔධՁ(2) • ઃఆΛάϧʔϓʹ·ͱΊΔ • developmentɺtestɺproductionͱ͍ͬͨ؀ڥ͝ͱʹ ઃఆΛάϧʔϓ͝ͱʹ·ͱΊΔ • ৽͍͠؀ڥ͕૿͑ͨࡍͷεέʔϧͷ͠ ʹ͍͘ • ઃఆ͕૊Έ߹Θͤతʹ૿͑ͨࡍɺΞϓ ϦέʔγϣϯͷσϓϩΠͷ؅ཧ͕ෆ҆ఆ ʹͳΓ͕ͪ
16. > ͳΔ΄Ͳ
17. ؀ڥม਺Ͳ͏ͩΖ͏ • ίϯςφ্Ͱಈ͔͢͜ͱΛ૝ఆ ECS(Fargate) • ίϯςφϓϩηεʹରͯ͠؀ڥม਺Λ஫ೖ
18. ίϯςφҎ֎ͷ৔߹ͩͱ • /etc/environmentʹॻ͘ -> ඞཁͳϓ ϩηεҎ֎΋ݟΕΔ • ApacheͷSetEnvઃఆͳͲ -> ϛυϧ ΢ΣΞ͝ͱͷઃఆඞཁʹͳΔʢcronʣ • 1ΞϓϦέʔγϣϯɾ1Ϣʔβʔͷલఏ Ͱ͋Ε͹ɺϢʔβʔ୯Ґͷ؀ڥม਺Ͱ΋ ͍͍ʢ.profileʁʣ
19. > ؀ڥม਺ʹೖΕΔํ๏͸ྑ ͦ͞͏
20. ஫ೖ͢Δ؀ڥม਺͸Ͳ͏؅ཧʁ • ✍ΞϓϦέʔγϣϯͳΒdotenvʹॻ͔͘ʁ • ։ൃ؀ڥ͚ͩ࢖͏ʁ • →։ൃ/ຊ൪Ͱ؀ڥม਺ͷѻ͍ํ͕ҧ͏ҧ࿨ײ • ຊ൪؀ڥ΋࢖͏ͳΒdotenvϑΝΠϧΛͲ͏؅ཧ͢Δʁ • →.env.production ϑΝΠϧΛgit؅ཧ಺ʹɾɾɾ • ✍ECSͳΒʁ • ௚઀؀ڥม਺Λઃఆ͸ආ͚ͨͦ͏ • KMS & ssm parameter storeͷ૊Έ߹Θͤʁ
21. ஫ೖ͢Δ؀ڥม਺͸Ͳ͏؅ཧʁ • ਺͕ଟ͘ͳ͖ͬͯͨ࣌ʹ௚ྻ؅ཧͳͷ͔ʁ • άϧʔϐϯά؅ཧ • ؀ڥม਺͚ͩͰઃఆ৘ใΛ؅ཧ͢Δͷ͕ͭ Βͦ͏
22. > ߟ͑ํΛ෦෼ద༻͢Δ
23. ํ਑ɿઃఆΛҰ෦෼཭ • ύεϫʔυͱ͍ͬͨΑΓൿಗͳ৘ใͷΈ؀ ڥม਺ʹ֨ೲ͢Δ • ίʔυ͔Β෼཭ • ECSͳΒKMSͳͲͰ҉߸ԽͰ͖Δ • ͦͷଞઃఆ͸ɺ؀ڥ͝ͱͷάϧʔϓʹ·ͱ ΊΔ • ਺͕૿͑ͨͱ͖ͷ؅ཧ
24. ࣮૷ྫ
    IUUQTHJUIVCDPN,IJHBTIJHVDIJHPDPOpHFYBNQMFUSFFW
25. ࣮૷ɿઃఆΛҰ෦෼཭ • ύεϫʔυ͸؀ڥม਺ʹ֨ೲ͢Δ • ͦͷଞઃఆ͸ɺ؀ڥ͝ͱͷTOMLϑΝΠϧ ʹ֨ೲ͢Δ
26. BurntSushi/toml • https://github.com/BurntSushi/toml • TOML parser for Golang with reflection. • Star: 2.186 (2018/8/20)
27. TOML [database] user = "sample_user" host = "master_mysql" port = 3306 name = "sample" databaseͷ઀ଓ৘ใΛఆٛ tomlϑΝΠϧΛ؀ڥ͝ͱʹ༻ҙ localhost.toml
28. Load Configuration // DBConfig represents database connection configuration information. type DBConfig struct { User string `toml:"user"` Password string // tomlϑΝΠϧ͔Β෼཭͢ΔͨΊλάΛ࡟আ Host string `toml:"host"` Port int `toml:"port"` Name string `toml:"name"` } // Config represents application configuration. type Config struct { DB DBConfig `toml:"database"` } ConfigΛߏ଄ମͱͯ͠ఆٛ structλάʹtomlͷfield໊Λࢦఆ config.go
29. Load Configuration // DBConfig represents database connection configuration information. type DBConfig struct { User string `toml:"user"` Password string // tomlϑΝΠϧ͔Β෼཭͢ΔͨΊλάΛ࡟আ Host string `toml:"host"` Port int `toml:"port"` Name string `toml:"name"` } // Config represents application configuration. type Config struct { DB DBConfig `toml:"database"` } ύεϫʔυͷΈ؀ڥม਺͔Βऔಘ config.go
30. Load Configuration // NewConfig return configuration struct. func NewConfig(path string, appMode string) (Config, error) { var conf Config confPath := path + appMode + ".toml" if _, err := toml.DecodeFile(confPath, &conf); err != nil { return conf, err } conf.DB.Password = os.Getenv("DB_PASSWORD") // ؀ڥม਺͔ΒಡΈࠐΉ return conf, nil } ࢖༻͢ΔtomlϑΝΠϧͷࢦఆ localhost -> localhost.toml production -> production.toml config.go
31. Load Configuration // NewConfig return configuration struct. func NewConfig(path string, appMode string) (Config, error) { var conf Config confPath := path + appMode + ".toml" if _, err := toml.DecodeFile(confPath, &conf); err != nil { return conf, err } conf.DB.Password = os.Getenv("DB_PASSWORD") // ؀ڥม਺͔ΒಡΈࠐΉ return conf, nil } tomlϑΝΠϧͷσίʔυ config.go
32. Load Configuration // NewConfig return configuration struct. func NewConfig(path string, appMode string) (Config, error) { var conf Config confPath := path + appMode + ".toml" if _, err := toml.DecodeFile(confPath, &conf); err != nil { return conf, err } conf.DB.Password = os.Getenv("DB_PASSWORD") // ؀ڥม਺͔ΒಡΈࠐΉ return conf, nil } ύεϫʔυΛ؀ڥม਺͔Βऔಘ config.go
33. Use Configuration const confDir = "./config/env/" //ɹઃఆϑΝΠϧ΁ͷ࣮ߦϑΝΠϧ͔Βͷ૬ରύεΛࢦఆ func main() { var err error appMode := os.Getenv("APP_MODE") // ಈ࡞؀ڥΛAPP_MODEͱ͍͏ܗͰ؀ڥม਺ʹ֨ೲ͢Δ if appMode == "" { panic("failed to get application mode, check whether APP_MODE is set.") } // Get configuration conf, err := config.NewConfig(confDir, appMode) // Ҿ਺ʹ౉͢ if err != nil { panic(err.Error()) } // Ҏ߱ଓ͘... } ઃఆ৘ใͷऔಘ main.go
34. Test Loading Configuration func TestNewConfig(t *testing.T) { cases := []struct { name string appMode string expected config.Config }{ { name: "localhost", appMode: "localhost", expected: config.Config{ DB: config.DBConfig{ User: "sample_user", Password: "sample_password", Host: "master_mysql", Port: 3306, Name: "sample", }, }, }, } //ଓ͘ } ؀ڥ͝ͱͷࠩҟɾաෆ଍ɾߟྀෆ ଍ʹ͍ͭͯͷϦεΫܰݮͷͨΊɺ ରԠ͢Δ؀ڥ͝ͱʹςετ config_test.go
35. Test Loading Configuration ɹɹ // લճͷଓ͖ for _, c := range cases { t.Run(c.name, func(t *testing.T) { confDir := "./env/" os.Setenv("DB_PASSWORD", c.expected.DB.Password) // ؀ڥม਺ʹظ଴͢ΔύεϫʔυΛηοτ ͢Δ res, err := config.NewConfig(confDir, c.appMode) assert.Equal(t, nil, err) assert.Equal(t, c.expected.DB.User, res.DB.User) assert.Equal(t, c.expected.DB.Password, res.DB.Password) assert.Equal(t, c.expected.DB.Host, res.DB.Host) assert.Equal(t, c.expected.DB.Port, res.DB.Port) assert.Equal(t, c.expected.DB.Name, res.DB.Name) }) } } config_test.go
36. ͞Βʹৄ͘͠͸Qiitaʹͯ IUUQTRJJUBDPN,IJHBTIJHVDIJJUFNTBCCGCGGB
37. ·ͱΊ
38. ·ͱΊ • Twelve-Factor AppͷઃఆϑΝΠϧͷࢥ૝ΛҰ ෦ద༻ͯ͠ɺઃఆΛίʔυ͔ΒҰ෦෼཭ͨ͠ • ઀ଓ৘ใΛઃఆϑΝΠϧͱͯ͠؀ڥ͝ͱʹ TOMLϑΝΠϧʹఆٛͨ͠ • ύεϫʔυΛ؀ڥม਺ʹ֨ೲ͢Δํࣜʹͨ͠
39. ͝ਗ਼ௌ͋Γ͕ͱ͏͍͟͝·͠ ͨɻ BASEגࣜձࣾ ౦ޱ࿨ᏻ @Khigashiguchi